PlateBuilder Class

class NXOpen.Features.ShipDesign.PlateBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a NXOpen.Features.ShipDesign.Plate builder.

This builder is used to create and edit ship plate feature. The plate feature can be created from construction curves, boundary faces or planes. And also a solid body cab be adopted as a plate.

To create a new instance of this class, use NXOpen.Features.ShipCollection.CreatePlateBuilder()

Default values.

Property	Value
DistanceTolerance	0.0254 (millimeters part), 0.001 (inches part)
MoldFaceOffset.Value	0 (millimeters part), 0 (inches part)
PlateStock.KnuckleRatio	3.0
PlateStock.KnuckleSmoothAngle	3.0
PlateStock.MaterialOption	0
PlateStock.OppositeThickness.Value	0 (millimeters part), 0 (inches part)
PlateStock.RestrictThicknessToMaterial	true
PlateStock.ThickenOption	SingleSided
PlateStock.Thickness.Value	10 (millimeters part), 0.5 (inches part)
PlateStock.ThicknessSourceOption	List
RegionOption	OutsideBody
Tightness	NonTight

New in version NX8.0.0.

Properties

Property	Description
AdoptionBodies	Returns the adoption bodies, which are used to create multiple plates.
AdoptionBodiesMoldFace	Returns the mold face of adoption bodies.
BodyBoundary	Returns the body boundary, which can be mixed with curve, face and plane to define the plate boundary.
CurveBoundary	Returns the curve boundary, which can be a single region or multiple regions.
DistanceTolerance	Returns or sets the distance tolerance.
FacePlaneBoundary	Returns the face, plane boundary, which defines a list of trimming objects with offset values.
FlipDirection	Returns or sets the flip direction, which can change the plate thickness direction.
MergeRegions	Returns the multiple regions to merge together as plate body.
MoldFace	Returns the mold face, which is used to create the plate body and define the plate placement.
MoldFaceOffset	Returns the mold face offset, which defines an offset distance to the mold face.
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
PlateBoundaryOptionList	Returns the build boundary option builder list
PlateStock	Returns the plate stock builder, which defines the plate material, grade, thickness, mass density, thicken option and opposite thickness.
ProjectDirection	Returns the project direction, which is used to project the boundary curves to the plate mold face.
RegionOption	Returns or sets the region option, which defines the plate areas in case of body faces as plate boundary.
RegionPoint	Returns or sets the region point, which is used to identify the plate region.
Regions	Returns the regions to create plates
ShipNames	Returns the ship name builder.
SplitKnuckleEdges	Returns the split knuckle edges, which are used to split a plate into separate knuckle parts.
SurroundingPatchSurfaceFilename	Returns or sets the surrounding patch surface filename
Tag	Returns the Tag for this object.
Tightness	Returns or sets the tightness, which defines the plate is tight (air tight, oil tight, water tight) or non tight.
Type	Returns or sets the plate type, which is creation or adoption.

Methods

Method	Description
AddMergeRegionPoint	Adds a merge region point.
AddRegionPoint	Adds a region point.
Commit	Commits any edits that have been applied to the builder.
CommitFeature	Commits the feature parameters and creates the feature
CreatePlateBoundaryOptionBuilder	Creates a NXOpen.Features.ShipDesign.PlateBoundaryOptionBuilder
CreateRegions	Creates regions to output the selected plates.
DeleteRegions	Deletes regions
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.
GetMultipleRegionPoints	Gets multiple region points.
GetObject	Returns the object currently being edited by this builder.
GetPlateBoundaryTrimType	Gets plate boundary trim type
GetShowMigratedBody	Gets the show migrated body flag.
HideInternalParentFeatureAfterEdit	Re-suppress an internal parent feature (a slave feature) after it has been edited.
MapRegionToRegionPoint	Maps the user selected plate region to a region point.
RemoveAllRegionPoints	Removes all region points.
RemoveMergeRegionPoint	Removes a merge region point.
RemoveRegionPoint	Removes a region point.
SetKnuckleEdges	Sets the knuckle edges, which include 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
SetPlateBoundaryTrimType	Sets plate boundary trim type
SetShowMigratedBody	Sets the show migrated body flag.
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

PlateBuilderBodyTypes Enumeration	Settings to indicate the plate output body type.
PlateBuilderRegionOptions Enumeration	Settings to indicate what areas to create the plate when using body faces as boundaries.
PlateBuilderTightnessOptions Enumeration	Settings to indicate what tightness to create the plate.
PlateBuilderTypes Enumeration	Settings to indicate how the plate is generated.

Property Detail

AdoptionBodies

PlateBuilder.AdoptionBodies

Returns the adoption bodies, which are used to create multiple plates.

Each plate has a single body.

-------------------------------------

Getter Method

Signature AdoptionBodies

Returns: Return type:NXOpen.SelectBodyList

New in version NX8.0.0.

License requirements: None.

AdoptionBodiesMoldFace

PlateBuilder.AdoptionBodiesMoldFace

Returns the mold face of adoption bodies.

-------------------------------------

Getter Method

Signature AdoptionBodiesMoldFace

Returns: Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

BodyBoundary

PlateBuilder.BodyBoundary

Returns the body boundary, which can be mixed with curve, face and plane to define the plate boundary.

-------------------------------------

Getter Method

Signature BodyBoundary

Returns: Return type:NXOpen.SelectBodyList

New in version NX8.0.0.

License requirements: None.

CurveBoundary

PlateBuilder.CurveBoundary

Returns the curve boundary, which can be a single region or multiple regions.

In case of multiple regions, it creates multiple plates.

-------------------------------------

Getter Method

Signature CurveBoundary

Returns: Return type:NXOpen.Section

New in version NX8.0.0.

License requirements: None.

DistanceTolerance

PlateBuilder.DistanceTolerance

Returns or sets the distance tolerance.

-------------------------------------

Getter Method

Signature DistanceTolerance

Returns: Return type:float

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DistanceTolerance

Parameters:distanceTolerance (float) –

New in version NX8.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

FacePlaneBoundary

PlateBuilder.FacePlaneBoundary

Returns the face, plane boundary, which defines a list of trimming objects with offset values.

-------------------------------------

Getter Method

Signature FacePlaneBoundary

Returns: Return type:NXOpen.ExpressionCollectorSetList

New in version NX8.0.0.

License requirements: None.

FlipDirection

PlateBuilder.FlipDirection

Returns or sets the flip direction, which can change the plate thickness direction.

-------------------------------------

Getter Method

Signature FlipDirection

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FlipDirection

Parameters:flipDirection (bool) –

New in version NX8.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

MergeRegions

PlateBuilder.MergeRegions

Returns the multiple regions to merge together as plate body.

-------------------------------------

Getter Method

Signature MergeRegions

Returns: Return type:NXOpen.SelectBodyList

New in version NX12.0.0.

License requirements: None.

MoldFace

PlateBuilder.MoldFace

Returns the mold face, which is used to create the plate body and define the plate placement.

-------------------------------------

Getter Method

Signature MoldFace

Returns: Return type:NXOpen.ScCollector

New in version NX8.0.0.

License requirements: None.

MoldFaceOffset

PlateBuilder.MoldFaceOffset

Returns the mold face offset, which defines an offset distance to the mold face.

-------------------------------------

Getter Method

Signature MoldFaceOffset

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

PlateBoundaryOptionList

PlateBuilder.PlateBoundaryOptionList

Returns the build boundary option builder list

-------------------------------------

Getter Method

Signature PlateBoundaryOptionList

Returns: Return type:NXOpen.Features.ShipDesign.PlateBoundaryOptionBuilderList

New in version NX11.0.0.

License requirements: None.

PlateStock

PlateBuilder.PlateStock

Returns the plate stock builder, which defines the plate material, grade, thickness, mass density, thicken option and opposite thickness.

-------------------------------------

Getter Method

Signature PlateStock

Returns:Plate Stock Builder Return type:NXOpen.Features.ShipDesign.PlateStockBuilder

New in version NX8.0.0.

License requirements: None.

ProjectDirection

PlateBuilder.ProjectDirection

Returns the project direction, which is used to project the boundary curves to the plate mold face.

-------------------------------------

Getter Method

Signature ProjectDirection

Returns:Projection Options data Return type:NXOpen.GeometricUtilities.ProjectionOptions

New in version NX8.0.0.

License requirements: None.

RegionOption

PlateBuilder.RegionOption

Returns or sets the region option, which defines the plate areas in case of body faces as plate boundary.

-------------------------------------

Getter Method

Signature RegionOption

Returns: Return type:NXOpen.Features.ShipDesign.PlateBuilderRegionOptions

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RegionOption

Parameters:regionOption (NXOpen.Features.ShipDesign.PlateBuilderRegionOptions) –

New in version NX8.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

RegionPoint

PlateBuilder.RegionPoint

Returns or sets the region point, which is used to identify the plate region.

-------------------------------------

Getter Method

Signature RegionPoint

Returns: Return type:NXOpen.Point3d

New in version NX9.0.3.

License requirements: None.

-------------------------------------

Setter Method

Signature RegionPoint

Parameters:regionPoint (NXOpen.Point3d) –

New in version NX9.0.3.

License requirements: nx_ship_detail (“Ship Detail Design”)

Regions

PlateBuilder.Regions

Returns the regions to create plates

-------------------------------------

Getter Method

Signature Regions

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX8.0.0.

License requirements: None.

ShipNames

PlateBuilder.ShipNames

Returns the ship name builder.

The ship name builder is used to construct the part name of the structure.

-------------------------------------

Getter Method

Signature ShipNames

Returns: Return type:NXOpen.Features.ShipDesign.ShipNamesBuilder

New in version NX11.0.0.

License requirements: None.

SplitKnuckleEdges

PlateBuilder.SplitKnuckleEdges

Returns the split knuckle edges, which are used to split a plate into separate knuckle parts.

-------------------------------------

Getter Method

Signature SplitKnuckleEdges

Returns: Return type:NXOpen.SelectEdgeList

New in version NX9.0.0.

License requirements: None.

Tightness

PlateBuilder.Tightness

Returns or sets the tightness, which defines the plate is tight (air tight, oil tight, water tight) or non tight.

-------------------------------------

Getter Method

Signature Tightness

Returns: Return type:NXOpen.Features.ShipDesign.PlateBuilderTightnessOptions

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Tightness

Parameters:tightness (NXOpen.Features.ShipDesign.PlateBuilderTightnessOptions) –

New in version NX9.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

Type

PlateBuilder.Type

Returns or sets the plate type, which is creation or adoption.

-------------------------------------

Getter Method

Signature Type

Returns: Return type:NXOpen.Features.ShipDesign.PlateBuilderTypes

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Type

Parameters:type (NXOpen.Features.ShipDesign.PlateBuilderTypes) –

New in version NX8.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

Method Detail

AddMergeRegionPoint

PlateBuilder.AddMergeRegionPoint

Adds a merge region point.

If there are multiple region points, do a loop to add one by one.

Signature AddMergeRegionPoint(regionPoint)

Parameters:regionPoint (NXOpen.Point3d) –

New in version NX12.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

AddRegionPoint

PlateBuilder.AddRegionPoint

Adds a region point.

If there are multiple region points, do a loop to add one by one.

Signature AddRegionPoint(regionPoint)

Parameters:regionPoint (NXOpen.Point3d) –

New in version NX10.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

CreatePlateBoundaryOptionBuilder

PlateBuilder.CreatePlateBoundaryOptionBuilder

Creates a NXOpen.Features.ShipDesign.PlateBoundaryOptionBuilder

Signature CreatePlateBoundaryOptionBuilder()

Returns: Return type:NXOpen.Features.ShipDesign.PlateBoundaryOptionBuilder

New in version NX11.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

CreateRegions

PlateBuilder.CreateRegions

Creates regions to output the selected plates.

Signature CreateRegions()

Returns:Region Bodies Return type:list of NXOpen.Body

New in version NX8.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

DeleteRegions

PlateBuilder.DeleteRegions

Deletes regions

Signature DeleteRegions()

New in version NX8.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

GetMultipleRegionPoints

PlateBuilder.GetMultipleRegionPoints

Gets multiple region points.

Signature GetMultipleRegionPoints()

Returns: Return type:list of NXOpen.Point3d

New in version NX10.0.0.

License requirements: None.

GetPlateBoundaryTrimType

PlateBuilder.GetPlateBoundaryTrimType

Gets plate boundary trim type

Signature GetPlateBoundaryTrimType(nItem)

Parameters:nItem (int) – Returns: Return type:NXOpen.Features.ShipDesign.PlateBoundaryOptionBuilderTrimTypes

New in version NX11.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

GetShowMigratedBody

PlateBuilder.GetShowMigratedBody

Gets the show migrated body flag.

Reserved for administrator use only.

Signature GetShowMigratedBody()

Returns: Return type:bool

New in version NX8.5.3.

License requirements: None.

MapRegionToRegionPoint

PlateBuilder.MapRegionToRegionPoint

Maps the user selected plate region to a region point.

Signature MapRegionToRegionPoint(plateRegionString, regionPoint)

Parameters:

• plateRegionString (str) –
• regionPoint (NXOpen.Point3d) –

New in version NX10.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

RemoveAllRegionPoints

PlateBuilder.RemoveAllRegionPoints

Removes all region points.

Signature RemoveAllRegionPoints()

New in version NX10.0.0.

License requirements: None.

RemoveMergeRegionPoint

PlateBuilder.RemoveMergeRegionPoint

Removes a merge region point.

Signature RemoveMergeRegionPoint(regionPoint)

Parameters:regionPoint (NXOpen.Point3d) –

New in version NX12.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

RemoveRegionPoint

PlateBuilder.RemoveRegionPoint

Removes a region point.

Plate will find the region body by the input region point and remove the cached region point.

Signature RemoveRegionPoint(regionPoint)

Parameters:regionPoint (NXOpen.Point3d) –

New in version NX10.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

SetKnuckleEdges

PlateBuilder.SetKnuckleEdges

Sets the knuckle edges, which include edges for both bend and split types.

Signature SetKnuckleEdges(knuckleEdges)

Parameters:knuckleEdges (list of NXOpen.Edge) – G0 edges

New in version NX9.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

SetPlateBoundaryTrimType

PlateBuilder.SetPlateBoundaryTrimType

Sets plate boundary trim type

Signature SetPlateBoundaryTrimType(nItem, type)

Parameters:

• nItem (int) –
• type (NXOpen.Features.ShipDesign.PlateBoundaryOptionBuilderTrimTypes) –

New in version NX11.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

SetShowMigratedBody

PlateBuilder.SetShowMigratedBody

Sets the show migrated body flag.

Reserved for administrator use only.

Signature SetShowMigratedBody(showMigratedBody)

Parameters:showMigratedBody (bool) –

New in version NX8.5.3.

License requirements: nx_ship_detail (“Ship Detail Design”)

Validate

PlateBuilder.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.