Represents the set of View related Visualization visual preferences
To obtain an instance of this class, refer to NXOpen::View

Created in NX3.0.0. More...

Classes
struct	DisplayAppearanceOptions
	Describes the rendering style and the appearance of edges and silhouettes in the view. More...

struct	SurfaceDisplayOptions
	Describes the appearance of edges and silhouettes in the view. More...

struct	TrueSurfaceDisplayPref
	Represents the various surface display parameters. More...

Public Types
enum	DisplayModeType { DisplayModeTypeWireframe, DisplayModeTypePartiallyShaded, DisplayModeTypeFullyShaded, DisplayModeTypeFaceAnalysis, DisplayModeTypeStudio }
	Describes the available display mode types. More...

enum	HiddenEdges { HiddenEdgesVisible, HiddenEdgesInvisible, HiddenEdgesGrayThin, HiddenEdgesDashed }
	Describes the appearance of hidden edges displayed in the view. More...

enum	HiddenEdgeStyleType { HiddenEdgeStyleTypeInvisible, HiddenEdgeStyleTypeHiddenGeometryColor, HiddenEdgeStyleTypeDashed }
	Describes how hidden edges are displayed for shaded faces in the view. More...

enum	HiddenEdgesType { HiddenEdgesTypeVisible, HiddenEdgesTypeInvisible, HiddenEdgesTypeDashed, HiddenEdgesTypeGrayThin, HiddenEdgesTypeHiddenSurface }
	Describes the available hidden edges types. More...

enum	RenderingStyle { RenderingStyleShaded, RenderingStyleWireframe, RenderingStyleStudio, RenderingStyleFaceAnalysis, RenderingStylePartiallyShaded, RenderingStyleStaticWireframe }
	Describes the rendering style for geometry displayed in the view. More...

enum	ShadedEdgeStyleType { ShadedEdgeStyleTypeShadedEdgeColor, ShadedEdgeStyleTypeBodyColor, ShadedEdgeStyleTypeNone }
	Describes how edges are displayed for shaded faces in the view. More...

enum	SmoothEdgeFont { SmoothEdgeFontOriginal, SmoothEdgeFontSolid, SmoothEdgeFontDashed, SmoothEdgeFontPhantom, SmoothEdgeFontCenterLine, SmoothEdgeFontDotted, SmoothEdgeFontLongDashed, SmoothEdgeFontDottedDashed }
	Describes all possible font selection for visible smooth edges. More...

enum	SmoothEdgeWidth { SmoothEdgeWidthOriginal, SmoothEdgeWidthThin, SmoothEdgeWidthNormal, SmoothEdgeWidthThick, SmoothEdgeWidthOne = 5, SmoothEdgeWidthTwo, SmoothEdgeWidthThree, SmoothEdgeWidthFour, SmoothEdgeWidthFive, SmoothEdgeWidthSix, SmoothEdgeWidthSeven, SmoothEdgeWidthEight, SmoothEdgeWidthNine }
	Describes all possible width selection for visible smooth edges. More...

Public Member Functions
NXOpen::Preferences::ViewVisualizationVisual::DisplayAppearanceOptions	DisplayAppearance ()
	Returns the rendering style and the edge display options of the view. More...

NXOpen::Preferences::ViewVisualizationVisual::HiddenEdgeStyleType	HiddenEdgeStyle ()
	Returns the hidden edge display style for shaded faces in the view. More...

void	SetDisplayAppearance (const NXOpen::Preferences::ViewVisualizationVisual::DisplayAppearanceOptions &displayAppearanceOptions)
	Sets the rendering style and the edge display options of the view. More...

void	SetHiddenEdgeStyle (NXOpen::Preferences::ViewVisualizationVisual::HiddenEdgeStyleType hiddenEdgeStyle)
	Sets the hidden edge display style for shaded faces in the view. More...

void	SetShadedEdgeColor (int shadedEdgeColor)
	Sets the edge color for shaded faces in the view. More...

void	SetShadedEdgeStyle (NXOpen::Preferences::ViewVisualizationVisual::ShadedEdgeStyleType shadedEdgeStyle)
	Sets the edge display style for shaded faces in the view. More...

void	SetShininessData (double shininessData)
	Sets the shininess value. More...

void	SetSurfaceDisplay (const NXOpen::Preferences::ViewVisualizationVisual::SurfaceDisplayOptions &surfaceDisplay)
	Sets the rendering style and the edge display options of the view. More...

void	SetTrueSurfaceDisplay (const NXOpen::Preferences::ViewVisualizationVisual::TrueSurfaceDisplayPref &trueSurfaceDisplay)
	Sets the true surface display parameters. More...

void	SetTwoSidedLight (bool twoSidedLight)
	Sets the two sided light flag. More...

int	ShadedEdgeColor ()
	Returns the edge color for shaded faces in the view. More...

NXOpen::Preferences::ViewVisualizationVisual::ShadedEdgeStyleType	ShadedEdgeStyle ()
	Returns the edge display style for shaded faces in the view. More...

double	ShininessData ()
	Returns the shininess value. More...

NXOpen::Preferences::ViewVisualizationVisual::SurfaceDisplayOptions	SurfaceDisplay ()
	Returns the rendering style and the edge display options of the view. More...

tag_t	Tag () const
	Returns the tag of this object. More...

NXOpen::Preferences::ViewVisualizationVisual::TrueSurfaceDisplayPref	TrueSurfaceDisplay ()
	Returns the true surface display parameters. More...

bool	TwoSidedLight ()
	Returns the two sided light flag. More...

Detailed Description

Represents the set of View related Visualization visual preferences
To obtain an instance of this class, refer to NXOpen::View

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::Preferences::ViewVisualizationVisual::DisplayModeType

Describes the available display mode types.

Specifies shading parameters for the selected view.

Deprecated:: Deprecated in NX4.0.0. Use NXOpen::Preferences::ViewVisualizationVisual::RenderingStyle instead.

Enumerator
DisplayModeTypeWireframe	View is displayed as a wireframe-model.
DisplayModeTypePartiallyShaded	Shade only selected object.
DisplayModeTypeFullyShaded	Shading is applicable to all objects in view.
DisplayModeTypeFaceAnalysis	Display faces using the color analysis data.
DisplayModeTypeStudio	In Studio mode, objects are realistically rendered according to material and texture characteristics assigned to them.

enum NXOpen::Preferences::ViewVisualizationVisual::HiddenEdges

Describes the appearance of hidden edges displayed in the view.

Enumerator
HiddenEdgesVisible	visible
HiddenEdgesInvisible	invisible
HiddenEdgesGrayThin	gray thin
HiddenEdgesDashed	dashed

enum NXOpen::Preferences::ViewVisualizationVisual::HiddenEdgeStyleType

Describes how hidden edges are displayed for shaded faces in the view.

Enumerator
HiddenEdgeStyleTypeInvisible	invisible
HiddenEdgeStyleTypeHiddenGeometryColor	hidden geometry color
HiddenEdgeStyleTypeDashed	dashed

enum NXOpen::Preferences::ViewVisualizationVisual::HiddenEdgesType

Describes the available hidden edges types.

Determines how hidden edges are displayed in the selected view.

Deprecated:: Deprecated in NX4.0.0. Use NXOpen::Preferences::ViewVisualizationVisual::HiddenEdges instead.

Enumerator
HiddenEdgesTypeVisible	All edges in a solid body that are hidden appear as solid lines.
HiddenEdgesTypeInvisible	grid line display of all existing and subsequently created solid bodies in the selected view, except that portions of geometry and text that appear behind solid bodies are erased
HiddenEdgesTypeDashed	grid line display of all existing and subsequently created solid bodies in the selected view, except that all portions of the geometry and text that appear behind solid bodies are displayed as dashed lines
HiddenEdgesTypeGrayThin	All hidden edges in the color gray, with solid font and thin width.
HiddenEdgesTypeHiddenSurface	Faceted display of all existing and subsequently created bodies in the selected view.

enum NXOpen::Preferences::ViewVisualizationVisual::RenderingStyle

Describes the rendering style for geometry displayed in the view.

Enumerator
RenderingStyleShaded	shaded
RenderingStyleWireframe	wireframe
RenderingStyleStudio	studio
RenderingStyleFaceAnalysis	face analysis
RenderingStylePartiallyShaded	partially shaded
RenderingStyleStaticWireframe	static wireframe

enum NXOpen::Preferences::ViewVisualizationVisual::ShadedEdgeStyleType

Describes how edges are displayed for shaded faces in the view.

Enumerator
ShadedEdgeStyleTypeShadedEdgeColor	shaded edge color
ShadedEdgeStyleTypeBodyColor	body color
ShadedEdgeStyleTypeNone	none

enum NXOpen::Preferences::ViewVisualizationVisual::SmoothEdgeFont

Describes all possible font selection for visible smooth edges.

Enumerator
SmoothEdgeFontOriginal	original
SmoothEdgeFontSolid	solid
SmoothEdgeFontDashed	dashed
SmoothEdgeFontPhantom	phantom
SmoothEdgeFontCenterLine	center line
SmoothEdgeFontDotted	dotted
SmoothEdgeFontLongDashed	long dashed
SmoothEdgeFontDottedDashed	dotted dashed

enum NXOpen::Preferences::ViewVisualizationVisual::SmoothEdgeWidth

Describes all possible width selection for visible smooth edges.

Enumerator
SmoothEdgeWidthOriginal	original
SmoothEdgeWidthThin	thin
SmoothEdgeWidthNormal	normal
SmoothEdgeWidthThick	thick
SmoothEdgeWidthOne	one
SmoothEdgeWidthTwo	two
SmoothEdgeWidthThree	three
SmoothEdgeWidthFour	four
SmoothEdgeWidthFive	five
SmoothEdgeWidthSix	six
SmoothEdgeWidthSeven	seven
SmoothEdgeWidthEight	eight
SmoothEdgeWidthNine	nine

Member Function Documentation

NXOpen::Preferences::ViewVisualizationVisual::DisplayAppearanceOptions NXOpen::Preferences::ViewVisualizationVisual::DisplayAppearance ( )

Returns the rendering style and the edge display options of the view.

Created in NX8.5.0.

License requirements : None

NXOpen::Preferences::ViewVisualizationVisual::HiddenEdgeStyleType NXOpen::Preferences::ViewVisualizationVisual::HiddenEdgeStyle ( )

Returns the hidden edge display style for shaded faces in the view.

Created in NX4.0.0.

License requirements : None

void NXOpen::Preferences::ViewVisualizationVisual::SetDisplayAppearance ( const NXOpen::Preferences::ViewVisualizationVisual::DisplayAppearanceOptions & displayAppearanceOptions )

Sets the rendering style and the edge display options of the view.

Created in NX8.5.0.

License requirements : None

Parameters

displayAppearanceOptions display appearance options

void NXOpen::Preferences::ViewVisualizationVisual::SetHiddenEdgeStyle ( NXOpen::Preferences::ViewVisualizationVisual::HiddenEdgeStyleType hiddenEdgeStyle )

Sets the hidden edge display style for shaded faces in the view.

Created in NX4.0.0.

License requirements : None

Parameters

hiddenEdgeStyle hidden edge style

void NXOpen::Preferences::ViewVisualizationVisual::SetShadedEdgeColor ( int shadedEdgeColor )

Sets the edge color for shaded faces in the view.

Created in NX4.0.0.

License requirements : None

Parameters

shadedEdgeColor shaded edge color

void NXOpen::Preferences::ViewVisualizationVisual::SetShadedEdgeStyle ( NXOpen::Preferences::ViewVisualizationVisual::ShadedEdgeStyleType shadedEdgeStyle )

Sets the edge display style for shaded faces in the view.

Created in NX4.0.0.

License requirements : None

Parameters

shadedEdgeStyle shaded edge style

void NXOpen::Preferences::ViewVisualizationVisual::SetShininessData ( double shininessData )

Sets the shininess value.

Specifies the intensity of the graphics driver addition of highlights to shaded surfaces, making them appear shiny. The value 0.0 adds no shininess, and 1.0 adds the maximum amount of shininess.
Created in NX3.0.0.

License requirements : None

Parameters

shininessData shininess data

void NXOpen::Preferences::ViewVisualizationVisual::SetSurfaceDisplay ( const NXOpen::Preferences::ViewVisualizationVisual::SurfaceDisplayOptions & surfaceDisplay )

Sets the rendering style and the edge display options of the view.

Deprecated:: Deprecated in NX8.5.0. Use NXOpen::Preferences::ViewVisualizationVisual::SetDisplayAppearance instead.

Created in NX4.0.0.

License requirements : None

Parameters

surfaceDisplay surface display

void NXOpen::Preferences::ViewVisualizationVisual::SetTrueSurfaceDisplay ( const NXOpen::Preferences::ViewVisualizationVisual::TrueSurfaceDisplayPref & trueSurfaceDisplay )

Sets the true surface display parameters.

Deprecated:: Deprecated in NX4.0.0. Use NXOpen::Preferences::ViewVisualizationVisual::SetDisplayAppearance instead.

Created in NX3.0.0.

License requirements : None

Parameters

trueSurfaceDisplay true surface display

void NXOpen::Preferences::ViewVisualizationVisual::SetTwoSidedLight ( bool twoSidedLight )

Sets the two sided light flag.

Specifies whether lighting should be applied to both the front and backsides of faces. If it is true, then lighting from a light source is applied to the front or the back face, depending on which side is exposed to the light source. If this is false, then lighting is not applied to the back of a face even if the back is exposed to the light source.
Created in NX3.0.0.

License requirements : None

Parameters

twoSidedLight two sided light

int NXOpen::Preferences::ViewVisualizationVisual::ShadedEdgeColor ( )

Returns the edge color for shaded faces in the view.

Created in NX4.0.0.

License requirements : None

NXOpen::Preferences::ViewVisualizationVisual::ShadedEdgeStyleType NXOpen::Preferences::ViewVisualizationVisual::ShadedEdgeStyle ( )

Returns the edge display style for shaded faces in the view.

Created in NX4.0.0.

License requirements : None

double NXOpen::Preferences::ViewVisualizationVisual::ShininessData ( )

Returns the shininess value.

Specifies the intensity of the graphics driver addition of highlights to shaded surfaces, making them appear shiny. The value 0.0 adds no shininess, and 1.0 adds the maximum amount of shininess.
Created in NX3.0.0.

License requirements : None

NXOpen::Preferences::ViewVisualizationVisual::SurfaceDisplayOptions NXOpen::Preferences::ViewVisualizationVisual::SurfaceDisplay ( )

Returns the rendering style and the edge display options of the view.

Deprecated:: Deprecated in NX8.5.0. Use NXOpen::Preferences::ViewVisualizationVisual::DisplayAppearance instead.

Created in NX4.0.0.

License requirements : None

tag_t NXOpen::Preferences::ViewVisualizationVisual::Tag ( ) const

Returns the tag of this object.

NXOpen::Preferences::ViewVisualizationVisual::TrueSurfaceDisplayPref NXOpen::Preferences::ViewVisualizationVisual::TrueSurfaceDisplay ( )

Returns the true surface display parameters.

Deprecated:: Deprecated in NX4.0.0. Use NXOpen::Preferences::ViewVisualizationVisual::DisplayAppearance instead.

Created in NX3.0.0.

License requirements : None

bool NXOpen::Preferences::ViewVisualizationVisual::TwoSidedLight ( )

Returns the two sided light flag.

Specifies whether lighting should be applied to both the front and backsides of faces. If it is true, then lighting from a light source is applied to the front or the back face, depending on which side is exposed to the light source. If this is false, then lighting is not applied to the back of a face even if the back is exposed to the light source.
Created in NX3.0.0.

License requirements : None

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

Preferences_ViewVisualizationVisual.hxx

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation