NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Drawings::ShipDraftingViewLinesViewStyle Class Reference

Represents set of Ship Drafting Lines View Style applicable to drafting views. More...

Public Types

enum  Lines {
  LinesHiddenNonsection, LinesVisibleNonsection, LinesHiddenSection, LinesVisibleSection,
  LinesSecondaryHiddenNonsection, LinesSecondaryVisibleNonsection, LinesSecondaryHiddenSection, LinesSecondaryVisibleSection
}
 Line type. More...
 

Public Member Functions

NXOpen::NXColorGetColor (const NXString &featureName, NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines linesType)
 Gets line color. More...
 
NXOpen::NXColorGetColor (const char *featureName, NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines linesType)
 Gets line color. More...
 
NXOpen::Preferences::Font GetFont (const NXString &featureName, NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines linesType)
 Gets line font. More...
 
NXOpen::Preferences::Font GetFont (const char *featureName, NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines linesType)
 Gets line font. More...
 
bool GetShipDrawingObject (const NXString &featureName)
 Get ship drawing object status. More...
 
bool GetShipDrawingObject (const char *featureName)
 Get ship drawing object status. More...
 
NXOpen::Preferences::Width GetWidth (const NXString &featureName, NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines linesType)
 Gets line width. More...
 
NXOpen::Preferences::Width GetWidth (const char *featureName, NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines linesType)
 Gets line width. More...
 
void SetColor (const NXString &featureName, NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines linesType, NXOpen::NXColor *color)
 The color of ship line. More...
 
void SetColor (const char *featureName, NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines linesType, NXOpen::NXColor *color)
 The color of ship line. More...
 
void SetFont (const NXString &featureName, NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines linesType, NXOpen::Preferences::Font font)
 The font type of ship line. More...
 
void SetFont (const char *featureName, NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines linesType, NXOpen::Preferences::Font font)
 The font type of ship line. More...
 
void SetShipDrawingObject (const NXString &featureName, bool singleLine)
 Note: The initial values are set based on the file NX_ShipAttribute.xml The status determines the line settings for the ship feature in a view. More...
 
void SetShipDrawingObject (const char *featureName, bool singleLine)
 Note: The initial values are set based on the file NX_ShipAttribute.xml The status determines the line settings for the ship feature in a view. More...
 
void SetWidth (const NXString &featureName, NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines linesType, NXOpen::Preferences::Width width)
 The width of ship line. More...
 
void SetWidth (const char *featureName, NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines linesType, NXOpen::Preferences::Width width)
 The width of ship line. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents set of Ship Drafting Lines View Style applicable to drafting views.

Ship Drafting View lines are used for the features in Ship Design
To obtain an instance of this class use Drawings::ViewStyle::ShipDraftingViewLines

Created in NX10.0.0.

Member Enumeration Documentation

Line type.

Enumerator
LinesHiddenNonsection 

Hidden, NonSection.

LinesVisibleNonsection 

Visible, NonSection.

LinesHiddenSection 

Hidden, Section.

LinesVisibleSection 

Visible, Section.

LinesSecondaryHiddenNonsection 

Secondary, Hidden, NonSection.

LinesSecondaryVisibleNonsection 

Secondary, Visible, NonSection.

LinesSecondaryHiddenSection 

Secondary, Hidden, Section.

LinesSecondaryVisibleSection 

Secondary, Visible, Section.

Member Function Documentation

NXOpen::NXColor* NXOpen::Drawings::ShipDraftingViewLinesViewStyle::GetColor ( const NXString featureName,
NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines  linesType 
)

Gets line color.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
NXOpen::NXColor* NXOpen::Drawings::ShipDraftingViewLinesViewStyle::GetColor ( const char *  featureName,
NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines  linesType 
)

Gets line color.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
NXOpen::Preferences::Font NXOpen::Drawings::ShipDraftingViewLinesViewStyle::GetFont ( const NXString featureName,
NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines  linesType 
)

Gets line font.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
NXOpen::Preferences::Font NXOpen::Drawings::ShipDraftingViewLinesViewStyle::GetFont ( const char *  featureName,
NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines  linesType 
)

Gets line font.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
bool NXOpen::Drawings::ShipDraftingViewLinesViewStyle::GetShipDrawingObject ( const NXString featureName)

Get ship drawing object status.

Returns
status that determines SLR for the feature
Created in NX10.0.0.

License requirements : None
Parameters
featureNamefeature name e.g. decks, bulkheads etc.
bool NXOpen::Drawings::ShipDraftingViewLinesViewStyle::GetShipDrawingObject ( const char *  featureName)

Get ship drawing object status.

Returns
status that determines SLR for the feature
Created in NX10.0.0.

License requirements : None
Parameters
featureNamefeature name e.g. decks, bulkheads etc.
NXOpen::Preferences::Width NXOpen::Drawings::ShipDraftingViewLinesViewStyle::GetWidth ( const NXString featureName,
NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines  linesType 
)

Gets line width.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
NXOpen::Preferences::Width NXOpen::Drawings::ShipDraftingViewLinesViewStyle::GetWidth ( const char *  featureName,
NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines  linesType 
)

Gets line width.

Returns

Created in NX10.0.0.

License requirements : None
Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
void NXOpen::Drawings::ShipDraftingViewLinesViewStyle::SetColor ( const NXString featureName,
NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines  linesType,
NXOpen::NXColor color 
)

The color of ship line.

The value should be between UF_OBJ_MIN_COLOR and UF_OBJ_MAX_COLOR.
Created in NX10.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
colorColor
void NXOpen::Drawings::ShipDraftingViewLinesViewStyle::SetColor ( const char *  featureName,
NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines  linesType,
NXOpen::NXColor color 
)

The color of ship line.

The value should be between UF_OBJ_MIN_COLOR and UF_OBJ_MAX_COLOR.
Created in NX10.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
colorColor
void NXOpen::Drawings::ShipDraftingViewLinesViewStyle::SetFont ( const NXString featureName,
NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines  linesType,
NXOpen::Preferences::Font  font 
)

The font type of ship line.


Created in NX10.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
fontFont
void NXOpen::Drawings::ShipDraftingViewLinesViewStyle::SetFont ( const char *  featureName,
NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines  linesType,
NXOpen::Preferences::Font  font 
)

The font type of ship line.


Created in NX10.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
fontFont
void NXOpen::Drawings::ShipDraftingViewLinesViewStyle::SetShipDrawingObject ( const NXString featureName,
bool  singleLine 
)

Note: The initial values are set based on the file NX_ShipAttribute.xml The status determines the line settings for the ship feature in a view.


Created in NX10.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
singleLinestatus that determines SLR for the feature
void NXOpen::Drawings::ShipDraftingViewLinesViewStyle::SetShipDrawingObject ( const char *  featureName,
bool  singleLine 
)

Note: The initial values are set based on the file NX_ShipAttribute.xml The status determines the line settings for the ship feature in a view.


Created in NX10.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
singleLinestatus that determines SLR for the feature
void NXOpen::Drawings::ShipDraftingViewLinesViewStyle::SetWidth ( const NXString featureName,
NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines  linesType,
NXOpen::Preferences::Width  width 
)

The width of ship line.


Created in NX10.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
widthWidth
void NXOpen::Drawings::ShipDraftingViewLinesViewStyle::SetWidth ( const char *  featureName,
NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Lines  linesType,
NXOpen::Preferences::Width  width 
)

The width of ship line.


Created in NX10.0.0.

License requirements : nx_ship_drafting ("Ship Drafting")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
widthWidth
tag_t NXOpen::Drawings::ShipDraftingViewLinesViewStyle::Tag ( ) const

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.