RayTracedStudioEditorBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# RayTracedStudioEditorBuilder Class

class `NXOpen.Display.``RayTracedStudioEditorBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Display.RayTracedStudioEditorBuilder`.

  Ray Traced Studio Editor controls display and output of CPU-based real-time ray tracing.

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

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
DynamicRayTracedStudioTilingQuality | Returns or sets the Ray Traced Studio tiling quality during interactive dynamic display
RayTracedStudioDisplayGamma | Returns or sets the Ray Traced Studio display gamma, controls the overall contrast or brightness of the image’s midtone values.
RayTracedStudioStaticImageDotsPerInch | Returns or sets the Ray Traced Studio static image dots per inch (DPI)
RayTracedStudioStaticImageDoubleHeight | Returns or sets the Ray Traced Studio static image height
RayTracedStudioStaticImageDoubleWidth | Returns or sets the Ray Traced Studio static image width
RayTracedStudioStaticImageFileFormat | Returns or sets the Ray Traced Studio static output image file format
RayTracedStudioStaticImageLockAspectRatio | Returns or sets the Ray Traced Studio static image aspect ratio will be maintained
RayTracedStudioStaticImageOrientation | Returns or sets the Ray Traced Studio static image orientation
RayTracedStudioStaticImagePixelHeight | Returns or sets the Ray Traced Studio static image pixel height
RayTracedStudioStaticImagePixelWidth | Returns or sets the Ray Traced Studio static image pixel width
RayTracedStudioStaticImageResolution | Returns or sets the Ray Traced Studio static image resolution
RayTracedStudioStaticImageSize | Returns or sets the Ray Traced Studio static image size
RayTracedStudioStaticImageUnits | Returns or sets the Ray Traced Studio static image units
StaticAntialiasing | Returns or sets the Ray Traced Studio static image antialiasing quality
StaticRayTracedStudioQuality | Returns or sets the Ray Traced Studio static image quality
StaticRayTracedStudioRenderDepth | Returns or sets the Ray Traced Studio static image render depth, controls the iterations of ray tracing reflection and refraction calculations
StationaryAntialiasing | Returns or sets the Ray Traced Studio stationary antialiasing quality when dynamic interaction stops
StationaryRayTracedStudioQuality | Returns or sets the Ray Traced Studio stationary display quality when dynamic interaction stops
StationaryRayTracedStudioshowStatusIndicator | Returns or sets the stationary Ray Traced Studio progess status indicator percent complete display
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.

# Enumerations

RayTracedStudioEditorBuilderDynamicRayTracedStudioTilingQualityType Enumeration | To specify the quality and performance of the interactive, dynamic Ray Traced Studio display.
RayTracedStudioEditorBuilderRayTracedStudioStaticImageFileFormatType Enumeration | To specify the Ray Traced Studio static image file format
RayTracedStudioEditorBuilderRayTracedStudioStaticImageOrientationType Enumeration | To specify the Ray Traced Studio static image orientation
RayTracedStudioEditorBuilderRayTracedStudioStaticImageResolutionType Enumeration | To specify the Ray Traced Studio static image resolution
RayTracedStudioEditorBuilderRayTracedStudioStaticImageSizeType Enumeration | To specify the Ray Traced Studio static image size
RayTracedStudioEditorBuilderRayTracedStudioStaticImageUnitsType Enumeration | To specify the Ray Traced Studio static image units
RayTracedStudioEditorBuilderStaticAntialiasingType Enumeration | To specify the antialiasing quality during stationary Ray Traced Studio display during static image rendering
RayTracedStudioEditorBuilderStaticRayTracedStudioQualityType Enumeration | To specify the quality and performance of the Ray Traced Studio display during static image rendering
RayTracedStudioEditorBuilderStationaryAntialiasingType Enumeration | To specify the antialiasing quality during stationary Ray Traced Studio display when dynamic interaction stops
RayTracedStudioEditorBuilderStationaryRayTracedStudioQualityType Enumeration | To specify the quality and performance of the Ray Traced Studio display when dynamic interaction stops

# Property Detail

## DynamicRayTracedStudioTilingQuality

`RayTracedStudioEditorBuilder.``DynamicRayTracedStudioTilingQuality`

  Returns or sets the Ray Traced Studio tiling quality during interactive dynamic display

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

  Getter Method

  Signature `DynamicRayTracedStudioTilingQuality`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DynamicRayTracedStudioTilingQuality`

  Parameters: | dynamicRayTracedStudioTilingQuality (`NXOpen.Display.RayTracedStudioEditorBuilderDynamicRayTracedStudioTilingQualityType`) –

  New in version NX9.0.0.

  License requirements: None.

## RayTracedStudioDisplayGamma

`RayTracedStudioEditorBuilder.``RayTracedStudioDisplayGamma`

  Returns or sets the Ray Traced Studio display gamma, controls the overall contrast or brightness of the image’s midtone values.

  A higher gamma value yields an overall brighter image.

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

  Getter Method

  Signature `RayTracedStudioDisplayGamma`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RayTracedStudioDisplayGamma`

  Parameters: | rayTracedStudioDisplayGamma (float) –

  New in version NX9.0.0.

  License requirements: None.

## RayTracedStudioStaticImageDotsPerInch

`RayTracedStudioEditorBuilder.``RayTracedStudioStaticImageDotsPerInch`

  Returns or sets the Ray Traced Studio static image dots per inch (DPI)

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

  Getter Method

  Signature `RayTracedStudioStaticImageDotsPerInch`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RayTracedStudioStaticImageDotsPerInch`

  Parameters: | rayTracedStudioStaticImageDotsPerInch (int) –

  New in version NX9.0.0.

  License requirements: None.

## RayTracedStudioStaticImageDoubleHeight

`RayTracedStudioEditorBuilder.``RayTracedStudioStaticImageDoubleHeight`

  Returns or sets the Ray Traced Studio static image height

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

  Getter Method

  Signature `RayTracedStudioStaticImageDoubleHeight`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RayTracedStudioStaticImageDoubleHeight`

  Parameters: | rayTracedStudioStaticImageDoubleHeight (float) –

  New in version NX9.0.0.

  License requirements: None.

## RayTracedStudioStaticImageDoubleWidth

`RayTracedStudioEditorBuilder.``RayTracedStudioStaticImageDoubleWidth`

  Returns or sets the Ray Traced Studio static image width

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

  Getter Method

  Signature `RayTracedStudioStaticImageDoubleWidth`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RayTracedStudioStaticImageDoubleWidth`

  Parameters: | rayTracedStudioStaticImageDoubleWidth (float) –

  New in version NX9.0.0.

  License requirements: None.

## RayTracedStudioStaticImageFileFormat

`RayTracedStudioEditorBuilder.``RayTracedStudioStaticImageFileFormat`

  Returns or sets the Ray Traced Studio static output image file format

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

  Getter Method

  Signature `RayTracedStudioStaticImageFileFormat`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RayTracedStudioStaticImageFileFormat`

  Parameters: | rayTracedStudioStaticImageFileFormat (`NXOpen.Display.RayTracedStudioEditorBuilderRayTracedStudioStaticImageFileFormatType`) –

  New in version NX9.0.0.

  License requirements: None.

## RayTracedStudioStaticImageLockAspectRatio

`RayTracedStudioEditorBuilder.``RayTracedStudioStaticImageLockAspectRatio`

  Returns or sets the Ray Traced Studio static image aspect ratio will be maintained

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

  Getter Method

  Signature `RayTracedStudioStaticImageLockAspectRatio`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RayTracedStudioStaticImageLockAspectRatio`

  Parameters: | rayTracedStudioStaticImageLockAspectRatio (bool) –

  New in version NX9.0.0.

  License requirements: None.

## RayTracedStudioStaticImageOrientation

`RayTracedStudioEditorBuilder.``RayTracedStudioStaticImageOrientation`

  Returns or sets the Ray Traced Studio static image orientation

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

  Getter Method

  Signature `RayTracedStudioStaticImageOrientation`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RayTracedStudioStaticImageOrientation`

  Parameters: | rayTracedStudioStaticImageOrientation (`NXOpen.Display.RayTracedStudioEditorBuilderRayTracedStudioStaticImageOrientationType`) –

  New in version NX9.0.0.

  License requirements: None.

## RayTracedStudioStaticImagePixelHeight

`RayTracedStudioEditorBuilder.``RayTracedStudioStaticImagePixelHeight`

  Returns or sets the Ray Traced Studio static image pixel height

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

  Getter Method

  Signature `RayTracedStudioStaticImagePixelHeight`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RayTracedStudioStaticImagePixelHeight`

  Parameters: | rayTracedStudioStaticImagePixelHeight (int) –

  New in version NX9.0.0.

  License requirements: None.

## RayTracedStudioStaticImagePixelWidth

`RayTracedStudioEditorBuilder.``RayTracedStudioStaticImagePixelWidth`

  Returns or sets the Ray Traced Studio static image pixel width

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

  Getter Method

  Signature `RayTracedStudioStaticImagePixelWidth`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RayTracedStudioStaticImagePixelWidth`

  Parameters: | rayTracedStudioStaticImagePixelWidth (int) –

  New in version NX9.0.0.

  License requirements: None.

## RayTracedStudioStaticImageResolution

`RayTracedStudioEditorBuilder.``RayTracedStudioStaticImageResolution`

  Returns or sets the Ray Traced Studio static image resolution

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

  Getter Method

  Signature `RayTracedStudioStaticImageResolution`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RayTracedStudioStaticImageResolution`

  Parameters: | rayTracedStudioStaticImageResolution (`NXOpen.Display.RayTracedStudioEditorBuilderRayTracedStudioStaticImageResolutionType`) –

  New in version NX9.0.0.

  License requirements: None.

## RayTracedStudioStaticImageSize

`RayTracedStudioEditorBuilder.``RayTracedStudioStaticImageSize`

  Returns or sets the Ray Traced Studio static image size

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

  Getter Method

  Signature `RayTracedStudioStaticImageSize`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RayTracedStudioStaticImageSize`

  Parameters: | rayTracedStudioStaticImageSize (`NXOpen.Display.RayTracedStudioEditorBuilderRayTracedStudioStaticImageSizeType`) –

  New in version NX9.0.0.

  License requirements: None.

## RayTracedStudioStaticImageUnits

`RayTracedStudioEditorBuilder.``RayTracedStudioStaticImageUnits`

  Returns or sets the Ray Traced Studio static image units

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

  Getter Method

  Signature `RayTracedStudioStaticImageUnits`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RayTracedStudioStaticImageUnits`

  Parameters: | rayTracedStudioStaticImageUnits (`NXOpen.Display.RayTracedStudioEditorBuilderRayTracedStudioStaticImageUnitsType`) –

  New in version NX9.0.0.

  License requirements: None.

## StaticAntialiasing

`RayTracedStudioEditorBuilder.``StaticAntialiasing`

  Returns or sets the Ray Traced Studio static image antialiasing quality

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

  Getter Method

  Signature `StaticAntialiasing`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StaticAntialiasing`

  Parameters: | staticAntialiasing (`NXOpen.Display.RayTracedStudioEditorBuilderStaticAntialiasingType`) –

  New in version NX9.0.0.

  License requirements: None.

## StaticRayTracedStudioQuality

`RayTracedStudioEditorBuilder.``StaticRayTracedStudioQuality`

  Returns or sets the Ray Traced Studio static image quality

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

  Getter Method

  Signature `StaticRayTracedStudioQuality`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StaticRayTracedStudioQuality`

  Parameters: | staticRayTracedStudioQuality (`NXOpen.Display.RayTracedStudioEditorBuilderStaticRayTracedStudioQualityType`) –

  New in version NX9.0.0.

  License requirements: None.

## StaticRayTracedStudioRenderDepth

`RayTracedStudioEditorBuilder.``StaticRayTracedStudioRenderDepth`

  Returns or sets the Ray Traced Studio static image render depth, controls the iterations of ray tracing reflection and refraction calculations

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

  Getter Method

  Signature `StaticRayTracedStudioRenderDepth`

  Returns: |
  Return type: | int

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StaticRayTracedStudioRenderDepth`

  Parameters: | staticRayTracedStudioRenderDepth (int) –

  New in version NX9.0.0.

  License requirements: None.

## StationaryAntialiasing

`RayTracedStudioEditorBuilder.``StationaryAntialiasing`

  Returns or sets the Ray Traced Studio stationary antialiasing quality when dynamic interaction stops

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

  Getter Method

  Signature `StationaryAntialiasing`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StationaryAntialiasing`

  Parameters: | stationaryAntialiasing (`NXOpen.Display.RayTracedStudioEditorBuilderStationaryAntialiasingType`) –

  New in version NX9.0.0.

  License requirements: None.

## StationaryRayTracedStudioQuality

`RayTracedStudioEditorBuilder.``StationaryRayTracedStudioQuality`

  Returns or sets the Ray Traced Studio stationary display quality when dynamic interaction stops

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

  Getter Method

  Signature `StationaryRayTracedStudioQuality`

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

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StationaryRayTracedStudioQuality`

  Parameters: | stationaryRayTracedStudioQuality (`NXOpen.Display.RayTracedStudioEditorBuilderStationaryRayTracedStudioQualityType`) –

  New in version NX9.0.0.

  License requirements: None.

## StationaryRayTracedStudioshowStatusIndicator

`RayTracedStudioEditorBuilder.``StationaryRayTracedStudioshowStatusIndicator`

  Returns or sets the stationary Ray Traced Studio progess status indicator percent complete display

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

  Getter Method

  Signature `StationaryRayTracedStudioshowStatusIndicator`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `StationaryRayTracedStudioshowStatusIndicator`

  Parameters: | stationaryRayTracedStudioshowStatusIndicator (bool) –

  New in version NX9.0.0.

  License requirements: None.

# Method Detail

## Validate

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