NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Properties | List of all members
NXOpen.Display.TrueStudioBuilder Class Reference

The TrueStudioBuillder manages Advanced Studio visualization display More...

Inheritance diagram for NXOpen.Display.TrueStudioBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  GlobalMaterial {
  PlasticColorwash, ShinyMetalColorwash, Clay, Plasticine,
  Chrome
}
 Types of True Studio Global Material display. More...
 
enum  RenderMethod { FullRender, ImprovedRender, PreviewRender }
 Types of True Studio Render Methods. More...
 

Properties

unsafe
NXOpen.Display.TrueStudioBuilder.GlobalMaterial 
GlobalMaterialType [get, set]
 Returns or sets the Global Material Type is used in Advanced Studio display when no material has been applied to the object. More...
 
unsafe bool ModeToggle [get, set]
 Returns or sets the Mode Toggle controls whether Advanced Studio display is enabled. More...
 
unsafe
NXOpen.Display.TrueStudioBuilder.RenderMethod 
RenderMethodType [get, set]
 Returns or sets the Render Method Type is used in Advanced Studio display to control the display quality and performance 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

- 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...
 
- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

The TrueStudioBuillder manages Advanced Studio visualization display

To create a new instance of this class, use NXOpen.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
PlasticColorwash 

Uses the object's color with plastic material characteristics.

ShinyMetalColorwash 

Uses the object's color with shiny metal material characteristics.

Clay 

Overrides the object color with a clay material display.

Plasticine 

Overrides the object color with a plasticine material display.

Chrome 

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
FullRender 

All rendering effects are honored.

ImprovedRender 

Some rendering effects are not honored.

Can be faster than Full Render.

PreviewRender 

Many rendering effects are not honored.

Faster than Full and Improved Render.

Property Documentation

unsafe NXOpen.Display.TrueStudioBuilder.GlobalMaterial NXOpen.Display.TrueStudioBuilder.GlobalMaterialType
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.TrueStudioBuilder.ModeToggle
getset

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.TrueStudioBuilder.RenderMethod NXOpen.Display.TrueStudioBuilder.RenderMethodType
getset

Returns or 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 to get this property: None.

License requirements to set this property: None.


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