ShipCutoutBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
ShipCutoutBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.ShipDesign.ShipCutout
builderTo create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateShipCutoutBuilder()
Default values.
Property Value SketchBlock.Exp1.Value 0 SketchBlock.Exp10.Value 0 SketchBlock.Exp11.Value 0 SketchBlock.Exp12.Value 0 SketchBlock.Exp2.Value 0 SketchBlock.Exp3.Value 0 SketchBlock.Exp4.Value 0 SketchBlock.Exp5.Value 0 SketchBlock.Exp6.Value 0 SketchBlock.Exp7.Value 0 SketchBlock.Exp8.Value 0 SketchBlock.Exp9.Value 0 SketchBlock.Sketches EndCut1 New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
AngularDim | Returns the angular dimension used to rotate the cutout’s profile The angular dimension is only used for the Face2Lines placement method. |
CoordSystem | Returns or sets the placement CSYS of the cutout. |
KeepCoordSystem | Returns or sets the keep coordinate system A toggle used to remember the selected object on apply. |
KeepReverseDirection1 | Returns or sets the toggle which allows re-use of the previous reverse direction toggle. |
KeepReverseDirection2 | Returns or sets the toggle which allows re-use of the previous reverse direction toggle. |
KeepSelectCSYSFace | Returns or sets the keep select csys face A toggle used to remember the selected object on apply. |
KeepSelectLine1 | Returns or sets the keep select line1 A toggle used to remember the selected object on apply. |
KeepSelectLine2 | Returns or sets the keep select line2 A toggle used to remember the selected object on apply. |
KeepSelectTargetFace | Returns or sets the keep select target face A toggle used to remember the selected object on apply. |
LinearOffset1 | Returns the linear offset distance from line1. |
LinearOffset2 | Returns the linear offset distance from line2. |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PatchSolutionFlag | Returns or sets the patch solution flag |
PatchSurfaceFilename | Returns or sets the patch surface filename |
PlacementType | Returns or sets the placement type. |
ReverseDirection1 | Returns or sets the reverse direction 1. |
ReverseDirection2 | Returns or sets the reverse direction 2. |
SelectCSYSFace | Returns the selection object for the target face. |
SelectLine1 | Returns the select Line1. |
SelectLine2 | Returns the select Line2 This line 2 is only used for the Face2Lines placement method. |
SelectTargetFace | Returns the select Target Face. |
SketchBlock | Returns the library sketch block that defines the Cutout outline |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature |
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. |
GetFeature | Returns the feature currently being edited by this builder. |
GetObject | Returns the object currently being edited by this builder. |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ShipCutoutBuilderCreationMethod Enumeration | available methods used to place a cutout object |
Property Detail¶
AngularDim¶
-
ShipCutoutBuilder.
AngularDim
¶ Returns the angular dimension used to rotate the cutout’s profile The angular dimension is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
AngularDim
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
CoordSystem¶
-
ShipCutoutBuilder.
CoordSystem
¶ Returns or sets the placement CSYS of the cutout.
The coordinate system is only used for the SpecifyCSYS placement method.
-------------------------------------
Getter Method
Signature
CoordSystem
Returns: Return type: NXOpen.CoordinateSystem
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoordSystem
Parameters: coordSystem ( NXOpen.CoordinateSystem
) –New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
KeepCoordSystem¶
-
ShipCutoutBuilder.
KeepCoordSystem
¶ Returns or sets the keep coordinate system A toggle used to remember the selected object on apply.
The keep coordinate system is only used for the SpecifyCSYS placement method.
-------------------------------------
Getter Method
Signature
KeepCoordSystem
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeepCoordSystem
Parameters: keepCoordSystem (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
KeepReverseDirection1¶
-
ShipCutoutBuilder.
KeepReverseDirection1
¶ Returns or sets the toggle which allows re-use of the previous reverse direction toggle.
This is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
KeepReverseDirection1
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeepReverseDirection1
Parameters: keepReverseDirection1 (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
KeepReverseDirection2¶
-
ShipCutoutBuilder.
KeepReverseDirection2
¶ Returns or sets the toggle which allows re-use of the previous reverse direction toggle.
This is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
KeepReverseDirection2
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeepReverseDirection2
Parameters: keepReverseDirection2 (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
KeepSelectCSYSFace¶
-
ShipCutoutBuilder.
KeepSelectCSYSFace
¶ Returns or sets the keep select csys face A toggle used to remember the selected object on apply.
The keep select csys face is only used for the SpecifyCSYS placement method.
-------------------------------------
Getter Method
Signature
KeepSelectCSYSFace
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeepSelectCSYSFace
Parameters: keepSelectCSYSFace (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
KeepSelectLine1¶
-
ShipCutoutBuilder.
KeepSelectLine1
¶ Returns or sets the keep select line1 A toggle used to remember the selected object on apply.
The keep select line1 is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
KeepSelectLine1
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeepSelectLine1
Parameters: keepSelectLine1 (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
KeepSelectLine2¶
-
ShipCutoutBuilder.
KeepSelectLine2
¶ Returns or sets the keep select line2 A toggle used to remember the selected object on apply.
The keep select line2 is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
KeepSelectLine2
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeepSelectLine2
Parameters: keepSelectLine2 (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
KeepSelectTargetFace¶
-
ShipCutoutBuilder.
KeepSelectTargetFace
¶ Returns or sets the keep select target face A toggle used to remember the selected object on apply.
The keep select target face is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
KeepSelectTargetFace
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
KeepSelectTargetFace
Parameters: keepSelectTargetFace (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
LinearOffset1¶
-
ShipCutoutBuilder.
LinearOffset1
¶ Returns the linear offset distance from line1.
The linear offset 1 is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
LinearOffset1
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
LinearOffset2¶
-
ShipCutoutBuilder.
LinearOffset2
¶ Returns the linear offset distance from line2.
The linear offset 2 is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
LinearOffset2
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
PlacementType¶
-
ShipCutoutBuilder.
PlacementType
¶ Returns or sets the placement type.
The creation method used to place the cutout object.
-------------------------------------
Getter Method
Signature
PlacementType
Returns: Return type: NXOpen.Features.ShipDesign.ShipCutoutBuilderCreationMethod
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PlacementType
Parameters: placementType ( NXOpen.Features.ShipDesign.ShipCutoutBuilderCreationMethod
) –New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
ReverseDirection1¶
-
ShipCutoutBuilder.
ReverseDirection1
¶ Returns or sets the reverse direction 1.
Allows you to reverse the direction used in the linear offset 1. The reverse direction 1 is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
ReverseDirection1
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseDirection1
Parameters: reverseDirection1 (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
ReverseDirection2¶
-
ShipCutoutBuilder.
ReverseDirection2
¶ Returns or sets the reverse direction 2.
Allows you to reverse the direction used in the linear offset 2. The reverse direction 2 is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
ReverseDirection2
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseDirection2
Parameters: reverseDirection2 (bool) – New in version NX7.5.0.
License requirements: nx_ship_concept (“Ship Concept”)
SelectCSYSFace¶
-
ShipCutoutBuilder.
SelectCSYSFace
¶ Returns the selection object for the target face.
This target CSYS face is only used for the SpecifyCSYS placement method.
-------------------------------------
Getter Method
Signature
SelectCSYSFace
Returns: Return type: NXOpen.SelectFace
New in version NX7.5.0.
License requirements: None.
SelectLine1¶
-
ShipCutoutBuilder.
SelectLine1
¶ Returns the select Line1.
This line 1 is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
SelectLine1
Returns: Return type: NXOpen.SelectNXObject
New in version NX7.5.0.
License requirements: None.
SelectLine2¶
-
ShipCutoutBuilder.
SelectLine2
¶ Returns the select Line2 This line 2 is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
SelectLine2
Returns: Return type: NXOpen.SelectNXObject
New in version NX7.5.0.
License requirements: None.
SelectTargetFace¶
-
ShipCutoutBuilder.
SelectTargetFace
¶ Returns the select Target Face.
This target face is only used for the Face2Lines placement method.
-------------------------------------
Getter Method
Signature
SelectTargetFace
Returns: Return type: NXOpen.SelectNXObject
New in version NX7.5.0.
License requirements: None.
SketchBlock¶
-
ShipCutoutBuilder.
SketchBlock
¶ Returns the library sketch block that defines the Cutout outline
-------------------------------------
Getter Method
Signature
SketchBlock
Returns: Return type: NXOpen.SketchExpressionModifierBuilder
New in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
ShipCutoutBuilder.
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.