BlankLayoutBuilder Class¶
-
class
NXOpen.Tooling.
BlankLayoutBuilder
¶ Bases:
NXOpen.Builder
Progressive Die Wizard blank layout builder
To create a new instance of this class, use
NXOpen.Tooling.BlankLayoutCollection.CreateBlankLayoutBuilder
Default values.
Property Value Bottom 0 LeftDistance 0 LeftRightSide Average LockPitchAndWidth 0 MinimumSpaceSize 0 Pitch 0 RightDistance 0 Rotate 0 SideWeb Average SnapSize One ThreeBlanks 0 Top 0 Width 0 XShift 0 YShift 0 New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
BasePoint | Returns or sets the base point. |
Blank | Returns the blank. |
BlankNameStr | Returns or sets the selected blank name. |
Bottom | Returns or sets the bottom boundary distance between blank and strip. |
LeftDistance | Returns or sets the left boudary distance between blank and strip. |
LeftRightSide | Returns or sets the type of use left or right side to decide the distance between blank and strip. |
LockPitchAndWidth | Returns or sets the lock pitch and width values from being changed during processing. |
MaterialUtilization | Returns or sets the material utilization of the blank. |
MinimumSpaceSize | Returns or sets the option to report minimum space size or not. |
MinimumSpaceSizeValue | Returns or sets the minimum distance between the adjacent blanks. |
Pitch | Returns or sets the distance between the adjacent stations. |
RightDistance | Returns or sets the right boundary distance between blank and strip. |
Rotate | Returns or sets the value to rotate the blank around the base point. |
SideWeb | Returns or sets the type of the overlap on the strip. |
SnapSize | Returns or sets the option to set the increment of the scale bar. |
Tag | Returns the Tag for this object. |
ThreeBlanks | Returns or sets the usage of three blanks or one blank. |
Top | Returns or sets the top boudary distance between blank and strip. |
Type | Returns or sets the blank layout type. |
Width | Returns or sets the width of the strip. |
XShift | Returns or sets the value to shift the blank in the X direction. |
YShift | Returns or sets the value to shift the blank in the Y direction. |
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. |
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¶
BlankLayoutBuilderLeftRightSideOption Enumeration | Specifies the option of left right side type. |
BlankLayoutBuilderSideWebOption Enumeration | Specifies the option of side webs type. |
BlankLayoutBuilderSnapSizeOption Enumeration | Specifies the option of snap size. |
BlankLayoutBuilderTypes Enumeration | Specifies the option of blank layout type. |
Property Detail¶
BasePoint¶
-
BlankLayoutBuilder.
BasePoint
¶ Returns or sets the base point.
-------------------------------------
Getter Method
Signature
BasePoint()
Returns: Return type: NXOpen.Point
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BasePoint(point)
Parameters: point ( NXOpen.Point
) –New in version NX7.5.0.
License requirements: None.
Blank¶
-
BlankLayoutBuilder.
Blank
¶ Returns the blank.
-------------------------------------
Getter Method
Signature
Blank()
Returns: Return type: NXOpen.SelectBody
New in version NX7.5.0.
License requirements: None.
BlankNameStr¶
-
BlankLayoutBuilder.
BlankNameStr
¶ Returns or sets the selected blank name.
-------------------------------------
Getter Method
Signature
BlankNameStr()
Returns: Returns the blank name Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BlankNameStr(blankNameStr)
Parameters: blankNameStr (str) – Sets the blank name New in version NX7.5.0.
License requirements: None.
Bottom¶
-
BlankLayoutBuilder.
Bottom
¶ Returns or sets the bottom boundary distance between blank and strip.
-------------------------------------
Getter Method
Signature
Bottom()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Bottom(bottom)
Parameters: bottom (float) – New in version NX7.5.0.
License requirements: None.
LeftDistance¶
-
BlankLayoutBuilder.
LeftDistance
¶ Returns or sets the left boudary distance between blank and strip.
-------------------------------------
Getter Method
Signature
LeftDistance()
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LeftDistance(leftDistance)
Parameters: leftDistance (float) – New in version NX8.0.0.
License requirements: None.
LeftRightSide¶
-
BlankLayoutBuilder.
LeftRightSide
¶ Returns or sets the type of use left or right side to decide the distance between blank and strip.
-------------------------------------
Getter Method
Signature
LeftRightSide()
Returns: Return type: NXOpen.Tooling.BlankLayoutBuilderLeftRightSideOption
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LeftRightSide(leftRightSide)
Parameters: leftRightSide ( NXOpen.Tooling.BlankLayoutBuilderLeftRightSideOption
) –New in version NX8.0.0.
License requirements: None.
LockPitchAndWidth¶
-
BlankLayoutBuilder.
LockPitchAndWidth
¶ Returns or sets the lock pitch and width values from being changed during processing.
-------------------------------------
Getter Method
Signature
LockPitchAndWidth()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LockPitchAndWidth(lockPitchAndWidth)
Parameters: lockPitchAndWidth (bool) – New in version NX7.5.0.
License requirements: None.
MaterialUtilization¶
-
BlankLayoutBuilder.
MaterialUtilization
¶ Returns or sets the material utilization of the blank.
-------------------------------------
Getter Method
Signature
MaterialUtilization()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaterialUtilization(materialUtilization)
Parameters: materialUtilization (str) – New in version NX7.5.0.
License requirements: None.
MinimumSpaceSize¶
-
BlankLayoutBuilder.
MinimumSpaceSize
¶ Returns or sets the option to report minimum space size or not.
-------------------------------------
Getter Method
Signature
MinimumSpaceSize()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinimumSpaceSize(minimumSpaceSize)
Parameters: minimumSpaceSize (bool) – New in version NX7.5.0.
License requirements: None.
MinimumSpaceSizeValue¶
-
BlankLayoutBuilder.
MinimumSpaceSizeValue
¶ Returns or sets the minimum distance between the adjacent blanks.
-------------------------------------
Getter Method
Signature
MinimumSpaceSizeValue()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinimumSpaceSizeValue(minimumSpaceSizeValue)
Parameters: minimumSpaceSizeValue (str) – New in version NX7.5.0.
License requirements: None.
Pitch¶
-
BlankLayoutBuilder.
Pitch
¶ Returns or sets the distance between the adjacent stations.
-------------------------------------
Getter Method
Signature
Pitch()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Pitch(pitch)
Parameters: pitch (float) – New in version NX7.5.0.
License requirements: None.
RightDistance¶
-
BlankLayoutBuilder.
RightDistance
¶ Returns or sets the right boundary distance between blank and strip.
-------------------------------------
Getter Method
Signature
RightDistance()
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RightDistance(rightDistance)
Parameters: rightDistance (float) – New in version NX8.0.0.
License requirements: None.
Rotate¶
-
BlankLayoutBuilder.
Rotate
¶ Returns or sets the value to rotate the blank around the base point.
-------------------------------------
Getter Method
Signature
Rotate()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Rotate(rotate)
Parameters: rotate (float) – New in version NX7.5.0.
License requirements: None.
SideWeb¶
-
BlankLayoutBuilder.
SideWeb
¶ Returns or sets the type of the overlap on the strip.
-------------------------------------
Getter Method
Signature
SideWeb()
Returns: Return type: NXOpen.Tooling.BlankLayoutBuilderSideWebOption
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SideWeb(sideWeb)
Parameters: sideWeb ( NXOpen.Tooling.BlankLayoutBuilderSideWebOption
) –New in version NX7.5.0.
License requirements: None.
SnapSize¶
-
BlankLayoutBuilder.
SnapSize
¶ Returns or sets the option to set the increment of the scale bar.
-------------------------------------
Getter Method
Signature
SnapSize()
Returns: Return type: NXOpen.Tooling.BlankLayoutBuilderSnapSizeOption
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SnapSize(snapSize)
Parameters: snapSize ( NXOpen.Tooling.BlankLayoutBuilderSnapSizeOption
) –New in version NX7.5.0.
License requirements: None.
ThreeBlanks¶
-
BlankLayoutBuilder.
ThreeBlanks
¶ Returns or sets the usage of three blanks or one blank.
-------------------------------------
Getter Method
Signature
ThreeBlanks()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ThreeBlanks(threeBlanks)
Parameters: threeBlanks (bool) – New in version NX8.0.0.
License requirements: None.
Top¶
-
BlankLayoutBuilder.
Top
¶ Returns or sets the top boudary distance between blank and strip.
-------------------------------------
Getter Method
Signature
Top()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Top(top)
Parameters: top (float) – New in version NX7.5.0.
License requirements: None.
Type¶
-
BlankLayoutBuilder.
Type
¶ Returns or sets the blank layout type.
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Tooling.BlankLayoutBuilderTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Tooling.BlankLayoutBuilderTypes
) –New in version NX7.5.0.
License requirements: None.
Width¶
-
BlankLayoutBuilder.
Width
¶ Returns or sets the width of the strip.
-------------------------------------
Getter Method
Signature
Width()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Width(width)
Parameters: width (float) – New in version NX7.5.0.
License requirements: None.
XShift¶
-
BlankLayoutBuilder.
XShift
¶ Returns or sets the value to shift the blank in the X direction.
-------------------------------------
Getter Method
Signature
XShift()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
XShift(xShift)
Parameters: xShift (float) – New in version NX7.5.0.
License requirements: None.
YShift¶
-
BlankLayoutBuilder.
YShift
¶ Returns or sets the value to shift the blank in the Y direction.
-------------------------------------
Getter Method
Signature
YShift()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
YShift(yShift)
Parameters: yShift (float) – New in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
BlankLayoutBuilder.
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.