NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Preferences.ShipDraftingViewLinesViewPreferences Class Reference

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

Inheritance diagram for NXOpen.Preferences.ShipDraftingViewLinesViewPreferences:

Public Types

enum  Lines {
  HiddenNonsection, VisibleNonsection, HiddenSection, VisibleSection,
  SecondaryHiddenNonsection, SecondaryVisibleNonsection, SecondaryHiddenSection, SecondaryVisibleSection
}
 Line type More...
 

Public Member Functions

unsafe void SetShipDrawingObject (string featureName, bool singleLine)
 Note: The initial values are set based on the file NX_ShipAttribute. More...
 
unsafe bool GetShipDrawingObject (string featureName)
 Get single line status More...
 
unsafe void SetColor (string featureName, NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.Lines linesType, int color)
 The color of ship line. More...
 
unsafe int GetColor (string featureName, NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.Lines linesType)
 Get line color More...
 
unsafe void SetFont (string featureName, NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.Lines linesType, NXOpen.Preferences.Font font)
 The font type of ship line. More...
 
unsafe NXOpen.Preferences.Font GetFont (string featureName, NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.Lines linesType)
 Get line font More...
 
unsafe void SetWidth (string featureName, NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.Lines linesType, NXOpen.Preferences.Width width)
 The width of hidden line or edges. More...
 
unsafe NXOpen.Preferences.Width GetWidth (string featureName, NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.Lines linesType)
 Get line width More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 

Detailed Description

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

Created in NX10.0.0

Member Enumeration Documentation

Line type

Enumerator
HiddenNonsection 

Hidden, NonSection

VisibleNonsection 

Visible, NonSection

HiddenSection 

Hidden, Section

VisibleSection 

Visible, Section

SecondaryHiddenNonsection 

Secondary, Hidden, NonSection

SecondaryVisibleNonsection 

Secondary, Visible, NonSection

SecondaryHiddenSection 

Secondary, Hidden, Section

SecondaryVisibleSection 

Secondary, Visible, Section

Member Function Documentation

unsafe int NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.GetColor ( string  featureName,
NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.Lines  linesType 
)

Get line color

Created in NX10.0.0

License requirements: None.

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
Returns
unsafe NXOpen.Preferences.Font NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.GetFont ( string  featureName,
NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.Lines  linesType 
)

Get line font

Created in NX10.0.0

License requirements: None.

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
Returns
unsafe bool NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.GetShipDrawingObject ( string  featureName)

Get single line status

Created in NX10.0.0

License requirements: None.

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
Returns
status that determines SLR for the feature
unsafe NXOpen.Preferences.Width NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.GetWidth ( string  featureName,
NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.Lines  linesType 
)

Get line width

Created in NX10.0.0

License requirements: None.

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
Returns
unsafe void NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.SetColor ( string  featureName,
NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.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 NX10.0.0

License requirements: nx_ship_drafting ("Ship Drafting")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
colorColor
unsafe void NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.SetFont ( string  featureName,
NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.Lines  linesType,
NXOpen.Preferences.Font  font 
)

The font type of ship line.

Created in NX10.0.0

License requirements: nx_ship_drafting ("Ship Drafting")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
fontFont
unsafe void NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.SetShipDrawingObject ( string  featureName,
bool  singleLine 
)

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.

Created in NX10.0.0

License requirements: nx_ship_drafting ("Ship Drafting")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
singleLinestatus that determines SLR for the feature
unsafe void NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.SetWidth ( string  featureName,
NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.Lines  linesType,
NXOpen.Preferences.Width  width 
)

The width of hidden line or edges.

Created in NX10.0.0

License requirements: nx_ship_drafting ("Ship Drafting")

Parameters
featureNamefeature name e.g. decks, bulkheads etc.
linesTypevisible or hidden line type
widthWidth

Property Documentation

Tag NXOpen.Preferences.ShipDraftingViewLinesViewPreferences.Tag
get

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.