PartVisualizationShade Class — NXOpen Python API Reference 12.0.0 documentation

# 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
--- | ---
AdvancedVisViewTolerance | Returns or sets the tolerance for advanced visualization views.
AdvancedVisViewUpdateMode | Returns or sets the update mode 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.
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.
RegenerateShadedViewsFromToleranceChange | Regenerates Shaded Views.
RegenerateStudioAnalysisViewsFromToleranceChange | Regenerates Studio Analysis 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

## 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`

  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`

  Parameters: | advancedVisViewUpdateMode (`NXOpen.Preferences.PartVisualizationShadeViewUpdateModeType`) –

  New in version NX3.0.0.

  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`

  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`

  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`

  Parameters: | hiddenGeomColor (int) –

  New in version NX3.0.0.

  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`

  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`

  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.

## RegenerateShadedViewsFromToleranceChange

`PartVisualizationShade.``RegenerateShadedViewsFromToleranceChange`

  Regenerates Shaded Views.

  Updates all objects based on their surfacing tolerance.

  Signature `RegenerateShadedViewsFromToleranceChange()`

  New in version NX12.0.0.

  License requirements: None.

## RegenerateStudioAnalysisViewsFromToleranceChange

`PartVisualizationShade.``RegenerateStudioAnalysisViewsFromToleranceChange`

  Regenerates Studio Analysis Views.

  Updates all objects based on their surfacing tolerance.

  Signature `RegenerateStudioAnalysisViewsFromToleranceChange(updateEnvCube)`

  Parameters: | updateEnvCube (bool) – True if env cube should be updated

  New in version NX12.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:

  - advVisViewToleranceSet (`NXOpen.Preferences.PartVisualizationShadeAdvViewToleranceType`) –
  - edgeTolerance (float) –
  - faceTolerance (float) –
  - angleTolerance (float) –
  - widthTolerance (float) –

  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:

  - shadedViewToleranceSet (`NXOpen.Preferences.PartVisualizationShadeShadedViewToleranceType`) –
  - edgeTolerance (float) –
  - faceTolerance (float) –
  - angleTolerance (float) –

  New in version NX8.0.0.

  License requirements: None.