GeneralArrangementViewBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
GeneralArrangementViewBuilder
¶ Bases:
NXOpen.Builder
This builder allows you to define the general arrangement view information.
It represents
NXOpen.Features.ShipDesign.GeneralArrangementViewBuilder
. This builder creates one Ship General Arrangement View and return it.To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateGeneralArrangementViewBuilder()
Default values.
Property Value Placement.AlignmentMethod Infer Placement.AlignmentOption ToView New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
Decks | Returns the decks |
DrawingSheet | Returns or sets the drawing sheet which the view on |
EndFrame | Returns or sets the end frame |
InheritedPMISource | Returns or sets the inherited source |
Placement | Returns the view placement |
Scale | Returns or sets the view Scale |
SelectStructures | Returns the selected structure |
SelectedModelView | Returns the list of selected Model View which are the source of PMI |
SourcePart | Returns or sets the source part |
StartFrame | Returns or sets the start frame |
Tag | Returns the Tag for this object. |
ViewCreation | Returns or sets the view creation type |
ViewDirection | Returns or sets the view direction |
ViewName | Returns or sets the view name |
ViewType | Returns or sets the view type |
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. |
SetViewPosition | Sets the view position on the drawing |
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¶
GeneralArrangementViewBuilderInheritedPMISourceOption Enumeration | Settings to indicate the Inherited PMI source type |
GeneralArrangementViewBuilderViewCreationType Enumeration | Settings to indicate the view type when view direction is X |
GeneralArrangementViewBuilderViewDirectionType Enumeration | Settings to indicate the view direction type |
Property Detail¶
Decks¶
-
GeneralArrangementViewBuilder.
Decks
¶ Returns the decks
-------------------------------------
Getter Method
Signature
Decks
Returns: Return type: NXOpen.Features.ShipDesign.DeckListBuilder
New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
DrawingSheet¶
-
GeneralArrangementViewBuilder.
DrawingSheet
¶ Returns or sets the drawing sheet which the view on
-------------------------------------
Getter Method
Signature
DrawingSheet
Returns: Return type: NXOpen.Drawings.DrawingSheet
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DrawingSheet
Parameters: drawingSheet ( NXOpen.Drawings.DrawingSheet
) –New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
EndFrame¶
-
GeneralArrangementViewBuilder.
EndFrame
¶ Returns or sets the end frame
-------------------------------------
Getter Method
Signature
EndFrame
Returns: Return type: NXOpen.NXObject
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
EndFrame
Parameters: endFrame ( NXOpen.NXObject
) –New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
InheritedPMISource¶
-
GeneralArrangementViewBuilder.
InheritedPMISource
¶ Returns or sets the inherited source
-------------------------------------
Getter Method
Signature
InheritedPMISource
Returns: Return type: NXOpen.Features.ShipDesign.GeneralArrangementViewBuilderInheritedPMISourceOption
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InheritedPMISource
Parameters: inheritedPMISource ( NXOpen.Features.ShipDesign.GeneralArrangementViewBuilderInheritedPMISourceOption
) –New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
Placement¶
-
GeneralArrangementViewBuilder.
Placement
¶ Returns the view placement
-------------------------------------
Getter Method
Signature
Placement
Returns: Return type: NXOpen.Drawings.ViewPlacementBuilder
New in version NX12.0.0.
License requirements: None.
Scale¶
-
GeneralArrangementViewBuilder.
Scale
¶ Returns or sets the view Scale
-------------------------------------
Getter Method
Signature
Scale
Returns: Return type: float New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Scale
Parameters: scale (float) – New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
SelectStructures¶
-
GeneralArrangementViewBuilder.
SelectStructures
¶ Returns the selected structure
-------------------------------------
Getter Method
Signature
SelectStructures
Returns: Return type: NXOpen.Features.ShipDesign.SelectStructuresBuilder
New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
SelectedModelView¶
-
GeneralArrangementViewBuilder.
SelectedModelView
¶ Returns the list of selected Model View which are the source of PMI
-------------------------------------
Getter Method
Signature
SelectedModelView
Returns: Return type: NXOpen.SelectModelingViewList
New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
SourcePart¶
-
GeneralArrangementViewBuilder.
SourcePart
¶ Returns or sets the source part
-------------------------------------
Getter Method
Signature
SourcePart
Returns: Return type: NXOpen.TaggedObject
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SourcePart
Parameters: sourcePart ( NXOpen.TaggedObject
) –New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
StartFrame¶
-
GeneralArrangementViewBuilder.
StartFrame
¶ Returns or sets the start frame
-------------------------------------
Getter Method
Signature
StartFrame
Returns: Return type: NXOpen.NXObject
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
StartFrame
Parameters: startFrame ( NXOpen.NXObject
) –New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
ViewCreation¶
-
GeneralArrangementViewBuilder.
ViewCreation
¶ Returns or sets the view creation type
-------------------------------------
Getter Method
Signature
ViewCreation
Returns: Return type: NXOpen.Features.ShipDesign.GeneralArrangementViewBuilderViewCreationType
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewCreation
Parameters: viewCreation ( NXOpen.Features.ShipDesign.GeneralArrangementViewBuilderViewCreationType
) –New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
ViewDirection¶
-
GeneralArrangementViewBuilder.
ViewDirection
¶ Returns or sets the view direction
-------------------------------------
Getter Method
Signature
ViewDirection
Returns: Return type: NXOpen.Features.ShipDesign.GeneralArrangementViewBuilderViewDirectionType
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewDirection
Parameters: viewDirection ( NXOpen.Features.ShipDesign.GeneralArrangementViewBuilderViewDirectionType
) –New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
ViewName¶
-
GeneralArrangementViewBuilder.
ViewName
¶ Returns or sets the view name
-------------------------------------
Getter Method
Signature
ViewName
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewName
Parameters: viewName (str) – New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
ViewType¶
-
GeneralArrangementViewBuilder.
ViewType
¶ Returns or sets the view type
-------------------------------------
Getter Method
Signature
ViewType
Returns: Return type: str New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewType
Parameters: viewType (str) – New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
Method Detail¶
SetViewPosition¶
-
GeneralArrangementViewBuilder.
SetViewPosition
¶ Sets the view position on the drawing
Signature
SetViewPosition(xPosition, yPosition)
Parameters: - xPosition (float) –
- yPosition (float) –
New in version NX12.0.0.
License requirements: nx_ship_gen_arrange (“Ship General Arrangement”)
Validate¶
-
GeneralArrangementViewBuilder.
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.