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

Inheritance diagram for NXOpen.Display.RayTracedStudioBuilder:

Public Types
enum	StationaryDisplayQualityType { High, Medium, Low }
	To specify the quality and performance of the Ray Traced Studio display. More...

Public Member Functions
unsafe void	RayTracedEditor ()
	Launch the Ray Traced Studio Editor command More...

unsafe void	RayTracedRenderingErase ()
	Erase Ray Traced Studio static (still) image from the Ray Traced Studio window More...

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

unsafe void	RayTracedRenderingStart ()
	Start Ray Traced Studio static image rendering More...

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

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

unsafe void	UpdateRayTracedDisplay ()
	Update the Ray Traced Studio display. More...

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

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe double	Brightness `[get, set]`
	Returns or sets the brightness for Iray Tonemap setting More...

unsafe NXOpen.Display.RayTracedStudioBuilder.StationaryDisplayQualityType	StationaryQuality `[get, set]`
	Returns or sets the Ray Traced Studio stationary display quality when dynamic interaction stops 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
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> 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 a null reference (Nothing in Visual Basic).

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
High	Very good ray traced display quality (Photoreal for Iray+)
Medium	Good ray traced display quality with good performance (Qualtiy Interactive for Iray+)
Low	The fastest ray traced display performance with preview quality (Fast Interactive for Iray+)

Member Function Documentation

unsafe void NXOpen.Display.RayTracedStudioBuilder.RayTracedEditor ( )

inline

Launch the Ray Traced Studio Editor command

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.Display.RayTracedStudioBuilder.RayTracedRenderingErase ( )

inline

Erase Ray Traced Studio static (still) image from the Ray Traced Studio window

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.Display.RayTracedStudioBuilder.RayTracedRenderingSave ( )

inline

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.

unsafe void NXOpen.Display.RayTracedStudioBuilder.RayTracedRenderingStart ( )

inline

Start Ray Traced Studio static image rendering

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.Display.RayTracedStudioBuilder.StartRayTracedDisplay ( )

inline

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

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.Display.RayTracedStudioBuilder.StopRayTracedDisplay ( )

inline

Stop the Ray Traced Studio progressive display.

Use the Start action to re-start the display.

Created in NX9.0.0

License requirements: None.

unsafe void NXOpen.Display.RayTracedStudioBuilder.UpdateRayTracedDisplay ( )

inline

Update the Ray Traced Studio display.

Use when geometry has changed to completely regenerate the display.

Created in NX9.0.0

License requirements: None.

Property Documentation

unsafe double NXOpen.Display.RayTracedStudioBuilder.Brightness

getset

Returns or sets the brightness for Iray Tonemap setting

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.RayTracedStudioBuilder.StationaryDisplayQualityType NXOpen.Display.RayTracedStudioBuilder.StationaryQuality

getset

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

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

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

Display_RayTracedStudioBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation