NXOpen.Annotations.PlaneBuilder Class Reference

Represents a NXOpen.Annotations.PlaneBuilder object. More...

Inheritance diagram for NXOpen.Annotations.PlaneBuilder:

Public Types
enum	PlaneMethodType {   XyPlane, XzPlane, YzPlane, ModelView,   UserDefined }
	method used to compute the annotation plane More...

Public Member Functions
unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...
void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...
override string	ToString ()
	Returns a String that represents the current Object. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Annotations.PlaneBuilder.PlaneMethodType	PlaneMethod [get, set]
	Returns or sets the plane method More...
unsafe bool	ProjectOntoPlane [get, set]
	Returns or sets the option to specify project Annotation onto plane. More...
unsafe NXOpen.Xform	UserDefinedPlane [get, set]
	Returns or sets the user-defined plane used by the operation More...
Properties inherited from NXOpen.TaggedObject
Tag	Tag [get]
	Returns the tag of this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a NXOpen.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
XyPlane	XY of the WCS
XzPlane	XZ of the WCS
YzPlane	YZ of the WCS
ModelView	Model view plane
UserDefined	User define plane

Member Function Documentation

unsafe bool NXOpen.Annotations.PlaneBuilder.Validate ( )

inline

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.

Created in NX3.0.1

License requirements: None.

Returns

Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Annotations.PlaneBuilder.PlaneMethodType NXOpen.Annotations.PlaneBuilder.PlaneMethod

getset

Returns or sets the plane method

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Annotations.PlaneBuilder.ProjectOntoPlane

getset

Returns or sets the option to specify project Annotation onto plane.

Created in NX1872.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Xform NXOpen.Annotations.PlaneBuilder.UserDefinedPlane

getset

Returns or sets the user-defined plane used by the operation

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

---

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

• Annotations_PlaneBuilder.cs