ShipTrimBodyBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
ShipTrimBodyBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Features.ShipDesign.ShipTrimBodyBuilder
.This class is used to create or edit a
NXOpen.Features.ShipDesign.ShipTrimBody
feature.To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateShipTrimBodyBuilder()
Default values.
Property Value BuiltUpOffset.FlangeAngle.Value 0 BuiltUpOffset.FlangeOffset.Value 0 (millimeters part), 0 (inches part) BuiltUpOffset.WebAngle.Value 0 BuiltUpOffset.WebOffset.Value 0 (millimeters part), 0 (inches part) New in version NX9.0.1.
Properties¶
Property | Description |
---|---|
ApplyEndCut | Returns or sets the indication of whether end cuts should be applied to the profiles. |
BuiltUpOffset | Returns the builder used to define the offsets for a built-up trim. |
ReverseDirection | Returns or sets the indication whether the default direction of split should be reversed. |
SplitDirectionOption | Returns or sets the split direction method being used to construct the splitting sheet body. |
Tag | Returns the Tag for this object. |
TargetBody | Returns the profile or plate solid bodies that are being split. |
ToolCurves | Returns the curve(s) used to construct the sheet body when ToolOption is NXOpen.Features.ShipDesign.SplitProfilePlateBuilderToolOptionType.Extrude . |
ToolFaces | Returns the datum or face(s) used to construct the sheet body when ToolOption is NXOpen.Features.ShipDesign.SplitProfilePlateBuilderToolOptionType.Plane . |
ToolOption | Returns or sets the tool type method that indicates which kind of tools will be used to construct the splitting sheet body. |
ToolVector | Returns or sets the vector defining the direction to extrude the curves to construct the sheet body when ToolOption is NXOpen.Features.ShipDesign.SplitProfilePlateBuilderToolOptionType.Extrude . |
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. |
Property Detail¶
ApplyEndCut¶
-
ShipTrimBodyBuilder.
ApplyEndCut
¶ Returns or sets the indication of whether end cuts should be applied to the profiles.
-------------------------------------
Getter Method
Signature
ApplyEndCut
Returns: Return type: bool New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------
Setter Method
Signature
ApplyEndCut
Parameters: applyEndCut (bool) – New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
BuiltUpOffset¶
-
ShipTrimBodyBuilder.
BuiltUpOffset
¶ Returns the builder used to define the offsets for a built-up trim.
-------------------------------------
Getter Method
Signature
BuiltUpOffset
Returns: Return type: NXOpen.Features.ShipDesign.BuiltUpOffsetBuilder
New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
ReverseDirection¶
-
ShipTrimBodyBuilder.
ReverseDirection
¶ Returns or sets the indication whether the default direction of split should be reversed.
-------------------------------------
Getter Method
Signature
ReverseDirection
Returns: Return type: bool New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------
Setter Method
Signature
ReverseDirection
Parameters: reverseDirection (bool) – New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
SplitDirectionOption¶
-
ShipTrimBodyBuilder.
SplitDirectionOption
¶ Returns or sets the split direction method being used to construct the splitting sheet body.
-------------------------------------
Getter Method
Signature
SplitDirectionOption
Returns: Return type: NXOpen.Features.ShipDesign.SplitProfilePlateBuilderSplitDirectionOptionType
New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------
Setter Method
Signature
SplitDirectionOption
Parameters: splitDirectionOption ( NXOpen.Features.ShipDesign.SplitProfilePlateBuilderSplitDirectionOptionType
) –New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
TargetBody¶
-
ShipTrimBodyBuilder.
TargetBody
¶ Returns the profile or plate solid bodies that are being split.
-------------------------------------
Getter Method
Signature
TargetBody
Returns: Return type: NXOpen.SelectNXObject
New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
ToolCurves¶
-
ShipTrimBodyBuilder.
ToolCurves
¶ Returns the curve(s) used to construct the sheet body when ToolOption is
NXOpen.Features.ShipDesign.SplitProfilePlateBuilderToolOptionType.Extrude
.-------------------------------------
Getter Method
Signature
ToolCurves
Returns: Curve only. Return type: NXOpen.SelectNXObjectList
New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
ToolFaces¶
-
ShipTrimBodyBuilder.
ToolFaces
¶ Returns the datum or face(s) used to construct the sheet body when ToolOption is
NXOpen.Features.ShipDesign.SplitProfilePlateBuilderToolOptionType.Plane
.-------------------------------------
Getter Method
Signature
ToolFaces
Returns: Face only. Return type: NXOpen.SelectNXObjectList
New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
ToolOption¶
-
ShipTrimBodyBuilder.
ToolOption
¶ Returns or sets the tool type method that indicates which kind of tools will be used to construct the splitting sheet body.
-------------------------------------
Getter Method
Signature
ToolOption
Returns: Return type: NXOpen.Features.ShipDesign.SplitProfilePlateBuilderToolOptionType
New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------
Setter Method
Signature
ToolOption
Parameters: toolOption ( NXOpen.Features.ShipDesign.SplitProfilePlateBuilderToolOptionType
) –New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
ToolVector¶
-
ShipTrimBodyBuilder.
ToolVector
¶ Returns or sets the vector defining the direction to extrude the curves to construct the sheet body when ToolOption is
NXOpen.Features.ShipDesign.SplitProfilePlateBuilderToolOptionType.Extrude
.-------------------------------------
Getter Method
Signature
ToolVector
Returns: Return type: NXOpen.Direction
New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
-------------------------------------
Setter Method
Signature
ToolVector
Parameters: toolVector ( NXOpen.Direction
) –New in version NX9.0.1.
License requirements: nx_ship_detail (“Ship Detail Design”)
Method Detail¶
Validate¶
-
ShipTrimBodyBuilder.
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.