ViewVisualizationVisual Class — NXOpen Python API Reference 12.0.0 documentation

# ViewVisualizationVisual Class

class `NXOpen.Preferences.``ViewVisualizationVisual`

  Bases: `object`

  Represents the set of View related Visualization visual preferences

  To obtain an instance of this class, refer to `NXOpen.View`

  New in version NX3.0.0.

# Properties

Property | Description
--- | ---
DisplayAppearance | Returns or sets the rendering style and the edge display options of the view.
HiddenEdgeStyle | Returns or sets the hidden edge display style for shaded faces in the view.
ShadedEdgeColor | Returns or sets the edge color for shaded faces in the view.
ShadedEdgeStyle | Returns or sets the edge display style for shaded faces in the view.
ShininessData | Returns or sets the shininess value.
SurfaceDisplay | Returns or sets the rendering style and the edge display options of the view.
TrueSurfaceDisplay | Returns or sets the true surface display parameters.
TwoSidedLight | Returns or sets the two sided light flag.

# Methods

# Enumerations

ViewVisualizationVisualDisplayModeType Enumeration | Describes the available display mode types.
ViewVisualizationVisualHiddenEdgeStyleType Enumeration | Describes how hidden edges are displayed for shaded faces in the view.
ViewVisualizationVisualHiddenEdges Enumeration | Describes the appearance of hidden edges displayed in the view.
ViewVisualizationVisualHiddenEdgesType Enumeration | Describes the available hidden edges types.
ViewVisualizationVisualRenderingStyle Enumeration | Describes the rendering style for geometry displayed in the view.
ViewVisualizationVisualShadedEdgeStyleType Enumeration | Describes how edges are displayed for shaded faces in the view.
ViewVisualizationVisualSmoothEdgeFont Enumeration | Describes all possible font selection for visible smooth edges
ViewVisualizationVisualSmoothEdgeWidth Enumeration | Describes all possible width selection for visible smooth edges

# Structs

ViewVisualizationVisualDisplayAppearanceOptions_Struct Struct | Describes the rendering style and the appearance of edges and silhouettes in the view.
ViewVisualizationVisualSurfaceDisplayOptions_Struct Struct | Describes the appearance of edges and silhouettes in the view.
ViewVisualizationVisualTrueSurfaceDisplayPref_Struct Struct | Represents the various surface display parameters.

# Property Detail

## DisplayAppearance

`ViewVisualizationVisual.``DisplayAppearance`

  Returns or sets the rendering style and the edge display options of the view.

  `-------------------------------------`

  Getter Method

  Signature `DisplayAppearance`

  Returns: |
  Return type: | `NXOpen.Preferences.ViewVisualizationVisualDisplayAppearanceOptions_Struct`

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DisplayAppearance`

  Parameters: | displayAppearanceOptions (`NXOpen.Preferences.ViewVisualizationVisualDisplayAppearanceOptions_Struct`) –

  New in version NX8.5.0.

  License requirements: None.

## HiddenEdgeStyle

`ViewVisualizationVisual.``HiddenEdgeStyle`

  Returns or sets the hidden edge display style for shaded faces in the view.

  `-------------------------------------`

  Getter Method

  Signature `HiddenEdgeStyle`

  Returns: |
  Return type: | `NXOpen.Preferences.ViewVisualizationVisualHiddenEdgeStyleType`

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `HiddenEdgeStyle`

  Parameters: | hiddenEdgeStyle (`NXOpen.Preferences.ViewVisualizationVisualHiddenEdgeStyleType`) –

  New in version NX4.0.0.

  License requirements: None.

## ShadedEdgeColor

`ViewVisualizationVisual.``ShadedEdgeColor`

  Returns or sets the edge color for shaded faces in the view.

  `-------------------------------------`

  Getter Method

  Signature `ShadedEdgeColor`

  Returns: |
  Return type: | int

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ShadedEdgeColor`

  Parameters: | shadedEdgeColor (int) –

  New in version NX4.0.0.

  License requirements: None.

## ShadedEdgeStyle

`ViewVisualizationVisual.``ShadedEdgeStyle`

  Returns or sets the edge display style for shaded faces in the view.

  `-------------------------------------`

  Getter Method

  Signature `ShadedEdgeStyle`

  Returns: |
  Return type: | `NXOpen.Preferences.ViewVisualizationVisualShadedEdgeStyleType`

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ShadedEdgeStyle`

  Parameters: | shadedEdgeStyle (`NXOpen.Preferences.ViewVisualizationVisualShadedEdgeStyleType`) –

  New in version NX4.0.0.

  License requirements: None.

## ShininessData

`ViewVisualizationVisual.``ShininessData`

  Returns or sets the shininess value.

  Specifies the intensity of the graphics driver addition of highlights to shaded surfaces, making them appear shiny. The value 0.0 adds no shininess, and 1.0 adds the maximum amount of shininess.

  `-------------------------------------`

  Getter Method

  Signature `ShininessData`

  Returns: |
  Return type: | float

  New in version NX3.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ShininessData`

  Parameters: | shininessData (float) –

  New in version NX3.0.0.

  License requirements: None.

## SurfaceDisplay

`ViewVisualizationVisual.``SurfaceDisplay`

  Returns or sets the rendering style and the edge display options of the view.

  `-------------------------------------`

  Getter Method

  Signature `SurfaceDisplay`

  Returns: |
  Return type: | `NXOpen.Preferences.ViewVisualizationVisualSurfaceDisplayOptions_Struct`

  New in version NX4.0.0.

  Deprecated since version NX8.5.0: Use `NXOpen.Preferences.ViewVisualizationVisual.DisplayAppearance()` instead.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SurfaceDisplay`

  Parameters: | surfaceDisplay (`NXOpen.Preferences.ViewVisualizationVisualSurfaceDisplayOptions_Struct`) –

  New in version NX4.0.0.

  Deprecated since version NX8.5.0: Use `NXOpen.Preferences.ViewVisualizationVisual.DisplayAppearance()` instead.

  License requirements: None.

## TrueSurfaceDisplay

`ViewVisualizationVisual.``TrueSurfaceDisplay`

  Returns or sets the true surface display parameters.

  `-------------------------------------`

  Getter Method

  Signature `TrueSurfaceDisplay`

  Returns: |
  Return type: | `NXOpen.Preferences.ViewVisualizationVisualTrueSurfaceDisplayPref_Struct`

  New in version NX3.0.0.

  Deprecated since version NX4.0.0: Use `NXOpen.Preferences.ViewVisualizationVisual.DisplayAppearance()` instead.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TrueSurfaceDisplay`

  Parameters: | trueSurfaceDisplay (`NXOpen.Preferences.ViewVisualizationVisualTrueSurfaceDisplayPref_Struct`) –

  New in version NX3.0.0.

  Deprecated since version NX4.0.0: Use `NXOpen.Preferences.ViewVisualizationVisual.DisplayAppearance()` instead.

  License requirements: None.

## TwoSidedLight

`ViewVisualizationVisual.``TwoSidedLight`

  Returns or sets the two sided light flag.

  Specifies whether lighting should be applied to both the front and backsides of faces. If it is true, then lighting from a light source is applied to the front or the back face, depending on which side is exposed to the light source. If this is false, then lighting is not applied to the back of a face even if the back is exposed to the light source.

  `-------------------------------------`

  Getter Method

  Signature `TwoSidedLight`

  Returns: |
  Return type: | bool

  New in version NX3.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TwoSidedLight`

  Parameters: | twoSidedLight (bool) –

  New in version NX3.0.0.

  License requirements: None.