SpecialFormingBuilder Class¶
-
class
NXOpen.Tooling.
SpecialFormingBuilder
¶ Bases:
NXOpen.Builder
Creates special forming insert builder for progressive die.
No entity is returned. To create a new instance of this class, use
NXOpen.Tooling.ProgressiveDieManager.CreateSpecialFormingBuilder()
Default values.
Property Value BoundedBlockOrUserDefined BoundedBlock BoxClearance 0 EndLimit.Value 0 (millimeters part), 0 (inches part) FirstClearance 0 InsertType Punch NeedFirstClearance 0 NeedSecondClearance 0 NeedThirdClearance 0 Parent PrjDie RenameComponent 0 SecondClearance 0 StartLimit.Value 0 (millimeters part), 0 (inches part) ThirdClearance 0 UseExistingSheetBody 0 WithoutFalseBody 0 New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
BoundedBlockOrUserDefined | Returns or sets the bounded block or user defined |
BoxClearance | Returns or sets the box clearance |
BoxPosition | Returns or sets the position of csys for box. |
EndLimit | Returns the end limit |
FirstClearance | Returns or sets the first clearance |
InsertType | Returns or sets the insert type |
IsEditGuidedExtension | Returns or sets the is edit guided extension |
NeedFirstClearance | Returns or sets the need first clearance |
NeedSecondClearance | Returns or sets the need second clearance |
NeedThirdClearance | Returns or sets the need third clearance |
OffsetValueLinearDimensionNegativeX | Returns the offset value linear dimension negative x |
OffsetValueLinearDimensionNegativeY | Returns the offset value linear dimension negative y |
OffsetValueLinearDimensionNegativeZ | Returns the offset value linear dimension negative z |
OffsetValueLinearDimensionPositiveX | Returns the offset value linear dimension positive x |
OffsetValueLinearDimensionPositiveY | Returns the offset value linear dimension positive y |
OffsetValueLinearDimensionPositiveZ | Returns the offset value linear dimension positive z |
Parent | Returns or sets the parent |
RenameComponent | Returns or sets the rename component |
SecondClearance | Returns or sets the second clearance |
SelectCurves | Returns the select curves |
SelectFace | Returns the select face |
SelectFormingBlock | Returns the select forming block |
SelectInsertToDelete | Returns the select insert to delete |
SelectSheetBody | Returns the select sheet body |
StartLimit | Returns the start limit |
Tag | Returns the Tag for this object. |
ThirdClearance | Returns or sets the third clearance |
Type | Returns or sets the type |
UseExistingSheetBody | Returns or sets the use existing sheet body |
WithoutFalseBody | Returns or sets the without false body |
WizardType | Returns or sets the wizard type |
Methods¶
Method | Description |
---|---|
AddInsertPartIntoAssembly | Add insert part into assembly. |
AssignAttributeForSketchFeature | Assign attribute for sketch feature. |
AssignClearance | Assign clearance. |
CalculateBoxSize | Calculate box size and set directions, edge length, lower point position. |
Commit | Commits any edits that have been applied to the builder. |
CreateBoundBox | Create bound box. |
CreateFormingInsert | Create forming insert |
CreateOffsetDatumPlaneForSketch | Create offset datum plane for sketch. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
EditBoundBox | Edit bound box. |
EditExtrudeCurves | Edit extrude curves. |
ExtrudeCurvesToTrueBodyAndFalseBody | Extrude curves to true body and false body. |
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. |
MoveObjectsToUndisplayableLayer | Move objects to undisplayable layer. |
SetBoxMatrixAndPosition | Sets box csys matrix. |
SetFormingRegion | Set forming region. |
SewWaveLinkedFaceAndGuidedExtensionSheet | Sew wave linked face and guided extension sheet. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
TrimTrueBodyWithSewedSheet | Trim true body with sewed sheet. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
WaveFormingRegion | Wave forming region. |
Enumerations¶
SpecialFormingBuilderBlockType Enumeration | the block type |
SpecialFormingBuilderParentValue Enumeration | Specifies the main page type. |
SpecialFormingBuilderPunchOrDie Enumeration | Specifies the main page type. |
SpecialFormingBuilderTypes Enumeration | Specifies the main page type. |
Property Detail¶
BoundedBlockOrUserDefined¶
-
SpecialFormingBuilder.
BoundedBlockOrUserDefined
¶ Returns or sets the bounded block or user defined
-------------------------------------
Getter Method
Signature
BoundedBlockOrUserDefined()
Returns: Return type: NXOpen.Tooling.SpecialFormingBuilderBlockType
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BoundedBlockOrUserDefined(boundedBlockOrUserDefined)
Parameters: boundedBlockOrUserDefined ( NXOpen.Tooling.SpecialFormingBuilderBlockType
) –New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
BoxClearance¶
-
SpecialFormingBuilder.
BoxClearance
¶ Returns or sets the box clearance
-------------------------------------
Getter Method
Signature
BoxClearance()
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BoxClearance(boxClearance)
Parameters: boxClearance (float) – New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
BoxPosition¶
-
SpecialFormingBuilder.
BoxPosition
¶ Returns or sets the position of csys for box.
-------------------------------------
Getter Method
Signature
BoxPosition()
Returns: Return type: NXOpen.Point3d
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BoxPosition(csysOrigin)
Parameters: csysOrigin ( NXOpen.Point3d
) –New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
EndLimit¶
-
SpecialFormingBuilder.
EndLimit
¶ Returns the end limit
-------------------------------------
Getter Method
Signature
EndLimit()
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
FirstClearance¶
-
SpecialFormingBuilder.
FirstClearance
¶ Returns or sets the first clearance
-------------------------------------
Getter Method
Signature
FirstClearance()
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FirstClearance(firstClearance)
Parameters: firstClearance (float) – New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
InsertType¶
-
SpecialFormingBuilder.
InsertType
¶ Returns or sets the insert type
-------------------------------------
Getter Method
Signature
InsertType()
Returns: Return type: NXOpen.Tooling.SpecialFormingBuilderPunchOrDie
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InsertType(insertType)
Parameters: insertType ( NXOpen.Tooling.SpecialFormingBuilderPunchOrDie
) –New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
IsEditGuidedExtension¶
-
SpecialFormingBuilder.
IsEditGuidedExtension
¶ Returns or sets the is edit guided extension
-------------------------------------
Getter Method
Signature
IsEditGuidedExtension()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsEditGuidedExtension(isEditGuidedExtension)
Parameters: isEditGuidedExtension (bool) – New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
NeedFirstClearance¶
-
SpecialFormingBuilder.
NeedFirstClearance
¶ Returns or sets the need first clearance
-------------------------------------
Getter Method
Signature
NeedFirstClearance()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NeedFirstClearance(needFirstClearance)
Parameters: needFirstClearance (bool) – New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
NeedSecondClearance¶
-
SpecialFormingBuilder.
NeedSecondClearance
¶ Returns or sets the need second clearance
-------------------------------------
Getter Method
Signature
NeedSecondClearance()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NeedSecondClearance(needSecondClearance)
Parameters: needSecondClearance (bool) – New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
NeedThirdClearance¶
-
SpecialFormingBuilder.
NeedThirdClearance
¶ Returns or sets the need third clearance
-------------------------------------
Getter Method
Signature
NeedThirdClearance()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NeedThirdClearance(needThirdClearance)
Parameters: needThirdClearance (bool) – New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
OffsetValueLinearDimensionNegativeX¶
-
SpecialFormingBuilder.
OffsetValueLinearDimensionNegativeX
¶ Returns the offset value linear dimension negative x
-------------------------------------
Getter Method
Signature
OffsetValueLinearDimensionNegativeX()
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
OffsetValueLinearDimensionNegativeY¶
-
SpecialFormingBuilder.
OffsetValueLinearDimensionNegativeY
¶ Returns the offset value linear dimension negative y
-------------------------------------
Getter Method
Signature
OffsetValueLinearDimensionNegativeY()
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
OffsetValueLinearDimensionNegativeZ¶
-
SpecialFormingBuilder.
OffsetValueLinearDimensionNegativeZ
¶ Returns the offset value linear dimension negative z
-------------------------------------
Getter Method
Signature
OffsetValueLinearDimensionNegativeZ()
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
OffsetValueLinearDimensionPositiveX¶
-
SpecialFormingBuilder.
OffsetValueLinearDimensionPositiveX
¶ Returns the offset value linear dimension positive x
-------------------------------------
Getter Method
Signature
OffsetValueLinearDimensionPositiveX()
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
OffsetValueLinearDimensionPositiveY¶
-
SpecialFormingBuilder.
OffsetValueLinearDimensionPositiveY
¶ Returns the offset value linear dimension positive y
-------------------------------------
Getter Method
Signature
OffsetValueLinearDimensionPositiveY()
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
OffsetValueLinearDimensionPositiveZ¶
-
SpecialFormingBuilder.
OffsetValueLinearDimensionPositiveZ
¶ Returns the offset value linear dimension positive z
-------------------------------------
Getter Method
Signature
OffsetValueLinearDimensionPositiveZ()
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
Parent¶
-
SpecialFormingBuilder.
Parent
¶ Returns or sets the parent
-------------------------------------
Getter Method
Signature
Parent()
Returns: Return type: NXOpen.Tooling.SpecialFormingBuilderParentValue
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Parent(parent)
Parameters: parent ( NXOpen.Tooling.SpecialFormingBuilderParentValue
) –New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
RenameComponent¶
-
SpecialFormingBuilder.
RenameComponent
¶ Returns or sets the rename component
-------------------------------------
Getter Method
Signature
RenameComponent()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RenameComponent(renameComponent)
Parameters: renameComponent (bool) – New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
SecondClearance¶
-
SpecialFormingBuilder.
SecondClearance
¶ Returns or sets the second clearance
-------------------------------------
Getter Method
Signature
SecondClearance()
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SecondClearance(secondClearance)
Parameters: secondClearance (float) – New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
SelectCurves¶
-
SpecialFormingBuilder.
SelectCurves
¶ Returns the select curves
-------------------------------------
Getter Method
Signature
SelectCurves()
Returns: Return type: NXOpen.Section
New in version NX11.0.0.
License requirements: None.
SelectFace¶
-
SpecialFormingBuilder.
SelectFace
¶ Returns the select face
-------------------------------------
Getter Method
Signature
SelectFace()
Returns: Return type: NXOpen.ScCollector
New in version NX11.0.0.
License requirements: None.
SelectFormingBlock¶
-
SpecialFormingBuilder.
SelectFormingBlock
¶ Returns the select forming block
-------------------------------------
Getter Method
Signature
SelectFormingBlock()
Returns: Return type: NXOpen.SelectBody
New in version NX11.0.0.
License requirements: None.
SelectInsertToDelete¶
-
SpecialFormingBuilder.
SelectInsertToDelete
¶ Returns the select insert to delete
-------------------------------------
Getter Method
Signature
SelectInsertToDelete()
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX11.0.0.
License requirements: None.
SelectSheetBody¶
-
SpecialFormingBuilder.
SelectSheetBody
¶ Returns the select sheet body
-------------------------------------
Getter Method
Signature
SelectSheetBody()
Returns: Return type: NXOpen.SelectBody
New in version NX11.0.0.
License requirements: None.
StartLimit¶
-
SpecialFormingBuilder.
StartLimit
¶ Returns the start limit
-------------------------------------
Getter Method
Signature
StartLimit()
Returns: Return type: NXOpen.Expression
New in version NX11.0.0.
License requirements: None.
ThirdClearance¶
-
SpecialFormingBuilder.
ThirdClearance
¶ Returns or sets the third clearance
-------------------------------------
Getter Method
Signature
ThirdClearance()
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ThirdClearance(thirdClearance)
Parameters: thirdClearance (float) – New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
Type¶
-
SpecialFormingBuilder.
Type
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Tooling.SpecialFormingBuilderTypes
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Tooling.SpecialFormingBuilderTypes
) –New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
UseExistingSheetBody¶
-
SpecialFormingBuilder.
UseExistingSheetBody
¶ Returns or sets the use existing sheet body
-------------------------------------
Getter Method
Signature
UseExistingSheetBody()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseExistingSheetBody(useExistingSheetBody)
Parameters: useExistingSheetBody (bool) – New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
WithoutFalseBody¶
-
SpecialFormingBuilder.
WithoutFalseBody
¶ Returns or sets the without false body
-------------------------------------
Getter Method
Signature
WithoutFalseBody()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WithoutFalseBody(withoutFalseBody)
Parameters: withoutFalseBody (bool) – New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
WizardType¶
-
SpecialFormingBuilder.
WizardType
¶ Returns or sets the wizard type
-------------------------------------
Getter Method
Signature
WizardType()
Returns: Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WizardType(wizardType)
Parameters: wizardType (int) – New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
Method Detail¶
AddInsertPartIntoAssembly¶
-
SpecialFormingBuilder.
AddInsertPartIntoAssembly
¶ Add insert part into assembly.
Signature
AddInsertPartIntoAssembly(parentPart, templatePartName, origin)
Parameters: - parentPart (
NXOpen.NXObject
) – - templatePartName (str) –
- origin (
NXOpen.Point3d
) –
Returns: Return type: New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
- parentPart (
AssignAttributeForSketchFeature¶
-
SpecialFormingBuilder.
AssignAttributeForSketchFeature
¶ Assign attribute for sketch feature.
Signature
AssignAttributeForSketchFeature(sketchFeatureTag)
Parameters: sketchFeatureTag ( NXOpen.NXObject
) –New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
AssignClearance¶
-
SpecialFormingBuilder.
AssignClearance
¶ Assign clearance.
Signature
AssignClearance()
New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
CalculateBoxSize¶
-
SpecialFormingBuilder.
CalculateBoxSize
¶ Calculate box size and set directions, edge length, lower point position.
Signature
CalculateBoxSize()
New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
CreateBoundBox¶
-
SpecialFormingBuilder.
CreateBoundBox
¶ Create bound box.
Signature
CreateBoundBox()
New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
CreateFormingInsert¶
-
SpecialFormingBuilder.
CreateFormingInsert
¶ Create forming insert
Signature
CreateFormingInsert()
New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
CreateOffsetDatumPlaneForSketch¶
-
SpecialFormingBuilder.
CreateOffsetDatumPlaneForSketch
¶ Create offset datum plane for sketch.
Signature
CreateOffsetDatumPlaneForSketch()
New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
EditBoundBox¶
-
SpecialFormingBuilder.
EditBoundBox
¶ Edit bound box.
Signature
EditBoundBox()
New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
EditExtrudeCurves¶
-
SpecialFormingBuilder.
EditExtrudeCurves
¶ Edit extrude curves.
Signature
EditExtrudeCurves()
New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
ExtrudeCurvesToTrueBodyAndFalseBody¶
-
SpecialFormingBuilder.
ExtrudeCurvesToTrueBodyAndFalseBody
¶ Extrude curves to true body and false body.
Signature
ExtrudeCurvesToTrueBodyAndFalseBody()
New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
MoveObjectsToUndisplayableLayer¶
-
SpecialFormingBuilder.
MoveObjectsToUndisplayableLayer
¶ Move objects to undisplayable layer.
Signature
MoveObjectsToUndisplayableLayer()
New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
SetBoxMatrixAndPosition¶
-
SpecialFormingBuilder.
SetBoxMatrixAndPosition
¶ Sets box csys matrix.
Signature
SetBoxMatrixAndPosition(matrix, position)
Parameters: - matrix (
NXOpen.Matrix3x3
) – - position (
NXOpen.Point3d
) –
New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
- matrix (
SetFormingRegion¶
-
SpecialFormingBuilder.
SetFormingRegion
¶ Set forming region.
Signature
SetFormingRegion(faces)
Parameters: faces (list of NXOpen.NXObject
) –New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
SewWaveLinkedFaceAndGuidedExtensionSheet¶
-
SpecialFormingBuilder.
SewWaveLinkedFaceAndGuidedExtensionSheet
¶ Sew wave linked face and guided extension sheet.
Signature
SewWaveLinkedFaceAndGuidedExtensionSheet()
New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
TrimTrueBodyWithSewedSheet¶
-
SpecialFormingBuilder.
TrimTrueBodyWithSewedSheet
¶ Trim true body with sewed sheet.
Signature
TrimTrueBodyWithSewedSheet()
New in version NX11.0.0.
License requirements: prog_die_wizard (“UG/Progressive Die Wizard”)
Validate¶
-
SpecialFormingBuilder.
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.