ShipbuildingLinesViewStyle Class — NXOpen Python API Reference 12.0.0 documentation

# ShipbuildingLinesViewStyle Class

class `NXOpen.Drawings.``ShipbuildingLinesViewStyle`

  Bases: `object`

  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()`

  New in version NX8.0.0.

# Methods

Method | Description
--- | ---
GetColor | Get line color
GetFont | Get line font
GetSingleLineRepresentation | Get single line status
GetWidth | Get line width
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

ShipbuildingLinesViewStyleLines Enumeration | Line type
ShipbuildingLinesViewStyleShipbuildingLines Enumeration | Geometry type

# Method Detail

## GetColor

`ShipbuildingLinesViewStyle.``GetColor`

  Get line color

  Signature `GetColor(featureName, linesType)`

  Parameters:

  - featureName (str) – feature name e.g. decks, bulkheads etc.
  - linesType (`NXOpen.Drawings.ShipbuildingLinesViewStyleLines`) – visible or hidden line type

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

## GetFont

`ShipbuildingLinesViewStyle.``GetFont`

  Get line font

  Signature `GetFont(featureName, linesType)`

  Parameters:

  - featureName (str) – feature name e.g. decks, bulkheads etc.
  - linesType (`NXOpen.Drawings.ShipbuildingLinesViewStyleLines`) – visible or hidden line type

  Returns: |
  Return type: | `NXOpen.Preferences.Font`

  New in version NX8.0.0.

  License requirements: None.

## GetSingleLineRepresentation

`ShipbuildingLinesViewStyle.``GetSingleLineRepresentation`

  Get single line status

  Signature `GetSingleLineRepresentation(featureType, featureName)`

  Parameters:

  - featureType (`NXOpen.Drawings.ShipbuildingLinesViewStyleShipbuildingLines`) – feature type
  - featureName (str) – feature name e.g. decks, bulkheads etc.

  Returns: | status that determines SLR for the feature
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

## GetWidth

`ShipbuildingLinesViewStyle.``GetWidth`

  Get line width

  Signature `GetWidth(featureName, linesType)`

  Parameters:

  - featureName (str) – feature name e.g. decks, bulkheads etc.
  - linesType (`NXOpen.Drawings.ShipbuildingLinesViewStyleLines`) – visible or hidden line type

  Returns: |
  Return type: | `NXOpen.Preferences.Width`

  New in version NX8.0.0.

  License requirements: None.

## SetColor

`ShipbuildingLinesViewStyle.``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.
  - linesType (`NXOpen.Drawings.ShipbuildingLinesViewStyleLines`) – visible or hidden line type
  - color (int) – Color

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)

## SetFont

`ShipbuildingLinesViewStyle.``SetFont`

  The font type of ship line.

  Signature `SetFont(featureName, linesType, font)`

  Parameters:

  - featureName (str) – feature name e.g. decks, bulkheads etc.
  - linesType (`NXOpen.Drawings.ShipbuildingLinesViewStyleLines`) – visible or hidden line type
  - font (`NXOpen.Preferences.Font`) – Font

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)

## SetSingleLineRepresentation

`ShipbuildingLinesViewStyle.``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.Drawings.ShipbuildingLinesViewStyleShipbuildingLines`) – feature type
  - featureName (str) – feature name e.g. decks, bulkheads etc.
  - singleLine (bool) – status that determines SLR for the feature

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)

## SetWidth

`ShipbuildingLinesViewStyle.``SetWidth`

  The width of hidden line or edges.

  Signature `SetWidth(featureName, linesType, width)`

  Parameters:

  - featureName (str) – feature name e.g. decks, bulkheads etc.
  - linesType (`NXOpen.Drawings.ShipbuildingLinesViewStyleLines`) – visible or hidden line type
  - width (`NXOpen.Preferences.Width`) – Width

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)