NXOpen::Preferences::ShipDraftingViewLinesViewPreferences Class Reference

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

Public Types
enum	Lines {   LinesHiddenNonsection, LinesVisibleNonsection, LinesHiddenSection, LinesVisibleSection,   LinesSecondaryHiddenNonsection, LinesSecondaryVisibleNonsection, LinesSecondaryHiddenSection, LinesSecondaryVisibleSection }
	Line type. More...

Public Member Functions
int	GetColor (const NXString &featureName, NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines linesType)
	Get line color. More...
int	GetColor (const char *featureName, NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines linesType)
	Get line color. More...
NXOpen::Preferences::Font	GetFont (const NXString &featureName, NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines linesType)
	Get line font. More...
NXOpen::Preferences::Font	GetFont (const char *featureName, NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines linesType)
	Get line font. More...
bool	GetShipDrawingObject (const NXString &featureName)
	Get single line status. More...
bool	GetShipDrawingObject (const char *featureName)
	Get single line status. More...
NXOpen::Preferences::Width	GetWidth (const NXString &featureName, NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines linesType)
	Get line width. More...
NXOpen::Preferences::Width	GetWidth (const char *featureName, NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines linesType)
	Get line width. More...
void	SetColor (const NXString &featureName, NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines linesType, int color)
	The color of ship line. More...
void	SetColor (const char *featureName, NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines linesType, int color)
	The color of ship line. More...
void	SetFont (const NXString &featureName, NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines linesType, NXOpen::Preferences::Font font)
	The font type of ship line. More...
void	SetFont (const char *featureName, NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines linesType, NXOpen::Preferences::Font font)
	The font type of ship line. More...
void	SetShipDrawingObject (const NXString &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. More...
void	SetShipDrawingObject (const char *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. More...
void	SetWidth (const NXString &featureName, NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines linesType, NXOpen::Preferences::Width width)
	The width of hidden line or edges. More...
void	SetWidth (const char *featureName, NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines linesType, NXOpen::Preferences::Width width)
	The width of hidden line or edges. More...
tag_t	Tag () const
	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

enum NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines

Line type.

Enumerator
LinesHiddenNonsection	Hidden, NonSection.
LinesVisibleNonsection	Visible, NonSection.
LinesHiddenSection	Hidden, Section.
LinesVisibleSection	Visible, Section.
LinesSecondaryHiddenNonsection	Secondary, Hidden, NonSection.
LinesSecondaryVisibleNonsection	Secondary, Visible, NonSection.
LinesSecondaryHiddenSection	Secondary, Hidden, Section.
LinesSecondaryVisibleSection	Secondary, Visible, Section.

Member Function Documentation

int NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::GetColor	(	const NXString &	featureName,
		NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines	linesType
	)

Get line color.

Returns

Created in NX10.0.0.

License requirements : None

Parameters

featureName	feature name e.g. decks, bulkheads etc.
linesType	visible or hidden line type

int NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::GetColor	(	const char *	featureName,
		NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines	linesType
	)

Get line color.

Returns

Created in NX10.0.0.

License requirements : None

Parameters

featureName	feature name e.g. decks, bulkheads etc.
linesType	visible or hidden line type

NXOpen::Preferences::Font NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::GetFont	(	const NXString &	featureName,
		NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines	linesType
	)

Get line font.

Returns

Created in NX10.0.0.

License requirements : None

Parameters

featureName	feature name e.g. decks, bulkheads etc.
linesType	visible or hidden line type

NXOpen::Preferences::Font NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::GetFont	(	const char *	featureName,
		NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines	linesType
	)

Get line font.

Returns

Created in NX10.0.0.

License requirements : None

Parameters

featureName	feature name e.g. decks, bulkheads etc.
linesType	visible or hidden line type

bool NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::GetShipDrawingObject

(

const NXString &

featureName

)

Get single line status.

Returns

status that determines SLR for the feature
Created in NX10.0.0.

License requirements : None

Parameters

featureName

feature name e.g. decks, bulkheads etc.

bool NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::GetShipDrawingObject

(

const char *

featureName

)

Get single line status.

Returns

status that determines SLR for the feature
Created in NX10.0.0.

License requirements : None

Parameters

featureName

feature name e.g. decks, bulkheads etc.

NXOpen::Preferences::Width NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::GetWidth	(	const NXString &	featureName,
		NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines	linesType
	)

Get line width.

Returns

Created in NX10.0.0.

License requirements : None

Parameters

featureName	feature name e.g. decks, bulkheads etc.
linesType	visible or hidden line type

NXOpen::Preferences::Width NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::GetWidth	(	const char *	featureName,
		NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Lines	linesType
	)

Get line width.

Returns

Created in NX10.0.0.

License requirements : None

Parameters

featureName	feature name e.g. decks, bulkheads etc.
linesType	visible or hidden line type

void NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::SetColor	(	const NXString &	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

featureName	feature name e.g. decks, bulkheads etc.
linesType	visible or hidden line type
color	Color

void NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::SetColor	(	const char *	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

featureName	feature name e.g. decks, bulkheads etc.
linesType	visible or hidden line type
color	Color

void NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::SetFont	(	const NXString &	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

featureName	feature name e.g. decks, bulkheads etc.
linesType	visible or hidden line type
font	Font

void NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::SetFont	(	const char *	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

featureName	feature name e.g. decks, bulkheads etc.
linesType	visible or hidden line type
font	Font

void NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::SetShipDrawingObject	(	const NXString &	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

featureName	feature name e.g. decks, bulkheads etc.
singleLine	status that determines SLR for the feature

void NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::SetShipDrawingObject	(	const char *	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

featureName	feature name e.g. decks, bulkheads etc.
singleLine	status that determines SLR for the feature

void NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::SetWidth	(	const NXString &	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

featureName	feature name e.g. decks, bulkheads etc.
linesType	visible or hidden line type
width	Width

void NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::SetWidth	(	const char *	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

featureName	feature name e.g. decks, bulkheads etc.
linesType	visible or hidden line type
width	Width

tag_t NXOpen::Preferences::ShipDraftingViewLinesViewPreferences::Tag

(

)

const

Returns the tag of this object.

---

The documentation for this class was generated from the following file:

• Preferences_ShipDraftingViewLinesViewPreferences.hxx