PlaneBuilder Class¶
-
class
NXOpen.Annotations.PlaneBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderRepresents a
NXOpen.Annotations.PlaneBuilderobject.This object stored information about the plane in which an annotation lies.
This is a sub-builder class and cannot be directly instantiated
New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| PlaneMethod | Returns or sets the plane method |
| Tag | Returns the Tag for this object. |
| UserDefinedPlane | Returns or sets the user-defined plane used by the operation |
Methods¶
| Method | Description |
|---|---|
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| PlaneBuilderPlaneMethodType Enumeration | method used to compute the annotation plane |
Property Detail¶
PlaneMethod¶
-
PlaneBuilder.PlaneMethod¶ Returns or sets the plane method
-------------------------------------Getter Method
Signature
PlaneMethodReturns: Return type: NXOpen.Annotations.PlaneBuilderPlaneMethodTypeNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PlaneMethodParameters: planeMethod ( NXOpen.Annotations.PlaneBuilderPlaneMethodType) –New in version NX6.0.0.
License requirements: None.
UserDefinedPlane¶
-
PlaneBuilder.UserDefinedPlane¶ Returns or sets the user-defined plane used by the operation
-------------------------------------Getter Method
Signature
UserDefinedPlaneReturns: user defined plane Return type: NXOpen.XformNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UserDefinedPlaneParameters: userDefinedPlane ( NXOpen.Xform) – user defined planeNew in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
PlaneBuilder.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.