NXOpen::Preferences::SubdivisionModelingPreferences Class Reference

Represents the set of Modeling preferences applicable to entire session
To obtain an instance of this class, refer to NXOpen::Preferences::SessionPreferences

Created in NX9.0.0. More...

Public Types
enum	CagePolylineVertexSizes { CagePolylineVertexSizesSmall, CagePolylineVertexSizesMedium, CagePolylineVertexSizesLarge }
	Cage polyline vertex size type. More...
enum	CagePolylineVertexStyles {   CagePolylineVertexStylesNone, CagePolylineVertexStylesSquare, CagePolylineVertexStylesTriangle, CagePolylineVertexStylesCircle,   CagePolylineVertexStylesPlus, CagePolylineVertexStylesCross }
	Cage polyline vertex style. More...
enum	DisplayModes { DisplayModesCageAndBody, DisplayModesCageOnly, DisplayModesBodyOnly }
	Display modes of subdivision cage and resulting body. More...
enum	VertexSizeTypes { VertexSizeTypesSmall, VertexSizeTypesMedium, VertexSizeTypesLarge }
	Vertex size type. More...
enum	VertexStyleTypes {   VertexStyleTypesSquare, VertexStyleTypesTriangle, VertexStyleTypesCircle, VertexStyleTypesPlus,   VertexStyleTypesCross }
	Vertex display style. More...

Public Member Functions
int	CagePolylineColor ()
	Returns the cage polyline color. More...
int	CagePolylineFont ()
	Returns the cage polyline font. More...
int	CagePolylineVertexColor ()
	Returns the cage polyline vertex color. More...
NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexSizes	CagePolylineVertexSize ()
	Returns the cage polyline vertex size. More...
NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexStyles	CagePolylineVertexStyle ()
	Returns the cage polyline vertex style. More...
int	CagePolylineWidth ()
	Returns the cage polyline width. More...
bool	CanAllowBackSideSelection ()
	Returns the flag indicating if the hidden topology selection is allowed or not. More...
bool	CanShowWeight ()
	Returns the flag indicating if the edge weights are displayed or not. More...
int	ConstraintColor ()
	Returns the constrained entity color. More...
NXOpen::Preferences::SubdivisionModelingPreferences::DisplayModes	DisplayMode ()
	Returns the mesh and solid body display option Created in NX10.0.0. More...
int	HighlightFaceTranslucency ()
	Returns the percentage translucency of the highlighted face. More...
bool	IsXRayCage ()
	Returns the flag indicating if the hidden edge of the cage are visible or not. More...
int	LineColor ()
	Returns the line color. More...
int	LineFont ()
	Returns the smooth edge line font. More...
int	LineWidth ()
	Returns the line width. More...
void	SetCagePolylineColor (int lineColor)
	Sets the cage polyline color. More...
void	SetCagePolylineFont (int lineFont)
	Sets the cage polyline font. More...
void	SetCagePolylineVertexColor (int vertexColor)
	Sets the cage polyline vertex color. More...
void	SetCagePolylineVertexSize (NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexSizes vertexSize)
	Sets the cage polyline vertex size. More...
void	SetCagePolylineVertexStyle (NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexStyles vertexStyle)
	Sets the cage polyline vertex style. More...
void	SetCagePolylineWidth (int lineWidth)
	Sets the cage polyline width. More...
void	SetCanAllowBackSideSelection (bool allow)
	Sets the flag indicating if the hidden topology selection is allowed or not. More...
void	SetCanShowWeight (bool showWeight)
	Sets the flag indicating if the edge weights are displayed or not. More...
void	SetConstraintColor (int color)
	Sets the constrained entity color. More...
void	SetDisplayMode (NXOpen::Preferences::SubdivisionModelingPreferences::DisplayModes displayOption)
	Sets the mesh and solid body display option Created in NX10.0.0. More...
void	SetHighlightFaceTranslucency (int highlightLineTranslucency)
	Sets the percentage translucency of the highlighted face. More...
void	SetLineColor (int lineColor)
	Sets the line color. More...
void	SetLineFont (int lineFont)
	Sets the smooth edge line font. More...
void	SetLineWidth (int lineWidth)
	Sets the line width. More...
void	SetSharpEdgeLineFont (int lineFont)
	Sets the sharp edge line font. More...
void	SetVertexColor (int vertexColor)
	Sets the vertex color. More...
void	SetVertexSize (NXOpen::Preferences::SubdivisionModelingPreferences::VertexSizeTypes vertexSize)
	Sets the vertex size. More...
void	SetVertexStyle (NXOpen::Preferences::SubdivisionModelingPreferences::VertexStyleTypes vertexStyle)
	Sets the vertex style. More...
void	SetXRayCage (bool isXRayCage)
	Sets the flag indicating if the hidden edge of the cage are visible or not. More...
int	SharpEdgeLineFont ()
	Returns the sharp edge line font. More...
tag_t	Tag () const
	Returns the tag of this object. More...
int	VertexColor ()
	Returns the vertex color. More...
NXOpen::Preferences::SubdivisionModelingPreferences::VertexSizeTypes	VertexSize ()
	Returns the vertex size. More...
NXOpen::Preferences::SubdivisionModelingPreferences::VertexStyleTypes	VertexStyle ()
	Returns the vertex style. More...

Detailed Description

Represents the set of Modeling preferences applicable to entire session
To obtain an instance of this class, refer to NXOpen::Preferences::SessionPreferences

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexSizes

Cage polyline vertex size type.

Enumerator
CagePolylineVertexSizesSmall	small
CagePolylineVertexSizesMedium	medium
CagePolylineVertexSizesLarge	large

enum NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexStyles

Cage polyline vertex style.

Enumerator
CagePolylineVertexStylesNone	none
CagePolylineVertexStylesSquare	square
CagePolylineVertexStylesTriangle	triangle
CagePolylineVertexStylesCircle	circle
CagePolylineVertexStylesPlus	plus
CagePolylineVertexStylesCross	cross

enum NXOpen::Preferences::SubdivisionModelingPreferences::DisplayModes

Display modes of subdivision cage and resulting body.

Enumerator
DisplayModesCageAndBody	Display both cage and body.
DisplayModesCageOnly	Display cage only.
DisplayModesBodyOnly	Display body only.

enum NXOpen::Preferences::SubdivisionModelingPreferences::VertexSizeTypes

Vertex size type.

Enumerator
VertexSizeTypesSmall	small
VertexSizeTypesMedium	medium
VertexSizeTypesLarge	large

enum NXOpen::Preferences::SubdivisionModelingPreferences::VertexStyleTypes

Vertex display style.

Enumerator
VertexStyleTypesSquare	square
VertexStyleTypesTriangle	triangle
VertexStyleTypesCircle	circle
VertexStyleTypesPlus	plus
VertexStyleTypesCross	cross

Member Function Documentation

int NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineColor

(

)

Returns the cage polyline color.

Created in NX11.0.0.

License requirements : None

int NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineFont

(

)

Returns the cage polyline font.

Created in NX11.0.0.

License requirements : None

int NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexColor

(

)

Returns the cage polyline vertex color.

Created in NX11.0.0.

License requirements : None

NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexSizes NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexSize

(

)

Returns the cage polyline vertex size.

Created in NX11.0.0.

License requirements : None

NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexStyles NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexStyle

(

)

Returns the cage polyline vertex style.

Created in NX11.0.0.

License requirements : None

int NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineWidth

(

)

Returns the cage polyline width.

Created in NX11.0.0.

License requirements : None

bool NXOpen::Preferences::SubdivisionModelingPreferences::CanAllowBackSideSelection

(

)

Returns the flag indicating if the hidden topology selection is allowed or not.

Created in NX10.0.0.

License requirements : None

bool NXOpen::Preferences::SubdivisionModelingPreferences::CanShowWeight

(

)

Returns the flag indicating if the edge weights are displayed or not.

Created in NX9.0.0.

License requirements : None

int NXOpen::Preferences::SubdivisionModelingPreferences::ConstraintColor

(

)

Returns the constrained entity color.

Created in NX11.0.0.

License requirements : None

NXOpen::Preferences::SubdivisionModelingPreferences::DisplayModes NXOpen::Preferences::SubdivisionModelingPreferences::DisplayMode

(

)

Returns the mesh and solid body display option
Created in NX10.0.0.

License requirements : None

int NXOpen::Preferences::SubdivisionModelingPreferences::HighlightFaceTranslucency

(

)

Returns the percentage translucency of the highlighted face.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Preferences::SubdivisionModelingPreferences::IsXRayCage

(

)

Returns the flag indicating if the hidden edge of the cage are visible or not.

Created in NX9.0.0.

License requirements : None

int NXOpen::Preferences::SubdivisionModelingPreferences::LineColor

(

)

Returns the line color.

Created in NX9.0.0.

License requirements : None

int NXOpen::Preferences::SubdivisionModelingPreferences::LineFont

(

)

Returns the smooth edge line font.

Created in NX9.0.0.

License requirements : None

int NXOpen::Preferences::SubdivisionModelingPreferences::LineWidth

(

)

Returns the line width.

Created in NX9.0.0.

License requirements : None

void NXOpen::Preferences::SubdivisionModelingPreferences::SetCagePolylineColor

(

int

lineColor

)

Sets the cage polyline color.

Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

lineColor

linecolor

void NXOpen::Preferences::SubdivisionModelingPreferences::SetCagePolylineFont

(

int

lineFont

)

Sets the cage polyline font.

Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

lineFont

linefont

void NXOpen::Preferences::SubdivisionModelingPreferences::SetCagePolylineVertexColor

(

int

vertexColor

)

Sets the cage polyline vertex color.

Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

vertexColor

vertexcolor

void NXOpen::Preferences::SubdivisionModelingPreferences::SetCagePolylineVertexSize

(

NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexSizes

vertexSize

)

Sets the cage polyline vertex size.

Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

vertexSize

vertexsize

void NXOpen::Preferences::SubdivisionModelingPreferences::SetCagePolylineVertexStyle

(

NXOpen::Preferences::SubdivisionModelingPreferences::CagePolylineVertexStyles

vertexStyle

)

Sets the cage polyline vertex style.

Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

vertexStyle

vertexstyle

void NXOpen::Preferences::SubdivisionModelingPreferences::SetCagePolylineWidth

(

int

lineWidth

)

Sets the cage polyline width.

Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

lineWidth

linewidth

void NXOpen::Preferences::SubdivisionModelingPreferences::SetCanAllowBackSideSelection

(

bool

allow

)

Sets the flag indicating if the hidden topology selection is allowed or not.

Created in NX10.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

allow

allow

void NXOpen::Preferences::SubdivisionModelingPreferences::SetCanShowWeight

(

bool

showWeight

)

Sets the flag indicating if the edge weights are displayed or not.

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

showWeight

showweight

void NXOpen::Preferences::SubdivisionModelingPreferences::SetConstraintColor

(

int

color

)

Sets the constrained entity color.

Created in NX11.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

color

color

void NXOpen::Preferences::SubdivisionModelingPreferences::SetDisplayMode

(

NXOpen::Preferences::SubdivisionModelingPreferences::DisplayModes

displayOption

)

Sets the mesh and solid body display option
Created in NX10.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

displayOption

displayoption

void NXOpen::Preferences::SubdivisionModelingPreferences::SetHighlightFaceTranslucency

(

int

highlightLineTranslucency

)

Sets the percentage translucency of the highlighted face.

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

highlightLineTranslucency

highlightlinetranslucency

void NXOpen::Preferences::SubdivisionModelingPreferences::SetLineColor

(

int

lineColor

)

Sets the line color.

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

lineColor

linecolor

void NXOpen::Preferences::SubdivisionModelingPreferences::SetLineFont

(

int

lineFont

)

Sets the smooth edge line font.

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

lineFont

linefont

void NXOpen::Preferences::SubdivisionModelingPreferences::SetLineWidth

(

int

lineWidth

)

Sets the line width.

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

lineWidth

linewidth

void NXOpen::Preferences::SubdivisionModelingPreferences::SetSharpEdgeLineFont

(

int

lineFont

)

Sets the sharp edge line font.

Created in NX10.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

lineFont

linefont

void NXOpen::Preferences::SubdivisionModelingPreferences::SetVertexColor

(

int

vertexColor

)

Sets the vertex color.

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

vertexColor

vertexcolor

void NXOpen::Preferences::SubdivisionModelingPreferences::SetVertexSize

(

NXOpen::Preferences::SubdivisionModelingPreferences::VertexSizeTypes

vertexSize

)

Sets the vertex size.

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

vertexSize

vertexsize

void NXOpen::Preferences::SubdivisionModelingPreferences::SetVertexStyle

(

NXOpen::Preferences::SubdivisionModelingPreferences::VertexStyleTypes

vertexStyle

)

Sets the vertex style.

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

vertexStyle

vertexstyle

void NXOpen::Preferences::SubdivisionModelingPreferences::SetXRayCage

(

bool

isXRayCage

)

Sets the flag indicating if the hidden edge of the cage are visible or not.

Created in NX9.0.0.

License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters

isXRayCage

isxraycage

int NXOpen::Preferences::SubdivisionModelingPreferences::SharpEdgeLineFont

(

)

Returns the sharp edge line font.

Created in NX10.0.0.

License requirements : None

tag_t NXOpen::Preferences::SubdivisionModelingPreferences::Tag

(

)

const

Returns the tag of this object.

int NXOpen::Preferences::SubdivisionModelingPreferences::VertexColor

(

)

Returns the vertex color.

Created in NX9.0.0.

License requirements : None

NXOpen::Preferences::SubdivisionModelingPreferences::VertexSizeTypes NXOpen::Preferences::SubdivisionModelingPreferences::VertexSize

(

)

Returns the vertex size.

Created in NX9.0.0.

License requirements : None

NXOpen::Preferences::SubdivisionModelingPreferences::VertexStyleTypes NXOpen::Preferences::SubdivisionModelingPreferences::VertexStyle

(

)

Returns the vertex style.

Created in NX9.0.0.

License requirements : None

---

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

• Preferences_SubdivisionModelingPreferences.hxx