Shadows Class — NXOpen Python API Reference 12.0.0 documentation

# Shadows Class

class `NXOpen.Display.``Shadows`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Display.Shadows`

  This class is restricted to being called from a program running during an Interactive NX session. If run from a non-interactive session it will return None.

  To create a new instance of this class, use `NXOpen.ViewCollection.CreateShadows()`

  New in version NX7.5.3.

# Properties

Property | Description
--- | ---
AmbientOcclusion | Returns or sets the shadows SSAO ambient occlusion
GenerateHqiShadows | Returns or sets the High Quality Image settings
RealTimeType | Returns or sets the Real Time Settings
ShadowCatcherSelection | Returns the Shadow Catcher Selection
ShadowsEnabled | Returns or sets the Overall Shadows
SoftShadowsBiasOffset | Returns or sets the Soft Shadows bias offset
SoftShadowsEdges | Returns or sets the Soft Shadows edges (softness)
SoftShadowsEnabled | Returns or sets the Soft Shadows
SoftShadowsGradientClamp | Returns or sets the Soft Shadows gradient clamp
SoftShadowsQuality | Returns or sets the Soft Shadows quality
SsaoBlurRadius | Returns or sets the shadows SSAO Blur Radius
SsaoContrast | Returns or sets the shadows SSAO contrast
SsaoQuality | Returns or sets the shadows SSAO quality
SsaoRadius | Returns or sets the shadows SSAO radius
Tag | Returns the Tag for this object.
UseShadowCatcher | Returns or sets the Shadow Catcher

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

ShadowsRealTimeState Enumeration | Real time type settings - environment_shadow_catcher_only is enabled only in Basic Studio mode
ShadowsSsaoContrastType Enumeration | Shadows SSAO contrast settings
ShadowsSsaoQualityType Enumeration | Shadows SSAO quality settings

# Property Detail

## AmbientOcclusion

`Shadows.``AmbientOcclusion`

  Returns or sets the shadows SSAO ambient occlusion

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

  Getter Method

  Signature `AmbientOcclusion`

  Returns: |
  Return type: | bool

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `AmbientOcclusion`

  Parameters: | shadowsSSAODisplayEnabled (bool) –

  New in version NX7.5.3.

  License requirements: None.

## GenerateHqiShadows

`Shadows.``GenerateHqiShadows`

  Returns or sets the High Quality Image settings

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

  Getter Method

  Signature `GenerateHqiShadows`

  Returns: |
  Return type: | bool

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `GenerateHqiShadows`

  Parameters: | generateHQIShadows (bool) –

  New in version NX7.5.3.

  License requirements: None.

## RealTimeType

`Shadows.``RealTimeType`

  Returns or sets the Real Time Settings

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

  Getter Method

  Signature `RealTimeType`

  Returns: |
  Return type: | `NXOpen.Display.ShadowsRealTimeState`

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `RealTimeType`

  Parameters: | realTimeType (`NXOpen.Display.ShadowsRealTimeState`) –

  New in version NX7.5.3.

  License requirements: None.

## ShadowCatcherSelection

`Shadows.``ShadowCatcherSelection`

  Returns the Shadow Catcher Selection

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

  Getter Method

  Signature `ShadowCatcherSelection`

  Returns: |
  Return type: | `NXOpen.SelectNXObjectList`

  New in version NX7.5.3.

  License requirements: None.

## ShadowsEnabled

`Shadows.``ShadowsEnabled`

  Returns or sets the Overall Shadows

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

  Getter Method

  Signature `ShadowsEnabled`

  Returns: |
  Return type: | bool

  New in version NX10.0.2.

  License requirements: None.

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

  Setter Method

  Signature `ShadowsEnabled`

  Parameters: | shadowsEnabled (bool) –

  New in version NX10.0.2.

  License requirements: None.

## SoftShadowsBiasOffset

`Shadows.``SoftShadowsBiasOffset`

  Returns or sets the Soft Shadows bias offset

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

  Getter Method

  Signature `SoftShadowsBiasOffset`

  Returns: |
  Return type: | float

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `SoftShadowsBiasOffset`

  Parameters: | softShadowsBiasOffset (float) –

  New in version NX7.5.3.

  License requirements: None.

## SoftShadowsEdges

`Shadows.``SoftShadowsEdges`

  Returns or sets the Soft Shadows edges (softness)

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

  Getter Method

  Signature `SoftShadowsEdges`

  Returns: |
  Return type: | int

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `SoftShadowsEdges`

  Parameters: | softShadowsEdges (int) –

  New in version NX7.5.3.

  License requirements: None.

## SoftShadowsEnabled

`Shadows.``SoftShadowsEnabled`

  Returns or sets the Soft Shadows

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

  Getter Method

  Signature `SoftShadowsEnabled`

  Returns: |
  Return type: | bool

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `SoftShadowsEnabled`

  Parameters: | softShadowsEnabled (bool) –

  New in version NX7.5.3.

  License requirements: None.

## SoftShadowsGradientClamp

`Shadows.``SoftShadowsGradientClamp`

  Returns or sets the Soft Shadows gradient clamp

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

  Getter Method

  Signature `SoftShadowsGradientClamp`

  Returns: |
  Return type: | float

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `SoftShadowsGradientClamp`

  Parameters: | softShadowsGradientClamp (float) –

  New in version NX7.5.3.

  License requirements: None.

## SoftShadowsQuality

`Shadows.``SoftShadowsQuality`

  Returns or sets the Soft Shadows quality

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

  Getter Method

  Signature `SoftShadowsQuality`

  Returns: |
  Return type: | int

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `SoftShadowsQuality`

  Parameters: | softShadowsQuality (int) –

  New in version NX7.5.3.

  License requirements: None.

## SsaoBlurRadius

`Shadows.``SsaoBlurRadius`

  Returns or sets the shadows SSAO Blur Radius

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

  Getter Method

  Signature `SsaoBlurRadius`

  Returns: |
  Return type: | float

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `SsaoBlurRadius`

  Parameters: | blurRadius (float) –

  New in version NX7.5.3.

  License requirements: None.

## SsaoContrast

`Shadows.``SsaoContrast`

  Returns or sets the shadows SSAO contrast

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

  Getter Method

  Signature `SsaoContrast`

  Returns: |
  Return type: | `NXOpen.Display.ShadowsSsaoContrastType`

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `SsaoContrast`

  Parameters: | contrast (`NXOpen.Display.ShadowsSsaoContrastType`) –

  New in version NX7.5.3.

  License requirements: None.

## SsaoQuality

`Shadows.``SsaoQuality`

  Returns or sets the shadows SSAO quality

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

  Getter Method

  Signature `SsaoQuality`

  Returns: |
  Return type: | `NXOpen.Display.ShadowsSsaoQualityType`

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `SsaoQuality`

  Parameters: | shadowsSSAOQuality (`NXOpen.Display.ShadowsSsaoQualityType`) –

  New in version NX7.5.3.

  License requirements: None.

## SsaoRadius

`Shadows.``SsaoRadius`

  Returns or sets the shadows SSAO radius

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

  Getter Method

  Signature `SsaoRadius`

  Returns: |
  Return type: | float

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `SsaoRadius`

  Parameters: | radius (float) –

  New in version NX7.5.3.

  License requirements: None.

## UseShadowCatcher

`Shadows.``UseShadowCatcher`

  Returns or sets the Shadow Catcher

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

  Getter Method

  Signature `UseShadowCatcher`

  Returns: |
  Return type: | bool

  New in version NX7.5.3.

  License requirements: None.

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

  Setter Method

  Signature `UseShadowCatcher`

  Parameters: | useShadowCatcher (bool) –

  New in version NX7.5.3.

  License requirements: None.

# Method Detail

## Validate

`Shadows.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.