|
NXOpen C++ Reference Guide
|
|
NXOpen C++ Reference Guide
|
Represents a room builder for general arrangement. More...
Public Types | |
| enum | Types { TypesCreate, TypesAdopt } |
| The room types. More... | |
Public Member Functions | |
| void | AdoptChanged () |
| Notifies system that the room creation type is changed to Adopt mode to reset room attributes. More... | |
| NXOpen::SelectBody * | AdoptionBody () |
| Returns the body to be adopted as a room. More... | |
| NXOpen::Features::ShipDesign::RoomAttributeListBuilder * | AttributeList () |
| Returns. More... | |
| bool | CreateRoomWithReferenceComponent () |
| Returns the option to indicate whether to create reference component for the room or not. More... | |
| bool | CreateRoomWithWall () |
| Returns the option to indicate whether to create wall for the room or not. More... | |
| NXOpen::SelectBodyList * | Deck () |
| Returns. More... | |
| double | DistanceTolerance () |
| Returns the distance tolerance which is used in room body creation. More... | |
| void | EvaluateAttributes (bool bUpdateRoomAreaAndVolume) |
| Evaluates room attributes. More... | |
| NXOpen::NXColor * | RoomColor () |
| Returns the color to be assigned to the created room body. More... | |
| NXOpen::Section * | Section () |
| Returns. More... | |
| void | SetCreateRoomWithReferenceComponent (bool createRoomWithReferenceComponent) |
| Sets the option to indicate whether to create reference component for the room or not. More... | |
| void | SetCreateRoomWithWall (bool createRoomWithWall) |
| Sets the option to indicate whether to create wall for the room or not. More... | |
| void | SetDistanceTolerance (double distanceTolerance) |
| Sets the distance tolerance which is used in room body creation. More... | |
| void | SetRoomColor (NXOpen::NXColor *color) |
| Sets the color to be assigned to the created room body. More... | |
| void | SetType (NXOpen::Features::ShipDesign::RoomBuilder::Types type) |
| Sets. More... | |
| NXOpen::Features::ShipDesign::ShipNamesBuilder * | ShipNames () |
| Returns. More... | |
| NXOpen::Features::ShipDesign::RoomThicknessItemBuilderList * | ThicknessList () |
| Returns. More... | |
| NXOpen::Features::ShipDesign::RoomBuilder::Types | Type () |
| Returns. More... | |
| void | UpdateTypeForAttributeListBuilder () |
| Updates room type which is either creation or adopt to the attribute list builder. More... | |
| NXOpen::Expression * | WallThickness () |
| Returns. More... | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
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.
| void NXOpen::Features::ShipDesign::RoomBuilder::AdoptChanged | ( | ) |
Notifies system that the room creation type is changed to Adopt mode to reset room attributes.
Created in NX12.0.2.
License requirements : nx_ship_gen_arrange ("Ship General Arrangement")
| NXOpen::SelectBody* NXOpen::Features::ShipDesign::RoomBuilder::AdoptionBody | ( | ) |
Returns the body to be adopted as a room.
Created in NX12.0.0.
License requirements : None
| NXOpen::Features::ShipDesign::RoomAttributeListBuilder* NXOpen::Features::ShipDesign::RoomBuilder::AttributeList | ( | ) |
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
| bool NXOpen::Features::ShipDesign::RoomBuilder::CreateRoomWithReferenceComponent | ( | ) |
Returns the option to indicate whether to create reference component for the room or not.
Created in NX12.0.2.
License requirements : None
| bool NXOpen::Features::ShipDesign::RoomBuilder::CreateRoomWithWall | ( | ) |
Returns the option to indicate whether to create wall for the room or not.
Created in NX12.0.0.
License requirements : None
| NXOpen::SelectBodyList* NXOpen::Features::ShipDesign::RoomBuilder::Deck | ( | ) |
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")
| double NXOpen::Features::ShipDesign::RoomBuilder::DistanceTolerance | ( | ) |
Returns the distance tolerance which is used in room body creation.
Created in NX12.0.0.
License requirements : None
| void NXOpen::Features::ShipDesign::RoomBuilder::EvaluateAttributes | ( | bool | bUpdateRoomAreaAndVolume | ) |
Evaluates room attributes.
Created in NX12.0.2.
License requirements : nx_ship_gen_arrange ("Ship General Arrangement")
| bUpdateRoomAreaAndVolume | bupdateroomareaandvolume |
| NXOpen::NXColor* NXOpen::Features::ShipDesign::RoomBuilder::RoomColor | ( | ) |
Returns the color to be assigned to the created room body.
Created in NX12.0.2.
License requirements : None
| NXOpen::Section* NXOpen::Features::ShipDesign::RoomBuilder::Section | ( | ) |
Returns.
the section.
The section defines the room boundary.
Created in NX12.0.0.
License requirements : None
| void NXOpen::Features::ShipDesign::RoomBuilder::SetCreateRoomWithReferenceComponent | ( | bool | createRoomWithReferenceComponent | ) |
Sets the option to indicate whether to create reference component for the room or not.
Created in NX12.0.2.
License requirements : nx_ship_gen_arrange ("Ship General Arrangement")
| createRoomWithReferenceComponent | createroomwithreferencecomponent |
| void NXOpen::Features::ShipDesign::RoomBuilder::SetCreateRoomWithWall | ( | bool | createRoomWithWall | ) |
Sets the option to indicate whether to create wall for the room or not.
Created in NX12.0.0.
License requirements : nx_ship_gen_arrange ("Ship General Arrangement")
| createRoomWithWall | createroomwithwall |
| void NXOpen::Features::ShipDesign::RoomBuilder::SetDistanceTolerance | ( | double | distanceTolerance | ) |
Sets the distance tolerance which is used in room body creation.
Created in NX12.0.0.
License requirements : nx_ship_gen_arrange ("Ship General Arrangement")
| distanceTolerance | distancetolerance |
| void NXOpen::Features::ShipDesign::RoomBuilder::SetRoomColor | ( | NXOpen::NXColor * | color | ) |
Sets the color to be assigned to the created room body.
Created in NX12.0.2.
License requirements : nx_ship_gen_arrange ("Ship General Arrangement")
| color | color |
| void NXOpen::Features::ShipDesign::RoomBuilder::SetType | ( | NXOpen::Features::ShipDesign::RoomBuilder::Types | type | ) |
Sets.
the room generation type.
If you set the type to Features::ShipDesign::RoomBuilder::TypesCreate , then please also set values for below properties:
If you set the type to Features::ShipDesign::RoomBuilder::TypesAdopt , then please also set values for below properties:
Created in NX12.0.0.
License requirements : nx_ship_gen_arrange ("Ship General Arrangement")
| type | type |
| NXOpen::Features::ShipDesign::ShipNamesBuilder* NXOpen::Features::ShipDesign::RoomBuilder::ShipNames | ( | ) |
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
| NXOpen::Features::ShipDesign::RoomThicknessItemBuilderList* NXOpen::Features::ShipDesign::RoomBuilder::ThicknessList | ( | ) |
Returns.
the room thicknesses list.
The thickness list is used for creating wall. It is only used when NXOpen::Features::ShipDesign::RoomBuilder::CreateRoomWithWall and NXOpen::Features::ShipDesign::RoomBuilder::SetCreateRoomWithWall is set to true. There should be one floor thickness, one ceiling thickness and multiple wall thicknesses.
Created in NX12.0.1.
License requirements : None
| NXOpen::Features::ShipDesign::RoomBuilder::Types NXOpen::Features::ShipDesign::RoomBuilder::Type | ( | ) |
Returns.
the room generation type.
If you set the type to Features::ShipDesign::RoomBuilder::TypesCreate , then please also set values for below properties:
If you set the type to Features::ShipDesign::RoomBuilder::TypesAdopt , then please also set values for below properties:
Created in NX12.0.0.
License requirements : None
| void NXOpen::Features::ShipDesign::RoomBuilder::UpdateTypeForAttributeListBuilder | ( | ) |
Updates room type which is either creation or adopt to the attribute list builder.
Created in NX12.0.2.
License requirements : nx_ship_gen_arrange ("Ship General Arrangement")
| NXOpen::Expression* NXOpen::Features::ShipDesign::RoomBuilder::WallThickness | ( | ) |
Returns.
the wall thickness.
The thickness is used for creating wall. It is only used when NXOpen::Features::ShipDesign::RoomBuilder::CreateRoomWithWall and NXOpen::Features::ShipDesign::RoomBuilder::SetCreateRoomWithWall is set to true. Use this method when the floor and all walls have the same thickness. Otherwise use NXOpen::Features::ShipDesign::RoomBuilder::ThicknessList to set different thicknesses for floor, ceiling and walls.
Created in NX12.0.0.
License requirements : None
