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

Inheritance diagram for NXOpen::Display::IRayPlusStudioEditorBuilder:

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

enum	IRayPlusStudioRemoteRenderFormatType { IRayPlusStudioRemoteRenderFormatTypeH264, IRayPlusStudioRemoteRenderFormatTypeLossless, IRayPlusStudioRemoteRenderFormatTypePng, IRayPlusStudioRemoteRenderFormatTypeJpeg }
	To specify the Ray Traced Studio remote rendering format. More...

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

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

enum	IRayPlusStudioStaticImageFileFormatType { IRayPlusStudioStaticImageFileFormatTypeTif, IRayPlusStudioStaticImageFileFormatTypePng, IRayPlusStudioStaticImageFileFormatTypeJpg }
	To specify the Ray Traced Studio static image file format. More...

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

enum	IRayPlusStudioStaticImageResolutionType { IRayPlusStudioStaticImageResolutionTypeHigh, IRayPlusStudioStaticImageResolutionTypeMedium, IRayPlusStudioStaticImageResolutionTypeLow, IRayPlusStudioStaticImageResolutionTypeUserDefined }
	To specify the Ray Traced Studio static image resolution. More...

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

enum	IRayPlusStudioStaticImageUnitsType { IRayPlusStudioStaticImageUnitsTypePixels, IRayPlusStudioStaticImageUnitsTypeMillimeters, IRayPlusStudioStaticImageUnitsTypeInches }
	To specify the Ray Traced Studio static image units. More...

Public Member Functions
bool	DynamicIRayPlusCaustics ()
	Returns the Ray Traced Studio dynamic antialiasing quality when dynamic interaction stops Created in NX10.0.2. More...

NXOpen::Display::IRayPlusStudioEditorBuilder::DynamicIRayPlusStudioRenderModeType	DynamicIRayPlusStudioRenderMode ()
	Returns the Ray Traced Studio dynamic display rendering mode Created in NX10.0.2. More...

NXOpen::DateBuilder *	DynamicIRayPlusStudioTime ()
	Returns the Ray Traced Studio dynamic display time-based rendering mode timer (read only) Created in NX10.0.2. More...

bool	IRayPlusStudioshowStatusIndicator ()
	Returns the Ray Traced Studio progess status indicator percent complete display Created in NX10.0.2. More...

int	IRayPlusStudioStaticImageDotsPerInch ()
	Returns the Ray Traced Studio static image dots per inch (DPI) Created in NX10.0.2. More...

double	IRayPlusStudioStaticImageDoubleHeight ()
	Returns the Ray Traced Studio static image height Created in NX10.0.2. More...

double	IRayPlusStudioStaticImageDoubleWidth ()
	Returns the Ray Traced Studio static image width Created in NX10.0.2. More...

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageFileFormatType	IRayPlusStudioStaticImageFileFormat ()
	Returns the Ray Traced Studio static output image file format Created in NX10.0.2. More...

bool	IRayPlusStudioStaticImageLockAspectRatio ()
	Returns the Ray Traced Studio static image aspect ratio will be maintained Created in NX10.0.2. More...

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageOrientationType	IRayPlusStudioStaticImageOrientation ()
	Returns the Ray Traced Studio static image orientation Created in NX10.0.2. More...

int	IRayPlusStudioStaticImagePixelHeight ()
	Returns the Ray Traced Studio static image pixel height Created in NX10.0.2. More...

int	IRayPlusStudioStaticImagePixelWidth ()
	Returns the Ray Traced Studio static image pixel width Created in NX10.0.2. More...

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageResolutionType	IRayPlusStudioStaticImageResolution ()
	Returns the Ray Traced Studio static image resolution Created in NX10.0.2. More...

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageSizeType	IRayPlusStudioStaticImageSize ()
	Returns the Ray Traced Studio static image size Created in NX10.0.2. More...

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageUnitsType	IRayPlusStudioStaticImageUnits ()
	Returns the Ray Traced Studio static image units Created in NX10.0.2. More...

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderFormatType	RemoteRenderFormat ()
	Returns the Ray Traced Studio display remote rendering format Created in NX10.0.2. More...

NXString	RemoteRenderIP ()
	Returns the Ray Traced Studio display remote rendering IP address Created in NX10.0.2. More...

NXString	RemoteRenderSecurityToken ()
	Returns the Ray Traced Studio display remote rendering security token Created in NX10.0.2. More...

bool	RemoteRenderToggle ()
	Returns the Ray Traced Studio display if remote rendering is used Created in NX10.0.2. More...

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderType	RemoteRenderType ()
	Returns the Ray Traced Studio display remote rendering type Created in NX10.0.2. More...

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderVideoType	RemoteRenderVideoMode ()
	Returns the Ray Traced Studio display remote rendering video mode More...

void	SetDynamicIRayPlusCaustics (bool dynamicIRayPlusCaustics)
	Sets the Ray Traced Studio dynamic antialiasing quality when dynamic interaction stops Created in NX10.0.2. More...

void	SetDynamicIRayPlusStudioRenderMode (NXOpen::Display::IRayPlusStudioEditorBuilder::DynamicIRayPlusStudioRenderModeType dynamicIRayPlusStudioRenderMode)
	Sets the Ray Traced Studio dynamic display rendering mode Created in NX10.0.2. More...

void	SetIRayPlusStudioshowStatusIndicator (bool iRayPlusStudioshowStatusIndicator)
	Sets the Ray Traced Studio progess status indicator percent complete display Created in NX10.0.2. More...

void	SetIRayPlusStudioStaticImageDotsPerInch (int iRayPlusStudioStaticImageDotsPerInch)
	Sets the Ray Traced Studio static image dots per inch (DPI) Created in NX10.0.2. More...

void	SetIRayPlusStudioStaticImageDoubleHeight (double iRayPlusStudioStaticImageDoubleHeight)
	Sets the Ray Traced Studio static image height Created in NX10.0.2. More...

void	SetIRayPlusStudioStaticImageDoubleWidth (double iRayPlusStudioStaticImageDoubleWidth)
	Sets the Ray Traced Studio static image width Created in NX10.0.2. More...

void	SetIRayPlusStudioStaticImageFileFormat (NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageFileFormatType iRayPlusStudioStaticImageFileFormat)
	Sets the Ray Traced Studio static output image file format Created in NX10.0.2. More...

void	SetIRayPlusStudioStaticImageLockAspectRatio (bool iRayPlusStudioStaticImageLockAspectRatio)
	Sets the Ray Traced Studio static image aspect ratio will be maintained Created in NX10.0.2. More...

void	SetIRayPlusStudioStaticImageOrientation (NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageOrientationType iRayPlusStudioStaticImageOrientation)
	Sets the Ray Traced Studio static image orientation Created in NX10.0.2. More...

void	SetIRayPlusStudioStaticImagePixelHeight (int iRayPlusStudioStaticImagePixelHeight)
	Sets the Ray Traced Studio static image pixel height Created in NX10.0.2. More...

void	SetIRayPlusStudioStaticImagePixelWidth (int iRayPlusStudioStaticImagePixelWidth)
	Sets the Ray Traced Studio static image pixel width Created in NX10.0.2. More...

void	SetIRayPlusStudioStaticImageResolution (NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageResolutionType iRayPlusStudioStaticImageResolution)
	Sets the Ray Traced Studio static image resolution Created in NX10.0.2. More...

void	SetIRayPlusStudioStaticImageSize (NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageSizeType iRayPlusStudioStaticImageSize)
	Sets the Ray Traced Studio static image size Created in NX10.0.2. More...

void	SetIRayPlusStudioStaticImageUnits (NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageUnitsType iRayPlusStudioStaticImageUnits)
	Sets the Ray Traced Studio static image units Created in NX10.0.2. More...

void	SetRemoteRenderFormat (NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderFormatType remoteRenderFormatType)
	Sets the Ray Traced Studio display remote rendering format Created in NX10.0.2. More...

void	SetRemoteRenderIP (const NXString &remoteRenderIP)
	Sets the Ray Traced Studio display remote rendering IP address Created in NX10.0.2. More...

void	SetRemoteRenderIP (const char *remoteRenderIP)
	Sets the Ray Traced Studio display remote rendering IP address Created in NX10.0.2. More...

void	SetRemoteRenderSecurityToken (const NXString &remoteRenderSecurityToken)
	Sets the Ray Traced Studio display remote rendering security token Created in NX10.0.2. More...

void	SetRemoteRenderSecurityToken (const char *remoteRenderSecurityToken)
	Sets the Ray Traced Studio display remote rendering security token Created in NX10.0.2. More...

void	SetRemoteRenderToggle (bool remoteRenderToggle)
	Sets the Ray Traced Studio display if remote rendering is used Created in NX10.0.2. More...

void	SetRemoteRenderType (NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderType remoteRenderType)
	Sets the Ray Traced Studio display remote rendering type Created in NX10.0.2. More...

void	SetRemoteRenderVideoMode (NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderVideoType remoteRenderVideoType)
	Sets the Ray Traced Studio display remote rendering video mode More...

NXOpen::DateBuilder *	StaticIRayPlusStudioTime ()
	Returns the Ray Traced Studio static display time-based rendering timer (read only) Created in NX10.0.2. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

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

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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 NULL.

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
DynamicIRayPlusStudioRenderModeTypePhotoreal	Very good ray traced display quality when dynamic interaction stops.
DynamicIRayPlusStudioRenderModeTypeQualityInteractive	Good ray traced display quality with good performance when dynamic interaction stops.
DynamicIRayPlusStudioRenderModeTypeFastInteractive	The fastest ray traced display performance with preview quality when dynamic interaction stops.

enum NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderFormatType

To specify the Ray Traced Studio remote rendering format.

Enumerator
IRayPlusStudioRemoteRenderFormatTypeH264	h264
IRayPlusStudioRemoteRenderFormatTypeLossless	lossless
IRayPlusStudioRemoteRenderFormatTypePng	png
IRayPlusStudioRemoteRenderFormatTypeJpeg	jpeg

enum NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderType

To specify the Ray Traced Studio remote rendering type.

Enumerator
IRayPlusStudioRemoteRenderTypeCluster	Network Cluster.
IRayPlusStudioRemoteRenderTypeVca	VCA.

enum NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderVideoType

To specify the Ray Traced Studio remote rendering video mode

Deprecated:: Deprecated in NX12.0.0.

This is removed. The video mode is determined by the Ray Traced Studio render mode.

Enumerator
IRayPlusStudioRemoteRenderVideoTypeStreaming	streaming
IRayPlusStudioRemoteRenderVideoTypeSynchronous	synchronous

enum NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageFileFormatType

To specify the Ray Traced Studio static image file format.

Enumerator
IRayPlusStudioStaticImageFileFormatTypeTif	Tagged Image File Format (TIFF) file format.
IRayPlusStudioStaticImageFileFormatTypePng	Portable Network Graphic (PNG) file format.
IRayPlusStudioStaticImageFileFormatTypeJpg	Joint Photographic Experts Group (JPEG) file format.

enum NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageOrientationType

To specify the Ray Traced Studio static image orientation.

Enumerator
IRayPlusStudioStaticImageOrientationTypeLandscape	static image orientation where width is greater than height
IRayPlusStudioStaticImageOrientationTypePortrait	static image orientation where height is greater than width

enum NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageResolutionType

To specify the Ray Traced Studio static image resolution.

Enumerator
IRayPlusStudioStaticImageResolutionTypeHigh	static image output resolution of 300 DPI (dots per inch)
IRayPlusStudioStaticImageResolutionTypeMedium	static image output resolution of 150 DPI (dots per inch)
IRayPlusStudioStaticImageResolutionTypeLow	static image output resolution of 72 DPI (dots per inch)
IRayPlusStudioStaticImageResolutionTypeUserDefined	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
IRayPlusStudioStaticImageSizeTypeRenderWindow	Ray Traced Studio window size used for static image output.
IRayPlusStudioStaticImageSizeTypeUserDefined	user specified size for static image output

enum NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageUnitsType

To specify the Ray Traced Studio static image units.

Enumerator
IRayPlusStudioStaticImageUnitsTypePixels	static image size specified in pixel
IRayPlusStudioStaticImageUnitsTypeMillimeters	static image size specified in millimeters
IRayPlusStudioStaticImageUnitsTypeInches	static image size specified in inches

Member Function Documentation

bool NXOpen::Display::IRayPlusStudioEditorBuilder::DynamicIRayPlusCaustics ( )

Returns the Ray Traced Studio dynamic antialiasing quality when dynamic interaction stops
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::IRayPlusStudioEditorBuilder::DynamicIRayPlusStudioRenderModeType NXOpen::Display::IRayPlusStudioEditorBuilder::DynamicIRayPlusStudioRenderMode ( )

Returns the Ray Traced Studio dynamic display rendering mode
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::DateBuilder* NXOpen::Display::IRayPlusStudioEditorBuilder::DynamicIRayPlusStudioTime ( )

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")

bool NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioshowStatusIndicator ( )

Returns the Ray Traced Studio progess status indicator percent complete display
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

int NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageDotsPerInch ( )

Returns the Ray Traced Studio static image dots per inch (DPI)
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

double NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageDoubleHeight ( )

Returns the Ray Traced Studio static image height
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

double NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageDoubleWidth ( )

Returns the Ray Traced Studio static image width
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageFileFormatType NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageFileFormat ( )

Returns the Ray Traced Studio static output image file format
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

bool NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageLockAspectRatio ( )

Returns the Ray Traced Studio static image aspect ratio will be maintained
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageOrientationType NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageOrientation ( )

Returns the Ray Traced Studio static image orientation
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

int NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImagePixelHeight ( )

Returns the Ray Traced Studio static image pixel height
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

int NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImagePixelWidth ( )

Returns the Ray Traced Studio static image pixel width
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageResolutionType NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageResolution ( )

Returns the Ray Traced Studio static image resolution
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageSizeType NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageSize ( )

Returns the Ray Traced Studio static image size
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageUnitsType NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageUnits ( )

Returns the Ray Traced Studio static image units
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderFormatType NXOpen::Display::IRayPlusStudioEditorBuilder::RemoteRenderFormat ( )

Returns the Ray Traced Studio display remote rendering format
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXString NXOpen::Display::IRayPlusStudioEditorBuilder::RemoteRenderIP ( )

Returns the Ray Traced Studio display remote rendering IP address
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXString NXOpen::Display::IRayPlusStudioEditorBuilder::RemoteRenderSecurityToken ( )

Returns the Ray Traced Studio display remote rendering security token
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

bool NXOpen::Display::IRayPlusStudioEditorBuilder::RemoteRenderToggle ( )

Returns the Ray Traced Studio display if remote rendering is used
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderType NXOpen::Display::IRayPlusStudioEditorBuilder::RemoteRenderType ( )

Returns the Ray Traced Studio display remote rendering type
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderVideoType NXOpen::Display::IRayPlusStudioEditorBuilder::RemoteRenderVideoMode ( )

Returns the Ray Traced Studio display remote rendering video mode

Deprecated:: Deprecated in NX12.0.0.

This is removed. The video mode is determined by the Ray Traced Studio render mode.

Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetDynamicIRayPlusCaustics ( bool dynamicIRayPlusCaustics )

Sets the Ray Traced Studio dynamic antialiasing quality when dynamic interaction stops
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

dynamicIRayPlusCaustics dynamiciraypluscaustics

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetDynamicIRayPlusStudioRenderMode ( NXOpen::Display::IRayPlusStudioEditorBuilder::DynamicIRayPlusStudioRenderModeType dynamicIRayPlusStudioRenderMode )

Sets the Ray Traced Studio dynamic display rendering mode
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

dynamicIRayPlusStudioRenderMode dynamicirayplusstudiorendermode

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetIRayPlusStudioshowStatusIndicator ( bool iRayPlusStudioshowStatusIndicator )

Sets the Ray Traced Studio progess status indicator percent complete display
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

iRayPlusStudioshowStatusIndicator irayplusstudioshowstatusindicator

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetIRayPlusStudioStaticImageDotsPerInch ( int iRayPlusStudioStaticImageDotsPerInch )

Sets the Ray Traced Studio static image dots per inch (DPI)
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

iRayPlusStudioStaticImageDotsPerInch irayplusstudiostaticimagedotsperinch

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetIRayPlusStudioStaticImageDoubleHeight ( double iRayPlusStudioStaticImageDoubleHeight )

Sets the Ray Traced Studio static image height
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

iRayPlusStudioStaticImageDoubleHeight irayplusstudiostaticimagedoubleheight

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetIRayPlusStudioStaticImageDoubleWidth ( double iRayPlusStudioStaticImageDoubleWidth )

Sets the Ray Traced Studio static image width
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

iRayPlusStudioStaticImageDoubleWidth irayplusstudiostaticimagedoublewidth

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetIRayPlusStudioStaticImageFileFormat ( NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageFileFormatType iRayPlusStudioStaticImageFileFormat )

Sets the Ray Traced Studio static output image file format
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

iRayPlusStudioStaticImageFileFormat irayplusstudiostaticimagefileformat

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetIRayPlusStudioStaticImageLockAspectRatio ( bool iRayPlusStudioStaticImageLockAspectRatio )

Sets the Ray Traced Studio static image aspect ratio will be maintained
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

iRayPlusStudioStaticImageLockAspectRatio irayplusstudiostaticimagelockaspectratio

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetIRayPlusStudioStaticImageOrientation ( NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageOrientationType iRayPlusStudioStaticImageOrientation )

Sets the Ray Traced Studio static image orientation
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

iRayPlusStudioStaticImageOrientation irayplusstudiostaticimageorientation

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetIRayPlusStudioStaticImagePixelHeight ( int iRayPlusStudioStaticImagePixelHeight )

Sets the Ray Traced Studio static image pixel height
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

iRayPlusStudioStaticImagePixelHeight irayplusstudiostaticimagepixelheight

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetIRayPlusStudioStaticImagePixelWidth ( int iRayPlusStudioStaticImagePixelWidth )

Sets the Ray Traced Studio static image pixel width
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

iRayPlusStudioStaticImagePixelWidth irayplusstudiostaticimagepixelwidth

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetIRayPlusStudioStaticImageResolution ( NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageResolutionType iRayPlusStudioStaticImageResolution )

Sets the Ray Traced Studio static image resolution
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

iRayPlusStudioStaticImageResolution irayplusstudiostaticimageresolution

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetIRayPlusStudioStaticImageSize ( NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageSizeType iRayPlusStudioStaticImageSize )

Sets the Ray Traced Studio static image size
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

iRayPlusStudioStaticImageSize irayplusstudiostaticimagesize

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetIRayPlusStudioStaticImageUnits ( NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioStaticImageUnitsType iRayPlusStudioStaticImageUnits )

Sets the Ray Traced Studio static image units
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

iRayPlusStudioStaticImageUnits irayplusstudiostaticimageunits

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetRemoteRenderFormat ( NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderFormatType remoteRenderFormatType )

Sets the Ray Traced Studio display remote rendering format
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

remoteRenderFormatType remoterenderformattype

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetRemoteRenderIP ( const NXString & remoteRenderIP )

Sets the Ray Traced Studio display remote rendering IP address
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

remoteRenderIP remoterenderip

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetRemoteRenderIP ( const char * remoteRenderIP )

Sets the Ray Traced Studio display remote rendering IP address
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

remoteRenderIP remoterenderip

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetRemoteRenderSecurityToken ( const NXString & remoteRenderSecurityToken )

Sets the Ray Traced Studio display remote rendering security token
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

remoteRenderSecurityToken remoterendersecuritytoken

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetRemoteRenderSecurityToken ( const char * remoteRenderSecurityToken )

Sets the Ray Traced Studio display remote rendering security token
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

remoteRenderSecurityToken remoterendersecuritytoken

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetRemoteRenderToggle ( bool remoteRenderToggle )

Sets the Ray Traced Studio display if remote rendering is used
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

remoteRenderToggle remoterendertoggle

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetRemoteRenderType ( NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderType remoteRenderType )

Sets the Ray Traced Studio display remote rendering type
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

remoteRenderType remoterendertype

void NXOpen::Display::IRayPlusStudioEditorBuilder::SetRemoteRenderVideoMode ( NXOpen::Display::IRayPlusStudioEditorBuilder::IRayPlusStudioRemoteRenderVideoType remoteRenderVideoType )

Sets the Ray Traced Studio display remote rendering video mode

Deprecated:: Deprecated in NX12.0.0.

This is removed. The video mode is determined by the Ray Traced Studio render mode.

Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

remoteRenderVideoType remoterendervideotype

NXOpen::DateBuilder* NXOpen::Display::IRayPlusStudioEditorBuilder::StaticIRayPlusStudioTime ( )

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")

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

Display_IRayPlusStudioEditorBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation