GlobalIlluminationBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# GlobalIlluminationBuilder Class

class `NXOpen.Display.``GlobalIlluminationBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Display.GlobalIlluminationBuilder`.

  Global Illumination provides simulation of real-world lighting using image-based lighting. Image-Based Lighting replaces the Lights in a view with lighting effects derived from a given image. Global Illumination Final Gather settings affect the Ray Traced Studio photo-realistic display of the work view.

  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.CreateGlobalIlluminationBuilder()`

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
IntensityDouble | Returns or sets the intensity control affects the brightness of the Ray Traced Studio lighting and depends on the global illumination image used
StaticFinalGatherQuality | Returns or sets the static final gather quality affects Ray Traced Studio static (still) image rendering
StationaryFinalGatherQuality | Returns or sets the stationary final gather quality affects Ray Traced Studio rendering when dynamic operations stop
Tag | Returns the Tag for this object.

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

# Property Detail

## IntensityDouble

`GlobalIlluminationBuilder.``IntensityDouble`

  Returns or sets the intensity control affects the brightness of the Ray Traced Studio lighting and depends on the global illumination image used

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

  Getter Method

  Signature `IntensityDouble`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IntensityDouble`

  Parameters: | intensityDouble (float) –

  New in version NX9.0.0.

  License requirements: None.

## StaticFinalGatherQuality

`GlobalIlluminationBuilder.``StaticFinalGatherQuality`

  Returns or sets the static final gather quality affects Ray Traced Studio static (still) image rendering

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

  Getter Method

  Signature `StaticFinalGatherQuality`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StaticFinalGatherQuality`

  Parameters: | staticFinalGatherQuality (float) –

  New in version NX9.0.0.

  License requirements: None.

## StationaryFinalGatherQuality

`GlobalIlluminationBuilder.``StationaryFinalGatherQuality`

  Returns or sets the stationary final gather quality affects Ray Traced Studio rendering when dynamic operations stop

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

  Getter Method

  Signature `StationaryFinalGatherQuality`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StationaryFinalGatherQuality`

  Parameters: | stationaryFinalGatherQuality (float) –

  New in version NX9.0.0.

  License requirements: None.

# Method Detail

## Validate

`GlobalIlluminationBuilder.``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.