NXOpen::Annotations::PlaneBuilder Class Reference

Represents a Annotations::PlaneBuilder object. More...

Inheritance diagram for NXOpen::Annotations::PlaneBuilder:

Public Types
enum	PlaneMethodType {   PlaneMethodTypeXyPlane, PlaneMethodTypeXzPlane, PlaneMethodTypeYzPlane, PlaneMethodTypeModelView,   PlaneMethodTypeUserDefined }
	method used to compute the annotation plane More...

Public Member Functions
NXOpen::Annotations::PlaneBuilder::PlaneMethodType	PlaneMethod ()
	Returns the plane method Created in NX6.0.0.
void	SetPlaneMethod (NXOpen::Annotations::PlaneBuilder::PlaneMethodType planeMethod)
	Sets the plane method Created in NX6.0.0.
void	SetUserDefinedPlane (NXOpen::Xform *userDefinedPlane)
	Sets the user-defined plane used by the operation Created in NX6.0.0.
NXOpen::Xform *	UserDefinedPlane ()
	Returns the user-defined plane used by the operation Created in NX6.0.0.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Annotations::PlaneBuilder object.

This object stored information about the plane in which an annotation lies.
This is a sub-builder class and cannot be directly instantiated

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::PlaneBuilder::PlaneMethodType

method used to compute the annotation plane

Enumerator:

PlaneMethodTypeXyPlane	XY of the WCS.
PlaneMethodTypeXzPlane	XZ of the WCS.
PlaneMethodTypeYzPlane	YZ of the WCS.
PlaneMethodTypeModelView	Model view plane.
PlaneMethodTypeUserDefined	User define plane.

Member Function Documentation

NXOpen::Annotations::PlaneBuilder::PlaneMethodType NXOpen::Annotations::PlaneBuilder::PlaneMethod

(

)

Returns the plane method
Created in NX6.0.0.

License requirements : None

void NXOpen::Annotations::PlaneBuilder::SetPlaneMethod

(

NXOpen::Annotations::PlaneBuilder::PlaneMethodType

planeMethod

)

Sets the plane method
Created in NX6.0.0.

License requirements : None

Parameters

planeMethod

planemethod

void NXOpen::Annotations::PlaneBuilder::SetUserDefinedPlane

(

NXOpen::Xform *

userDefinedPlane

)

Sets the user-defined plane used by the operation
Created in NX6.0.0.

License requirements : None

Parameters

userDefinedPlane

user defined plane

NXOpen::Xform* NXOpen::Annotations::PlaneBuilder::UserDefinedPlane

(

)

Returns the user-defined plane used by the operation
Created in NX6.0.0.

License requirements : None

virtual bool NXOpen::Annotations::PlaneBuilder::Validate ( )

virtual

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.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

The documentation for this class was generated from the following file:

• Annotations_PlaneBuilder.hxx