NXOpen::Preferences::ShipbuildingLinesViewPreferences Class Reference

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

Public Types
enum	Lines { LinesHidden, LinesVisible }
	Line type. More...
enum	ShipbuildingLines { ShipbuildingLinesProfile, ShipbuildingLinesPlate }
	Geometry type. More...

Public Member Functions
int	GetColor (const NXString &featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType)
	Get line color.
int	GetColor (const char *featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType)
	Get line color.
NXOpen::Preferences::Font	GetFont (const NXString &featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType)
	Get line font.
NXOpen::Preferences::Font	GetFont (const char *featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType)
	Get line font.
bool	GetSingleLineRepresentation (NXOpen::Preferences::ShipbuildingLinesViewPreferences::ShipbuildingLines featureType, const NXString &featureName)
	Get single line status.
bool	GetSingleLineRepresentation (NXOpen::Preferences::ShipbuildingLinesViewPreferences::ShipbuildingLines featureType, const char *featureName)
	Get single line status.
NXOpen::Preferences::Width	GetWidth (const NXString &featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType)
	Get line width.
NXOpen::Preferences::Width	GetWidth (const char *featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType)
	Get line width.
void	SetColor (const NXString &featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType, int color)
	The color of ship line.
void	SetColor (const char *featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType, int color)
	The color of ship line.
void	SetFont (const NXString &featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType, NXOpen::Preferences::Font font)
	The font type of ship line.
void	SetFont (const char *featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType, NXOpen::Preferences::Font font)
	The font type of ship line.
void	SetSingleLineRepresentation (NXOpen::Preferences::ShipbuildingLinesViewPreferences::ShipbuildingLines featureType, const NXString &featureName, bool singleLine)
	Note: The initial values are set based on the customer defaults depending on whether the feature is a Profile or a Plate.
void	SetSingleLineRepresentation (NXOpen::Preferences::ShipbuildingLinesViewPreferences::ShipbuildingLines featureType, const char *featureName, bool singleLine)
	Note: The initial values are set based on the customer defaults depending on whether the feature is a Profile or a Plate.
void	SetWidth (const NXString &featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType, NXOpen::Preferences::Width width)
	The width of hidden line or edges.
void	SetWidth (const char *featureName, NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines linesType, NXOpen::Preferences::Width width)
	The width of hidden line or edges.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

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  <br> To obtain an instance of this class use @link Preferences::ViewPreferences::ShipbuildingLines Preferences::ViewPreferences::ShipbuildingLines@endlink   <br> 

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines

Line type.

Enumerator:

LinesHidden	Hidden.
LinesVisible	Visible.

enum NXOpen::Preferences::ShipbuildingLinesViewPreferences::ShipbuildingLines

Geometry type.

Enumerator:

ShipbuildingLinesProfile	Profile.
ShipbuildingLinesPlate	Plate.

Member Function Documentation

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

Get line color.

Returns

Created in NX8.0.0.

License requirements : None

Parameters

featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
linesType	visible or hidden line type

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

Get line color.

Returns

Created in NX8.0.0.

License requirements : None

Parameters

featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
linesType	visible or hidden line type

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

Get line font.

Returns

Created in NX8.0.0.

License requirements : None

Parameters

featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
linesType	visible or hidden line type

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

Get line font.

Returns

Created in NX8.0.0.

License requirements : None

Parameters

featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
linesType	visible or hidden line type

bool NXOpen::Preferences::ShipbuildingLinesViewPreferences::GetSingleLineRepresentation	(	NXOpen::Preferences::ShipbuildingLinesViewPreferences::ShipbuildingLines	featureType,
		const NXString &	featureName
	)

Get single line status.

Returns

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

License requirements : None

Parameters

featureType	feature type
featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.

bool NXOpen::Preferences::ShipbuildingLinesViewPreferences::GetSingleLineRepresentation	(	NXOpen::Preferences::ShipbuildingLinesViewPreferences::ShipbuildingLines	featureType,
		const char *	featureName
	)

Get single line status.

Returns

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

License requirements : None

Parameters

featureType	feature type
featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.

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

Get line width.

Returns

Created in NX8.0.0.

License requirements : None

Parameters

featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
linesType	visible or hidden line type

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

Get line width.

Returns

Created in NX8.0.0.

License requirements : None

Parameters

featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
linesType	visible or hidden line type

void NXOpen::Preferences::ShipbuildingLinesViewPreferences::SetColor	(	const NXString &	featureName,
		NXOpen::Preferences::ShipbuildingLinesViewPreferences::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 NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
linesType	visible or hidden line type
color	Color

void NXOpen::Preferences::ShipbuildingLinesViewPreferences::SetColor	(	const char *	featureName,
		NXOpen::Preferences::ShipbuildingLinesViewPreferences::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 NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
linesType	visible or hidden line type
color	Color

void NXOpen::Preferences::ShipbuildingLinesViewPreferences::SetFont	(	const NXString &	featureName,
		NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines	linesType,
		NXOpen::Preferences::Font	font
	)

The font type of ship line.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
linesType	visible or hidden line type
font	Font

void NXOpen::Preferences::ShipbuildingLinesViewPreferences::SetFont	(	const char *	featureName,
		NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines	linesType,
		NXOpen::Preferences::Font	font
	)

The font type of ship line.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
linesType	visible or hidden line type
font	Font

void NXOpen::Preferences::ShipbuildingLinesViewPreferences::SetSingleLineRepresentation	(	NXOpen::Preferences::ShipbuildingLinesViewPreferences::ShipbuildingLines	featureType,
		const NXString &	featureName,
		bool	singleLine
	)

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.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureType	feature type
featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
singleLine	status that determines SLR for the feature

void NXOpen::Preferences::ShipbuildingLinesViewPreferences::SetSingleLineRepresentation	(	NXOpen::Preferences::ShipbuildingLinesViewPreferences::ShipbuildingLines	featureType,
		const char *	featureName,
		bool	singleLine
	)

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.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureType	feature type
featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
singleLine	status that determines SLR for the feature

void NXOpen::Preferences::ShipbuildingLinesViewPreferences::SetWidth	(	const NXString &	featureName,
		NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines	linesType,
		NXOpen::Preferences::Width	width
	)

The width of hidden line or edges.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
linesType	visible or hidden line type
width	Width

void NXOpen::Preferences::ShipbuildingLinesViewPreferences::SetWidth	(	const char *	featureName,
		NXOpen::Preferences::ShipbuildingLinesViewPreferences::Lines	linesType,
		NXOpen::Preferences::Width	width
	)

The width of hidden line or edges.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureName	feature name e.g. decks, bulkheads etc. NOTE: The full Unicode character set is not supported for this parameter.
linesType	visible or hidden line type
width	Width

tag_t NXOpen::Preferences::ShipbuildingLinesViewPreferences::Tag

(

)

const

Returns the tag of this object.

---

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

• Preferences_ShipbuildingLinesViewPreferences.hxx