NXOpen.Annotations.OriginBuilder Class Reference

Represents a NXOpen.Annotations.OriginBuilder More...

Inheritance diagram for NXOpen.Annotations.OriginBuilder:

Public Types
enum	AlignmentPosition {   TopLeft, TopCenter, TopRight, MidLeft,   MidCenter, MidRight, BottomLeft, BottomCenter,   BottomRight }
	alignment position on the annotation More...

Public Member Functions
unsafe NXOpen.Annotations.Annotation.AssociativeOriginData	GetAssociativeOrigin ()
	Gets the data that specifies the origin's associativity More...
unsafe void	SetAssociativeOrigin (NXOpen.Annotations.Annotation.AssociativeOriginData assocOrigin)
	Associates the annotation's origin to the specified objects More...
unsafe void	SetInferRelativeToGeometry (bool inferRelativeToGeometry)
	Infers a relative to geometry associative on commit if no other associativity has been applied More...
unsafe void	SetInferRelativeToGeometryFromLeader (bool inferFromLeader)
	Infers a relative to geometry associative origin from leader More...
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.OriginBuilder.AlignmentPosition	Anchor [get, set]
	Returns or sets the anchor location of the origin on the annotation More...
unsafe NXOpen.Drawings.SelectDraftingView	AnnotationView [get]
	Returns the view of the annotation (drafting member views only) More...
unsafe NXOpen.SelectDisplayableObject	Origin [get]
	Returns the origin More...
unsafe NXOpen.Point3d	OriginPoint [get, set]
	Returns or sets the origin point More...
unsafe NXOpen.Annotations.PlaneBuilder	Plane [get]
	Returns the plane 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.OriginBuilder

This is a sub-builder class and cannot be directly instantiated

Created in NX6.0.0

Member Enumeration Documentation

enum NXOpen.Annotations.OriginBuilder.AlignmentPosition

alignment position on the annotation

Enumerator
TopLeft	Top left position
TopCenter	Top center position
TopRight	Top right position
MidLeft	Mid left position
MidCenter	Mid center position
MidRight	Mid right position
BottomLeft	Bottom left position
BottomCenter	Bottom center position
BottomRight	Bottom right position

Member Function Documentation

unsafe NXOpen.Annotations.Annotation.AssociativeOriginData NXOpen.Annotations.OriginBuilder.GetAssociativeOrigin ( )

inline

Gets the data that specifies the origin's associativity

Created in NX6.0.0

License requirements: None.

Returns

associativity data

unsafe void NXOpen.Annotations.OriginBuilder.SetAssociativeOrigin ( NXOpen.Annotations.Annotation.AssociativeOriginData  assocOrigin )

inline

Associates the annotation's origin to the specified objects

Created in NX6.0.0

License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING") OR solid_modeling ("SOLIDS MODELING")

Parameters

assocOrigin

associativity data

unsafe void NXOpen.Annotations.OriginBuilder.SetInferRelativeToGeometry ( bool  inferRelativeToGeometry )

inline

Infers a relative to geometry associative on commit if no other associativity has been applied

Created in NX6.0.1

License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING") OR solid_modeling ("SOLIDS MODELING")

Parameters

inferRelativeToGeometry

relative to geometry flag

unsafe void NXOpen.Annotations.OriginBuilder.SetInferRelativeToGeometryFromLeader ( bool  inferFromLeader )

inline

Infers a relative to geometry associative origin from leader

Created in NX12.0.1

License requirements: geometric_tol ("GDT") OR drafting ("DRAFTING") OR solid_modeling ("SOLIDS MODELING")

Parameters

inferFromLeader

infer relative to geometry from leader flag

unsafe bool NXOpen.Annotations.OriginBuilder.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.OriginBuilder.AlignmentPosition NXOpen.Annotations.OriginBuilder.Anchor

getset

Returns or sets the anchor location of the origin on the annotation

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING") OR solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Drawings.SelectDraftingView NXOpen.Annotations.OriginBuilder.AnnotationView

get

Returns the view of the annotation (drafting member views only)

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.SelectDisplayableObject NXOpen.Annotations.OriginBuilder.Origin

get

Returns the origin

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Point3d NXOpen.Annotations.OriginBuilder.OriginPoint

getset

Returns or sets the origin point

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: geometric_tol ("GDT") OR drafting ("DRAFTING") OR solid_modeling ("SOLIDS MODELING")

unsafe NXOpen.Annotations.PlaneBuilder NXOpen.Annotations.OriginBuilder.Plane

get

Returns the plane

Created in NX6.0.0

License requirements: None.

---

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

• Annotations_OriginBuilder.cs