NX Open C++ Reference Guide
Classes | Public Member Functions
NXOpen::Annotations::Annotation Class Reference

Represents an annotation / PMI (Product and Manufacturing Information) display instance object. More...

Inheritance diagram for NXOpen::Annotations::Annotation:
NXOpen::DisplayableObject NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject NXOpen::Annotations::BaseFrameBar NXOpen::Annotations::Dimension NXOpen::Annotations::DimensionSet NXOpen::Annotations::DraftingAid NXOpen::Annotations::Hatch NXOpen::Annotations::PmiAttribute NXOpen::Annotations::PmiWave NXOpen::Annotations::Region NXOpen::Annotations::TableSection NXOpen::Annotations::TitleBlock

List of all members.

Classes

struct  AssociativeOriginData
 Describes the geometry that an annotation's origin is associated with. More...

Public Member Functions

NXOpen::Point3d AnnotationOrigin ()
 Returns the origin (location) of the annotation
Created in NX3.0.0.
NXOpen::XformAnnotationPlane ()
 Returns the annotation plane
Created in NX4.0.0.
NXOpen::Annotations::Annotation::AssociativeOriginData GetAssociativeOrigin (NXOpen::Point3d *origin)
 Gets data that specifies the origin's associativity.
NXOpen::Annotations::AssociativityGetAssociativity (int associativityIndex)
 Returns the associativity at specified index.
NXOpen::XformGetInferredAnnotationPlane (NXOpen::Annotations::PmiDefaultPlane jaDefaultPlane)
 Returns the inferred annotation plane.
NXOpen::Annotations::LetteringPreferencesGetLetteringPreferences ()
 Returns the lettering preferences for the annotation.
NXOpen::Annotations::LineAndArrowPreferencesGetLineAndArrowPreferences ()
 Returns the line and arrow preferences for the annotation.
NXOpen::Annotations::SymbolPreferencesGetSymbolPreferences ()
 Returns the symbol preferences for the annotation.
std::vector< NXOpen::View * > GetViews ()
 Returns the views that the PMI display instance object is displayed in NOTE: This method is only valid for PMI display instance objects This method will return an empty view list for non-PMI display instance objects.
bool HasAssociativeOrigin ()
 Returns a flag indicating whether the origin is associative
Created in NX3.0.0.
void InsertIntoStack (NXOpen::Annotations::Annotation *stack, NXOpen::Annotations::StackAlignmentPosition position)
 Inserts the symbol into a stack
Created in NX6.0.1.
bool IsRetained ()
 Returns a flag indicating whether the annotation is retained
Created in NX3.0.0.
NXOpen::Annotations::LeaderOrientation LeaderOrientation ()
 Returns the leader orientation for the annotation
Created in NX3.0.0.
int NumberOfAssociativities ()
 Returns the number of associativities for the annotation.
void SetAnnotationOrigin (const NXOpen::Point3d &origin)
 Sets the origin (location) of the annotation
Created in NX3.0.0.
void SetAnnotationPlane (NXOpen::Xform *annotationPlane)
 Sets the annotation plane
Created in NX4.0.0.
void SetAssociativeOrigin (const NXOpen::Annotations::Annotation::AssociativeOriginData &assocOrigin, const NXOpen::Point3d &origin)
 Associates the annotation's origin to the specified geometry
Created in NX3.0.0.
void SetAssociativity (int associativityIndex, NXOpen::Annotations::Associativity *associativity)
 Sets the associativity at specified index.
void SetLeaderOrientation (NXOpen::Annotations::LeaderOrientation leaderOrientation)
 Sets the leader orientation for the annotation
Created in NX3.0.0.
void SetLetteringPreferences (NXOpen::Annotations::LetteringPreferences *letteringPrefs)
 Sets the lettering preferences for the annotation
Created in NX3.0.0.
void SetLineAndArrowPreferences (NXOpen::Annotations::LineAndArrowPreferences *lineArrowPrefs)
 Sets the line and arrow preferences for the annotation
Created in NX3.0.0.
void SetSymbolPreferences (NXOpen::Annotations::SymbolPreferences *symbolPrefs)
 Sets the symbol preferences for the annotation
Created in NX5.0.0.
void SetViews (const std::vector< NXOpen::View * > &modelViews)
 Sets the views that the PMI display instance object is displayed in.

Detailed Description

Represents an annotation / PMI (Product and Manufacturing Information) display instance object.


Creation of drafting annotation objects is controlled by drafting license.

Creation of PMI display instance objects is controlled by geometric_tol license.

In all edit methods, the changes are not applied to the system until an update is performed. An update can be performed by calling Update::DoUpdate ().

This is an abstract class.

Created in NX3.0.0.


Member Function Documentation

Returns the origin (location) of the annotation
Created in NX3.0.0.



License requirements : None

Returns the annotation plane
Created in NX4.0.0.



License requirements : None

Gets data that specifies the origin's associativity.

Returns:
associativity data
Created in NX3.0.0.

License requirements : None
Parameters:
origincoordinates of the origin

Returns the associativity at specified index.

Returns:
Associativity object
Created in NX4.0.0.

License requirements : None
Parameters:
associativityIndexAssociativity index

Returns the inferred annotation plane.

Returns:

Created in NX4.0.0.

License requirements : None
Parameters:
jaDefaultPlaneja default plane

Returns the lettering preferences for the annotation.

Returns:

Created in NX3.0.0.

License requirements : None

Returns the line and arrow preferences for the annotation.

Returns:

Created in NX3.0.0.

License requirements : None

Returns the symbol preferences for the annotation.

Returns:

Created in NX5.0.0.

License requirements : None

Returns the views that the PMI display instance object is displayed in NOTE: This method is only valid for PMI display instance objects This method will return an empty view list for non-PMI display instance objects.

Returns:
List of views that PMI display instance object is displayed in
Created in NX4.0.0.

License requirements : None

Returns a flag indicating whether the origin is associative
Created in NX3.0.0.



License requirements : None

Inserts the symbol into a stack
Created in NX6.0.1.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
stackAnnotation in the stack
positionAlignment position

Returns a flag indicating whether the annotation is retained
Created in NX3.0.0.



License requirements : None

Returns the leader orientation for the annotation
Created in NX3.0.0.



License requirements : None

Returns the number of associativities for the annotation.


Created in NX4.0.0.

License requirements : None

Sets the origin (location) of the annotation
Created in NX3.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
originthe new location

Sets the annotation plane
Created in NX4.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
annotationPlaneannotation plane

Associates the annotation's origin to the specified geometry
Created in NX3.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
assocOriginassociativity data
origincoordinates of the origin
void NXOpen::Annotations::Annotation::SetAssociativity ( int  associativityIndex,
NXOpen::Annotations::Associativity associativity 
)

Sets the associativity at specified index.


Created in NX4.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
associativityIndexAssociativity index
associativityAssociativity object

Sets the leader orientation for the annotation
Created in NX3.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
leaderOrientationleader orientation

Sets the lettering preferences for the annotation
Created in NX3.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
letteringPrefslettering prefs

Sets the line and arrow preferences for the annotation
Created in NX3.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
lineArrowPrefsline arrow prefs

Sets the symbol preferences for the annotation
Created in NX5.0.0.



License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters:
symbolPrefssymbol prefs
void NXOpen::Annotations::Annotation::SetViews ( const std::vector< NXOpen::View * > &  modelViews)

Sets the views that the PMI display instance object is displayed in.

NOTE: This method is only valid for PMI display instance objects.
Created in NX4.0.0.

License requirements : geometric_tol ("GDT")

Parameters:
modelViewsList of new views to display PMI display instance object in

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.