NX Open C++ Reference Guide
Classes | Public Types | Public Member Functions
NXOpen::Preferences::SessionVisualizationShade Class Reference

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

List of all members.

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

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

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.

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

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

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

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


Created in NX4.0.0.

License requirements : None

Regenerates Shaded Views.

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

License requirements : None

Regenerates Studio Analysis Views.

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

License requirements : None

Parameters:
updateEnvOptionSend TRUE if env cube updation is required. Else send FALSE

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


Created in NX7.0.0.

License requirements : None

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


Created in NX8.0.0.

License requirements : None

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


Created in NX8.0.0.

License requirements : None

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


Created in NX7.0.0.

License requirements : None

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


Created in NX7.0.0.

License requirements : None

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:
edgesEmphasisEdge Emphasis Option to be set or not

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


Created in NX4.0.0.

License requirements : None

Parameters:
lwrtStudioDisplayOption to be set or not

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


Created in NX7.0.0.

License requirements : None

Parameters:
seeThrusee thru

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


Created in NX8.0.0.

License requirements : None

Parameters:
seeThruDeEmphasizedObjectssee thru de emphasized objects

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


Created in NX8.0.0.

License requirements : None

Parameters:
seeThruSectionsee thru section

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


Created in NX7.0.0.

License requirements : None

Parameters:
seeThruStylesee thru style

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


Created in NX7.0.0.

License requirements : None

Parameters:
seeThruOptionssee thru options

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:
facetEdgesfacet edges

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

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.