ShipbuildingLinesViewPreferences Class¶
-
class
NXOpen.Preferences.
ShipbuildingLinesViewPreferences
¶ Bases:
object
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
New in version NX8.0.0.
Methods¶
Method | Description |
---|---|
GetColor | Get line color @return |
GetFont | Get line font @return |
GetSingleLineRepresentation | Get single line status @return status that determines SLR for the feature |
GetWidth | Get line width @return |
SetColor | The color of ship line. |
SetFont | The font type of ship line. |
SetSingleLineRepresentation | Note: The initial values are set based on the customer defaults depending on whether the feature is a Profile or a Plate. |
SetWidth | The width of hidden line or edges. |
Enumerations¶
ShipbuildingLinesViewPreferencesLines Enumeration | Line type |
ShipbuildingLinesViewPreferencesShipbuildingLines Enumeration | Geometry type |
Method Detail¶
GetColor¶
-
ShipbuildingLinesViewPreferences.
GetColor
¶ Get line color
Signature
GetColor(featureName, linesType)
Parameters: - featureName (str) – feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
- linesType (
NXOpen.Preferences.ShipbuildingLinesViewPreferencesLines
) – visible or hidden line type
Returns: Return type: int
New in version NX8.0.0.
License requirements: None.
GetFont¶
-
ShipbuildingLinesViewPreferences.
GetFont
¶ Get line font
Signature
GetFont(featureName, linesType)
Parameters: - featureName (str) – feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
- linesType (
NXOpen.Preferences.ShipbuildingLinesViewPreferencesLines
) – visible or hidden line type
Returns: Return type: New in version NX8.0.0.
License requirements: None.
GetSingleLineRepresentation¶
-
ShipbuildingLinesViewPreferences.
GetSingleLineRepresentation
¶ Get single line status
Signature
GetSingleLineRepresentation(featureType, featureName)
Parameters: - featureType (
NXOpen.Preferences.ShipbuildingLinesViewPreferencesShipbuildingLines
) – feature type - featureName (str) – feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
Returns: status that determines SLR for the feature
Return type: bool
New in version NX8.0.0.
License requirements: None.
- featureType (
GetWidth¶
-
ShipbuildingLinesViewPreferences.
GetWidth
¶ Get line width
Signature
GetWidth(featureName, linesType)
Parameters: - featureName (str) – feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
- linesType (
NXOpen.Preferences.ShipbuildingLinesViewPreferencesLines
) – visible or hidden line type
Returns: Return type: New in version NX8.0.0.
License requirements: None.
SetColor¶
-
ShipbuildingLinesViewPreferences.
SetColor
¶ The color of ship line.
The value should be between UF_OBJ_MIN_COLOR and UF_OBJ_MAX_COLOR.
Signature
SetColor(featureName, linesType, color)
Parameters: - featureName (str) – feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
- linesType (
NXOpen.Preferences.ShipbuildingLinesViewPreferencesLines
) – visible or hidden line type - color (int) – Color
New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
SetFont¶
-
ShipbuildingLinesViewPreferences.
SetFont
¶ The font type of ship line.
Signature
SetFont(featureName, linesType, font)
Parameters: - featureName (str) – feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
- linesType (
NXOpen.Preferences.ShipbuildingLinesViewPreferencesLines
) – visible or hidden line type - font (
NXOpen.Preferences.Font
) – Font
New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
SetSingleLineRepresentation¶
-
ShipbuildingLinesViewPreferences.
SetSingleLineRepresentation
¶ 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.
Signature
SetSingleLineRepresentation(featureType, featureName, singleLine)
Parameters: - featureType (
NXOpen.Preferences.ShipbuildingLinesViewPreferencesShipbuildingLines
) – feature type - featureName (str) – feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
- singleLine (bool) – status that determines SLR for the feature
New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
- featureType (
SetWidth¶
-
ShipbuildingLinesViewPreferences.
SetWidth
¶ The width of hidden line or edges.
Signature
SetWidth(featureName, linesType, width)
Parameters: - featureName (str) – feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
- linesType (
NXOpen.Preferences.ShipbuildingLinesViewPreferencesLines
) – visible or hidden line type - width (
NXOpen.Preferences.Width
) – Width
New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)