Represents a NXOpen.Display.IRayPlusStudioEditorBuilder . More...

Inheritance diagram for NXOpen.Display.IRayPlusStudioEditorBuilder:

Public Types
enum	DynamicIRayPlusStudioRenderModeType { Photoreal, QualityInteractive, FastInteractive }
	To specify the quality and performance of the Ray Traced Studio display when dynamic interaction stops More...

enum	IRayPlusStudioLensType { Monospherical, Stereospherical }
	To specify the Ray Traced Studio lens distortion type More...

enum	IRayPlusStudioRemoteRenderFormatType { H264, Lossless, Png, Jpeg }
	To specify the Ray Traced Studio remote rendering format More...

enum	IRayPlusStudioRemoteRenderType { Cluster, Vca }
	To specify the Ray Traced Studio remote rendering type More...

enum	IRayPlusStudioRemoteRenderVideoType { Streaming, Synchronous }
	To specify the Ray Traced Studio remote rendering video mode More...

enum	IRayPlusStudioStaticImageFileFormatType { Tif, Png, Jpg }
	To specify the Ray Traced Studio static image file format More...

enum	IRayPlusStudioStaticImageOrientationType { Landscape, Portrait }
	To specify the Ray Traced Studio static image orientation More...

enum	IRayPlusStudioStaticImageResolutionType { High, Medium, Low, UserDefined }
	To specify the Ray Traced Studio static image resolution More...

enum	IRayPlusStudioStaticImageSizeType { RenderWindow, UserDefined }
	To specify the Ray Traced Studio static image size More...

enum	IRayPlusStudioStaticImageUnitsType { Pixels, Millimeters, Inches }
	To specify the Ray Traced Studio static image units More...

enum	IRayPlusStudioStereoLayoutType { TopBottom, SideBySide }
	To specify the Ray Traced Studio stereo layout More...

Properties
unsafe bool	DynamicIRayPlusCaustics `[get, set]`
	Returns or sets the Ray Traced Studio dynamic antialiasing quality when dynamic interaction stops More...

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.DynamicIRayPlusStudioRenderModeType	DynamicIRayPlusStudioRenderMode `[get, set]`
	Returns or sets the Ray Traced Studio dynamic display rendering mode More...

unsafe NXOpen.DateBuilder	DynamicIRayPlusStudioTime `[get]`
	Returns the Ray Traced Studio dynamic display time-based rendering mode timer (read only) More...

unsafe double	EyeSeparation `[get, set]`
	Returns or sets the Ray Traced Studio display eye separation distance to use if rendering a stereo image More...

unsafe bool	IRayPlusStudioshowStatusIndicator `[get, set]`
	Returns or sets the Ray Traced Studio progess status indicator percent complete display More...

unsafe int	IRayPlusStudioStaticImageDotsPerInch `[get, set]`
	Returns or sets the Ray Traced Studio static image dots per inch (DPI) More...

unsafe double	IRayPlusStudioStaticImageDoubleHeight `[get, set]`
	Returns or sets the Ray Traced Studio static image height More...

unsafe double	IRayPlusStudioStaticImageDoubleWidth `[get, set]`
	Returns or sets the Ray Traced Studio static image width More...

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageFileFormatType	IRayPlusStudioStaticImageFileFormat `[get, set]`
	Returns or sets the Ray Traced Studio static output image file format More...

unsafe bool	IRayPlusStudioStaticImageLockAspectRatio `[get, set]`
	Returns or sets the Ray Traced Studio static image aspect ratio will be maintained More...

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageOrientationType	IRayPlusStudioStaticImageOrientation `[get, set]`
	Returns or sets the Ray Traced Studio static image orientation More...

unsafe int	IRayPlusStudioStaticImagePixelHeight `[get, set]`
	Returns or sets the Ray Traced Studio static image pixel height More...

unsafe int	IRayPlusStudioStaticImagePixelWidth `[get, set]`
	Returns or sets the Ray Traced Studio static image pixel width More...

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageResolutionType	IRayPlusStudioStaticImageResolution `[get, set]`
	Returns or sets the Ray Traced Studio static image resolution More...

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageSizeType	IRayPlusStudioStaticImageSize `[get, set]`
	Returns or sets the Ray Traced Studio static image size More...

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageUnitsType	IRayPlusStudioStaticImageUnits `[get, set]`
	Returns or sets the Ray Traced Studio static image units More...

unsafe int	IRayPlusStudioStaticImageVrHeight `[get, set]`
	Returns or sets the Ray Traced Studio static image height when rendering a VR-ready image More...

unsafe int	IRayPlusStudioStaticImageVrWidth `[get, set]`
	Returns or sets the Ray Traced Studio static image width when rendering a VR-ready image More...

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioLensType	LensType `[get, set]`
	Returns or sets the Ray Traced Studio display lens distortion type to use if rendering a VR-ready image More...

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioRemoteRenderFormatType	RemoteRenderFormat `[get, set]`
	Returns or sets the Ray Traced Studio display remote rendering format More...

unsafe string	RemoteRenderIP `[get, set]`
	Returns or sets the Ray Traced Studio display remote rendering IP address More...

unsafe string	RemoteRenderSecurityToken `[get, set]`
	Returns or sets the Ray Traced Studio display remote rendering security token More...

unsafe bool	RemoteRenderToggle `[get, set]`
	Returns or sets the Ray Traced Studio display if remote rendering is used More...

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioRemoteRenderType	RemoteRenderType `[get, set]`
	Returns or sets the Ray Traced Studio display remote rendering type More...

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioRemoteRenderVideoType	RemoteRenderVideoMode `[get, set]`
	Returns or sets the Ray Traced Studio display remote rendering video mode More...

unsafe NXOpen.DateBuilder	StaticIRayPlusStudioTime `[get]`
	Returns the Ray Traced Studio static display time-based rendering timer (read only) More...

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStereoLayoutType	StereoLayout `[get, set]`
	Returns or sets the Ray Traced Studio display image layout to use if rendering a stereo image More...

unsafe NXOpen.CartesianCoordinateSystem	VrCamera `[get, set]`
	Returns or sets the Ray Traced Studio display VR camera coordinate system More...

unsafe bool	VrEnabledToggle `[get, set]`
	Returns or sets the Ray Traced Studio display if the image will be rendered in a VR-ready format More...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...

unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

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 a null reference (Nothing in Visual Basic).

To create a new instance of this class, use NXOpen.ViewCollection.CreateIrayPlusStudioEditorBuilder

Created in NX10.0.2

Member Enumeration Documentation

enum NXOpen.Display.IRayPlusStudioEditorBuilder.DynamicIRayPlusStudioRenderModeType

To specify the quality and performance of the Ray Traced Studio display when dynamic interaction stops

Enumerator
Photoreal	Very good ray traced display quality when dynamic interaction stops
QualityInteractive	Good ray traced display quality with good performance when dynamic interaction stops
FastInteractive	The fastest ray traced display performance with preview quality when dynamic interaction stops

enum NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioLensType

To specify the Ray Traced Studio lens distortion type

Enumerator
Monospherical	Mono Spherical
Stereospherical	Stereo Spherical

enum NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioRemoteRenderFormatType

To specify the Ray Traced Studio remote rendering format

Enumerator
H264
Lossless
Png
Jpeg

enum NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioRemoteRenderType

To specify the Ray Traced Studio remote rendering type

Enumerator
Cluster	Network Cluster
Vca	VCA

enum NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioRemoteRenderVideoType

To specify the Ray Traced Studio remote rendering video mode

Enumerator
Streaming
Synchronous

enum NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageFileFormatType

To specify the Ray Traced Studio static image file format

Enumerator
Tif	Tagged Image File Format (TIFF) file format
Png	Portable Network Graphic (PNG) file format
Jpg	Joint Photographic Experts Group (JPEG) file format

enum NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageOrientationType

To specify the Ray Traced Studio static image orientation

Enumerator
Landscape	static image orientation where width is greater than height
Portrait	static image orientation where height is greater than width

enum NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageResolutionType

To specify the Ray Traced Studio static image resolution

Enumerator
High	static image output resolution of 300 DPI (dots per inch)
Medium	static image output resolution of 150 DPI (dots per inch)
Low	static image output resolution of 72 DPI (dots per inch)
UserDefined	user specified image output resolution in DPI (dots per inch)

enum NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageSizeType

To specify the Ray Traced Studio static image size

Enumerator
RenderWindow	Ray Traced Studio window size used for static image output
UserDefined	user specified size for static image output

enum NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageUnitsType

To specify the Ray Traced Studio static image units

Enumerator
Pixels	static image size specified in pixel
Millimeters	static image size specified in millimeters
Inches	static image size specified in inches

enum NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStereoLayoutType

To specify the Ray Traced Studio stereo layout

Enumerator
TopBottom	Top-Bottom
SideBySide	Side-by-Side

Property Documentation

unsafe bool NXOpen.Display.IRayPlusStudioEditorBuilder.DynamicIRayPlusCaustics

getset

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

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.DynamicIRayPlusStudioRenderModeType NXOpen.Display.IRayPlusStudioEditorBuilder.DynamicIRayPlusStudioRenderMode

getset

Returns or sets the Ray Traced Studio dynamic display rendering mode

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.DateBuilder NXOpen.Display.IRayPlusStudioEditorBuilder.DynamicIRayPlusStudioTime

get

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

Created in NX10.0.2

License requirements: studio_render ("UG STUDIO RENDER")

unsafe double NXOpen.Display.IRayPlusStudioEditorBuilder.EyeSeparation

getset

Returns or sets the Ray Traced Studio display eye separation distance to use if rendering a stereo image

Created in NX12.0.1

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe bool NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioshowStatusIndicator

getset

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

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe int NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageDotsPerInch

getset

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

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe double NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageDoubleHeight

getset

Returns or sets the Ray Traced Studio static image height

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe double NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageDoubleWidth

getset

Returns or sets the Ray Traced Studio static image width

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageFileFormatType NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageFileFormat

getset

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

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe bool NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageLockAspectRatio

getset

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

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageOrientationType NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageOrientation

getset

Returns or sets the Ray Traced Studio static image orientation

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe int NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImagePixelHeight

getset

Returns or sets the Ray Traced Studio static image pixel height

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe int NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImagePixelWidth

getset

Returns or sets the Ray Traced Studio static image pixel width

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageResolutionType NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageResolution

getset

Returns or sets the Ray Traced Studio static image resolution

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageSizeType NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageSize

getset

Returns or sets the Ray Traced Studio static image size

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageUnitsType NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageUnits

getset

Returns or sets the Ray Traced Studio static image units

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe int NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageVrHeight

getset

Returns or sets the Ray Traced Studio static image height when rendering a VR-ready image

Created in NX12.0.1

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe int NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStaticImageVrWidth

getset

Returns or sets the Ray Traced Studio static image width when rendering a VR-ready image

Created in NX12.0.1

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioLensType NXOpen.Display.IRayPlusStudioEditorBuilder.LensType

getset

Returns or sets the Ray Traced Studio display lens distortion type to use if rendering a VR-ready image

Created in NX12.0.1

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioRemoteRenderFormatType NXOpen.Display.IRayPlusStudioEditorBuilder.RemoteRenderFormat

getset

Returns or sets the Ray Traced Studio display remote rendering format

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe string NXOpen.Display.IRayPlusStudioEditorBuilder.RemoteRenderIP

getset

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

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe string NXOpen.Display.IRayPlusStudioEditorBuilder.RemoteRenderSecurityToken

getset

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

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe bool NXOpen.Display.IRayPlusStudioEditorBuilder.RemoteRenderToggle

getset

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

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioRemoteRenderType NXOpen.Display.IRayPlusStudioEditorBuilder.RemoteRenderType

getset

Returns or sets the Ray Traced Studio display remote rendering type

Created in NX10.0.2

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioRemoteRenderVideoType NXOpen.Display.IRayPlusStudioEditorBuilder.RemoteRenderVideoMode

getset

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

Created in NX10.0.2

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

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.DateBuilder NXOpen.Display.IRayPlusStudioEditorBuilder.StaticIRayPlusStudioTime

get

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

Created in NX10.0.2

License requirements: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.Display.IRayPlusStudioEditorBuilder.IRayPlusStudioStereoLayoutType NXOpen.Display.IRayPlusStudioEditorBuilder.StereoLayout

getset

Returns or sets the Ray Traced Studio display image layout to use if rendering a stereo image

Created in NX12.0.1

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.CartesianCoordinateSystem NXOpen.Display.IRayPlusStudioEditorBuilder.VrCamera

getset

Returns or sets the Ray Traced Studio display VR camera coordinate system

Created in NX12.0.1

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

unsafe bool NXOpen.Display.IRayPlusStudioEditorBuilder.VrEnabledToggle

getset

Returns or sets the Ray Traced Studio display if the image will be rendered in a VR-ready format

Created in NX12.0.1

License requirements to get this property: studio_render ("UG STUDIO RENDER")

License requirements to set this property: studio_render ("UG STUDIO RENDER")

The documentation for this class was generated from the following file:

Display_IRayPlusStudioEditorBuilder.cs

Public Types

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Property Documentation