RayTracedStudioBuilder Class¶
-
class
NXOpen.Display.RayTracedStudioBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Display.RayTracedStudioBuilder.Ray Traced Studio displays CPU-based real-time ray tracing results of a model dynamically.
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.CreateRayTracedStudioBuilder()New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| Brightness | Returns or sets the brightness for Iray Tonemap setting |
| StationaryQuality | Returns or sets the Ray Traced Studio stationary display quality when dynamic interaction stops |
| 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. |
| RayTracedEditor | Launch the Ray Traced Studio Editor command |
| RayTracedRenderingErase | Erase Ray Traced Studio static (still) image from the Ray Traced Studio window |
| RayTracedRenderingSave | Save a copy of the Ray Traced Studio static (still) image display from the window to an image file |
| RayTracedRenderingStart | Start Ray Traced Studio static image rendering |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| StartRayTracedDisplay | Start the Ray Traced Studio display after it has been stopped using the Stop action. |
| StopRayTracedDisplay | Stop the Ray Traced Studio progressive display. |
| UpdateRayTracedDisplay | Update the Ray Traced Studio display. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| RayTracedStudioBuilderStationaryDisplayQualityType Enumeration | To specify the quality and performance of the Ray Traced Studio display. |
Property Detail¶
Brightness¶
-
RayTracedStudioBuilder.Brightness¶ Returns or sets the brightness for Iray Tonemap setting
-------------------------------------Getter Method
Signature
BrightnessReturns: Return type: float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
BrightnessParameters: brightness (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
StationaryQuality¶
-
RayTracedStudioBuilder.StationaryQuality¶ Returns or sets the Ray Traced Studio stationary display quality when dynamic interaction stops
-------------------------------------Getter Method
Signature
StationaryQualityReturns: Return type: NXOpen.Display.RayTracedStudioBuilderStationaryDisplayQualityTypeNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StationaryQualityParameters: stationaryQuality ( NXOpen.Display.RayTracedStudioBuilderStationaryDisplayQualityType) –New in version NX9.0.0.
License requirements: None.
Method Detail¶
RayTracedEditor¶
-
RayTracedStudioBuilder.RayTracedEditor¶ Launch the Ray Traced Studio Editor command
Signature
RayTracedEditor()New in version NX9.0.0.
License requirements: None.
RayTracedRenderingErase¶
-
RayTracedStudioBuilder.RayTracedRenderingErase¶ Erase Ray Traced Studio static (still) image from the Ray Traced Studio window
Signature
RayTracedRenderingErase()New in version NX9.0.0.
License requirements: None.
RayTracedRenderingSave¶
-
RayTracedStudioBuilder.RayTracedRenderingSave¶ Save a copy of the Ray Traced Studio static (still) image display from the window to an image file
Signature
RayTracedRenderingSave()New in version NX9.0.0.
License requirements: None.
RayTracedRenderingStart¶
-
RayTracedStudioBuilder.RayTracedRenderingStart¶ Start Ray Traced Studio static image rendering
Signature
RayTracedRenderingStart()New in version NX9.0.0.
License requirements: None.
StartRayTracedDisplay¶
-
RayTracedStudioBuilder.StartRayTracedDisplay¶ Start the Ray Traced Studio display after it has been stopped using the Stop action.
Signature
StartRayTracedDisplay()New in version NX9.0.0.
License requirements: None.
StopRayTracedDisplay¶
-
RayTracedStudioBuilder.StopRayTracedDisplay¶ Stop the Ray Traced Studio progressive display.
Use the Start action to re-start the display.
Signature
StopRayTracedDisplay()New in version NX9.0.0.
License requirements: None.
UpdateRayTracedDisplay¶
-
RayTracedStudioBuilder.UpdateRayTracedDisplay¶ Update the Ray Traced Studio display.
Use when geometry has changed to completely regenerate the display.
Signature
UpdateRayTracedDisplay()New in version NX9.0.0.
License requirements: None.
Validate¶
-
RayTracedStudioBuilder.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.