ExpansionDrawingBuilder Class¶
-
class
NXOpen.Features.ShipDesign.ExpansionDrawingBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Features.ShipDesign.ExpansionDrawingBuilder.This class is used to create expansion drawing and just returns None
To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateExpansionDrawingBuilder()New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| AftPlane | Returns or sets the aft plane |
| BasePlane | Returns or sets the base plane |
| BasicDesignMode | Returns or sets the basic design application flag |
| DrawingTemplate | Returns the drawing template |
| EnglishScale | Returns or sets the English drawing scale |
| ForePlane | Returns or sets the fore plane |
| IsEdit | Returns or sets the flag to indicate to either create or edit a Ship Expansion View. |
| MetricScale | Returns or sets the Metric drawing scale |
| PlatesToExpand | Returns the plates to be expanded |
| ScaleDenominator | Returns or sets the denominator of a custom scale |
| ScaleNumerator | Returns or sets the numerator of a custom scale |
| Tag | Returns the Tag for this object. |
| Tolerance | Returns or sets the tolerance |
| UpperPlane | Returns or sets the upper plane |
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. |
| 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¶
| ExpansionDrawingBuilderJaExpansiondrawingbuilderEnglishScale Enumeration | the standard English drawing sheet scales |
| ExpansionDrawingBuilderJaExpansiondrawingbuilderMetricScale Enumeration | the standard Metric drawing sheet scales |
Property Detail¶
AftPlane¶
-
ExpansionDrawingBuilder.AftPlane¶ Returns or sets the aft plane
-------------------------------------Getter Method
Signature
AftPlaneReturns: Return type: NXOpen.PlaneNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AftPlaneParameters: aftPlane ( NXOpen.Plane) –New in version NX10.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
BasePlane¶
-
ExpansionDrawingBuilder.BasePlane¶ Returns or sets the base plane
-------------------------------------Getter Method
Signature
BasePlaneReturns: Return type: NXOpen.PlaneNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BasePlaneParameters: basePlane ( NXOpen.Plane) –New in version NX10.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
BasicDesignMode¶
-
ExpansionDrawingBuilder.BasicDesignMode¶ Returns or sets the basic design application flag
-------------------------------------Getter Method
Signature
BasicDesignModeReturns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BasicDesignModeParameters: isBasic (bool) – New in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
DrawingTemplate¶
-
ExpansionDrawingBuilder.DrawingTemplate¶ Returns the drawing template
-------------------------------------Getter Method
Signature
DrawingTemplateReturns: Return type: NXOpen.Features.ShipDesign.DrawingTemplateBuilderNew in version NX10.0.0.
License requirements: None.
EnglishScale¶
-
ExpansionDrawingBuilder.EnglishScale¶ Returns or sets the English drawing scale
-------------------------------------Getter Method
Signature
EnglishScaleReturns: the English drawing scale Return type: NXOpen.Features.ShipDesign.ExpansionDrawingBuilderJaExpansiondrawingbuilderEnglishScaleNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
EnglishScaleParameters: englishScale ( NXOpen.Features.ShipDesign.ExpansionDrawingBuilderJaExpansiondrawingbuilderEnglishScale) – the English drawing scaleNew in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
ForePlane¶
-
ExpansionDrawingBuilder.ForePlane¶ Returns or sets the fore plane
-------------------------------------Getter Method
Signature
ForePlaneReturns: Return type: NXOpen.PlaneNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ForePlaneParameters: forePlane ( NXOpen.Plane) –New in version NX10.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
IsEdit¶
-
ExpansionDrawingBuilder.IsEdit¶ Returns or sets the flag to indicate to either create or edit a Ship Expansion View.
-------------------------------------Getter Method
Signature
IsEditReturns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsEditParameters: isEdit (bool) – New in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
MetricScale¶
-
ExpansionDrawingBuilder.MetricScale¶ Returns or sets the Metric drawing scale
-------------------------------------Getter Method
Signature
MetricScaleReturns: the Metric drawing scale Return type: NXOpen.Features.ShipDesign.ExpansionDrawingBuilderJaExpansiondrawingbuilderMetricScaleNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MetricScaleParameters: metricScale ( NXOpen.Features.ShipDesign.ExpansionDrawingBuilderJaExpansiondrawingbuilderMetricScale) – the Metric drawing scaleNew in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
PlatesToExpand¶
-
ExpansionDrawingBuilder.PlatesToExpand¶ Returns the plates to be expanded
-------------------------------------Getter Method
Signature
PlatesToExpandReturns: Return type: NXOpen.SelectNXObjectListNew in version NX10.0.0.
License requirements: None.
ScaleDenominator¶
-
ExpansionDrawingBuilder.ScaleDenominator¶ Returns or sets the denominator of a custom scale
-------------------------------------Getter Method
Signature
ScaleDenominatorReturns: the denominator of a custom scale Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ScaleDenominatorParameters: scaleDenominator (float) – the denominator of a custom scale New in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
ScaleNumerator¶
-
ExpansionDrawingBuilder.ScaleNumerator¶ Returns or sets the numerator of a custom scale
-------------------------------------Getter Method
Signature
ScaleNumeratorReturns: the numerator of a custom scale Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ScaleNumeratorParameters: scaleNumerator (float) – New in version NX11.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
Tolerance¶
-
ExpansionDrawingBuilder.Tolerance¶ Returns or sets the tolerance
-------------------------------------Getter Method
Signature
ToleranceReturns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ToleranceParameters: tolerance (float) – New in version NX10.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
UpperPlane¶
-
ExpansionDrawingBuilder.UpperPlane¶ Returns or sets the upper plane
-------------------------------------Getter Method
Signature
UpperPlaneReturns: Return type: NXOpen.PlaneNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UpperPlaneParameters: upperPlane ( NXOpen.Plane) –New in version NX10.0.0.
License requirements: nx_ship_drafting (“Ship Drafting”)
Method Detail¶
Validate¶
-
ExpansionDrawingBuilder.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.