NX Open C++ Reference Guide
Public Types | Public Member Functions
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:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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.

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

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.

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

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

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


Created in NX8.0.0.

License requirements : None

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

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:
globalMaterialTypeglobalmaterialtype

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


Created in NX8.0.0.

License requirements : None

Parameters:
modeTogglemodetoggle

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:
renderMethodTyperendermethodtype

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.