Represents a room builder for general arrangement. More...
Public Types | |
| enum | Types { Create, Adopt } |
| The room types. More... | |
Properties | |
| unsafe NXOpen.SelectBody | AdoptionBody [get] |
| Returns the body to be adopted as a room. More... | |
| unsafe NXOpen.Features.ShipDesign.RoomAttributeListBuilder | AttributeList [get] |
| Returns the room attribute list. More... | |
| unsafe bool | CreateRoomWithWall [get, set] |
| Returns or sets the option to indicate whether to create wall for the room or not. More... | |
| unsafe NXOpen.SelectBodyList | Deck [get] |
| Returns the deck body. More... | |
| unsafe double | DistanceTolerance [get, set] |
| Returns or sets the distance tolerance which is used in room body creation. More... | |
| unsafe NXOpen.Section | Section [get] |
| Returns the section. More... | |
| unsafe NXOpen.Features.ShipDesign.ShipNamesBuilder | ShipNames [get] |
| Returns the ship name. More... | |
| unsafe NXOpen.Features.ShipDesign.RoomBuilder.Types | Type [get, set] |
| Returns or sets the room generation type. More... | |
| unsafe NXOpen.Expression | WallThickness [get] |
| Returns the wall thickness. 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... | |
Detailed Description
Represents a room builder for general arrangement.
This builder is used to define a room.
To create a new instance of this class, use NXOpen.Features.ShipCollection.CreateRoomBuilder
Default values.
| Property | Value |
|---|---|
|
WallThickness.Value |
7 (millimeters part), 0.25 (inches part) |
Created in NX12.0.0
Member Enumeration Documentation
Property Documentation
|
get |
Returns the body to be adopted as a room.
Created in NX12.0.0
License requirements: None.
|
get |
Returns the room attribute list.
The room attributes defines attributes those are applied to the room component and body.
Created in NX12.0.0
License requirements: None.
|
getset |
Returns or sets the option to indicate whether to create wall for the room or not.
Created in NX12.0.0
License requirements to get this property: None.
License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement")
|
get |
Returns the deck body.
The deck body defines the owning deck of this room.
Created in NX12.0.0
License requirements: nx_ship_gen_arrange ("Ship General Arrangement")
|
getset |
Returns or sets the distance tolerance which is used in room body creation.
Created in NX12.0.0
License requirements to get this property: None.
License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement")
|
get |
Returns the section.
The section defines the room boundary.
Created in NX12.0.0
License requirements: None.
|
get |
Returns the ship name.
The ship name is used to assign name to the room container.
It is only used when the work part is deck container, where a new room part will be created.
Created in NX12.0.0
License requirements: None.
|
getset |
Returns or sets the room generation type.
If you set the type to Features.ShipDesign.RoomBuilder.Types.Create , then please also set values for below properties:
- NXOpen.Features.ShipDesign.RoomBuilder.Section
- NXOpen.Features.ShipDesign.RoomBuilder.Deck
- NXOpen.Features.ShipDesign.RoomBuilder.CreateRoomWithWall
- NXOpen.Features.ShipDesign.RoomBuilder.WallThickness
If you set the type to Features.ShipDesign.RoomBuilder.Types.Adopt , then please also set values for below properties:
Created in NX12.0.0
License requirements to get this property: None.
License requirements to set this property: nx_ship_gen_arrange ("Ship General Arrangement")
|
get |
Returns the wall thickness.
The thickness is used for creating wall. It is only used when NXOpen.Features.ShipDesign.RoomBuilder.CreateRoomWithWall is set to true.
Created in NX12.0.0
License requirements: None.
The documentation for this class was generated from the following file:
- dotnet_pool/Features_ShipDesign_RoomBuilder.cs