Represents a NXOpen::Display::RayTracedStudioBuilder . More...

Inheritance diagram for NXOpen::Display::RayTracedStudioBuilder:

Public Types
enum	StationaryDisplayQualityType { StationaryDisplayQualityTypeHigh, StationaryDisplayQualityTypeMedium, StationaryDisplayQualityTypeLow }
	To specify the quality and performance of the Ray Traced Studio display. More...

Public Member Functions
double	Brightness ()
	Returns the brightness for Iray Tonemap setting Created in NX10.0.2. More...

void	RayTracedEditor ()
	Launch the Ray Traced Studio Editor command Created in NX9.0.0. More...

void	RayTracedRenderingErase ()
	Erase Ray Traced Studio static (still) image from the Ray Traced Studio window Created in NX9.0.0. More...

void	RayTracedRenderingSave ()
	Save a copy of the Ray Traced Studio static (still) image display from the window to an image file Created in NX9.0.0. More...

void	RayTracedRenderingStart ()
	Start Ray Traced Studio static image rendering Created in NX9.0.0. More...

void	SetBrightness (double brightness)
	Sets the brightness for Iray Tonemap setting Created in NX10.0.2. More...

void	SetStationaryQuality (NXOpen::Display::RayTracedStudioBuilder::StationaryDisplayQualityType stationaryQuality)
	Sets the Ray Traced Studio stationary display quality when dynamic interaction stops Created in NX9.0.0. More...

void	StartRayTracedDisplay ()
	Start the Ray Traced Studio display after it has been stopped using the Stop action. More...

NXOpen::Display::RayTracedStudioBuilder::StationaryDisplayQualityType	StationaryQuality ()
	Returns the Ray Traced Studio stationary display quality when dynamic interaction stops Created in NX9.0.0. More...

void	StopRayTracedDisplay ()
	Stop the Ray Traced Studio progressive display. More...

void	UpdateRayTracedDisplay ()
	Update the Ray Traced Studio display. 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::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 NULL.

To create a new instance of this class, use NXOpen::ViewCollection::CreateRayTracedStudioBuilder

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Display::RayTracedStudioBuilder::StationaryDisplayQualityType

To specify the quality and performance of the Ray Traced Studio display.

In the RTRT stationary mode, when dynamic interaction stops, these are High. Medium, and Low options. In the IRay+ dynamci rendering mode, these become Photoreal, Qualtiy Interactive, and Fast Interactive options.

Enumerator
StationaryDisplayQualityTypeHigh	Very good ray traced display quality (Photoreal for Iray+)
StationaryDisplayQualityTypeMedium	Good ray traced display quality with good performance (Qualtiy Interactive for Iray+)
StationaryDisplayQualityTypeLow	The fastest ray traced display performance with preview quality (Fast Interactive for Iray+)

Member Function Documentation

double NXOpen::Display::RayTracedStudioBuilder::Brightness ( )

Returns the brightness for Iray Tonemap setting
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

void NXOpen::Display::RayTracedStudioBuilder::RayTracedEditor ( )

Launch the Ray Traced Studio Editor command
Created in NX9.0.0.

License requirements : None

void NXOpen::Display::RayTracedStudioBuilder::RayTracedRenderingErase ( )

Erase Ray Traced Studio static (still) image from the Ray Traced Studio window
Created in NX9.0.0.

License requirements : None

void NXOpen::Display::RayTracedStudioBuilder::RayTracedRenderingSave ( )

Save a copy of the Ray Traced Studio static (still) image display from the window to an image file
Created in NX9.0.0.

License requirements : None

void NXOpen::Display::RayTracedStudioBuilder::RayTracedRenderingStart ( )

Start Ray Traced Studio static image rendering
Created in NX9.0.0.

License requirements : None

void NXOpen::Display::RayTracedStudioBuilder::SetBrightness ( double brightness )

Sets the brightness for Iray Tonemap setting
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

brightness brightness

void NXOpen::Display::RayTracedStudioBuilder::SetStationaryQuality ( NXOpen::Display::RayTracedStudioBuilder::StationaryDisplayQualityType stationaryQuality )

Sets the Ray Traced Studio stationary display quality when dynamic interaction stops
Created in NX9.0.0.

License requirements : None

Parameters

stationaryQuality stationaryquality

void NXOpen::Display::RayTracedStudioBuilder::StartRayTracedDisplay ( )

Start the Ray Traced Studio display after it has been stopped using the Stop action.

Created in NX9.0.0.

License requirements : None

NXOpen::Display::RayTracedStudioBuilder::StationaryDisplayQualityType NXOpen::Display::RayTracedStudioBuilder::StationaryQuality ( )

Returns the Ray Traced Studio stationary display quality when dynamic interaction stops
Created in NX9.0.0.

License requirements : None

void NXOpen::Display::RayTracedStudioBuilder::StopRayTracedDisplay ( )

Stop the Ray Traced Studio progressive display.

Use the Start action to re-start the display.
Created in NX9.0.0.

License requirements : None

void NXOpen::Display::RayTracedStudioBuilder::UpdateRayTracedDisplay ( )

Update the Ray Traced Studio display.

Use when geometry has changed to completely regenerate the display.
Created in NX9.0.0.

License requirements : None

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

Display_RayTracedStudioBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation