SessionVisualizationShade Class

class NXOpen.Preferences.SessionVisualizationShade

Bases: object

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 NXOpen.UI

New in version NX3.0.0.

Properties

Property	Description
EdgesEmphasis	Returns or sets the edge emphasis flag.
LwrtStudioDisplay	Returns or sets the lwrt studio display flag.
SeeThru	Returns or sets the setting that determines whether See-Thru is applied to all less important objects.
SeeThruDeEmphasizedObjects	Returns or sets the setting that determines whether See-Thru is applied to de-emphasized objects.
SeeThruSection	Returns or sets the setting that determines whether See-Thru is applied to the section cap.
SeeThruStyle	Returns or sets the see-thru style that determines how translucency is applied to less important shaded geometry.
SeeThruStyleOptions	Returns or sets the See-Thru color, edge, and translucency options used for the various See-Thru Styles.
ShowFacetEdges	Returns or sets the show facet edge flag.

Methods

Method	Description
RegenerateShadedViewsFromToleranceChange	Regenerates Shaded Views.
RegenerateStudioAnalysisViewsFromTolChange	Regenerates Studio Analysis Views.

Enumerations

SessionVisualizationShadeSeeThruEdgesType Enumeration	Determines whether edges are displayed for less important shaded geometry when See-Thru is enabled.
SessionVisualizationShadeSeeThruStyleType Enumeration	Determines how translucency is applied to less important shaded geometry when See-Thru is enabled.

Structs

SessionVisualizationShadeRgb_Struct Struct	Specifies a color by its red, green, and blue values, where each value is between 0 and 1.
SessionVisualizationShadeSeeThruOptions_Struct Struct	Specifies the See-Thru color, edge, and translucency options used for the various See-Thru Styles.

Property Detail

EdgesEmphasis

SessionVisualizationShade.EdgesEmphasis

Returns or sets the edge emphasis flag.

Alters how edges are displayed when Shaded Face Edges is flag is true.

-------------------------------------

Getter Method

Signature EdgesEmphasis()

Returns: Return type:bool

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature EdgesEmphasis(edgesEmphasis)

Parameters:edgesEmphasis (bool) – Edge Emphasis Option to be set or not

New in version NX3.0.0.

License requirements: None.

LwrtStudioDisplay

SessionVisualizationShade.LwrtStudioDisplay

Returns or sets the lwrt studio display flag.

Alters how studio are displayed.

-------------------------------------

Getter Method

Signature LwrtStudioDisplay()

Returns: Return type:bool

New in version NX4.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LwrtStudioDisplay(lwrtStudioDisplay)

Parameters:lwrtStudioDisplay (bool) – Option to be set or not

New in version NX4.0.0.

License requirements: None.

SeeThru

SessionVisualizationShade.SeeThru

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

-------------------------------------

Getter Method

Signature SeeThru()

Returns: Return type:bool

New in version NX7.0.0.

Deprecated since version NX8.5.0: See NXOpen.Preferences.SessionVisualizationEmphasis.

License requirements: None.

-------------------------------------

Setter Method

Signature SeeThru(seeThru)

Parameters:seeThru (bool) –

New in version NX7.0.0.

Deprecated since version NX8.5.0: See NXOpen.Preferences.SessionVisualizationEmphasis.

License requirements: None.

SeeThruDeEmphasizedObjects

SessionVisualizationShade.SeeThruDeEmphasizedObjects

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

-------------------------------------

Getter Method

Signature SeeThruDeEmphasizedObjects()

Returns: Return type:bool

New in version NX8.0.0.

Deprecated since version NX8.5.0: Use NXOpen.Preferences.SessionVisualizationEmphasis.SeeThruDeEmphasizedObjects() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature SeeThruDeEmphasizedObjects(seeThruDeEmphasizedObjects)

Parameters:seeThruDeEmphasizedObjects (bool) –

New in version NX8.0.0.

Deprecated since version NX8.5.0: Use NXOpen.Preferences.SessionVisualizationEmphasis.SeeThruDeEmphasizedObjects() instead.

License requirements: None.

SeeThruSection

SessionVisualizationShade.SeeThruSection

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

-------------------------------------

Getter Method

Signature SeeThruSection()

Returns: Return type:bool

New in version NX8.0.0.

Deprecated since version NX8.5.0: Use NXOpen.Preferences.SessionVisualizationEmphasis.SeeThruSection() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature SeeThruSection(seeThruSection)

Parameters:seeThruSection (bool) –

New in version NX8.0.0.

Deprecated since version NX8.5.0: Use NXOpen.Preferences.SessionVisualizationEmphasis.SeeThruSection() instead.

License requirements: None.

SeeThruStyle

SessionVisualizationShade.SeeThruStyle

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

-------------------------------------

Getter Method

Signature SeeThruStyle()

Returns: Return type:NXOpen.Preferences.SessionVisualizationShadeSeeThruStyleType

New in version NX7.0.0.

Deprecated since version NX8.5.0: Use NXOpen.Preferences.PartVisualizationEmphasis.SeeThruStyle() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature SeeThruStyle(seeThruStyle)

Parameters:seeThruStyle (NXOpen.Preferences.SessionVisualizationShadeSeeThruStyleType) –

New in version NX7.0.0.

Deprecated since version NX8.5.0: Use NXOpen.Preferences.PartVisualizationEmphasis.SeeThruStyle() instead.

License requirements: None.

SeeThruStyleOptions

SessionVisualizationShade.SeeThruStyleOptions

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

-------------------------------------

Getter Method

Signature SeeThruStyleOptions()

Returns: Return type:NXOpen.Preferences.SessionVisualizationShadeSeeThruOptions_Struct

New in version NX7.0.0.

Deprecated since version NX8.5.0: See NXOpen.Preferences.PartVisualizationEmphasis.

License requirements: None.

-------------------------------------

Setter Method

Signature SeeThruStyleOptions(seeThruOptions)

Parameters:seeThruOptions (NXOpen.Preferences.SessionVisualizationShadeSeeThruOptions_Struct) –

New in version NX7.0.0.

Deprecated since version NX8.5.0: See NXOpen.Preferences.PartVisualizationEmphasis.

License requirements: None.

ShowFacetEdges

SessionVisualizationShade.ShowFacetEdges

Returns or 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.

-------------------------------------

Getter Method

Signature ShowFacetEdges()

Returns: Return type:bool

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowFacetEdges(facetEdges)

Parameters:facetEdges (bool) –

New in version NX3.0.0.

License requirements: None.

Method Detail

RegenerateShadedViewsFromToleranceChange

SessionVisualizationShade.RegenerateShadedViewsFromToleranceChange

Regenerates Shaded Views.

Updates all objects based on their surfacing tolerance.

Signature RegenerateShadedViewsFromToleranceChange()

New in version NX3.0.0.

License requirements: None.

RegenerateStudioAnalysisViewsFromTolChange

SessionVisualizationShade.RegenerateStudioAnalysisViewsFromTolChange

Regenerates Studio Analysis Views.

Updates all objects based on their surfacing tolerance.

Signature RegenerateStudioAnalysisViewsFromTolChange(updateEnvOption)

Parameters:updateEnvOption (bool) – Send TRUE if env cube updation is required. Else send FALSE

New in version NX3.0.0.

License requirements: None.