DiePlaneBuilder Class¶
-
class
NXOpen.Die.
DiePlaneBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
NXOpen.Die.DiePlaneBuilder
.The Die Plane is a helper to the main Die Design feature to specify the plane, such as the base plane or end planes. If a coordinate system is specified, then the XY plane of the coordinate system will be used.
To create a new instance of this class, use
NXOpen.Die.DieCollection.CreateDiePlane
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
CoordinateSystemMatrix | Returns or sets the coordinate system matrix |
CoordinateSystemOrigin | Returns or sets the coordinate system origin |
InputType | Returns or sets the type of input that defined the plane |
ReverseSourceDirection | Returns or sets the indication if the source’s direction should be reversed. |
SelectPlane | Returns the selected plane |
SpecifyPlane | Returns or sets the specified plane |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
DiePlaneBuilderPlaneType Enumeration | the options available for defining the plane |
Property Detail¶
CoordinateSystemMatrix¶
-
DiePlaneBuilder.
CoordinateSystemMatrix
¶ Returns or sets the coordinate system matrix
-------------------------------------
Getter Method
Signature
CoordinateSystemMatrix()
Returns: Return type: NXOpen.Matrix3x3
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoordinateSystemMatrix(coordinateSystemMatrix)
Parameters: coordinateSystemMatrix ( NXOpen.Matrix3x3
) –New in version NX6.0.0.
License requirements: ug_die_design (“Die Design”)
CoordinateSystemOrigin¶
-
DiePlaneBuilder.
CoordinateSystemOrigin
¶ Returns or sets the coordinate system origin
-------------------------------------
Getter Method
Signature
CoordinateSystemOrigin()
Returns: Return type: NXOpen.Point3d
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CoordinateSystemOrigin(coordinateSystemOrigin)
Parameters: coordinateSystemOrigin ( NXOpen.Point3d
) –New in version NX6.0.0.
License requirements: ug_die_design (“Die Design”)
InputType¶
-
DiePlaneBuilder.
InputType
¶ Returns or sets the type of input that defined the plane
-------------------------------------
Getter Method
Signature
InputType()
Returns: Return type: NXOpen.Die.DiePlaneBuilderPlaneType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InputType(inputType)
Parameters: inputType ( NXOpen.Die.DiePlaneBuilderPlaneType
) –New in version NX7.5.0.
License requirements: ug_die_design (“Die Design”)
ReverseSourceDirection¶
-
DiePlaneBuilder.
ReverseSourceDirection
¶ Returns or sets the indication if the source’s direction should be reversed.
True indicates the source’s direction should be reversed
-------------------------------------
Getter Method
Signature
ReverseSourceDirection()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseSourceDirection(reverseSourceDirection)
Parameters: reverseSourceDirection (bool) – New in version NX6.0.0.
License requirements: ug_die_design (“Die Design”)
SelectPlane¶
-
DiePlaneBuilder.
SelectPlane
¶ Returns the selected plane
-------------------------------------
Getter Method
Signature
SelectPlane()
Returns: Return type: NXOpen.SelectNXObject
New in version NX6.0.0.
License requirements: None.
SpecifyPlane¶
-
DiePlaneBuilder.
SpecifyPlane
¶ Returns or sets the specified plane
-------------------------------------
Getter Method
Signature
SpecifyPlane()
Returns: Return type: NXOpen.Plane
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SpecifyPlane(specifyPlane)
Parameters: specifyPlane ( NXOpen.Plane
) –New in version NX6.0.0.
License requirements: ug_die_design (“Die Design”)
Method Detail¶
Validate¶
-
DiePlaneBuilder.
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.