SectionDrawingBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
SectionDrawingBuilder
¶ Bases:
NXOpen.Builder
This builder allows you to define the section drawing information.
It represents
NXOpen.Features.ShipDesign.SectionDrawingBuilder
. This builder creates one or more Ship Section View and just returns None.To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateSectionDrawingBuilder()
Default values.
Property Value SectionsPerDrawing Multiple ViewType DetailDesign ViewsPerSheet One New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
DrawingPartList | Returns the list of drawing parts in current NX session |
SectionsPerDrawing | Returns or sets the sct per drawing |
Tag | Returns the Tag for this object. |
ViewList | Returns the section view list |
ViewType | Returns or sets the view type |
ViewsPerSheet | Returns or sets the views per sheet |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreateDrawingPartBuilder | Creates a NXOpen.Features.ShipDesign.DrawingPartBuilder |
CreateSectionViewBuilder | Creates a NXOpen.Features.ShipDesign.SectionViewBuilder |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
FindFocusPlates | Returns a list of focus plates at the given position, this function just used when the frontProximity and backProximity has the same value. |
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¶
SectionDrawingBuilderSectionsPerDrawingOptions Enumeration | Settings to indicate the section per drawing. |
SectionDrawingBuilderViewTypeOptions Enumeration | Settings to indicate the view type. |
SectionDrawingBuilderViewsPerSheetOptions Enumeration | Settings to indicate the views per sheet. |
Property Detail¶
DrawingPartList¶
-
SectionDrawingBuilder.
DrawingPartList
¶ Returns the list of drawing parts in current NX session
-------------------------------------
Getter Method
Signature
DrawingPartList
Returns: Return type: NXOpen.Features.ShipDesign.DrawingPartBuilderList
New in version NX12.0.0.
License requirements: None.
SectionsPerDrawing¶
-
SectionDrawingBuilder.
SectionsPerDrawing
¶ Returns or sets the sct per drawing
-------------------------------------
Getter Method
Signature
SectionsPerDrawing
Returns: Return type: NXOpen.Features.ShipDesign.SectionDrawingBuilderSectionsPerDrawingOptions
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SectionsPerDrawing
Parameters: sctPerDrawing ( NXOpen.Features.ShipDesign.SectionDrawingBuilderSectionsPerDrawingOptions
) –New in version NX10.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
ViewList¶
-
SectionDrawingBuilder.
ViewList
¶ Returns the section view list
-------------------------------------
Getter Method
Signature
ViewList
Returns: Return type: NXOpen.Features.ShipDesign.SectionViewBuilderList
New in version NX10.0.0.
License requirements: None.
ViewType¶
-
SectionDrawingBuilder.
ViewType
¶ Returns or sets the view type
-------------------------------------
Getter Method
Signature
ViewType
Returns: Return type: NXOpen.Features.ShipDesign.SectionDrawingBuilderViewTypeOptions
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewType
Parameters: viewType ( NXOpen.Features.ShipDesign.SectionDrawingBuilderViewTypeOptions
) –New in version NX10.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
ViewsPerSheet¶
-
SectionDrawingBuilder.
ViewsPerSheet
¶ Returns or sets the views per sheet
-------------------------------------
Getter Method
Signature
ViewsPerSheet
Returns: Return type: NXOpen.Features.ShipDesign.SectionDrawingBuilderViewsPerSheetOptions
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewsPerSheet
Parameters: sctPerDrawing ( NXOpen.Features.ShipDesign.SectionDrawingBuilderViewsPerSheetOptions
) –New in version NX10.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
Method Detail¶
CreateDrawingPartBuilder¶
-
SectionDrawingBuilder.
CreateDrawingPartBuilder
¶ Creates a
NXOpen.Features.ShipDesign.DrawingPartBuilder
Signature
CreateDrawingPartBuilder(drawingPart)
Parameters: drawingPart ( NXOpen.Part
) –Returns: Return type: NXOpen.Features.ShipDesign.DrawingPartBuilder
New in version NX12.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
CreateSectionViewBuilder¶
-
SectionDrawingBuilder.
CreateSectionViewBuilder
¶ Creates a
NXOpen.Features.ShipDesign.SectionViewBuilder
Signature
CreateSectionViewBuilder()
Returns: Return type: NXOpen.Features.ShipDesign.SectionViewBuilder
New in version NX10.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
FindFocusPlates¶
-
SectionDrawingBuilder.
FindFocusPlates
¶ Overloaded method FindFocusPlates
FindFocusPlates(frame, offset, frontProximity, backProximity)
FindFocusPlates(frame, direction, offset, frontProximity, backProximity)
-------------------------------------
Returns a list of focus plates at the given position, this function just used when the frontProximity and backProximity has the same value. Otherwise it just use the big value for both frontProximity and backProximity
Signature
FindFocusPlates(frame, offset, frontProximity, backProximity)
Parameters: - frame (
NXOpen.NXObject
) – the frame or plane - offset (float) – the offset of view position to the plane
- frontProximity (float) – the proximity in front of the view
- backProximity (float) – the proximity at the back of the view
Returns: the found focus plates
Return type: list of
NXOpen.NXObject
New in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
-------------------------------------
Returns a list of focus plates at the given position, this function is used when user want use different frontProximity and backProximity.
Signature
FindFocusPlates(frame, direction, offset, frontProximity, backProximity)
Parameters: - frame (
NXOpen.NXObject
) – the frame - direction (
NXOpen.Features.ShipDesign.SectionViewBuilderDirectionOptions
) – the direction of the view - offset (float) – the offset of view position to the plane
- frontProximity (float) – the proximity in front of the view
- backProximity (float) – the proximity at the back of the view
Returns: the found focus plates
Return type: list of
NXOpen.NXObject
New in version NX11.0.2.
License requirements: nx_ship_drafting (“Ship Drafting”)
-------------------------------------
Validate¶
-
SectionDrawingBuilder.
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.