ScrapDesignBuilder Class

class NXOpen.Tooling.ScrapDesignBuilder

Bases: NXOpen.Builder

Represents a scrap design builder

To create a new instance of this class, use NXOpen.Tooling.ScrapDesignCollection.CreateScrapDesignBuilder()

Default values.

Property Value
AddonOperation Overlap
ApplyColor 0
DefStationNum 1
DoubleA 0
DoubleAngle 0
DoubleB 0
DoubleH 0
DoubleR 0.2
EditMethod Split
EditStationNum 1
MinRad 0.1
OvercutOperation NormalType
OverlapWidth 0.1
PierceType Piercing
ProcessFive 0
ProcessFour 0
ProcessOne 0
ProcessThree 0
ProcessTwo 0
RemoveFilter InferScrap
ScrapPosition ProjectToStrip
ScrapTol 0.01
ScrapTypeEnum Create

New in version NX6.0.0.

Properties

Property Description
AddonOperation Returns or sets the add-on operation, which includes overlap, overcut, trimming and user defined
ApplyColor Returns or sets the toggle to determine whether the color will be used to all other scraps with the same shape
AssignColor Returns or sets the color for assigned scrap
AttachEdge Returns the edge that overlap will be attached
AttachScrap Returns the scrap that overlap will be attached
BoundaryList Returns the boundary list served for boundary line method
ChangeColScrap Returns the changing color of scrap
CurveList Returns the curve list served for boundary+sketch or close boundaries method
DefStationNum Returns or sets the defined station number, according to it scraps can be laid out automatically in strip
DoubleA Returns or sets the double A served as the parameter of overcut
DoubleAngle Returns or sets the double Angle served as the parameter of overcut
DoubleB Returns or sets the double B served as the parameter of overcut
DoubleH Returns or sets the double H served as the parameter of overcut
DoubleR Returns or sets the double R served as the parameter of overcut
EditMethod Returns or sets the edit method, which includes splitting, merging, applying minimum radius, changing station, deleting and updating
EditStationNum Returns or sets the station number to lay out in strip
ExistScrap Returns the existed scrap served for exist sheet body method
HoleColor Returns or sets the hole color
MinRad Returns or sets the minimum radius to blend sharp corners
OvercutColor Returns or sets the overcut color
OvercutEdge Returns the edge that overcut will be attached
OvercutOperation Returns or sets the overcut operation, which includes normal type, tangent type, circular type and rectangular type
OverlapColor Returns or sets the overlap color
OverlapWidth Returns or sets the overlap width
PierceType Returns or sets the piercing type, piercing or piloting
PiercingColor Returns or sets the piercing color
PilotingColor Returns or sets the piloting color
ProcessFive Returns or sets the process five
ProcessFour Returns or sets the process four
ProcessOne Returns or sets the process one
ProcessThree Returns or sets the process three
ProcessTwo Returns or sets the process two
RemoveFilter Returns or sets the removing filter
ScrapMethod Returns or sets the scrap method, which includes boundary+sketch, hole boundary, close curves, boundary lines and existed sheet body
ScrapPosition Returns or sets the scrap position
ScrapTol Returns or sets the scrap tolerance, when fail to create scrap in some cases, this value can be decreased to try again
ScrapTypeEnum Returns or sets the scrap type enum
SecondScrap Returns the second scrap to merge with the first one
SplitCurve Returns the splitting curve
SplitScrap Returns the scrap to be splitted or merged
Tag Returns the Tag for this object.
TrimNum Returns or sets the trimming number
TrimmingColor Returns or sets the trimming color
UserAddonCurve Returns the user defined add-on curve to create overlap+overcut

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.
GetOvercutPosition Returns the overcut position, it determines where the overcut sketch will be constrained
SetOvercutPosition Sets the overcut position, it determines where the overcut sketch will be constrained
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.

Enumerations

ScrapDesignBuilderAddonType Enumeration Specifies the add-on type
ScrapDesignBuilderBody Enumeration Specifies the operation type of scraps
ScrapDesignBuilderDefScrapType Enumeration Specifies the definition type of scraps
ScrapDesignBuilderEditScrapType Enumeration Specifies the edit type of scraps
ScrapDesignBuilderOvercutType Enumeration Specifies the over cut type, different type has different parameters
ScrapDesignBuilderRemoveType Enumeration Specifies the removing type as filter
ScrapDesignBuilderScrapDefPosition Enumeration Specifies the position method of scraps, projecting method is normally used
ScrapDesignBuilderScrapDefType Enumeration Specifies the creation type of scraps
ScrapDesignBuilderTrimNumType Enumeration Specifies the step of trimming process, the maximum is five

Property Detail

AddonOperation

ScrapDesignBuilder.AddonOperation

Returns or sets the add-on operation, which includes overlap, overcut, trimming and user defined

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

Getter Method

Signature AddonOperation

Returns:Indicates the add-on operation
Return type:NXOpen.Tooling.ScrapDesignBuilderAddonType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature AddonOperation

Parameters:addonOperation (NXOpen.Tooling.ScrapDesignBuilderAddonType) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ApplyColor

ScrapDesignBuilder.ApplyColor

Returns or sets the toggle to determine whether the color will be used to all other scraps with the same shape

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

Getter Method

Signature ApplyColor

Returns:Indicates whether the color will be used to all other scraps
Return type:bool

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ApplyColor

Parameters:applyColor (bool) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

AssignColor

ScrapDesignBuilder.AssignColor

Returns or sets the color for assigned scrap

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

Getter Method

Signature AssignColor

Returns:Indicates the color of scraps
Return type:Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature AssignColor

Parameters:assignColor (Id) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

AttachEdge

ScrapDesignBuilder.AttachEdge

Returns the edge that overlap will be attached

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

Getter Method

Signature AttachEdge

Returns:
Return type:NXOpen.SelectEdgeList

New in version NX6.0.0.

License requirements: None.

AttachScrap

ScrapDesignBuilder.AttachScrap

Returns the scrap that overlap will be attached

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

Getter Method

Signature AttachScrap

Returns:
Return type:NXOpen.SelectBody

New in version NX6.0.0.

License requirements: None.

BoundaryList

ScrapDesignBuilder.BoundaryList

Returns the boundary list served for boundary line method

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

Getter Method

Signature BoundaryList

Returns:
Return type:NXOpen.ScCollector

New in version NX6.0.0.

License requirements: None.

ChangeColScrap

ScrapDesignBuilder.ChangeColScrap

Returns the changing color of scrap

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

Getter Method

Signature ChangeColScrap

Returns:
Return type:NXOpen.SelectBodyList

New in version NX6.0.0.

License requirements: None.

CurveList

ScrapDesignBuilder.CurveList

Returns the curve list served for boundary+sketch or close boundaries method

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

Getter Method

Signature CurveList

Returns:The curve list is to create scraps
Return type:NXOpen.Section

New in version NX6.0.0.

License requirements: None.

DefStationNum

ScrapDesignBuilder.DefStationNum

Returns or sets the defined station number, according to it scraps can be laid out automatically in strip

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

Getter Method

Signature DefStationNum

Returns:
Return type:int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DefStationNum

Parameters:defStationNum (int) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

DoubleA

ScrapDesignBuilder.DoubleA

Returns or sets the double A served as the parameter of overcut

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

Getter Method

Signature DoubleA

Returns:Indicates the parameter A of overcut
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DoubleA

Parameters:doubleA (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

DoubleAngle

ScrapDesignBuilder.DoubleAngle

Returns or sets the double Angle served as the parameter of overcut

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

Getter Method

Signature DoubleAngle

Returns:Indicates the parameter Angle of overcut
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DoubleAngle

Parameters:doubleAngle (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

DoubleB

ScrapDesignBuilder.DoubleB

Returns or sets the double B served as the parameter of overcut

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

Getter Method

Signature DoubleB

Returns:Indicates the parameter B of overcut
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DoubleB

Parameters:doubleB (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

DoubleH

ScrapDesignBuilder.DoubleH

Returns or sets the double H served as the parameter of overcut

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

Getter Method

Signature DoubleH

Returns:Indicates the parameter H of overcut
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DoubleH

Parameters:doubleH (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

DoubleR

ScrapDesignBuilder.DoubleR

Returns or sets the double R served as the parameter of overcut

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

Getter Method

Signature DoubleR

Returns:Indicates the parameter R of overcut
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature DoubleR

Parameters:doubleR (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

EditMethod

ScrapDesignBuilder.EditMethod

Returns or sets the edit method, which includes splitting, merging, applying minimum radius, changing station, deleting and updating

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

Getter Method

Signature EditMethod

Returns:Indicates the edit method
Return type:NXOpen.Tooling.ScrapDesignBuilderEditScrapType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature EditMethod

Parameters:editMethod (NXOpen.Tooling.ScrapDesignBuilderEditScrapType) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

EditStationNum

ScrapDesignBuilder.EditStationNum

Returns or sets the station number to lay out in strip

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

Getter Method

Signature EditStationNum

Returns:Indicates the station number of scraps
Return type:int

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature EditStationNum

Parameters:editStationNum (int) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ExistScrap

ScrapDesignBuilder.ExistScrap

Returns the existed scrap served for exist sheet body method

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

Getter Method

Signature ExistScrap

Returns:
Return type:NXOpen.SelectBodyList

New in version NX6.0.0.

License requirements: None.

HoleColor

ScrapDesignBuilder.HoleColor

Returns or sets the hole color

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

Getter Method

Signature HoleColor

Returns:Indicates the color of hole scraps
Return type:Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature HoleColor

Parameters:holeColor (Id) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

MinRad

ScrapDesignBuilder.MinRad

Returns or sets the minimum radius to blend sharp corners

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

Getter Method

Signature MinRad

Returns:Indicates the minimum radius for sharp corners
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature MinRad

Parameters:minRad (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

OvercutColor

ScrapDesignBuilder.OvercutColor

Returns or sets the overcut color

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

Getter Method

Signature OvercutColor

Returns:Indicates the color of overcuts
Return type:Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature OvercutColor

Parameters:overcutColor (Id) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

OvercutEdge

ScrapDesignBuilder.OvercutEdge

Returns the edge that overcut will be attached

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

Getter Method

Signature OvercutEdge

Returns:
Return type:NXOpen.SelectEdge

New in version NX6.0.0.

License requirements: None.

OvercutOperation

ScrapDesignBuilder.OvercutOperation

Returns or sets the overcut operation, which includes normal type, tangent type, circular type and rectangular type

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

Getter Method

Signature OvercutOperation

Returns:Indicates the type of overcut
Return type:NXOpen.Tooling.ScrapDesignBuilderOvercutType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature OvercutOperation

Parameters:overcutOperation (NXOpen.Tooling.ScrapDesignBuilderOvercutType) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

OverlapColor

ScrapDesignBuilder.OverlapColor

Returns or sets the overlap color

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

Getter Method

Signature OverlapColor

Returns:Indicates the color of overlaps
Return type:Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature OverlapColor

Parameters:overlapColor (Id) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

OverlapWidth

ScrapDesignBuilder.OverlapWidth

Returns or sets the overlap width

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

Getter Method

Signature OverlapWidth

Returns:Indicates the width of overlap
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature OverlapWidth

Parameters:overlapWidth (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

PierceType

ScrapDesignBuilder.PierceType

Returns or sets the piercing type, piercing or piloting

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

Getter Method

Signature PierceType

Returns:Indicates the scrap type
Return type:NXOpen.Tooling.ScrapDesignBuilderDefScrapType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PierceType

Parameters:pierceType (NXOpen.Tooling.ScrapDesignBuilderDefScrapType) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

PiercingColor

ScrapDesignBuilder.PiercingColor

Returns or sets the piercing color

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

Getter Method

Signature PiercingColor

Returns:Indicates the color of piercing scraps
Return type:Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PiercingColor

Parameters:piercingColor (Id) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

PilotingColor

ScrapDesignBuilder.PilotingColor

Returns or sets the piloting color

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

Getter Method

Signature PilotingColor

Returns:Indicates the color of piloting scraps
Return type:Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature PilotingColor

Parameters:pilotingColor (Id) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ProcessFive

ScrapDesignBuilder.ProcessFive

Returns or sets the process five

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

Getter Method

Signature ProcessFive

Returns:Indicates five steps of trimming process
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ProcessFive

Parameters:processFive (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ProcessFour

ScrapDesignBuilder.ProcessFour

Returns or sets the process four

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

Getter Method

Signature ProcessFour

Returns:Indicates four steps of trimming process
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ProcessFour

Parameters:processFour (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ProcessOne

ScrapDesignBuilder.ProcessOne

Returns or sets the process one

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

Getter Method

Signature ProcessOne

Returns:Indicates one step of trimming process
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ProcessOne

Parameters:processOne (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ProcessThree

ScrapDesignBuilder.ProcessThree

Returns or sets the process three

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

Getter Method

Signature ProcessThree

Returns:Indicates three steps of trimming process
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ProcessThree

Parameters:processThree (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ProcessTwo

ScrapDesignBuilder.ProcessTwo

Returns or sets the process two

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

Getter Method

Signature ProcessTwo

Returns:Indicates two steps of trimming process
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ProcessTwo

Parameters:processTwo (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

RemoveFilter

ScrapDesignBuilder.RemoveFilter

Returns or sets the removing filter

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

Getter Method

Signature RemoveFilter

Returns:Indicates the filter of removing scraps
Return type:NXOpen.Tooling.ScrapDesignBuilderRemoveType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature RemoveFilter

Parameters:removeFilter (NXOpen.Tooling.ScrapDesignBuilderRemoveType) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ScrapMethod

ScrapDesignBuilder.ScrapMethod

Returns or sets the scrap method, which includes boundary+sketch, hole boundary, close curves, boundary lines and existed sheet body

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

Getter Method

Signature ScrapMethod

Returns:Indicates the creating method of scraps
Return type:NXOpen.Tooling.ScrapDesignBuilderScrapDefType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ScrapMethod

Parameters:scrapMethod (NXOpen.Tooling.ScrapDesignBuilderScrapDefType) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ScrapPosition

ScrapDesignBuilder.ScrapPosition

Returns or sets the scrap position

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

Getter Method

Signature ScrapPosition

Returns:Indicates the position method to create scraps
Return type:NXOpen.Tooling.ScrapDesignBuilderScrapDefPosition

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ScrapPosition

Parameters:scrapPosition (NXOpen.Tooling.ScrapDesignBuilderScrapDefPosition) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ScrapTol

ScrapDesignBuilder.ScrapTol

Returns or sets the scrap tolerance, when fail to create scrap in some cases, this value can be decreased to try again

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

Getter Method

Signature ScrapTol

Returns:Indicates the tolerance to create scraps
Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ScrapTol

Parameters:scrapTol (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

ScrapTypeEnum

ScrapDesignBuilder.ScrapTypeEnum

Returns or sets the scrap type enum

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

Getter Method

Signature ScrapTypeEnum

Returns:Indicates the operating method of scraps
Return type:NXOpen.Tooling.ScrapDesignBuilderBody

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature ScrapTypeEnum

Parameters:scrapTypeEnum (NXOpen.Tooling.ScrapDesignBuilderBody) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

SecondScrap

ScrapDesignBuilder.SecondScrap

Returns the second scrap to merge with the first one

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

Getter Method

Signature SecondScrap

Returns:
Return type:NXOpen.SelectBodyList

New in version NX6.0.0.

License requirements: None.

SplitCurve

ScrapDesignBuilder.SplitCurve

Returns the splitting curve

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

Getter Method

Signature SplitCurve

Returns:
Return type:NXOpen.Section

New in version NX6.0.0.

License requirements: None.

SplitScrap

ScrapDesignBuilder.SplitScrap

Returns the scrap to be splitted or merged

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

Getter Method

Signature SplitScrap

Returns:
Return type:NXOpen.SelectBodyList

New in version NX6.0.0.

License requirements: None.

TrimNum

ScrapDesignBuilder.TrimNum

Returns or sets the trimming number

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

Getter Method

Signature TrimNum

Returns:Indicates the steps of trimming process
Return type:NXOpen.Tooling.ScrapDesignBuilderTrimNumType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature TrimNum

Parameters:trimNum (NXOpen.Tooling.ScrapDesignBuilderTrimNumType) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

TrimmingColor

ScrapDesignBuilder.TrimmingColor

Returns or sets the trimming color

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

Getter Method

Signature TrimmingColor

Returns:Indicates the color of trimming scraps
Return type:Id

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature TrimmingColor

Parameters:trimmingColor (Id) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

UserAddonCurve

ScrapDesignBuilder.UserAddonCurve

Returns the user defined add-on curve to create overlap+overcut

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

Getter Method

Signature UserAddonCurve

Returns:
Return type:NXOpen.Section

New in version NX6.0.0.

License requirements: None.

Method Detail

GetOvercutPosition

ScrapDesignBuilder.GetOvercutPosition

Returns the overcut position, it determines where the overcut sketch will be constrained

Signature GetOvercutPosition()

Returns:Indicates the position to constrain overcut sketch
Return type:NXOpen.Point3d

New in version NX6.0.2.

License requirements: None.

SetOvercutPosition

ScrapDesignBuilder.SetOvercutPosition

Sets the overcut position, it determines where the overcut sketch will be constrained

Signature SetOvercutPosition(overcutPosition)

Parameters:overcutPosition (NXOpen.Point3d) –

New in version NX6.0.2.

License requirements: solid_modeling (“SOLIDS MODELING”)

Validate

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