DisplayChangerBuilder Class¶
-
class
NXOpen.Mechatronics.
DisplayChangerBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Mechatronics.DisplayChanger
builder.To create a new instance of this class, use
NXOpen.Mechatronics.DisplayChangerCollection.CreateDisplayChangerBuilder
New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
CollisionSensor | Returns the object select. |
Color | Returns or sets the initial color display property |
ExecuteMode | Returns or sets the execute mode. |
InitVisibility | Returns or sets the initial visibility display property. |
Name | Returns or sets the name. |
Tag | Returns the Tag for this object. |
Translucency | Returns or sets the initial translucency display property. |
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¶
DisplayChangerBuilderExecuteModes Enumeration | the execute modes. |
Property Detail¶
CollisionSensor¶
-
DisplayChangerBuilder.
CollisionSensor
¶ Returns the object select.
This can be a
NXOpen.Mechatronics.CollisionSensor
.-------------------------------------
Getter Method
Signature
CollisionSensor()
Returns: Return type: NXOpen.Mechatronics.SelectCollisionSensor
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Color¶
-
DisplayChangerBuilder.
Color
¶ Returns or sets the initial color display property
-------------------------------------
Getter Method
Signature
Color()
Returns: Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Color(color)
Parameters: color (int) – New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ExecuteMode¶
-
DisplayChangerBuilder.
ExecuteMode
¶ Returns or sets the execute mode.
-------------------------------------
Getter Method
Signature
ExecuteMode()
Returns: Return type: NXOpen.Mechatronics.DisplayChangerBuilderExecuteModes
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExecuteMode(mode)
Parameters: mode ( NXOpen.Mechatronics.DisplayChangerBuilderExecuteModes
) –New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
InitVisibility¶
-
DisplayChangerBuilder.
InitVisibility
¶ Returns or sets the initial visibility display property.
-------------------------------------
Getter Method
Signature
InitVisibility()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InitVisibility(visibility)
Parameters: visibility (bool) – New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Name¶
-
DisplayChangerBuilder.
Name
¶ Returns or sets the name.
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Name(name)
Parameters: name (str) – New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Translucency¶
-
DisplayChangerBuilder.
Translucency
¶ Returns or sets the initial translucency display property.
-------------------------------------
Getter Method
Signature
Translucency()
Returns: Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Translucency(translucency)
Parameters: translucency (int) – New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
Validate¶
-
DisplayChangerBuilder.
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.