SectionEditorBuilder Class¶
-
class
NXOpen.Features.ShipDesign.SectionEditorBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Features.ShipDesign.SectionEditorBuilderbuilder.This builder is used to edit Ship Section View and returns None. To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateSectionEditorBuilder()New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| BackProximity | Returns the ship section back proximity |
| Denominator | Returns or sets the denominator of the view scale |
| FrontProximity | Returns the ship section front proximity |
| Numerator | Returns or sets the numerator of the view scale |
| SectionRule | Returns or sets the ship section rule method |
| ShipStructure | Returns the ship structures |
| SymmetricalStructure | Returns or sets the symmetrical structure |
| Tag | Returns the Tag for this object. |
| ViewList | Returns the ship section views list |
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. |
| FindFocusPlates | Returns a list of focus plates at the given position @return |
| 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. |
Property Detail¶
BackProximity¶
-
SectionEditorBuilder.BackProximity¶ Returns the ship section back proximity
-------------------------------------Getter Method
Signature
BackProximity()Returns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: None.
Denominator¶
-
SectionEditorBuilder.Denominator¶ Returns or sets the denominator of the view scale
-------------------------------------Getter Method
Signature
Denominator()Returns: Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Denominator(denominator)Parameters: denominator (int) – New in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
FrontProximity¶
-
SectionEditorBuilder.FrontProximity¶ Returns the ship section front proximity
-------------------------------------Getter Method
Signature
FrontProximity()Returns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: None.
Numerator¶
-
SectionEditorBuilder.Numerator¶ Returns or sets the numerator of the view scale
-------------------------------------Getter Method
Signature
Numerator()Returns: Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Numerator(numerator)Parameters: numerator (int) – New in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
SectionRule¶
-
SectionEditorBuilder.SectionRule¶ Returns or sets the ship section rule method
-------------------------------------Getter Method
Signature
SectionRule()Returns: Return type: NXOpen.Features.ShipDesign.SectionViewBuilderSectionRuleOptionsNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SectionRule(enumSectionMethod)Parameters: enumSectionMethod ( NXOpen.Features.ShipDesign.SectionViewBuilderSectionRuleOptions) –New in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
ShipStructure¶
-
SectionEditorBuilder.ShipStructure¶ Returns the ship structures
-------------------------------------Getter Method
Signature
ShipStructure()Returns: Return type: NXOpen.Features.ShipDesign.ShipStructureBuilderNew in version NX11.0.0.
License requirements: None.
SymmetricalStructure¶
-
SectionEditorBuilder.SymmetricalStructure¶ Returns or sets the symmetrical structure
-------------------------------------Getter Method
Signature
SymmetricalStructure()Returns: Return type: NXOpen.Features.ShipDesign.SectionViewBuilderSymmetricalStructureOptionsNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SymmetricalStructure(symmetricalStructure)Parameters: symmetricalStructure ( NXOpen.Features.ShipDesign.SectionViewBuilderSymmetricalStructureOptions) –New in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
ViewList¶
-
SectionEditorBuilder.ViewList¶ Returns the ship section views list
-------------------------------------Getter Method
Signature
ViewList()Returns: Return type: NXOpen.Drawings.SelectDraftingViewListNew in version NX11.0.0.
License requirements: None.
Method Detail¶
FindFocusPlates¶
-
SectionEditorBuilder.FindFocusPlates¶ Returns a list of focus plates at the given position
Signature
FindFocusPlates(origin, normal, frontProximity, backProximity)Parameters: - origin (
NXOpen.Point3d) – - normal (
NXOpen.Vector3d) – - frontProximity (float) –
- backProximity (float) –
Returns: Return type: list of
NXOpen.NXObjectNew in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
- origin (
Validate¶
-
SectionEditorBuilder.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.