DisplaySolidBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
DisplaySolidBuilder
¶ Bases:
NXOpen.Builder
This class is used to identify ship structure that is to have a temporary solid display built for it.
To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateDisplaySolidBuilder()
Default values.
Property Value DisplayOption Curve New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
DisplayOption | Returns or sets the setting for how the basic design objects are displayed. |
ShipStructure | Returns the ship structure whose solid display is desired. |
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¶
DisplaySolidBuilderDisplayOptionTypes Enumeration | Used to specify how the basic design profile system objects are displayed. |
Property Detail¶
DisplayOption¶
-
DisplaySolidBuilder.
DisplayOption
¶ Returns or sets the setting for how the basic design objects are displayed.
-------------------------------------
Getter Method
Signature
DisplayOption
Returns: Return type: NXOpen.Features.ShipDesign.DisplaySolidBuilderDisplayOptionTypes
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayOption
Parameters: displayOption ( NXOpen.Features.ShipDesign.DisplaySolidBuilderDisplayOptionTypes
) –New in version NX8.5.0.
License requirements: nx_ship_basic (“Ship Basic Design”)
ShipStructure¶
-
DisplaySolidBuilder.
ShipStructure
¶ Returns the ship structure whose solid display is desired.
-------------------------------------
Getter Method
Signature
ShipStructure
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX8.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
DisplaySolidBuilder.
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.