TrueStudioBuilder Class¶
-
class
NXOpen.Display.TrueStudioBuilder¶ Bases:
NXOpen.BuilderThe TrueStudioBuillder manages Advanced Studio visualization display
To create a new instance of this class, use
NXOpen.Display.TrueStudioCollection.CreateTrueStudioBuilder()New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| GlobalMaterialType | Returns or sets the Global Material Type is used in Advanced Studio display when no material has been applied to the object. |
| ModeToggle | Returns or sets the Mode Toggle controls whether Advanced Studio display is enabled. |
| RenderMethodType | Returns or sets the Render Method Type is used in Advanced Studio display to control the display quality and performance |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| TrueStudioBuilderGlobalMaterial Enumeration | Types of True Studio Global Material display. |
| TrueStudioBuilderRenderMethod Enumeration | Types of True Studio Render Methods. |
Property Detail¶
GlobalMaterialType¶
-
TrueStudioBuilder.GlobalMaterialType¶ Returns or sets the Global Material Type is used in Advanced Studio display when no material has been applied to the object.
-------------------------------------Getter Method
Signature
GlobalMaterialTypeReturns: Return type: NXOpen.Display.TrueStudioBuilderGlobalMaterialNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
GlobalMaterialTypeParameters: globalMaterialType ( NXOpen.Display.TrueStudioBuilderGlobalMaterial) –New in version NX8.0.0.
License requirements: None.
ModeToggle¶
-
TrueStudioBuilder.ModeToggle¶ Returns or sets the Mode Toggle controls whether Advanced Studio display is enabled.
-------------------------------------Getter Method
Signature
ModeToggleReturns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ModeToggleParameters: modeToggle (bool) – New in version NX8.0.0.
License requirements: None.
RenderMethodType¶
-
TrueStudioBuilder.RenderMethodType¶ Returns or sets the Render Method Type is used in Advanced Studio display to control the display quality and performance
-------------------------------------Getter Method
Signature
RenderMethodTypeReturns: Return type: NXOpen.Display.TrueStudioBuilderRenderMethodNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RenderMethodTypeParameters: renderMethodType ( NXOpen.Display.TrueStudioBuilderRenderMethod) –New in version NX8.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
TrueStudioBuilder.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.