HullBuilder Class¶
-
class
NXOpen.Features.ShipDesign.
HullBuilder
¶ Bases:
NXOpen.Features.ShipDesign.PlateSystemBuilder
This class is used to create or edit a
NXOpen.Features.ShipDesign.Hull
feature.To create a new instance of this class, use
NXOpen.Features.ShipCollection.CreateHullBuilder()
Default values.
Property Value Offset.Value 0 (millimeters part), 0 (inches part) Primary FwdPortToInUp PrimaryOnReference FwdPortToInUp Secondary1 FwdPortToInUp Secondary1OnReference FwdPortToInUp Secondary2 FwdPortToInUp Secondary2OnReference FwdPortToInUp New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
AngleTolerance | Returns or sets the tolerance, in degrees, used to determine when angles are zero. |
BoundaryPlane | Returns or sets the plane defined to indicate the boundary of the plate system. |
BoundarySection | Returns the section containing curves that define the boundary of the plate system. |
BoundarySheets | Returns the sheet bodies or datum planes selected, or a face collector used to define the boundary of the plate system. |
Centerline | Returns or sets the plane representing the center line of the hull. |
DistanceTolerance | Returns or sets the tolerance used to determine when distances are considered zero. |
MoldFaceSheet | Returns the sheet body selected that defines the overall shape of the hull. |
MoldFaces | Returns the faces selected that defines the overall shape of the hull. |
Offset | Returns the offset to apply to the selected mold face to produce the desired mold face. |
OrientationAngleRule | Returns or sets the angle rule to use when measuring angles. |
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 |
Primary | Returns or sets the primary stiffener direction. |
PrimaryOnReference | Returns or sets the primary stiffener direction when the plate system is located on a midship reference. |
ProjectionDirection | Returns the direction used to project the boundary section curves onto the mold face. |
Regions | Returns the regions selected from the sheet, that has the inscribed boundaries, to keep for the final plate system shape. |
Secondary1 | Returns or sets the direction of the stiffener flange. |
Secondary1OnReference | Returns or sets the direction of the stiffener flange when the stiffener is located on a midship reference. |
Secondary2 | Returns or sets the direction of the stiffener flange. |
Secondary2OnReference | Returns or sets the direction of the stiffener flange when the stiffener is located on a midship reference. |
ShipNames | Returns the Ship Names builder, used to assign names to the Plate Systems created. |
SplitKnuckleEdges | Returns the split knuckle edges, which are used to create seam feature to split a plate system into plate subsystem. |
Stock | Returns the plate stock builder, used to define the plate material, grade, thickness, mass density, and thicken option. |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
ThicknessDirection | Returns the thickness direction builder, used to specify the thickness direction from the mold face. |
Tightness | Returns or sets the tightness desired for the plate system. |
Type | Returns or sets the method used to define the mold face of the hull. |
Weld | Returns the welding characteristics builder, used to assign welding characteristics to the outermost edges of a plate system. |
Methods¶
Method | Description |
---|---|
CleanUpTemporaryCurves | Cleans up the temp curves. |
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
CreatePlaneForList | Create a NXOpen.Features.ShipDesign.PlaneListBuilder to add a defined plane to a list. |
CreateRegionBody | Create the region body that has the inscribed boundaries. |
DeletePreviewBody | Deletes the preview body. |
DeleteRegionBody | Delete the current region body. |
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. |
SetKnuckleEdges | Sets the knuckle edges, which includes edges for both bend and split types. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
SetPreviewOption | Sets the preview option. |
SetRegionIndex | Sets the region index. |
SetRegionPoints | Set the points derived from the regions of the sheet, that has the inscribed boundaries, to keep for the final plate system shape. |
SetSplitEdgeUpdateFlag | Sets the flag to indicate that split knuckle edges are out of date and need to update. |
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¶
HullBuilderTypes Enumeration | Indicates the method that is being used to define the mold face of the hull. |
Property Detail¶
Centerline¶
-
HullBuilder.
Centerline
¶ Returns or sets the plane representing the center line of the hull.
This is optional, if not supplied the center line will considered to be the ship main dimensions Y = 0 plane.
-------------------------------------
Getter Method
Signature
Centerline()
Returns: Return type: NXOpen.Plane
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Centerline(offsetPlane)
Parameters: offsetPlane ( NXOpen.Plane
) –New in version NX11.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”)
MoldFaceSheet¶
-
HullBuilder.
MoldFaceSheet
¶ Returns the sheet body selected that defines the overall shape of the hull.
This is only used if the
NXOpen.Features.ShipDesign.HullBuilderTypes.SheetBody
is set.-------------------------------------
Getter Method
Signature
MoldFaceSheet()
Returns: Return type: NXOpen.SelectBody
New in version NX8.0.0.
License requirements: None.
MoldFaces¶
-
HullBuilder.
MoldFaces
¶ Returns the faces selected that defines the overall shape of the hull.
This is only used if the
NXOpen.Features.ShipDesign.HullBuilderTypes.Faces
is set.-------------------------------------
Getter Method
Signature
MoldFaces()
Returns: Return type: NXOpen.ScCollector
New in version NX8.0.0.
License requirements: None.
Type¶
-
HullBuilder.
Type
¶ Returns or sets the method used to define the mold face of the hull.
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Features.ShipDesign.HullBuilderTypes
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Features.ShipDesign.HullBuilderTypes
) –New in version NX8.0.0.
License requirements: nx_ship_basic (“Ship Basic Design”)
Method Detail¶
Validate¶
-
HullBuilder.
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.