EdgeCutBuilder Class

class NXOpen.Features.ShipDesign.EdgeCutBuilder

Bases: NXOpen.Features.FeatureBuilder

Represents a NXOpen.Features.ShipDesign.EdgeCut builder.

The Edge Cut creates a series of cuts with an offset from an edge or curve.

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

Default values.

Property Value
CutCount 0
CutOrientationAngle.Value 0
GuideOffset.Value 50 (millimeters part), 2 (inches part)
SpaceBetweenCuts.Value 50 (millimeters part), 2 (inches part)
Spacing EvenDistribution
SymmetricOffsets 0

New in version NX8.5.0.

Properties

Property Description
CutCount Returns or sets the number of cuts
CutOrientationAngle Returns the cut orientation angle.
EndPositionOnGuide Returns the offset from the end of the guide curve (or end trim object) where cut placement will end.
GuideCurve Returns the guide curve used to place the cuts (may be made up of edges or curves).
GuideOffset Returns the guide offset (how far away to place the cuts from the guide curve)
HorizontalReference Returns or sets the horizontal reference.
ManufacturingInformation Returns the manufacturing stock builder that holds the manufacturing data.
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
PathGeometry Returns the path geometry.
PathReverseDirection Returns or sets the path reverse direction flag.
PlacementGeometry Returns the placement geometry.
ReferenceDirection Returns or sets the reference direction
ReferencePoint Returns or sets the reference point (part units)
SelectEndLimit Returns the select end limit.
SelectStartLimit Returns the select start limit.
SelectTargetFace Returns the select target face.
SketchBlock Returns the sketch block.
SpaceBetweenCuts Returns the distance between each cut.
Spacing Returns or sets the spacing (even distribution or custom defined)
SpacingReference Returns or sets the spacing reference direction.
StartPositionOnGuide Returns the offset from the start of the guide curve (or start trim object) where cut placement will begin
SurroundingPatchSurfaceFilename Returns or sets the surrounding patch surface filename
SymmetricOffsets Returns or sets the symmetric offsets toggle.
Tag Returns the Tag for this object.
Version Returns the version of the feature (used to determine which properties and methods are applicable) during edit.

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

EdgeCutBuilderArraySpacing Enumeration available methods used to define the spacing between the cuts
EdgeCutBuilderVersionID Enumeration version identifiers for the different revisions of the edge cut feature.

Property Detail

CutCount

EdgeCutBuilder.CutCount

Returns or sets the number of cuts

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

Getter Method

Signature CutCount

Returns:
Return type:int

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature CutCount

Parameters:cutCount (int) –

New in version NX8.5.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

CutOrientationAngle

EdgeCutBuilder.CutOrientationAngle

Returns the cut orientation angle.

Typically the x axis of the cut’s cross section sketch is parallel to the guide curve, the orientation angle rotates the sketch away from the guide curve

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

Getter Method

Signature CutOrientationAngle

Returns:
Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

EndPositionOnGuide

EdgeCutBuilder.EndPositionOnGuide

Returns the offset from the end of the guide curve (or end trim object) where cut placement will end.

Note if the spacing is set to CustomDefined, you won’t notice the end trim getting used, unless you try to place too many cuts between along the guide (including any trim objects and offsets added by the Start and End positions on the guide).

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

Getter Method

Signature EndPositionOnGuide

Returns:
Return type:NXOpen.GeometricUtilities.OnPathDimensionBuilder

New in version NX8.5.0.

License requirements: None.

GuideCurve

EdgeCutBuilder.GuideCurve

Returns the guide curve used to place the cuts (may be made up of edges or curves).

NOTE this is only used on features that were created prior to NX901. If editing a feature created in NX9.0.1 or beyond, use the path geometry property instead.

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

Getter Method

Signature GuideCurve

Returns:
Return type:NXOpen.Section

New in version NX8.5.0.

License requirements: None.

GuideOffset

EdgeCutBuilder.GuideOffset

Returns the guide offset (how far away to place the cuts from the guide curve)

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

Getter Method

Signature GuideOffset

Returns:
Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

HorizontalReference

EdgeCutBuilder.HorizontalReference

Returns or sets the horizontal reference.

The horizontal reference is optional. It is used to orient the cuts. If null, the guide tangent is used for the orientation reference at each cut.

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

Getter Method

Signature HorizontalReference

Returns:
Return type:NXOpen.Direction

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature HorizontalReference

Parameters:horizontalReference (NXOpen.Direction) –

New in version NX12.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

ManufacturingInformation

EdgeCutBuilder.ManufacturingInformation

Returns the manufacturing stock builder that holds the manufacturing data.

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

Getter Method

Signature ManufacturingInformation

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

New in version NX8.5.1.

License requirements: None.

PathGeometry

EdgeCutBuilder.PathGeometry

Returns the path geometry.

NOTE this is only used on features that were created in NX901 or later. If editing a feature created before NX9.0.1, use the guide curve property instead.

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

Getter Method

Signature PathGeometry

Returns:
Return type:NXOpen.SelectTaggedObjectList

New in version NX9.0.1.

License requirements: None.

PathReverseDirection

EdgeCutBuilder.PathReverseDirection

Returns or sets the path reverse direction flag.

NOTE this is only used on features that were created in NX901 or later.

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

Getter Method

Signature PathReverseDirection

Returns:
Return type:bool

New in version NX9.0.1.

License requirements: None.

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

Setter Method

Signature PathReverseDirection

Parameters:pathReverseDirection (bool) –

New in version NX9.0.1.

License requirements: nx_ship_detail (“Ship Detail Design”)

PlacementGeometry

EdgeCutBuilder.PlacementGeometry

Returns the placement geometry.

NOTE this is only used on features that were created in NX901 or later. If editing a feature created before NX9.0.1, use the select target face property instead.

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

Getter Method

Signature PlacementGeometry

Returns:
Return type:NXOpen.SelectDisplayableObjectList

New in version NX9.0.1.

License requirements: None.

ReferenceDirection

EdgeCutBuilder.ReferenceDirection

Returns or sets the reference direction

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

Getter Method

Signature ReferenceDirection

Returns:
Return type:NXOpen.Vector3d

New in version NX9.0.1.

License requirements: None.

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

Setter Method

Signature ReferenceDirection

Parameters:referenceDirection (NXOpen.Vector3d) –

New in version NX9.0.1.

License requirements: nx_ship_detail (“Ship Detail Design”)

ReferencePoint

EdgeCutBuilder.ReferencePoint

Returns or sets the reference point (part units)

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

Getter Method

Signature ReferencePoint

Returns:
Return type:NXOpen.Point3d

New in version NX9.0.1.

License requirements: None.

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

Setter Method

Signature ReferencePoint

Parameters:referencePoint (NXOpen.Point3d) –

New in version NX9.0.1.

License requirements: nx_ship_detail (“Ship Detail Design”)

SelectEndLimit

EdgeCutBuilder.SelectEndLimit

Returns the select end limit.

The end limit is used to trim the end of the guide curve. Note if the spacing is set to CustomDefined, you won’t notice the end trim getting used, unless you try to place too many cuts between the start and end trim (including any offsets added by the Start and End positions on the guide). NOTE features created before NX9.0.1 could use solid edges, lines, circles, splines, spcurves, datum planes, and planar faces as a limit object. Any feature created in NX9.0.1 or beyond can use any of those limit objects as well as non-planar faces.

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

Getter Method

Signature SelectEndLimit

Returns:
Return type:NXOpen.SelectNXObject

New in version NX8.5.0.

License requirements: None.

SelectStartLimit

EdgeCutBuilder.SelectStartLimit

Returns the select start limit.

The start limit is used to trim the start of the guide curve. NOTE features created before NX9.0.1 could use solid edges, lines, circles, splines, spcurves, datum planes, and planar faces as a limit object. Any feature created in NX9.0.1 or beyond can use any of those limit objects as well as non-planar faces.

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

Getter Method

Signature SelectStartLimit

Returns:
Return type:NXOpen.SelectNXObject

New in version NX8.5.0.

License requirements: None.

SelectTargetFace

EdgeCutBuilder.SelectTargetFace

Returns the select target face.

NOTE this is only used on features that were created prior to NX901. If editing a feature created in NX9.0.1 or beyond, use the placement geometry property instead.

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

Getter Method

Signature SelectTargetFace

Returns:
Return type:NXOpen.SelectFaceList

New in version NX8.5.0.

License requirements: None.

SketchBlock

EdgeCutBuilder.SketchBlock

Returns the sketch block.

Users can specify the hole shape using a single sketch. The sketch type and its parameters are controlled by the NXOpen.Features.ShipDesign.SteelFeatureSpreadsheetBuilder.

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

Getter Method

Signature SketchBlock

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

New in version NX8.5.0.

License requirements: None.

SpaceBetweenCuts

EdgeCutBuilder.SpaceBetweenCuts

Returns the distance between each cut.

Note this is ignored if spacing is set to equal spacing.

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

Getter Method

Signature SpaceBetweenCuts

Returns:
Return type:NXOpen.Expression

New in version NX8.5.0.

License requirements: None.

Spacing

EdgeCutBuilder.Spacing

Returns or sets the spacing (even distribution or custom defined)

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

Getter Method

Signature Spacing

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

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature Spacing

Parameters:spacing (NXOpen.Features.ShipDesign.EdgeCutBuilderArraySpacing) –

New in version NX8.5.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

SpacingReference

EdgeCutBuilder.SpacingReference

Returns or sets the spacing reference direction.

The spacing reference direction is optional. It is used to measure the space between cuts in a linear distance. If null, the spacing is measured via arc length along the guide.

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

Getter Method

Signature SpacingReference

Returns:
Return type:NXOpen.Direction

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature SpacingReference

Parameters:spacingReference (NXOpen.Direction) –

New in version NX12.0.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

StartPositionOnGuide

EdgeCutBuilder.StartPositionOnGuide

Returns the offset from the start of the guide curve (or start trim object) where cut placement will begin

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

Getter Method

Signature StartPositionOnGuide

Returns:
Return type:NXOpen.GeometricUtilities.OnPathDimensionBuilder

New in version NX8.5.0.

License requirements: None.

SymmetricOffsets

EdgeCutBuilder.SymmetricOffsets

Returns or sets the symmetric offsets toggle.

Note this is ignored if spacing is set to custom defined. When symmetric offsets are used, the length of the guide is divided by the number of cuts to define the space between cuts, and half of the distance between each cut is applied as a start and end offset along the guide.

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

Getter Method

Signature SymmetricOffsets

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature SymmetricOffsets

Parameters:symmetricOffsets (bool) –

New in version NX8.5.0.

License requirements: nx_ship_detail (“Ship Detail Design”)

Version

EdgeCutBuilder.Version

Returns the version of the feature (used to determine which properties and methods are applicable) during edit.

The version of new features during create will be NX901

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

Getter Method

Signature Version

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

New in version NX9.0.1.

License requirements: None.

Method Detail

Validate

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