IRayPlusStudioEditorBuilder Class

class NXOpen.Display.IRayPlusStudioEditorBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Display.IRayPlusStudioEditorBuilder.

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.CreateIrayPlusStudioEditorBuilder()

New in version NX10.0.2.

Properties

Property	Description
DynamicIRayPlusCaustics	Returns or sets the Ray Traced Studio dynamic antialiasing quality when dynamic interaction stops
DynamicIRayPlusStudioRenderMode	Returns or sets the Ray Traced Studio dynamic display rendering mode
DynamicIRayPlusStudioTime	Returns the Ray Traced Studio dynamic display time-based rendering mode timer (read only)
IRayPlusStudioStaticImageDotsPerInch	Returns or sets the Ray Traced Studio static image dots per inch (DPI)
IRayPlusStudioStaticImageDoubleHeight	Returns or sets the Ray Traced Studio static image height
IRayPlusStudioStaticImageDoubleWidth	Returns or sets the Ray Traced Studio static image width
IRayPlusStudioStaticImageFileFormat	Returns or sets the Ray Traced Studio static output image file format
IRayPlusStudioStaticImageLockAspectRatio	Returns or sets the Ray Traced Studio static image aspect ratio will be maintained
IRayPlusStudioStaticImageOrientation	Returns or sets the Ray Traced Studio static image orientation
IRayPlusStudioStaticImagePixelHeight	Returns or sets the Ray Traced Studio static image pixel height
IRayPlusStudioStaticImagePixelWidth	Returns or sets the Ray Traced Studio static image pixel width
IRayPlusStudioStaticImageResolution	Returns or sets the Ray Traced Studio static image resolution
IRayPlusStudioStaticImageSize	Returns or sets the Ray Traced Studio static image size
IRayPlusStudioStaticImageUnits	Returns or sets the Ray Traced Studio static image units
IRayPlusStudioshowStatusIndicator	Returns or sets the Ray Traced Studio progess status indicator percent complete display
RemoteRenderFormat	Returns or sets the Ray Traced Studio display remote rendering format
RemoteRenderIP	Returns or sets the Ray Traced Studio display remote rendering IP address
RemoteRenderSecurityToken	Returns or sets the Ray Traced Studio display remote rendering security token
RemoteRenderToggle	Returns or sets the Ray Traced Studio display if remote rendering is used
RemoteRenderType	Returns or sets the Ray Traced Studio display remote rendering type
RemoteRenderVideoMode	Returns or sets the Ray Traced Studio display remote rendering video mode
StaticIRayPlusStudioTime	Returns the Ray Traced Studio static display time-based rendering timer (read only)
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

IRayPlusStudioEditorBuilderDynamicIRayPlusStudioRenderModeType Enumeration	To specify the quality and performance of the Ray Traced Studio display when dynamic interaction stops
IRayPlusStudioEditorBuilderIRayPlusStudioRemoteRenderFormatType Enumeration	To specify the Ray Traced Studio remote rendering format
IRayPlusStudioEditorBuilderIRayPlusStudioRemoteRenderType Enumeration	To specify the Ray Traced Studio remote rendering type
IRayPlusStudioEditorBuilderIRayPlusStudioRemoteRenderVideoType Enumeration	To specify the Ray Traced Studio remote rendering video mode
IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageFileFormatType Enumeration	To specify the Ray Traced Studio static image file format
IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageOrientationType Enumeration	To specify the Ray Traced Studio static image orientation
IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageResolutionType Enumeration	To specify the Ray Traced Studio static image resolution
IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageSizeType Enumeration	To specify the Ray Traced Studio static image size
IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageUnitsType Enumeration	To specify the Ray Traced Studio static image units

Property Detail

DynamicIRayPlusCaustics

IRayPlusStudioEditorBuilder.DynamicIRayPlusCaustics

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

-------------------------------------

Getter Method

Signature DynamicIRayPlusCaustics

Returns: Return type:bool

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature DynamicIRayPlusCaustics

Parameters:dynamicIRayPlusCaustics (bool) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

DynamicIRayPlusStudioRenderMode

IRayPlusStudioEditorBuilder.DynamicIRayPlusStudioRenderMode

Returns or sets the Ray Traced Studio dynamic display rendering mode

-------------------------------------

Getter Method

Signature DynamicIRayPlusStudioRenderMode

Returns: Return type:NXOpen.Display.IRayPlusStudioEditorBuilderDynamicIRayPlusStudioRenderModeType

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature DynamicIRayPlusStudioRenderMode

Parameters:dynamicIRayPlusStudioRenderMode (NXOpen.Display.IRayPlusStudioEditorBuilderDynamicIRayPlusStudioRenderModeType) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

DynamicIRayPlusStudioTime

IRayPlusStudioEditorBuilder.DynamicIRayPlusStudioTime

Returns the Ray Traced Studio dynamic display time-based rendering mode timer (read only)

-------------------------------------

Getter Method

Signature DynamicIRayPlusStudioTime

Returns: Return type:NXOpen.DateBuilder

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

IRayPlusStudioStaticImageDotsPerInch

IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageDotsPerInch

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

-------------------------------------

Getter Method

Signature IRayPlusStudioStaticImageDotsPerInch

Returns: Return type:int

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature IRayPlusStudioStaticImageDotsPerInch

Parameters:iRayPlusStudioStaticImageDotsPerInch (int) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

IRayPlusStudioStaticImageDoubleHeight

IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageDoubleHeight

Returns or sets the Ray Traced Studio static image height

-------------------------------------

Getter Method

Signature IRayPlusStudioStaticImageDoubleHeight

Returns: Return type:float

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature IRayPlusStudioStaticImageDoubleHeight

Parameters:iRayPlusStudioStaticImageDoubleHeight (float) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

IRayPlusStudioStaticImageDoubleWidth

IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageDoubleWidth

Returns or sets the Ray Traced Studio static image width

-------------------------------------

Getter Method

Signature IRayPlusStudioStaticImageDoubleWidth

Returns: Return type:float

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature IRayPlusStudioStaticImageDoubleWidth

Parameters:iRayPlusStudioStaticImageDoubleWidth (float) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

IRayPlusStudioStaticImageFileFormat

IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageFileFormat

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

-------------------------------------

Getter Method

Signature IRayPlusStudioStaticImageFileFormat

Returns: Return type:NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageFileFormatType

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature IRayPlusStudioStaticImageFileFormat

Parameters:iRayPlusStudioStaticImageFileFormat (NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageFileFormatType) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

IRayPlusStudioStaticImageLockAspectRatio

IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageLockAspectRatio

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

-------------------------------------

Getter Method

Signature IRayPlusStudioStaticImageLockAspectRatio

Returns: Return type:bool

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature IRayPlusStudioStaticImageLockAspectRatio

Parameters:iRayPlusStudioStaticImageLockAspectRatio (bool) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

IRayPlusStudioStaticImageOrientation

IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageOrientation

Returns or sets the Ray Traced Studio static image orientation

-------------------------------------

Getter Method

Signature IRayPlusStudioStaticImageOrientation

Returns: Return type:NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageOrientationType

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature IRayPlusStudioStaticImageOrientation

Parameters:iRayPlusStudioStaticImageOrientation (NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageOrientationType) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

IRayPlusStudioStaticImagePixelHeight

IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImagePixelHeight

Returns or sets the Ray Traced Studio static image pixel height

-------------------------------------

Getter Method

Signature IRayPlusStudioStaticImagePixelHeight

Returns: Return type:int

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature IRayPlusStudioStaticImagePixelHeight

Parameters:iRayPlusStudioStaticImagePixelHeight (int) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

IRayPlusStudioStaticImagePixelWidth

IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImagePixelWidth

Returns or sets the Ray Traced Studio static image pixel width

-------------------------------------

Getter Method

Signature IRayPlusStudioStaticImagePixelWidth

Returns: Return type:int

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature IRayPlusStudioStaticImagePixelWidth

Parameters:iRayPlusStudioStaticImagePixelWidth (int) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

IRayPlusStudioStaticImageResolution

IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageResolution

Returns or sets the Ray Traced Studio static image resolution

-------------------------------------

Getter Method

Signature IRayPlusStudioStaticImageResolution

Returns: Return type:NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageResolutionType

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature IRayPlusStudioStaticImageResolution

Parameters:iRayPlusStudioStaticImageResolution (NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageResolutionType) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

IRayPlusStudioStaticImageSize

IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageSize

Returns or sets the Ray Traced Studio static image size

-------------------------------------

Getter Method

Signature IRayPlusStudioStaticImageSize

Returns: Return type:NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageSizeType

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature IRayPlusStudioStaticImageSize

Parameters:iRayPlusStudioStaticImageSize (NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageSizeType) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

IRayPlusStudioStaticImageUnits

IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageUnits

Returns or sets the Ray Traced Studio static image units

-------------------------------------

Getter Method

Signature IRayPlusStudioStaticImageUnits

Returns: Return type:NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageUnitsType

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature IRayPlusStudioStaticImageUnits

Parameters:iRayPlusStudioStaticImageUnits (NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageUnitsType) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

IRayPlusStudioshowStatusIndicator

IRayPlusStudioEditorBuilder.IRayPlusStudioshowStatusIndicator

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

-------------------------------------

Getter Method

Signature IRayPlusStudioshowStatusIndicator

Returns: Return type:bool

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature IRayPlusStudioshowStatusIndicator

Parameters:iRayPlusStudioshowStatusIndicator (bool) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

RemoteRenderFormat

IRayPlusStudioEditorBuilder.RemoteRenderFormat

Returns or sets the Ray Traced Studio display remote rendering format

-------------------------------------

Getter Method

Signature RemoteRenderFormat

Returns: Return type:NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioRemoteRenderFormatType

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature RemoteRenderFormat

Parameters:remoteRenderFormatType (NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioRemoteRenderFormatType) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

RemoteRenderIP

IRayPlusStudioEditorBuilder.RemoteRenderIP

Returns or sets the Ray Traced Studio display remote rendering IP address

-------------------------------------

Getter Method

Signature RemoteRenderIP

Returns: Return type:str

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature RemoteRenderIP

Parameters:remoteRenderIP (str) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

RemoteRenderSecurityToken

IRayPlusStudioEditorBuilder.RemoteRenderSecurityToken

Returns or sets the Ray Traced Studio display remote rendering security token

-------------------------------------

Getter Method

Signature RemoteRenderSecurityToken

Returns: Return type:str

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature RemoteRenderSecurityToken

Parameters:remoteRenderSecurityToken (str) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

RemoteRenderToggle

IRayPlusStudioEditorBuilder.RemoteRenderToggle

Returns or sets the Ray Traced Studio display if remote rendering is used

-------------------------------------

Getter Method

Signature RemoteRenderToggle

Returns: Return type:bool

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature RemoteRenderToggle

Parameters:remoteRenderToggle (bool) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

RemoteRenderType

IRayPlusStudioEditorBuilder.RemoteRenderType

Returns or sets the Ray Traced Studio display remote rendering type

-------------------------------------

Getter Method

Signature RemoteRenderType

Returns: Return type:NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioRemoteRenderType

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature RemoteRenderType

Parameters:remoteRenderType (NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioRemoteRenderType) –

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

RemoteRenderVideoMode

IRayPlusStudioEditorBuilder.RemoteRenderVideoMode

Returns or sets the Ray Traced Studio display remote rendering video mode

-------------------------------------

Getter Method

Signature RemoteRenderVideoMode

Returns: Return type:NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioRemoteRenderVideoType

New in version NX10.0.2.

Deprecated since version NX12.0.0: This is removed. The video mode is determined by the Ray Traced Studio render mode.

License requirements: studio_render (“UG STUDIO RENDER”)

-------------------------------------

Setter Method

Signature RemoteRenderVideoMode

Parameters:remoteRenderVideoType (NXOpen.Display.IRayPlusStudioEditorBuilderIRayPlusStudioRemoteRenderVideoType) –

New in version NX10.0.2.

Deprecated since version NX12.0.0: This is removed. The video mode is determined by the Ray Traced Studio render mode.

License requirements: studio_render (“UG STUDIO RENDER”)

StaticIRayPlusStudioTime

IRayPlusStudioEditorBuilder.StaticIRayPlusStudioTime

Returns the Ray Traced Studio static display time-based rendering timer (read only)

-------------------------------------

Getter Method

Signature StaticIRayPlusStudioTime

Returns: Return type:NXOpen.DateBuilder

New in version NX10.0.2.

License requirements: studio_render (“UG STUDIO RENDER”)

Method Detail

Validate

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