NXOpen::Display::TrueStudioBuilder Class Reference

The TrueStudioBuillder manages Advanced Studio visualization display
To create a new instance of this class, use Display::TrueStudioCollection::CreateTrueStudioBuilder

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::Display::TrueStudioBuilder:

Public Types
enum	GlobalMaterial {   GlobalMaterialPlasticColorwash, GlobalMaterialShinyMetalColorwash, GlobalMaterialClay, GlobalMaterialPlasticine,   GlobalMaterialChrome }
	Types of True Studio Global Material display. More...
enum	RenderMethod { RenderMethodFullRender, RenderMethodImprovedRender, RenderMethodPreviewRender }
	Types of True Studio Render Methods. More...

Public Member Functions
NXOpen::Display::TrueStudioBuilder::GlobalMaterial	GlobalMaterialType ()
	Returns the Global Material Type is used in Advanced Studio display when no material has been applied to the object.
bool	ModeToggle ()
	Returns the Mode Toggle controls whether Advanced Studio display is enabled.
NXOpen::Display::TrueStudioBuilder::RenderMethod	RenderMethodType ()
	Returns the Render Method Type is used in Advanced Studio display to control the display quality and performance Created in NX8.0.0.
void	SetGlobalMaterialType (NXOpen::Display::TrueStudioBuilder::GlobalMaterial globalMaterialType)
	Sets the Global Material Type is used in Advanced Studio display when no material has been applied to the object.
void	SetModeToggle (bool modeToggle)
	Sets the Mode Toggle controls whether Advanced Studio display is enabled.
void	SetRenderMethodType (NXOpen::Display::TrueStudioBuilder::RenderMethod renderMethodType)
	Sets the Render Method Type is used in Advanced Studio display to control the display quality and performance Created in NX8.0.0.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

The TrueStudioBuillder manages Advanced Studio visualization display
To create a new instance of this class, use Display::TrueStudioCollection::CreateTrueStudioBuilder

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::Display::TrueStudioBuilder::GlobalMaterial

Types of True Studio Global Material display.

This material is displayed on objects when no other material has been applied.

Enumerator:

GlobalMaterialPlasticColorwash	Uses the object's color with plastic material characteristics.
GlobalMaterialShinyMetalColorwash	Uses the object's color with shiny metal material characteristics.
GlobalMaterialClay	Overrides the object color with a clay material display.
GlobalMaterialPlasticine	Overrides the object color with a plasticine material display.
GlobalMaterialChrome	Overrides the object color with a chrome material display.

enum NXOpen::Display::TrueStudioBuilder::RenderMethod

Types of True Studio Render Methods.

The render method is used to specify display quality or real-time performance

Enumerator:

RenderMethodFullRender	All rendering effects are honored.
RenderMethodImprovedRender	Some rendering effects are not honored. Can be faster than Full Render.
RenderMethodPreviewRender	Many rendering effects are not honored. Faster than Full and Improved Render.

Member Function Documentation

NXOpen::Display::TrueStudioBuilder::GlobalMaterial NXOpen::Display::TrueStudioBuilder::GlobalMaterialType

(

)

Returns the Global Material Type is used in Advanced Studio display when no material has been applied to the object.

Created in NX8.0.0.

License requirements : None

bool NXOpen::Display::TrueStudioBuilder::ModeToggle

(

)

Returns the Mode Toggle controls whether Advanced Studio display is enabled.

Created in NX8.0.0.

License requirements : None

NXOpen::Display::TrueStudioBuilder::RenderMethod NXOpen::Display::TrueStudioBuilder::RenderMethodType

(

)

Returns the Render Method Type is used in Advanced Studio display to control the display quality and performance
Created in NX8.0.0.

License requirements : None

void NXOpen::Display::TrueStudioBuilder::SetGlobalMaterialType

(

NXOpen::Display::TrueStudioBuilder::GlobalMaterial

globalMaterialType

)

Sets the Global Material Type is used in Advanced Studio display when no material has been applied to the object.

Created in NX8.0.0.

License requirements : None

Parameters

globalMaterialType

globalmaterialtype

void NXOpen::Display::TrueStudioBuilder::SetModeToggle

(

bool

modeToggle

)

Sets the Mode Toggle controls whether Advanced Studio display is enabled.

Created in NX8.0.0.

License requirements : None

Parameters

modeToggle

modetoggle

void NXOpen::Display::TrueStudioBuilder::SetRenderMethodType

(

NXOpen::Display::TrueStudioBuilder::RenderMethod

renderMethodType

)

Sets the Render Method Type is used in Advanced Studio display to control the display quality and performance
Created in NX8.0.0.

License requirements : None

Parameters

renderMethodType

rendermethodtype

---

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

• Display_TrueStudioBuilder.hxx