PartVisualizationShade Class

class NXOpen.Preferences.PartVisualizationShade

Bases: object

Represents the set of shade visualization preferences applicable to entire part

To obtain an instance of this class, refer to NXOpen.Preferences.PartPreferences

New in version NX3.0.0.

Properties

Property Description
AdvVisFacetScaleRatio Returns or sets the facet to view scale ratio for Advanced Visualization views as specified by the user
AdvVisFacetToViewScale Returns or sets whether the facet to view scale for Advanced Visualization views should be computed automatically or should be defined by the user
AdvancedVisViewAngleTolerance Returns or sets the angle tolerance for advanced visualization views.
AdvancedVisViewEdgeTolerance Returns or sets the edge tolerance for advanced visualization views.
AdvancedVisViewFaceTolerance Returns or sets the face tolerance for advanced visualization views.
AdvancedVisViewTolerance Returns or sets the tolerance for advanced visualization views.
AdvancedVisViewUpdateMode Returns or sets the update mode for advanced visualization views.
AdvancedVisViewWidthTolerance Returns or sets the width tolerance for advanced Visualization Views.
AlignAdvVisViewFacetsAlongEdges Returns or sets the state of whether facets should be aligned along common edges for Advanced Visualization Views
AlignShadedViewFacetsAlongEdges Returns or sets the state of whether facets should be aligned along common edges for Shaded Views
HiddenGeometryColor Returns or sets the shade hidden geometry color.
ShadedFacetScaleRatio Returns or sets the facet to view scale ratio for Shaded views as specified by the user
ShadedFacetToViewScale Returns or sets whether the facet to view scale for Shaded views should be computed automatically or should be defined by the user
ShadedViewAngleTolerance Returns or sets the angle tolerance for shaded views.
ShadedViewEdgeTolerance Returns or sets the edge tolerance for shaded views.
ShadedViewFaceTolerance Returns or sets the face tolerance for shaded views.
ShadedViewTolerance Returns or sets the tolerance for shaded views.
ShadedViewUpdateMode Returns or sets the update mode for shaded views.

Methods

Method Description
GetAdvVisViewFacetTolerances Returns the edge, face, angle and width tolerances to be used with the specified tolerance set for Advanced Visualization views.
GetShadedViewFacetTolerances Returns the edge, face and angle tolerances to be used with the specified tolerance set for shaded views.
SetAdvVisViewFacetTolerances Sets the edge, face, angle and width tolerances to be used with the specified tolerance set for Advanced Visualization views.
SetShadedViewFacetTolerances Sets the edge, face and angle tolerances to be used with the specified tolerance set for shaded views.

Enumerations

PartVisualizationShadeAdvViewToleranceType Enumeration Describes the available tolerance types for Advanced View.
PartVisualizationShadeHiddenShadedFaceEdges Enumeration Describes whether the shaded face edges are invisible or dashed visible or with a color to depict the hidden geometry
PartVisualizationShadeShadedFaceEdge Enumeration Describes whether the shaded face edges are having no color or body color or user defined color.
PartVisualizationShadeShadedViewToleranceType Enumeration Describes the available tolerance types for Shaded View.
PartVisualizationShadeViewUpdateModeType Enumeration Describes whether the applied changes are applicable to visible object or all object or no object

Property Detail

AdvVisFacetScaleRatio

PartVisualizationShade.AdvVisFacetScaleRatio

Returns or sets the facet to view scale ratio for Advanced Visualization views as specified by the user

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

Getter Method

Signature AdvVisFacetScaleRatio()

Returns:
Return type:float

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to Display.FacetSettingsBuilder.AdvVisRefinementFactor() instead

License requirements: None.

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

Setter Method

Signature AdvVisFacetScaleRatio(advVisViewFacetScaleRatio)

Parameters:advVisViewFacetScaleRatio (float) –

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to Display.FacetSettingsBuilder.AdvVisRefinementFactor() instead

License requirements: None.

AdvVisFacetToViewScale

PartVisualizationShade.AdvVisFacetToViewScale

Returns or sets whether the facet to view scale for Advanced Visualization views should be computed automatically or should be defined by the user

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

Getter Method

Signature AdvVisFacetToViewScale()

Returns:
Return type:bool

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to Display.FacetSettingsBuilder.AdvVisFacetScale() instead

License requirements: None.

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

Setter Method

Signature AdvVisFacetToViewScale(advVisViewFacetToViewScale)

Parameters:advVisViewFacetToViewScale (bool) –

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to Display.FacetSettingsBuilder.AdvVisFacetScale() instead

License requirements: None.

AdvancedVisViewAngleTolerance

PartVisualizationShade.AdvancedVisViewAngleTolerance

Returns or sets the angle tolerance for advanced visualization views.

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

Getter Method

Signature AdvancedVisViewAngleTolerance()

Returns:
Return type:float

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetAdvVisViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetAdvVisViewFacetTolerances() instead.

License requirements: None.

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

Setter Method

Signature AdvancedVisViewAngleTolerance(advancedVisViewAngleTolerance)

Parameters:advancedVisViewAngleTolerance (float) –

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetAdvVisViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetAdvVisViewFacetTolerances() instead.

License requirements: None.

AdvancedVisViewEdgeTolerance

PartVisualizationShade.AdvancedVisViewEdgeTolerance

Returns or sets the edge tolerance for advanced visualization views.

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

Getter Method

Signature AdvancedVisViewEdgeTolerance()

Returns:
Return type:float

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetAdvVisViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetAdvVisViewFacetTolerances() instead.

License requirements: None.

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

Setter Method

Signature AdvancedVisViewEdgeTolerance(advancedVisViewEdgeTolerance)

Parameters:advancedVisViewEdgeTolerance (float) –

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetAdvVisViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetAdvVisViewFacetTolerances() instead.

License requirements: None.

AdvancedVisViewFaceTolerance

PartVisualizationShade.AdvancedVisViewFaceTolerance

Returns or sets the face tolerance for advanced visualization views.

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

Getter Method

Signature AdvancedVisViewFaceTolerance()

Returns:
Return type:float

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetAdvVisViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetAdvVisViewFacetTolerances() instead.

License requirements: None.

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

Setter Method

Signature AdvancedVisViewFaceTolerance(advancedVisViewFaceTolerance)

Parameters:advancedVisViewFaceTolerance (float) –

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetAdvVisViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetAdvVisViewFacetTolerances() instead.

License requirements: None.

AdvancedVisViewTolerance

PartVisualizationShade.AdvancedVisViewTolerance

Returns or sets the tolerance for advanced visualization views.

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

Getter Method

Signature AdvancedVisViewTolerance()

Returns:
Return type:NXOpen.Preferences.PartVisualizationShadeAdvViewToleranceType

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature AdvancedVisViewTolerance(advancedVisViewTolerance)

Parameters:advancedVisViewTolerance (NXOpen.Preferences.PartVisualizationShadeAdvViewToleranceType) –

New in version NX3.0.0.

License requirements: None.

AdvancedVisViewUpdateMode

PartVisualizationShade.AdvancedVisViewUpdateMode

Returns or sets the update mode for advanced visualization views.

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

Getter Method

Signature AdvancedVisViewUpdateMode()

Returns:
Return type:NXOpen.Preferences.PartVisualizationShadeViewUpdateModeType

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature AdvancedVisViewUpdateMode(advancedVisViewUpdateMode)

Parameters:advancedVisViewUpdateMode (NXOpen.Preferences.PartVisualizationShadeViewUpdateModeType) –

New in version NX3.0.0.

License requirements: None.

AdvancedVisViewWidthTolerance

PartVisualizationShade.AdvancedVisViewWidthTolerance

Returns or sets the width tolerance for advanced Visualization Views.

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

Getter Method

Signature AdvancedVisViewWidthTolerance()

Returns:
Return type:float

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetAdvVisViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetAdvVisViewFacetTolerances() instead.

License requirements: None.

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

Setter Method

Signature AdvancedVisViewWidthTolerance(advancedVisViewWidthTolerance)

Parameters:advancedVisViewWidthTolerance (float) –

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetAdvVisViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetAdvVisViewFacetTolerances() instead.

License requirements: None.

AlignAdvVisViewFacetsAlongEdges

PartVisualizationShade.AlignAdvVisViewFacetsAlongEdges

Returns or sets the state of whether facets should be aligned along common edges for Advanced Visualization Views

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

Getter Method

Signature AlignAdvVisViewFacetsAlongEdges()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature AlignAdvVisViewFacetsAlongEdges(alignAdvVisViewFacetsAlongEdges)

Parameters:alignAdvVisViewFacetsAlongEdges (bool) –

New in version NX8.5.0.

License requirements: None.

AlignShadedViewFacetsAlongEdges

PartVisualizationShade.AlignShadedViewFacetsAlongEdges

Returns or sets the state of whether facets should be aligned along common edges for Shaded Views

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

Getter Method

Signature AlignShadedViewFacetsAlongEdges()

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature AlignShadedViewFacetsAlongEdges(alignShadedViewFacetsAlongEdges)

Parameters:alignShadedViewFacetsAlongEdges (bool) –

New in version NX8.5.0.

License requirements: None.

HiddenGeometryColor

PartVisualizationShade.HiddenGeometryColor

Returns or sets the shade hidden geometry color.

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

Getter Method

Signature HiddenGeometryColor()

Returns:
Return type:int

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature HiddenGeometryColor(hiddenGeomColor)

Parameters:hiddenGeomColor (int) –

New in version NX3.0.0.

License requirements: None.

ShadedFacetScaleRatio

PartVisualizationShade.ShadedFacetScaleRatio

Returns or sets the facet to view scale ratio for Shaded views as specified by the user

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

Getter Method

Signature ShadedFacetScaleRatio()

Returns:
Return type:float

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to Display.FacetSettingsBuilder.ShadedRefinementFactor() instead

License requirements: None.

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

Setter Method

Signature ShadedFacetScaleRatio(shadedViewFacetScaleRatio)

Parameters:shadedViewFacetScaleRatio (float) –

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to Display.FacetSettingsBuilder.ShadedRefinementFactor() instead

License requirements: None.

ShadedFacetToViewScale

PartVisualizationShade.ShadedFacetToViewScale

Returns or sets whether the facet to view scale for Shaded views should be computed automatically or should be defined by the user

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

Getter Method

Signature ShadedFacetToViewScale()

Returns:
Return type:bool

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to Display.FacetSettingsBuilder.ShadedFacetScale() instead

License requirements: None.

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

Setter Method

Signature ShadedFacetToViewScale(shadedViewFacetToViewScale)

Parameters:shadedViewFacetToViewScale (bool) –

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to Display.FacetSettingsBuilder.ShadedFacetScale() instead

License requirements: None.

ShadedViewAngleTolerance

PartVisualizationShade.ShadedViewAngleTolerance

Returns or sets the angle tolerance for shaded views.

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

Getter Method

Signature ShadedViewAngleTolerance()

Returns:
Return type:float

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetShadedViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetShadedViewFacetTolerances() instead.

License requirements: None.

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

Setter Method

Signature ShadedViewAngleTolerance(shadedViewAngleTolerance)

Parameters:shadedViewAngleTolerance (float) –

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetShadedViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetShadedViewFacetTolerances() instead.

License requirements: None.

ShadedViewEdgeTolerance

PartVisualizationShade.ShadedViewEdgeTolerance

Returns or sets the edge tolerance for shaded views.

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

Getter Method

Signature ShadedViewEdgeTolerance()

Returns:
Return type:float

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetShadedViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetShadedViewFacetTolerances() instead.

License requirements: None.

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

Setter Method

Signature ShadedViewEdgeTolerance(shadedViewEdgeTolerance)

Parameters:shadedViewEdgeTolerance (float) –

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetShadedViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetShadedViewFacetTolerances() instead.

License requirements: None.

ShadedViewFaceTolerance

PartVisualizationShade.ShadedViewFaceTolerance

Returns or sets the face tolerance for shaded views.

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

Getter Method

Signature ShadedViewFaceTolerance()

Returns:
Return type:float

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetShadedViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetShadedViewFacetTolerances() instead.

License requirements: None.

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

Setter Method

Signature ShadedViewFaceTolerance(shadedViewFaceTolerance)

Parameters:shadedViewFaceTolerance (float) –

New in version NX3.0.0.

Deprecated since version NX8.0.0: Use NXOpen.Preferences.PartVisualizationShade.GetShadedViewFacetTolerances() and NXOpen.Preferences.PartVisualizationShade.SetShadedViewFacetTolerances() instead.

License requirements: None.

ShadedViewTolerance

PartVisualizationShade.ShadedViewTolerance

Returns or sets the tolerance for shaded views.

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

Getter Method

Signature ShadedViewTolerance()

Returns:
Return type:NXOpen.Preferences.PartVisualizationShadeShadedViewToleranceType

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature ShadedViewTolerance(shadedViewTolerance)

Parameters:shadedViewTolerance (NXOpen.Preferences.PartVisualizationShadeShadedViewToleranceType) –

New in version NX3.0.0.

License requirements: None.

ShadedViewUpdateMode

PartVisualizationShade.ShadedViewUpdateMode

Returns or sets the update mode for shaded views.

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

Getter Method

Signature ShadedViewUpdateMode()

Returns:
Return type:NXOpen.Preferences.PartVisualizationShadeViewUpdateModeType

New in version NX3.0.0.

License requirements: None.

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

Setter Method

Signature ShadedViewUpdateMode(shadedViewUpdateMode)

Parameters:shadedViewUpdateMode (NXOpen.Preferences.PartVisualizationShadeViewUpdateModeType) –

New in version NX3.0.0.

License requirements: None.

Method Detail

GetAdvVisViewFacetTolerances

PartVisualizationShade.GetAdvVisViewFacetTolerances

Returns the edge, face, angle and width tolerances to be used with the specified tolerance set for Advanced Visualization views.

Signature GetAdvVisViewFacetTolerances(advVisViewToleranceSet)

Parameters:advVisViewToleranceSet (NXOpen.Preferences.PartVisualizationShadeAdvViewToleranceType) –
Returns:a tuple
Return type:A tuple consisting of (edgeTolerance, faceTolerance, angleTolerance, widthTolerance). edgeTolerance is a float. faceTolerance is a float. angleTolerance is a float. widthTolerance is a float.

New in version NX8.0.0.

License requirements: None.

GetShadedViewFacetTolerances

PartVisualizationShade.GetShadedViewFacetTolerances

Returns the edge, face and angle tolerances to be used with the specified tolerance set for shaded views.

Signature GetShadedViewFacetTolerances(shadedViewToleranceSet)

Parameters:shadedViewToleranceSet (NXOpen.Preferences.PartVisualizationShadeShadedViewToleranceType) –
Returns:a tuple
Return type:A tuple consisting of (edgeTolerance, faceTolerance, angleTolerance). edgeTolerance is a float. faceTolerance is a float. angleTolerance is a float.

New in version NX8.0.0.

License requirements: None.

SetAdvVisViewFacetTolerances

PartVisualizationShade.SetAdvVisViewFacetTolerances

Sets the edge, face, angle and width tolerances to be used with the specified tolerance set for Advanced Visualization views.

Signature SetAdvVisViewFacetTolerances(advVisViewToleranceSet, edgeTolerance, faceTolerance, angleTolerance, widthTolerance)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetShadedViewFacetTolerances

PartVisualizationShade.SetShadedViewFacetTolerances

Sets the edge, face and angle tolerances to be used with the specified tolerance set for shaded views.

Signature SetShadedViewFacetTolerances(shadedViewToleranceSet, edgeTolerance, faceTolerance, angleTolerance)

Parameters:

New in version NX8.0.0.

License requirements: None.