NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Preferences::ShipbuildingLinesViewPreferences Class Reference

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

List of all members.

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::Preferences::ShipbuildingLinesViewPreferences::Lines linesType)
 Get line color.
NXOpen::Preferences::Font GetFont (const NXString &featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType)
 Get line font.
bool GetSingleLineRepresentation (NXOpen::Preferences::ShipbuildingLinesViewPreferences::ShipbuildingLines featureType, const NXString &featureName)
 Get single line status.
NXOpen::Preferences::Width GetWidth (const NXString &featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType)
 Get line width.
void SetColor (const NXString &featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType, int color)
 The color of ship line.
void SetFont (const NXString &featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType, NXOpen::Preferences::Font font)
 The font type of ship line.
void SetSingleLineRepresentation (NXOpen::Preferences::ShipbuildingLinesViewPreferences::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.
void SetWidth (const NXString &featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType, NXOpen::Preferences::Width width)
 The width of hidden line or edges.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

Represents set of Shipbuilding Lines View Preferences 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 Preferences::ViewPreferences::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

Get line color.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
featureNamefeature name e.g. decks, bulkheads etc.
NOTE: The full Unicode character set is not supported for this parameter.
linesTypevisible or hidden line type

Get line font.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
featureNamefeature name e.g. decks, bulkheads etc.
NOTE: The full Unicode character set is not supported for this parameter.
linesTypevisible or hidden line type

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.
NOTE: The full Unicode character set is not supported for this parameter.

Get line width.

Returns:

Created in NX8.0.0.

License requirements : None
Parameters:
featureNamefeature name e.g. decks, bulkheads etc.
NOTE: The full Unicode character set is not supported for this parameter.
linesTypevisible or hidden line type

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.
NOTE: The full Unicode character set is not supported for this parameter.
linesTypevisible or hidden line type
colorColor

The font type of ship line.


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
featureNamefeature name e.g. decks, bulkheads etc.
NOTE: The full Unicode character set is not supported for this parameter.
linesTypevisible or hidden line type
fontFont

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.
NOTE: The full Unicode character set is not supported for this parameter.
singleLinestatus that determines SLR for the feature

The width of hidden line or edges.


Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters:
featureNamefeature name e.g. decks, bulkheads etc.
NOTE: The full Unicode character set is not supported for this parameter.
linesTypevisible or hidden line type
widthWidth

Returns the tag of this object.


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