NXOpen::Preferences::SessionVisualizationShade Class Reference

Represents the UI related Visualization Shade preferences. More...

Classes
struct	Rgb
	Specifies a color by its red, green, and blue values, where each value is between 0 and 1. More...
struct	SeeThruOptions
	Specifies the See-Thru color, edge, and translucency options used for the various See-Thru Styles. More...

Public Types
enum	SeeThruEdgesType { SeeThruEdgesTypeOff, SeeThruEdgesTypeNormal }
	Determines whether edges are displayed for less important shaded geometry when See-Thru is enabled. More...
enum	SeeThruStyleType { SeeThruStyleTypeShell, SeeThruStyleTypeOriginalColorShell, SeeThruStyleTypeLayers }
	Determines how translucency is applied to less important shaded geometry when See-Thru is enabled. More...

Public Member Functions
bool	EdgesEmphasis ()
	Returns the edge emphasis flag.Alters how edges are displayed when Shaded Face Edges is flag is true.
bool	LwrtStudioDisplay ()
	Returns the lwrt studio display flag.Alters how studio are displayed.
void	RegenerateShadedViewsFromToleranceChange ()
	Regenerates Shaded Views.
void	RegenerateStudioAnalysisViewsFromTolChange (bool updateEnvOption)
	Regenerates Studio Analysis Views.
bool	SeeThru ()
	Returns the setting that determines whether See-Thru is applied to all less important objects.
bool	SeeThruDeEmphasizedObjects ()
	Returns the setting that determines whether See-Thru is applied to de-emphasized objects.
bool	SeeThruSection ()
	Returns the setting that determines whether See-Thru is applied to the section cap.
NXOpen::Preferences::SessionVisualizationShade::SeeThruStyleType	SeeThruStyle ()
	Returns the see-thru style that determines how translucency is applied to less important shaded geometry.
NXOpen::Preferences::SessionVisualizationShade::SeeThruOptions	SeeThruStyleOptions ()
	Returns the See-Thru color, edge, and translucency options used for the various See-Thru Styles.
void	SetEdgesEmphasis (bool edgesEmphasis)
	Sets the edge emphasis flag.Alters how edges are displayed when Shaded Face Edges is flag is true.
void	SetLwrtStudioDisplay (bool lwrtStudioDisplay)
	Sets the lwrt studio display flag.Alters how studio are displayed.
void	SetSeeThru (bool seeThru)
	Sets the setting that determines whether See-Thru is applied to all less important objects.
void	SetSeeThruDeEmphasizedObjects (bool seeThruDeEmphasizedObjects)
	Sets the setting that determines whether See-Thru is applied to de-emphasized objects.
void	SetSeeThruSection (bool seeThruSection)
	Sets the setting that determines whether See-Thru is applied to the section cap.
void	SetSeeThruStyle (NXOpen::Preferences::SessionVisualizationShade::SeeThruStyleType seeThruStyle)
	Sets the see-thru style that determines how translucency is applied to less important shaded geometry.
void	SetSeeThruStyleOptions (const NXOpen::Preferences::SessionVisualizationShade::SeeThruOptions &seeThruOptions)
	Sets the See-Thru color, edge, and translucency options used for the various See-Thru Styles.
void	SetShowFacetEdges (bool facetEdges)
	Sets the show facet edge flag.
bool	ShowFacetEdges ()
	Returns the show facet edge flag.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents the UI related Visualization Shade preferences.

These preferences are maintained at UI level and applicable to entire session
To obtain an instance of this class, refer to UI

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::Preferences::SessionVisualizationShade::SeeThruEdgesType

Determines whether edges are displayed for less important shaded geometry when See-Thru is enabled.

Deprecated:

Deprecated in NX8.5.0. Use Preferences::PartVisualizationEmphasis::EdgesType instead.

Enumerator:

SeeThruEdgesTypeOff	Displays no edges for less important shaded geometry.
SeeThruEdgesTypeNormal	Displays edges for less important shaded geometry if edges are normally displayed for shaded geometry.

enum NXOpen::Preferences::SessionVisualizationShade::SeeThruStyleType

Determines how translucency is applied to less important shaded geometry when See-Thru is enabled.

Deprecated:

Deprecated in NX8.5.0. Use Preferences::PartVisualizationEmphasis::SeeThruStyleType instead.

Enumerator:

SeeThruStyleTypeShell	Displays less important shaded geometry as a translucent shell with a specified color.
SeeThruStyleTypeOriginalColorShell	Displays less important shaded geometry as a translucent shell, preserving original shaded geometry colors.
SeeThruStyleTypeLayers	Displays less important shaded geometry as translucent layers with a specified color.

Member Function Documentation

bool NXOpen::Preferences::SessionVisualizationShade::EdgesEmphasis

(

)

Returns the edge emphasis flag.Alters how edges are displayed when Shaded Face Edges is flag is true.

Created in NX3.0.0.

License requirements : None

bool NXOpen::Preferences::SessionVisualizationShade::LwrtStudioDisplay

(

)

Returns the lwrt studio display flag.Alters how studio are displayed.

Created in NX4.0.0.

License requirements : None

void NXOpen::Preferences::SessionVisualizationShade::RegenerateShadedViewsFromToleranceChange

(

)

Regenerates Shaded Views.

Updates all objects based on their surfacing tolerance.
Created in NX3.0.0.

License requirements : None

void NXOpen::Preferences::SessionVisualizationShade::RegenerateStudioAnalysisViewsFromTolChange

(

bool

updateEnvOption

)

Regenerates Studio Analysis Views.

Updates all objects based on their surfacing tolerance.
Created in NX3.0.0.

License requirements : None

Parameters

updateEnvOption

Send TRUE if env cube updation is required. Else send FALSE

bool NXOpen::Preferences::SessionVisualizationShade::SeeThru

(

)

Returns the setting that determines whether See-Thru is applied to all less important objects.

Deprecated:

Deprecated in NX8.5.0. See Preferences::SessionVisualizationEmphasis .

Created in NX7.0.0.

License requirements : None

bool NXOpen::Preferences::SessionVisualizationShade::SeeThruDeEmphasizedObjects

(

)

Returns the setting that determines whether See-Thru is applied to de-emphasized objects.

Deprecated:

Deprecated in NX8.5.0. Use Preferences::SessionVisualizationEmphasis::SeeThruDeEmphasizedObjects instead.

Created in NX8.0.0.

License requirements : None

bool NXOpen::Preferences::SessionVisualizationShade::SeeThruSection

(

)

Returns the setting that determines whether See-Thru is applied to the section cap.

Deprecated:

Deprecated in NX8.5.0. Use Preferences::SessionVisualizationEmphasis::SeeThruSection instead.

Created in NX8.0.0.

License requirements : None

NXOpen::Preferences::SessionVisualizationShade::SeeThruStyleType NXOpen::Preferences::SessionVisualizationShade::SeeThruStyle

(

)

Returns the see-thru style that determines how translucency is applied to less important shaded geometry.

Deprecated:

Deprecated in NX8.5.0. Use Preferences::PartVisualizationEmphasis::SeeThruStyle instead.

Created in NX7.0.0.

License requirements : None

NXOpen::Preferences::SessionVisualizationShade::SeeThruOptions NXOpen::Preferences::SessionVisualizationShade::SeeThruStyleOptions

(

)

Returns the See-Thru color, edge, and translucency options used for the various See-Thru Styles.

Deprecated:

Deprecated in NX8.5.0. See Preferences::PartVisualizationEmphasis .

Created in NX7.0.0.

License requirements : None

void NXOpen::Preferences::SessionVisualizationShade::SetEdgesEmphasis

(

bool

edgesEmphasis

)

Sets the edge emphasis flag.Alters how edges are displayed when Shaded Face Edges is flag is true.

Created in NX3.0.0.

License requirements : None

Parameters

edgesEmphasis

Edge Emphasis Option to be set or not

void NXOpen::Preferences::SessionVisualizationShade::SetLwrtStudioDisplay

(

bool

lwrtStudioDisplay

)

Sets the lwrt studio display flag.Alters how studio are displayed.

Created in NX4.0.0.

License requirements : None

Parameters

lwrtStudioDisplay

Option to be set or not

void NXOpen::Preferences::SessionVisualizationShade::SetSeeThru

(

bool

seeThru

)

Sets the setting that determines whether See-Thru is applied to all less important objects.

Deprecated:

Deprecated in NX8.5.0. See Preferences::SessionVisualizationEmphasis .

Created in NX7.0.0.

License requirements : None

Parameters

seeThru

see thru

void NXOpen::Preferences::SessionVisualizationShade::SetSeeThruDeEmphasizedObjects

(

bool

seeThruDeEmphasizedObjects

)

Sets the setting that determines whether See-Thru is applied to de-emphasized objects.

Deprecated:

Deprecated in NX8.5.0. Use Preferences::SessionVisualizationEmphasis::SetSeeThruDeEmphasizedObjects instead.

Created in NX8.0.0.

License requirements : None

Parameters

seeThruDeEmphasizedObjects

see thru de emphasized objects

void NXOpen::Preferences::SessionVisualizationShade::SetSeeThruSection

(

bool

seeThruSection

)

Sets the setting that determines whether See-Thru is applied to the section cap.

Deprecated:

Deprecated in NX8.5.0. Use Preferences::SessionVisualizationEmphasis::SetSeeThruSection instead.

Created in NX8.0.0.

License requirements : None

Parameters

seeThruSection

see thru section

void NXOpen::Preferences::SessionVisualizationShade::SetSeeThruStyle

(

NXOpen::Preferences::SessionVisualizationShade::SeeThruStyleType

seeThruStyle

)

Sets the see-thru style that determines how translucency is applied to less important shaded geometry.

Deprecated:

Deprecated in NX8.5.0. Use Preferences::PartVisualizationEmphasis::SetSeeThruStyle instead.

Created in NX7.0.0.

License requirements : None

Parameters

seeThruStyle

see thru style

void NXOpen::Preferences::SessionVisualizationShade::SetSeeThruStyleOptions

(

const NXOpen::Preferences::SessionVisualizationShade::SeeThruOptions &

seeThruOptions

)

Sets the See-Thru color, edge, and translucency options used for the various See-Thru Styles.

Deprecated:

Deprecated in NX8.5.0. See Preferences::PartVisualizationEmphasis .

Created in NX7.0.0.

License requirements : None

Parameters

seeThruOptions

see thru options

void NXOpen::Preferences::SessionVisualizationShade::SetShowFacetEdges

(

bool

facetEdges

)

Sets the show facet edge flag.

Toggles the display of facet edges. If this flag is true it can help when trying to evaluate or interpret faceted edges.
Created in NX3.0.0.

License requirements : None

Parameters

facetEdges

facet edges

bool NXOpen::Preferences::SessionVisualizationShade::ShowFacetEdges

(

)

Returns the show facet edge flag.

Toggles the display of facet edges. If this flag is true it can help when trying to evaluate or interpret faceted edges.
Created in NX3.0.0.

License requirements : None

tag_t NXOpen::Preferences::SessionVisualizationShade::Tag

(

)

const

Returns the tag of this object.

---

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

• Preferences_SessionVisualizationShade.hxx