NX Open C++ Reference Guide
|
Represents an annotation / PMI (Product and Manufacturing Information) display instance object. More...
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::Xform * | AnnotationPlane () |
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::Associativity * | GetAssociativity (int associativityIndex) |
Returns the associativity at specified index. | |
NXOpen::Xform * | GetInferredAnnotationPlane (NXOpen::Annotations::PmiDefaultPlane jaDefaultPlane) |
Returns the inferred annotation plane. | |
NXOpen::Annotations::LetteringPreferences * | GetLetteringPreferences () |
Returns the lettering preferences for the annotation. | |
NXOpen::Annotations::LineAndArrowPreferences * | GetLineAndArrowPreferences () |
Returns the line and arrow preferences for the annotation. | |
NXOpen::Annotations::SymbolPreferences * | GetSymbolPreferences () |
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. |
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.
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
NXOpen::Annotations::Annotation::AssociativeOriginData NXOpen::Annotations::Annotation::GetAssociativeOrigin | ( | NXOpen::Point3d * | origin | ) |
Gets data that specifies the origin's associativity.
origin | coordinates of the origin |
NXOpen::Annotations::Associativity* NXOpen::Annotations::Annotation::GetAssociativity | ( | int | associativityIndex | ) |
Returns the associativity at specified index.
associativityIndex | Associativity index |
NXOpen::Xform* NXOpen::Annotations::Annotation::GetInferredAnnotationPlane | ( | NXOpen::Annotations::PmiDefaultPlane | jaDefaultPlane | ) |
Returns the inferred annotation plane.
jaDefaultPlane | ja default plane |
NXOpen::Annotations::LetteringPreferences* NXOpen::Annotations::Annotation::GetLetteringPreferences | ( | ) |
Returns the lettering preferences for the annotation.
NXOpen::Annotations::LineAndArrowPreferences* NXOpen::Annotations::Annotation::GetLineAndArrowPreferences | ( | ) |
Returns the line and arrow preferences for the annotation.
Returns the symbol preferences for the annotation.
std::vector<NXOpen::View *> NXOpen::Annotations::Annotation::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.
Returns a flag indicating whether the origin is associative
Created in NX3.0.0.
License requirements : None
void NXOpen::Annotations::Annotation::InsertIntoStack | ( | NXOpen::Annotations::Annotation * | stack, |
NXOpen::Annotations::StackAlignmentPosition | position | ||
) |
Inserts the symbol into a stack
Created in NX6.0.1.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
stack | Annotation in the stack |
position | Alignment 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
void NXOpen::Annotations::Annotation::SetAnnotationOrigin | ( | const NXOpen::Point3d & | origin | ) |
Sets the origin (location) of the annotation
Created in NX3.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
origin | the new location |
void NXOpen::Annotations::Annotation::SetAnnotationPlane | ( | NXOpen::Xform * | annotationPlane | ) |
Sets the annotation plane
Created in NX4.0.0.
License requirements : geometric_tol ("GDT")
annotationPlane | annotation plane |
void NXOpen::Annotations::Annotation::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.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
assocOrigin | associativity data |
origin | coordinates 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")
associativityIndex | Associativity index |
associativity | Associativity object |
void NXOpen::Annotations::Annotation::SetLeaderOrientation | ( | NXOpen::Annotations::LeaderOrientation | leaderOrientation | ) |
Sets the leader orientation for the annotation
Created in NX3.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
leaderOrientation | leader orientation |
void NXOpen::Annotations::Annotation::SetLetteringPreferences | ( | NXOpen::Annotations::LetteringPreferences * | letteringPrefs | ) |
Sets the lettering preferences for the annotation
Created in NX3.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
letteringPrefs | lettering prefs |
void NXOpen::Annotations::Annotation::SetLineAndArrowPreferences | ( | NXOpen::Annotations::LineAndArrowPreferences * | lineArrowPrefs | ) |
Sets the line and arrow preferences for the annotation
Created in NX3.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
lineArrowPrefs | line arrow prefs |
void NXOpen::Annotations::Annotation::SetSymbolPreferences | ( | NXOpen::Annotations::SymbolPreferences * | symbolPrefs | ) |
Sets the symbol preferences for the annotation
Created in NX5.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
symbolPrefs | symbol 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")
modelViews | List of new views to display PMI display instance object in |