ShipDraftingViewLinesViewPreferences Class — NXOpen Python API Reference 12.0.0 documentation

# ShipDraftingViewLinesViewPreferences Class

class `NXOpen.Preferences.``ShipDraftingViewLinesViewPreferences`

  Bases: `object`

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

  Ship drafting view lines are used for the features in Ship Design To obtain an instance of this class use `Preferences.ViewPreferences.ShipDraftingViewLines()`

  New in version NX10.0.0.

# Methods

Method | Description
--- | ---
GetColor | Get line color
GetFont | Get line font
GetShipDrawingObject | Get single line status
GetWidth | Get line width
SetColor | The color of ship line.
SetFont | The font type of ship line.
SetShipDrawingObject | Note: The initial values are set based on the file NX_ShipAttribute.
SetWidth | The width of hidden line or edges.

# Enumerations

ShipDraftingViewLinesViewPreferencesLines Enumeration | Line type

# Method Detail

## GetColor

`ShipDraftingViewLinesViewPreferences.``GetColor`

  Get line color

  Signature `GetColor(featureName, linesType)`

  Parameters:

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

  Returns: |
  Return type: | int

  New in version NX10.0.0.

  License requirements: None.

## GetFont

`ShipDraftingViewLinesViewPreferences.``GetFont`

  Get line font

  Signature `GetFont(featureName, linesType)`

  Parameters:

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

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

  New in version NX10.0.0.

  License requirements: None.

## GetShipDrawingObject

`ShipDraftingViewLinesViewPreferences.``GetShipDrawingObject`

  Get single line status

  Signature `GetShipDrawingObject(featureName)`

  Parameters: | featureName (str) – feature name e.g. decks, bulkheads etc.
  Returns: | status that determines SLR for the feature
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

## GetWidth

`ShipDraftingViewLinesViewPreferences.``GetWidth`

  Get line width

  Signature `GetWidth(featureName, linesType)`

  Parameters:

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

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

  New in version NX10.0.0.

  License requirements: None.

## SetColor

`ShipDraftingViewLinesViewPreferences.``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.Preferences.ShipDraftingViewLinesViewPreferencesLines`) – visible or hidden line type
  - color (int) – Color

  New in version NX10.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)

## SetFont

`ShipDraftingViewLinesViewPreferences.``SetFont`

  The font type of ship line.

  Signature `SetFont(featureName, linesType, font)`

  Parameters:

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

  New in version NX10.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)

## SetShipDrawingObject

`ShipDraftingViewLinesViewPreferences.``SetShipDrawingObject`

  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.

  Signature `SetShipDrawingObject(featureName, singleLine)`

  Parameters:

  - featureName (str) – feature name e.g. decks, bulkheads etc.
  - singleLine (bool) – status that determines SLR for the feature

  New in version NX10.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)

## SetWidth

`ShipDraftingViewLinesViewPreferences.``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.Preferences.ShipDraftingViewLinesViewPreferencesLines`) – visible or hidden line type
  - width (`NXOpen.Preferences.Width`) – Width

  New in version NX10.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)