LayoutBuilder Class¶
-
class
NXOpen.Tooling.
LayoutBuilder
¶ Bases:
NXOpen.Builder
Represents a Tooling::LayoutBuilder builder
To create a new instance of this class, use
NXOpen.Tooling.MWLayoutCollection.CreateLayoutBuilder
Default values.
Property Value CirCavityNumber 2 CirRadius 0 CirRotateAngle 360 CirStartAngle 0 DimBalFirst.Value 0 (millimeters part), 0 (inches part) LinXnumber 2 LinYnumber 1 New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
BalCavityNumber | Returns or sets the balance cavity number |
CirCavityNumber | Returns or sets the copy number for circular transform |
CirRadius | Returns or sets the radius value |
CirRotateAngle | Returns or sets the rotate angle |
CirStartAngle | Returns or sets the start angle |
DimBalFirst | Returns the first dimension for balance transform |
DimBalSecond | Returns the second dimension for balance transform |
DimXdist | Returns the cavity distance dimension in X-axis |
DimYdist | Returns the cavity distance dimension in Y-axis |
LayoutVector | Returns or sets the rotate vector |
LinXnumber | Returns or sets the copy number for linear transform in X-axis |
LinYnumber | Returns or sets the copy number for linear transform in Y-axis |
MwLayoutType | Returns or sets the layout pattern type |
RotatePoint | Returns or sets the rotate point |
SelectCavity | Returns the select cavity |
SubType | Returns or sets the layout transform type |
Tag | Returns the Tag for this object. |
Xref | Returns or sets the layout cavity number in X-axis |
Yref | Returns or sets the layout cavity number in Y-axis |
Methods¶
Method | Description |
---|---|
Autocenter | Make center of cavity |
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. |
Insertpocket | Insert pocket |
Layout | Perform cavity layout |
Remove | Remove cavity |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Transform | Reposition cavity |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
LayoutBuilderBalNumber Enumeration | Represents the number of balance cavity. |
LayoutBuilderLayoutSubType Enumeration | Represents the the sub type of layout. |
LayoutBuilderLayoutType Enumeration | Represents the type of layout. |
LayoutBuilderXrefNum Enumeration | Represents the type of x move refer. |
LayoutBuilderYrefNum Enumeration | Represents the type of y move refer. |
Property Detail¶
BalCavityNumber¶
-
LayoutBuilder.
BalCavityNumber
¶ Returns or sets the balance cavity number
-------------------------------------
Getter Method
Signature
BalCavityNumber()
Returns: Return type: NXOpen.Tooling.LayoutBuilderBalNumber
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BalCavityNumber(enumBalCavityNumber)
Parameters: enumBalCavityNumber ( NXOpen.Tooling.LayoutBuilderBalNumber
) –New in version NX6.0.0.
License requirements: None.
CirCavityNumber¶
-
LayoutBuilder.
CirCavityNumber
¶ Returns or sets the copy number for circular transform
-------------------------------------
Getter Method
Signature
CirCavityNumber()
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CirCavityNumber(cirCavityNumber)
Parameters: cirCavityNumber (int) – New in version NX6.0.0.
License requirements: None.
CirRadius¶
-
LayoutBuilder.
CirRadius
¶ Returns or sets the radius value
-------------------------------------
Getter Method
Signature
CirRadius()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CirRadius(cirRadius)
Parameters: cirRadius (float) – New in version NX6.0.0.
License requirements: None.
CirRotateAngle¶
-
LayoutBuilder.
CirRotateAngle
¶ Returns or sets the rotate angle
-------------------------------------
Getter Method
Signature
CirRotateAngle()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CirRotateAngle(cirRotateAngle)
Parameters: cirRotateAngle (float) – New in version NX6.0.0.
License requirements: None.
CirStartAngle¶
-
LayoutBuilder.
CirStartAngle
¶ Returns or sets the start angle
-------------------------------------
Getter Method
Signature
CirStartAngle()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CirStartAngle(cirStartAngle)
Parameters: cirStartAngle (float) – New in version NX6.0.0.
License requirements: None.
DimBalFirst¶
-
LayoutBuilder.
DimBalFirst
¶ Returns the first dimension for balance transform
-------------------------------------
Getter Method
Signature
DimBalFirst()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
DimBalSecond¶
-
LayoutBuilder.
DimBalSecond
¶ Returns the second dimension for balance transform
-------------------------------------
Getter Method
Signature
DimBalSecond()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
DimXdist¶
-
LayoutBuilder.
DimXdist
¶ Returns the cavity distance dimension in X-axis
-------------------------------------
Getter Method
Signature
DimXdist()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
DimYdist¶
-
LayoutBuilder.
DimYdist
¶ Returns the cavity distance dimension in Y-axis
-------------------------------------
Getter Method
Signature
DimYdist()
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
LayoutVector¶
-
LayoutBuilder.
LayoutVector
¶ Returns or sets the rotate vector
-------------------------------------
Getter Method
Signature
LayoutVector()
Returns: Return type: NXOpen.Direction
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LayoutVector(layoutVector)
Parameters: layoutVector ( NXOpen.Direction
) –New in version NX6.0.0.
License requirements: None.
LinXnumber¶
-
LayoutBuilder.
LinXnumber
¶ Returns or sets the copy number for linear transform in X-axis
-------------------------------------
Getter Method
Signature
LinXnumber()
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LinXnumber(linXNumber)
Parameters: linXNumber (int) – New in version NX6.0.0.
License requirements: None.
LinYnumber¶
-
LayoutBuilder.
LinYnumber
¶ Returns or sets the copy number for linear transform in Y-axis
-------------------------------------
Getter Method
Signature
LinYnumber()
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LinYnumber(linYNumber)
Parameters: linYNumber (int) – New in version NX6.0.0.
License requirements: None.
MwLayoutType¶
-
LayoutBuilder.
MwLayoutType
¶ Returns or sets the layout pattern type
-------------------------------------
Getter Method
Signature
MwLayoutType()
Returns: Return type: NXOpen.Tooling.LayoutBuilderLayoutType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MwLayoutType(enumLayoutType)
Parameters: enumLayoutType ( NXOpen.Tooling.LayoutBuilderLayoutType
) –New in version NX6.0.0.
License requirements: None.
RotatePoint¶
-
LayoutBuilder.
RotatePoint
¶ Returns or sets the rotate point
-------------------------------------
Getter Method
Signature
RotatePoint()
Returns: Return type: NXOpen.Point
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RotatePoint(rotatePoint)
Parameters: rotatePoint ( NXOpen.Point
) –New in version NX6.0.0.
License requirements: None.
SelectCavity¶
-
LayoutBuilder.
SelectCavity
¶ Returns the select cavity
-------------------------------------
Getter Method
Signature
SelectCavity()
Returns: Return type: NXOpen.SelectBodyList
New in version NX6.0.0.
License requirements: None.
SubType¶
-
LayoutBuilder.
SubType
¶ Returns or sets the layout transform type
-------------------------------------
Getter Method
Signature
SubType()
Returns: Return type: NXOpen.Tooling.LayoutBuilderLayoutSubType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SubType(enumSubType)
Parameters: enumSubType ( NXOpen.Tooling.LayoutBuilderLayoutSubType
) –New in version NX6.0.0.
License requirements: None.
Xref¶
-
LayoutBuilder.
Xref
¶ Returns or sets the layout cavity number in X-axis
-------------------------------------
Getter Method
Signature
Xref()
Returns: Return type: NXOpen.Tooling.LayoutBuilderXrefNum
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Xref(enumXRef)
Parameters: enumXRef ( NXOpen.Tooling.LayoutBuilderXrefNum
) –New in version NX6.0.0.
License requirements: None.
Yref¶
-
LayoutBuilder.
Yref
¶ Returns or sets the layout cavity number in Y-axis
-------------------------------------
Getter Method
Signature
Yref()
Returns: Return type: NXOpen.Tooling.LayoutBuilderYrefNum
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Yref(enumYRef)
Parameters: enumYRef ( NXOpen.Tooling.LayoutBuilderYrefNum
) –New in version NX6.0.0.
License requirements: None.
Method Detail¶
Autocenter¶
-
LayoutBuilder.
Autocenter
¶ Make center of cavity
Signature
Autocenter()
New in version NX6.0.0.
License requirements: None.
Insertpocket¶
-
LayoutBuilder.
Insertpocket
¶ Insert pocket
Signature
Insertpocket()
New in version NX6.0.0.
License requirements: None.
Layout¶
-
LayoutBuilder.
Layout
¶ Perform cavity layout
Signature
Layout()
New in version NX6.0.0.
License requirements: None.
Remove¶
-
LayoutBuilder.
Remove
¶ Remove cavity
Signature
Remove()
New in version NX6.0.0.
License requirements: None.
Transform¶
-
LayoutBuilder.
Transform
¶ Reposition cavity
Signature
Transform()
New in version NX6.0.0.
License requirements: None.
Validate¶
-
LayoutBuilder.
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.