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

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

Public Types

enum  Lines { LinesHidden, LinesVisible }
 Line type. More...
 
enum  ShipbuildingLines { ShipbuildingLinesProfile, ShipbuildingLinesPlate }
 Geometry type. More...
 

Public Member Functions

int GetColor (const NXString &featureName, NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines linesType)
 Get line color. More...
 
int GetColor (const char *featureName, NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines linesType)
 Get line color. More...
 
NXOpen::Preferences::Font GetFont (const NXString &featureName, NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines linesType)
 Get line font. More...
 
NXOpen::Preferences::Font GetFont (const char *featureName, NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines linesType)
 Get line font. More...
 
bool GetSingleLineRepresentation (NXOpen::Drawings::ShipbuildingLinesViewStyle::ShipbuildingLines featureType, const NXString &featureName)
 Get single line status. More...
 
bool GetSingleLineRepresentation (NXOpen::Drawings::ShipbuildingLinesViewStyle::ShipbuildingLines featureType, const char *featureName)
 Get single line status. More...
 
NXOpen::Preferences::Width GetWidth (const NXString &featureName, NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines linesType)
 Get line width. More...
 
NXOpen::Preferences::Width GetWidth (const char *featureName, NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines linesType)
 Get line width. More...
 
void SetColor (const NXString &featureName, NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines linesType, int color)
 The color of ship line. More...
 
void SetColor (const char *featureName, NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines linesType, int color)
 The color of ship line. More...
 
void SetFont (const NXString &featureName, NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines linesType, NXOpen::Preferences::Font font)
 The font type of ship line. More...
 
void SetFont (const char *featureName, NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines linesType, NXOpen::Preferences::Font font)
 The font type of ship line. More...
 
void SetSingleLineRepresentation (NXOpen::Drawings::ShipbuildingLinesViewStyle::ShipbuildingLines featureType, const NXString &featureName, bool singleLine)
 Note: The initial values are set based on the customer defaults depending on whether the feature is a Profile or a Plate. More...
 
void SetSingleLineRepresentation (NXOpen::Drawings::ShipbuildingLinesViewStyle::ShipbuildingLines featureType, const char *featureName, bool singleLine)
 Note: The initial values are set based on the customer defaults depending on whether the feature is a Profile or a Plate. More...
 
void SetWidth (const NXString &featureName, NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines linesType, NXOpen::Preferences::Width width)
 The width of hidden line or edges. More...
 
void SetWidth (const char *featureName, NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines linesType, NXOpen::Preferences::Width width)
 The width of hidden line or edges. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents set of Shipbuilding Lines View Style applicable to drafting views.

Shipbuilding lines are used for a Profile or a Plate feature in Ship Design
To obtain an instance of this class use Drawings::ViewStyle::ShipbuildingLines

Created in NX8.0.0.

Member Enumeration Documentation

Line type.

Enumerator
LinesHidden 

Hidden.

LinesVisible 

Visible.

Geometry type.

Enumerator
ShipbuildingLinesProfile 

Profile.

ShipbuildingLinesPlate 

Plate.

Member Function Documentation

int NXOpen::Drawings::ShipbuildingLinesViewStyle::GetColor ( const NXString featureName,
NXOpen::Drawings::ShipbuildingLinesViewStyle::Lines  linesType 
)

Get line color.

Returns

Created in NX8.0.0.

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

Get line color.

Returns

Created in NX8.0.0.

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

Get line font.

Returns

Created in NX8.0.0.

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

Get line font.

Returns

Created in NX8.0.0.

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

Get single line status.

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

License requirements : None
Parameters
featureTypefeature type
featureNamefeature name e.g. decks, bulkheads etc.
bool NXOpen::Drawings::ShipbuildingLinesViewStyle::GetSingleLineRepresentation ( NXOpen::Drawings::ShipbuildingLinesViewStyle::ShipbuildingLines  featureType,
const char *  featureName 
)

Get single line status.

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

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

Get line width.

Returns

Created in NX8.0.0.

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

Get line width.

Returns

Created in NX8.0.0.

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

The color of ship line.

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

License requirements : drafting ("DRAFTING")

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

The color of ship line.

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

License requirements : drafting ("DRAFTING")

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

The font type of ship line.


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

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

The font type of ship line.


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

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

Note: The initial values are set based on the customer defaults depending on whether the feature is a Profile or a Plate.

The status determines the single line representation for the ship feature in a view.
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters
featureTypefeature type
featureNamefeature name e.g. decks, bulkheads etc.
singleLinestatus that determines SLR for the feature
void NXOpen::Drawings::ShipbuildingLinesViewStyle::SetSingleLineRepresentation ( NXOpen::Drawings::ShipbuildingLinesViewStyle::ShipbuildingLines  featureType,
const char *  featureName,
bool  singleLine 
)

Note: The initial values are set based on the customer defaults depending on whether the feature is a Profile or a Plate.

The status determines the single line representation for the ship feature in a view.
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

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

The width of hidden line or edges.


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

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

The width of hidden line or edges.


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
widthWidth
tag_t NXOpen::Drawings::ShipbuildingLinesViewStyle::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.