NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Annotations::AnnotationManager Class Reference

Represents an object that manages annotation and PMI (Product and Manufacturing Information) display instance objects. More...

Public Member Functions

NXOpen::Annotations::BendTableCollectionBendTables ()
 Bend Table collection
Created in NX9.0.0. More...
 
NXOpen::Annotations::BusinessModifierCollectionBusinessModifiers ()
 BusinessModifier collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::CenterlineCollectionCenterlines ()
 Centerlines collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::GdtConvertToGdt (NXOpen::Annotations::SimpleDraftingAid *draftingAid, bool keepDraftingAid, NXOpen::Annotations::LeaderBundle *leader)
 Converts a simple drafting aid into a GDT by creating a new GDT using the text, origin, and preferences from the drafting aid. More...
 
NXOpen::Annotations::SimpleDraftingAidConvertToIdSymbol (NXOpen::Annotations::SimpleDraftingAid *draftingAid, bool keepDraftingAid, NXOpen::Annotations::LeaderBundle *leader)
 Converts a simple drafting aid into an ID symbol by creating a new ID symbol using the text, origin, and preferences from the drafting aid. More...
 
NXOpen::Annotations::LabelConvertToLabel (NXOpen::Annotations::SimpleDraftingAid *draftingAid, bool keepDraftingAid, NXOpen::Annotations::LeaderBundle *leader)
 Converts a simple drafting aid into a label by creating a new label using the text, origin, and preferences from the drafting aid. More...
 
NXOpen::Annotations::LineWeldConvertToLineWeld (NXOpen::Annotations::LineWeld *draftingAid, bool keepDraftingAid, NXOpen::Annotations::LeaderBundle *leader)
 Converts a simple drafting aid into a line weld by creating a new line weld using the text, origin, and preferences from the drafting aid. More...
 
NXOpen::Annotations::NoteConvertToNote (NXOpen::Annotations::SimpleDraftingAid *draftingAid, bool keepDraftingAid)
 Converts a simple drafting aid into a note by creating a new note using the text, origin, and preferences from the drafting aid. More...
 
NXOpen::Annotations::AssociateDimensionBuilderCreateAssociateDimensionBuilder (NXOpen::Annotations::Dimension *dimension)
 Creates the Dimension Associativity builder. More...
 
NXOpen::Annotations::AssociativeTextCreateAssociativeText ()
 Creates a NXOpen::Annotations::AssociativeText . More...
 
NXOpen::Annotations::AssociativityBuilderCreateAssociativityBuilder (NXOpen::Annotations::Dimension *dimension, int assocIndex)
 Creates the Dimension Associativity builder. More...
 
NXOpen::Annotations::ComponentDataCreateComponentData (NXOpen::Annotations::Annotation *annotationTag)
 Creates a NXOpen::Annotations::ComponentData for an annotation. More...
 
NXOpen::Annotations::CompoundDatumReferenceBuilderCreateCompoundDatumReferenceBuilder ()
 Creates a new compound datum dialog. More...
 
NXOpen::Annotations::DatumReferenceBuilderCreateDatumReferenceBuilder (NXOpen::Annotations::FcfDatumReference *datumReference)
 Creates a NXOpen::Annotations::DatumReferenceBuilder. More...
 
NXOpen::Annotations::DraftingDatumTargetBuilderCreateDraftingDatumTargetBuilder (NXOpen::Annotations::DraftingDatumTarget *datumTarget)
 Creates a NXOpen::Annotations::DraftingDatumTargetBuilder. More...
 
NXOpen::Annotations::DraftingFeatureControlFrameBuilderCreateDraftingFeatureControlFrameBuilder (NXOpen::Annotations::Gdt *fcf)
 Creates a NXOpen::Annotations::DraftingFeatureControlFrameBuilder. More...
 
NXOpen::Annotations::DraftingNoteBuilderCreateDraftingNoteBuilder (NXOpen::Annotations::SimpleDraftingAid *annotation)
 Creates a NXOpen::Annotations::DraftingNoteBuilder. More...
 
NXOpen::Annotations::EditLeaderBuilderCreateEditLeaderBuilder (NXOpen::DisplayableObject *tableTag)
 Creates a NXOpen::Annotations::EditLeaderBuilder. More...
 
NXOpen::Annotations::DatumReferenceBuilderCreateEmptyDatumReferenceBuilder ()
 Creates a new empty datum reference builder. More...
 
NXOpen::Annotations::FeatureControlFrameDataBuilderCreateFeatureControlFrameDataBuilder (NXOpen::Annotations::FeatureControlFrameData *frame)
 Creates a NXOpen::Annotations::FeatureControlFrameDataBuilder. More...
 
NXOpen::Annotations::FeatureControlFrameIndicatorBuilderCreateFeatureControlFrameIndicatorBuilder ()
 Creates a NXOpen::Annotations::FeatureControlFrameIndicatorBuilder. More...
 
NXOpen::Annotations::GdtCreateGdt (std::vector< NXString > &textLines, const NXOpen::Point3d &origin, NXOpen::Annotations::LetteringPreferences *letteringPreferences, NXOpen::Annotations::UserSymbolPreferences *userSymbolPreferences, NXOpen::Annotations::LineAndArrowPreferences *lineArrowPreferences, bool alwaysVertical, NXOpen::Annotations::LeaderBundle *leader)
 Creates a GDT symbol. More...
 
NXOpen::Annotations::LabelCreateLabel (std::vector< NXString > &textLines, const NXOpen::Point3d &origin, NXOpen::Annotations::LetteringPreferences *letteringPreferences, NXOpen::Annotations::UserSymbolPreferences *userSymbolPreferences, NXOpen::Annotations::LineAndArrowPreferences *lineArrowPreferences, NXOpen::Annotations::LeaderBundle *leader)
 Creates a label. More...
 
NXOpen::Annotations::LeaderDataCreateLeaderData ()
 Creates a NXOpen::Annotations::LeaderData. More...
 
NXOpen::Annotations::NoteCreateNote (std::vector< NXString > &textLines, const NXOpen::Point3d &origin, NXOpen::AxisOrientation orientation, NXOpen::Annotations::LetteringPreferences *letteringPreferences, NXOpen::Annotations::UserSymbolPreferences *userSymbolPreferences)
 Creates a note. More...
 
NXOpen::Annotations::PmiDatumTargetBuilderCreatePmiDatumTargetBuilder (NXOpen::Annotations::DatumTarget *datumTarget)
 Creates a NXOpen::Annotations::PmiDatumTargetBuilder. More...
 
NXOpen::Annotations::PmiFeatureControlFrameBuilderCreatePmiFeatureControlFrameBuilder (NXOpen::Annotations::Fcf *fcf)
 Creates a NXOpen::Annotations::PmiFeatureControlFrameBuilder. More...
 
NXOpen::Annotations::PmiNoteBuilderCreatePmiNoteBuilder (NXOpen::Annotations::SimpleDraftingAid *annotation)
 Creates a NXOpen::Annotations::PmiNoteBuilder. More...
 
NXOpen::Annotations::PmiTrackingPropertiesBuilderCreatePmiTrackingPropertiesBuilder ()
 Creates a NXOpen::Annotations::PmiTrackingPropertiesBuilder . More...
 
NXOpen::Annotations::QueryPmiBuilderCreateQueryPmiBuilder ()
 Creates the Query PMI builder. More...
 
NXOpen::ModelingViewCreateQueryView (const std::vector< NXOpen::Annotations::Annotation * > &pmiSymbols)
 Creates a model view displaying the given PMI symbols. More...
 
NXString CurrentSbfFile ()
 Returns the symbol font definition file. More...
 
NXOpen::Annotations::CustomSymbolCollectionCustomSymbols ()
 CustomSymbol collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::GdtDatumCollectionDatums ()
 Datum collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::DatumTargetCollectionDatumTargets ()
 DatumTarget collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::DimensionSetCollectionDimensionSets ()
 DimensionSet collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::DraftingDatumTargetCollectionDraftingDatumTargets ()
 DraftingDatumTarget collection
Created in NX8.0.1. More...
 
NXOpen::Annotations::DraftingImageCollectionDraftingImages ()
 Drafting Image collection
Created in NX9.0.0. More...
 
NXOpen::Annotations::DraftingSurfaceFinishCollectionDraftingSurfaceFinishSymbols ()
 Drafting surface finish collection
Created in NX7.5.0. More...
 
NXOpen::Annotations::FcfCollectionFcfs ()
 Fcf collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::FrameBarCollectionFrameBars ()
 Frame bar collection
Created in NX8.0.0. More...
 
NXOpen::XformGetDefaultAnnotationPlane (NXOpen::Annotations::PmiDefaultPlane jaDefaultPlane)
 Returns the default annotation plane for the specified part. More...
 
NXString GetStandardSymbolTextFont ()
 Returns the font to use for displaying symbols with standard fonts. More...
 
NXOpen::Annotations::HatchCollectionHatches ()
 Hatch collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::HoleTableCollectionHoleTables ()
 Hole Table collection
Created in NX9.0.0. More...
 
NXOpen::Annotations::IdSymbolCollectionIdSymbols ()
 IdSymbol collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::IntersectionSymbolCollectionIntersectionSymbols ()
 IntersectionSymbol collection
Created in NX3.0.0. More...
 
NXOpen::SymbolFontLoadSymbolFontFromSbfFile (const NXString &symbolName, double *symbolWidth, double *symbolHeight)
 Loads a symbol font from the current symbol font definition file. More...
 
NXOpen::SymbolFontLoadSymbolFontFromSbfFile (const char *symbolName, double *symbolWidth, double *symbolHeight)
 Loads a symbol font from the current symbol font definition file. More...
 
void MakePmi (NXOpen::Annotations::Annotation *annotation)
 Flag the annotation as PMI object. More...
 
NXOpen::Annotations::AppendedTextNewAppendedText ()
 Creates a new AppendedText object. More...
 
NXOpen::Annotations::AssociativityNewAssociativity ()
 Creates a new Associativity object. More...
 
NXOpen::Annotations::DatumReferenceNewDatumReference ()
 Creates a new DatumReference object. More...
 
NXOpen::Annotations::DimensionDataNewDimensionData ()
 Creates new DimensionData object. More...
 
NXOpen::Annotations::FcfFrameNewFcfFrame ()
 Creates a new FcfFrame object. More...
 
NXOpen::Annotations::FcfFrameDataNewFcfFrameData ()
 Creates a new Fcf Frame Data object. More...
 
NXOpen::Annotations::LeaderBundleNewLeaderBundle ()
 Constructs a new LeaderBundle object. More...
 
NXOpen::Annotations::MasterCustomSymbolDataNewMasterCustomSymbolData ()
 Creates a new MasterCustomSymbolData object. More...
 
NXOpen::Annotations::PmiDataNewPmiData ()
 Creates a new PmiData object. More...
 
NXOpen::Annotations::UserSymbolPreferencesNewUserSymbolPreferences (NXOpen::Annotations::UserSymbolPreferences::SizeType type, double lengthOrScale, double heightOrAspectRatio)
 Constructs a new UserSymbolPreferences object. More...
 
NXOpen::Annotations::OffsetCenterPointCollectionOffsetCenterPoints ()
 OffsetCenterPoint collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::OrdinateMarginCollectionOrdinateMargins ()
 OrdinateMargin collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::PartSymbolFolderCollectionPartSymbolFolders ()
 Part Symbol Folder collection
Created in NX7.5.0. More...
 
NXOpen::Annotations::PmiFilterCollectionPmiFilters ()
 PmiFilter collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::PmiTableSectionCollectionPmiTableSections ()
 PMI Table collection
Created in NX12.0.0. More...
 
NXOpen::Preferences::AnnotationPreferencesPreferences ()
 Global annotation preferences
Created in NX3.0.0. More...
 
std::vector
< NXOpen::Annotations::Annotation * > 
QueryPmiFromGeometry (const std::vector< NXOpen::DisplayableObject * > &geom)
 Finds all PMI symbols that reference the given geometry as an associated object. More...
 
std::vector< NXStringReadAllSymbolNamesFromSbfFile ()
 Reads the names of all symbol fonts in the current symbol font definition file. More...
 
void RemovePmi (NXOpen::Annotations::Annotation *annotation)
 Remove PMI flag from annotation. More...
 
void SaveUserSymbolPart (NXOpen::Annotations::MasterCustomSymbolData *symData)
 Save a new master Custom Symbol file. More...
 
void SetCurrentSbfFile (const NXString &fileName)
 Sets the symbol font definition file. More...
 
void SetCurrentSbfFile (const char *fileName)
 Sets the symbol font definition file. More...
 
void SetMasterSymbolNameInQaf ()
 This method writes master custom symbol name to the predefined quick access folder and saves the part. More...
 
void SetParallelToScreen (bool parallelToScreen, const std::vector< NXOpen::Annotations::Annotation * > &annotations)
 Sets the parallel to screen status on each input annotation. More...
 
void SetStandardSymbolTextFont (const NXString &symbolTextFontName)
 
Created in NX8.5.0. More...
 
void SetStandardSymbolTextFont (const char *symbolTextFontName)
 
Created in NX8.5.0. More...
 
void SetWeldStandard (NXOpen::Annotations::WeldStandard standard)
 Sets the weld standard for the part file. More...
 
NXOpen::Annotations::SymbolFileCollectionSymbolFiles ()
 Library Symbol collection
Created in NX8.0.0. More...
 
NXOpen::Annotations::TableCollectionTables ()
 Table collection
Created in NX8.0.0. More...
 
NXOpen::Annotations::TableSectionCollectionTableSections ()
 Table section collection
Created in NX8.0.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
NXOpen::Annotations::TargetPointCollectionTargetPoints ()
 TargetPoint collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::WeldCollectionWelds ()
 Weld collection
Created in NX3.0.0. More...
 
NXOpen::Annotations::WeldStandard WeldStandard ()
 Returns the weld standard for the part file. More...
 

Detailed Description

Represents an object that manages annotation and PMI (Product and Manufacturing Information) display instance objects.

This class contains the collection objects for creating and iterating over annotations and PMI display instances.
To obtain an instance of this class, refer to NXOpen::BasePart

Created in NX3.0.0.

Member Function Documentation

NXOpen::Annotations::BendTableCollection* NXOpen::Annotations::AnnotationManager::BendTables ( )

Bend Table collection
Created in NX9.0.0.


NXOpen::Annotations::BusinessModifierCollection* NXOpen::Annotations::AnnotationManager::BusinessModifiers ( )

BusinessModifier collection
Created in NX3.0.0.


NXOpen::Annotations::CenterlineCollection* NXOpen::Annotations::AnnotationManager::Centerlines ( )

Centerlines collection
Created in NX3.0.0.


NXOpen::Annotations::Gdt* NXOpen::Annotations::AnnotationManager::ConvertToGdt ( NXOpen::Annotations::SimpleDraftingAid draftingAid,
bool  keepDraftingAid,
NXOpen::Annotations::LeaderBundle leader 
)

Converts a simple drafting aid into a GDT by creating a new GDT using the text, origin, and preferences from the drafting aid.

If there are other annotations that are dependent on the drafting aid, (for example, a label that has a leader attached to the drafting aid), those dependencies will NOT be copied over.

Returns
the new GDT
Created in NX3.0.0.

License requirements : drafting ("DRAFTING")
Parameters
draftingAidthe drafting aid to convert
keepDraftingAidwhether to keep the drafting aid. If false, the drafting aid will be deleted
leaderspecifies the leaders for the new GDT
NXOpen::Annotations::SimpleDraftingAid* NXOpen::Annotations::AnnotationManager::ConvertToIdSymbol ( NXOpen::Annotations::SimpleDraftingAid draftingAid,
bool  keepDraftingAid,
NXOpen::Annotations::LeaderBundle leader 
)

Converts a simple drafting aid into an ID symbol by creating a new ID symbol using the text, origin, and preferences from the drafting aid.

If there are other annotations that are dependent on the drafting aid, (for example, a label that has a leader attached to the drafting aid), those dependencies will NOT be copied over.

Returns
the new ID Symbol
Created in NX4.0.0.

License requirements : drafting ("DRAFTING")
Parameters
draftingAidthe drafting aid to convert
keepDraftingAidwhether to keep the drafting aid. If false, the drafting aid will be deleted
leaderspecifies the leaders for the new ID Symbol
NXOpen::Annotations::Label* NXOpen::Annotations::AnnotationManager::ConvertToLabel ( NXOpen::Annotations::SimpleDraftingAid draftingAid,
bool  keepDraftingAid,
NXOpen::Annotations::LeaderBundle leader 
)

Converts a simple drafting aid into a label by creating a new label using the text, origin, and preferences from the drafting aid.

If there are other annotations that are dependent on the drafting aid, (for example, a label that has a leader attached to the drafting aid), those dependencies will NOT be copied over.

Returns
the new label
Created in NX3.0.0.

License requirements : drafting ("DRAFTING")
Parameters
draftingAidthe drafting aid to convert
keepDraftingAidwhether to keep the drafting aid. If false, the drafting aid will be deleted
leaderspecifies the leaders for the new label. The leader type must be Plain, Around, PlainAligned, or AroundAligned. To use any other type of leader, you must create a GDT instead.
NXOpen::Annotations::LineWeld* NXOpen::Annotations::AnnotationManager::ConvertToLineWeld ( NXOpen::Annotations::LineWeld draftingAid,
bool  keepDraftingAid,
NXOpen::Annotations::LeaderBundle leader 
)

Converts a simple drafting aid into a line weld by creating a new line weld using the text, origin, and preferences from the drafting aid.

If there are other annotations that are dependent on the drafting aid, (for example, a line weld that has a leader attached to the drafting aid), those dependencies will NOT be copied over.

Returns
the new line weld
Created in NX3.0.0.

License requirements : drafting ("DRAFTING")
Parameters
draftingAidthe drafting aid to convert
keepDraftingAidwhether to keep the drafting aid. If false, the drafting aid will be deleted
leaderspecifies the leaders for the new label. The leader type must be Plain, Around, PlainAligned, or AroundAligned. To use any other type of leader, you must create a GDT instead.
NXOpen::Annotations::Note* NXOpen::Annotations::AnnotationManager::ConvertToNote ( NXOpen::Annotations::SimpleDraftingAid draftingAid,
bool  keepDraftingAid 
)

Converts a simple drafting aid into a note by creating a new note using the text, origin, and preferences from the drafting aid.

If there are other annotations that are dependent on the drafting aid, (for example, a label that has a leader attached to the drafting aid), those dependencies will NOT be copied over.

Returns
the new note
Created in NX3.0.0.

License requirements : drafting ("DRAFTING")
Parameters
draftingAidthe drafting aid to convert
keepDraftingAidwhether to keep the drafting aid. If false, the drafting aid will be deleted
NXOpen::Annotations::AssociateDimensionBuilder* NXOpen::Annotations::AnnotationManager::CreateAssociateDimensionBuilder ( NXOpen::Annotations::Dimension dimension)

Creates the Dimension Associativity builder.

Returns
AssociateDimensionBuilder object
Created in NX5.0.0.

License requirements : None
Parameters
dimensionNXOpen::Annotations::Dimension to be edited
NXOpen::Annotations::AssociativeText* NXOpen::Annotations::AnnotationManager::CreateAssociativeText ( )

Creates a NXOpen::Annotations::AssociativeText .


The NXOpen::Annotations::AssociativeText instance must be deleted after its use.

Returns

Created in NX8.0.0.

License requirements : None
NXOpen::Annotations::AssociativityBuilder* NXOpen::Annotations::AnnotationManager::CreateAssociativityBuilder ( NXOpen::Annotations::Dimension dimension,
int  assocIndex 
)

Creates the Dimension Associativity builder.

Returns
AssociateDimensionBuilder object
Created in NX5.0.0.

License requirements : None
Parameters
dimensionNXOpen::Annotations::Dimension to be edited
assocIndexAssociativity index
NXOpen::Annotations::ComponentData* NXOpen::Annotations::AnnotationManager::CreateComponentData ( NXOpen::Annotations::Annotation annotationTag)

Creates a NXOpen::Annotations::ComponentData for an annotation.

Returns

Created in NX6.0.2.

License requirements : None
Parameters
annotationTagthe annotation whose component data will be available with this object
NXOpen::Annotations::CompoundDatumReferenceBuilder* NXOpen::Annotations::AnnotationManager::CreateCompoundDatumReferenceBuilder ( )

Creates a new compound datum dialog.

Returns

Created in NX5.0.0.

License requirements : geometric_tol ("GDT")
NXOpen::Annotations::DatumReferenceBuilder* NXOpen::Annotations::AnnotationManager::CreateDatumReferenceBuilder ( NXOpen::Annotations::FcfDatumReference datumReference)

Creates a NXOpen::Annotations::DatumReferenceBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
datumReferencethe datum reference to be edited, if NULL, then create an fcf symbol
NXOpen::Annotations::DraftingDatumTargetBuilder* NXOpen::Annotations::AnnotationManager::CreateDraftingDatumTargetBuilder ( NXOpen::Annotations::DraftingDatumTarget datumTarget)

Creates a NXOpen::Annotations::DraftingDatumTargetBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
datumTargetDatum to edit
NXOpen::Annotations::DraftingFeatureControlFrameBuilder* NXOpen::Annotations::AnnotationManager::CreateDraftingFeatureControlFrameBuilder ( NXOpen::Annotations::Gdt fcf)

Creates a NXOpen::Annotations::DraftingFeatureControlFrameBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
fcfthe fcf symbol to be edited, if NULL, then create an fcf symbol
NXOpen::Annotations::DraftingNoteBuilder* NXOpen::Annotations::AnnotationManager::CreateDraftingNoteBuilder ( NXOpen::Annotations::SimpleDraftingAid annotation)

Creates a NXOpen::Annotations::DraftingNoteBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
annotationNXOpen::Annotations::SimpleDraftingAid to be edited
NXOpen::Annotations::EditLeaderBuilder* NXOpen::Annotations::AnnotationManager::CreateEditLeaderBuilder ( NXOpen::DisplayableObject tableTag)

Creates a NXOpen::Annotations::EditLeaderBuilder.

Returns

Created in NX6.0.1.

License requirements : drafting ("DRAFTING")
Parameters
tableTagthe table object to edit
NXOpen::Annotations::DatumReferenceBuilder* NXOpen::Annotations::AnnotationManager::CreateEmptyDatumReferenceBuilder ( )

Creates a new empty datum reference builder.

Returns

Created in NX9.0.0.

License requirements : None
NXOpen::Annotations::FeatureControlFrameDataBuilder* NXOpen::Annotations::AnnotationManager::CreateFeatureControlFrameDataBuilder ( NXOpen::Annotations::FeatureControlFrameData frame)

Creates a NXOpen::Annotations::FeatureControlFrameDataBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
framethe fcf symbol to be edited, if NULL, then create an fcf symbol
NXOpen::Annotations::FeatureControlFrameIndicatorBuilder* NXOpen::Annotations::AnnotationManager::CreateFeatureControlFrameIndicatorBuilder ( )

Creates a NXOpen::Annotations::FeatureControlFrameIndicatorBuilder.

Returns

Created in NX12.0.0.

License requirements : None
NXOpen::Annotations::Gdt* NXOpen::Annotations::AnnotationManager::CreateGdt ( std::vector< NXString > &  textLines,
const NXOpen::Point3d origin,
NXOpen::Annotations::LetteringPreferences letteringPreferences,
NXOpen::Annotations::UserSymbolPreferences userSymbolPreferences,
NXOpen::Annotations::LineAndArrowPreferences lineArrowPreferences,
bool  alwaysVertical,
NXOpen::Annotations::LeaderBundle leader 
)

Creates a GDT symbol.

Returns
the new GDT
Created in NX3.0.0.

License requirements : drafting ("DRAFTING")
Parameters
textLinestext for the GDT
originorigin for the GDT
letteringPreferenceslettering preferences. If NULL, the global lettering preferences will be used
userSymbolPreferencesuser symbol preferences. If NULL, the scale and aspect ratio will be set to 1.0
lineArrowPreferencesline and arrow preferences. If NULL, the global line and arrow preferences will be used
alwaysVerticalalways vertical
leaderspecifies the leaders for the GDT. The following leader types are not valid for GDT symbols: PlainNostub and AlignedNostub
NXOpen::Annotations::Label* NXOpen::Annotations::AnnotationManager::CreateLabel ( std::vector< NXString > &  textLines,
const NXOpen::Point3d origin,
NXOpen::Annotations::LetteringPreferences letteringPreferences,
NXOpen::Annotations::UserSymbolPreferences userSymbolPreferences,
NXOpen::Annotations::LineAndArrowPreferences lineArrowPreferences,
NXOpen::Annotations::LeaderBundle leader 
)

Creates a label.

The leader type must be Plain, Around, PlainAligned, or AroundAligned. To use any other type of leader, you must create a GDT instead.

Returns
the new label
Created in NX3.0.0.

License requirements : drafting ("DRAFTING")
Parameters
textLinestext for the label
originorigin for the label
letteringPreferenceslettering preferences. If NULL, the global lettering preferences will be used
userSymbolPreferencesuser symbol preferences. If NULL, the scale and aspect ratio will be set to 1.0
lineArrowPreferencesline and arrow preferences. If NULL, the global line and arrow preferences will be used
leaderspecifies the leaders for the label
NXOpen::Annotations::LeaderData* NXOpen::Annotations::AnnotationManager::CreateLeaderData ( )

Creates a NXOpen::Annotations::LeaderData.

Returns

Created in NX6.0.0.

License requirements : None
NXOpen::Annotations::Note* NXOpen::Annotations::AnnotationManager::CreateNote ( std::vector< NXString > &  textLines,
const NXOpen::Point3d origin,
NXOpen::AxisOrientation  orientation,
NXOpen::Annotations::LetteringPreferences letteringPreferences,
NXOpen::Annotations::UserSymbolPreferences userSymbolPreferences 
)

Creates a note.

Returns
the new note
Created in NX3.0.0.

License requirements : drafting ("DRAFTING")
Parameters
textLinestext for the note
originorigin for the note
orientationdetermines whether the note will be horizontal or vertical
letteringPreferenceslettering preferences. If NULL, the global lettering preferences will be used
userSymbolPreferencesuser symbol preferences. If NULL, the scale and aspect ratio will be set to 1.0
NXOpen::Annotations::PmiDatumTargetBuilder* NXOpen::Annotations::AnnotationManager::CreatePmiDatumTargetBuilder ( NXOpen::Annotations::DatumTarget datumTarget)

Creates a NXOpen::Annotations::PmiDatumTargetBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
datumTargetDatum to edit
NXOpen::Annotations::PmiFeatureControlFrameBuilder* NXOpen::Annotations::AnnotationManager::CreatePmiFeatureControlFrameBuilder ( NXOpen::Annotations::Fcf fcf)

Creates a NXOpen::Annotations::PmiFeatureControlFrameBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
fcfthe fcf symbol to be edited, if NULL, then create an fcf symbol
NXOpen::Annotations::PmiNoteBuilder* NXOpen::Annotations::AnnotationManager::CreatePmiNoteBuilder ( NXOpen::Annotations::SimpleDraftingAid annotation)

Creates a NXOpen::Annotations::PmiNoteBuilder.

Returns

Created in NX6.0.0.

License requirements : None
Parameters
annotationNXOpen::Annotations::SimpleDraftingAid to be edited
NXOpen::Annotations::PmiTrackingPropertiesBuilder* NXOpen::Annotations::AnnotationManager::CreatePmiTrackingPropertiesBuilder ( )

Creates a NXOpen::Annotations::PmiTrackingPropertiesBuilder .

Returns
PmiTrackingPropertiesBuilder object
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")
NXOpen::Annotations::QueryPmiBuilder* NXOpen::Annotations::AnnotationManager::CreateQueryPmiBuilder ( )

Creates the Query PMI builder.

Returns

Created in NX5.0.0.

License requirements : geometric_tol ("GDT")
NXOpen::ModelingView* NXOpen::Annotations::AnnotationManager::CreateQueryView ( const std::vector< NXOpen::Annotations::Annotation * > &  pmiSymbols)

Creates a model view displaying the given PMI symbols.

This method would ordinarily be invoked with the PMI symbols resulting from a call to NXOpen::Annotations::AnnotationManager::QueryPmiFromGeometry .

Returns
Model view displaying the given PMI symbols
Created in NX5.0.0.

License requirements : geometric_tol ("GDT")
Parameters
pmiSymbolsList of PMI symbols, ordinarily from a geometry query
NXString NXOpen::Annotations::AnnotationManager::CurrentSbfFile ( )

Returns the symbol font definition file.

LoadSymbolFontFromSbfFile will read from this file
Created in NX3.0.0.

License requirements : None

NXOpen::Annotations::CustomSymbolCollection* NXOpen::Annotations::AnnotationManager::CustomSymbols ( )

CustomSymbol collection
Created in NX3.0.0.


NXOpen::Annotations::GdtDatumCollection* NXOpen::Annotations::AnnotationManager::Datums ( )

Datum collection
Created in NX3.0.0.


NXOpen::Annotations::DatumTargetCollection* NXOpen::Annotations::AnnotationManager::DatumTargets ( )

DatumTarget collection
Created in NX3.0.0.


NXOpen::Annotations::DimensionSetCollection* NXOpen::Annotations::AnnotationManager::DimensionSets ( )

DimensionSet collection
Created in NX3.0.0.


NXOpen::Annotations::DraftingDatumTargetCollection* NXOpen::Annotations::AnnotationManager::DraftingDatumTargets ( )

DraftingDatumTarget collection
Created in NX8.0.1.


NXOpen::Annotations::DraftingImageCollection* NXOpen::Annotations::AnnotationManager::DraftingImages ( )

Drafting Image collection
Created in NX9.0.0.


NXOpen::Annotations::DraftingSurfaceFinishCollection* NXOpen::Annotations::AnnotationManager::DraftingSurfaceFinishSymbols ( )

Drafting surface finish collection
Created in NX7.5.0.


NXOpen::Annotations::FcfCollection* NXOpen::Annotations::AnnotationManager::Fcfs ( )

Fcf collection
Created in NX3.0.0.


NXOpen::Annotations::FrameBarCollection* NXOpen::Annotations::AnnotationManager::FrameBars ( )

Frame bar collection
Created in NX8.0.0.


NXOpen::Xform* NXOpen::Annotations::AnnotationManager::GetDefaultAnnotationPlane ( NXOpen::Annotations::PmiDefaultPlane  jaDefaultPlane)

Returns the default annotation plane for the specified part.

Returns

Created in NX4.0.0.

License requirements : None
Parameters
jaDefaultPlaneja default plane
NXString NXOpen::Annotations::AnnotationManager::GetStandardSymbolTextFont ( )

Returns the font to use for displaying symbols with standard fonts.

Returns
The name of the text font to use for displaying a symbol when using a standard font.
Created in NX8.5.0.

License requirements : None
NXOpen::Annotations::HatchCollection* NXOpen::Annotations::AnnotationManager::Hatches ( )

Hatch collection
Created in NX3.0.0.


NXOpen::Annotations::HoleTableCollection* NXOpen::Annotations::AnnotationManager::HoleTables ( )

Hole Table collection
Created in NX9.0.0.


NXOpen::Annotations::IdSymbolCollection* NXOpen::Annotations::AnnotationManager::IdSymbols ( )

IdSymbol collection
Created in NX3.0.0.


NXOpen::Annotations::IntersectionSymbolCollection* NXOpen::Annotations::AnnotationManager::IntersectionSymbols ( )

IntersectionSymbol collection
Created in NX3.0.0.


NXOpen::SymbolFont* NXOpen::Annotations::AnnotationManager::LoadSymbolFontFromSbfFile ( const NXString symbolName,
double *  symbolWidth,
double *  symbolHeight 
)

Loads a symbol font from the current symbol font definition file.

Returns

Created in NX3.0.0.

License requirements : None
Parameters
symbolNamename of the symbol
symbolWidthsymbol width
symbolHeightsymbol height
NXOpen::SymbolFont* NXOpen::Annotations::AnnotationManager::LoadSymbolFontFromSbfFile ( const char *  symbolName,
double *  symbolWidth,
double *  symbolHeight 
)

Loads a symbol font from the current symbol font definition file.

Returns

Created in NX3.0.0.

License requirements : None
Parameters
symbolNamename of the symbol
symbolWidthsymbol width
symbolHeightsymbol height
void NXOpen::Annotations::AnnotationManager::MakePmi ( NXOpen::Annotations::Annotation annotation)

Flag the annotation as PMI object.

Once flagged, the annotation particiaptes in all PMI specific behaviors, so you can manage it from Part Navigator, inherit on a drawing view, control its display in different model views etc..
Created in NX6.0.0.

License requirements : geometric_tol ("GDT")

Parameters
annotationNXOpen::Annotations::Annotation to be edited
NXOpen::Annotations::AppendedText* NXOpen::Annotations::AnnotationManager::NewAppendedText ( )

Creates a new AppendedText object.

Returns
New AppendedText object
Created in NX4.0.0.

License requirements : None
NXOpen::Annotations::Associativity* NXOpen::Annotations::AnnotationManager::NewAssociativity ( )

Creates a new Associativity object.

Returns
New Associativity object
Created in NX4.0.0.

License requirements : None
NXOpen::Annotations::DatumReference* NXOpen::Annotations::AnnotationManager::NewDatumReference ( )

Creates a new DatumReference object.

Returns
New DatumReference object
Created in NX4.0.0.

License requirements : None
NXOpen::Annotations::DimensionData* NXOpen::Annotations::AnnotationManager::NewDimensionData ( )

Creates new DimensionData object.

Returns
New DimensionData object
Created in NX4.0.0.

License requirements : None
NXOpen::Annotations::FcfFrame* NXOpen::Annotations::AnnotationManager::NewFcfFrame ( )

Creates a new FcfFrame object.

Returns
New FcfFrame object
Created in NX4.0.0.

License requirements : None
NXOpen::Annotations::FcfFrameData* NXOpen::Annotations::AnnotationManager::NewFcfFrameData ( )

Creates a new Fcf Frame Data object.

Returns
New Fcf Frame Data object
Created in NX5.0.0.

License requirements : None
NXOpen::Annotations::LeaderBundle* NXOpen::Annotations::AnnotationManager::NewLeaderBundle ( )

Constructs a new LeaderBundle object.

Returns

Created in NX3.0.0.

License requirements : None
NXOpen::Annotations::MasterCustomSymbolData* NXOpen::Annotations::AnnotationManager::NewMasterCustomSymbolData ( )

Creates a new MasterCustomSymbolData object.

Returns
New MasterCustomSymbolData object
Deprecated:
Deprecated in NX9.0.0. Use NXOpen::Annotations::MasterSymbolBuilder instead.


Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::PmiData* NXOpen::Annotations::AnnotationManager::NewPmiData ( )

Creates a new PmiData object.

Returns
New PMIData object
Created in NX4.0.0.

License requirements : None
NXOpen::Annotations::UserSymbolPreferences* NXOpen::Annotations::AnnotationManager::NewUserSymbolPreferences ( NXOpen::Annotations::UserSymbolPreferences::SizeType  type,
double  lengthOrScale,
double  heightOrAspectRatio 
)

Constructs a new UserSymbolPreferences object.

Returns
the new object
Created in NX3.0.0.

License requirements : None
Parameters
typeWhether to use length and height or scale and aspect ratio
lengthOrScaleLength or scale
heightOrAspectRatioHeight or aspect ratio
NXOpen::Annotations::OffsetCenterPointCollection* NXOpen::Annotations::AnnotationManager::OffsetCenterPoints ( )

OffsetCenterPoint collection
Created in NX3.0.0.


NXOpen::Annotations::OrdinateMarginCollection* NXOpen::Annotations::AnnotationManager::OrdinateMargins ( )

OrdinateMargin collection
Created in NX3.0.0.


NXOpen::Annotations::PartSymbolFolderCollection* NXOpen::Annotations::AnnotationManager::PartSymbolFolders ( )

Part Symbol Folder collection
Created in NX7.5.0.


NXOpen::Annotations::PmiFilterCollection* NXOpen::Annotations::AnnotationManager::PmiFilters ( )

PmiFilter collection
Created in NX3.0.0.


NXOpen::Annotations::PmiTableSectionCollection* NXOpen::Annotations::AnnotationManager::PmiTableSections ( )

PMI Table collection
Created in NX12.0.0.


NXOpen::Preferences::AnnotationPreferences* NXOpen::Annotations::AnnotationManager::Preferences ( )

Global annotation preferences
Created in NX3.0.0.


std::vector<NXOpen::Annotations::Annotation *> NXOpen::Annotations::AnnotationManager::QueryPmiFromGeometry ( const std::vector< NXOpen::DisplayableObject * > &  geom)

Finds all PMI symbols that reference the given geometry as an associated object.

The geometry types supported are limited to those supported by NXOpen::Annotations::AssociatedObject .

Returns
PMI symbols that reference the geometry
Created in NX5.0.0.

License requirements : geometric_tol ("GDT")
Parameters
geomGeometry to be searched
std::vector<NXString> NXOpen::Annotations::AnnotationManager::ReadAllSymbolNamesFromSbfFile ( )

Reads the names of all symbol fonts in the current symbol font definition file.

Returns
array of names of all symbol fonts in the file
Created in NX3.0.0.

License requirements : None
void NXOpen::Annotations::AnnotationManager::RemovePmi ( NXOpen::Annotations::Annotation annotation)

Remove PMI flag from annotation.

After the flag is removed, the annotation can't be managed as PMI. However it retains all its properties.
Created in NX6.0.0.

License requirements : geometric_tol ("GDT")

Parameters
annotationNXOpen::Annotations::Annotation to be edited
void NXOpen::Annotations::AnnotationManager::SaveUserSymbolPart ( NXOpen::Annotations::MasterCustomSymbolData symData)

Save a new master Custom Symbol file.

Use builder class NXOpen::Annotations::MasterSymbolBuilder methods instead of this method.

Deprecated:
Deprecated in NX7.5.2. Use NXOpen::Annotations::MasterSymbolBuilder instead.


Created in NX6.0.0.

License requirements : None

Parameters
symDataNew master part data
void NXOpen::Annotations::AnnotationManager::SetCurrentSbfFile ( const NXString fileName)

Sets the symbol font definition file.

LoadSymbolFontFromSbfFile will read from this file
Created in NX3.0.0.

License requirements : None

Parameters
fileNamefile name
void NXOpen::Annotations::AnnotationManager::SetCurrentSbfFile ( const char *  fileName)

Sets the symbol font definition file.

LoadSymbolFontFromSbfFile will read from this file
Created in NX3.0.0.

License requirements : None

Parameters
fileNamefile name
void NXOpen::Annotations::AnnotationManager::SetMasterSymbolNameInQaf ( )

This method writes master custom symbol name to the predefined quick access folder and saves the part.

The given part should correspond to the part file of native symbol part file otherwise error will be raised.
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

void NXOpen::Annotations::AnnotationManager::SetParallelToScreen ( bool  parallelToScreen,
const std::vector< NXOpen::Annotations::Annotation * > &  annotations 
)

Sets the parallel to screen status on each input annotation.


Created in NX11.0.1.

License requirements : geometric_tol ("GDT")

Parameters
parallelToScreenParallel to Screen Setting
annotationsAnnotations to be set
void NXOpen::Annotations::AnnotationManager::SetStandardSymbolTextFont ( const NXString symbolTextFontName)


Created in NX8.5.0.



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

Parameters
symbolTextFontNameThe name of the text font to use for displaying a symbol when using a standard font.
void NXOpen::Annotations::AnnotationManager::SetStandardSymbolTextFont ( const char *  symbolTextFontName)


Created in NX8.5.0.



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

Parameters
symbolTextFontNameThe name of the text font to use for displaying a symbol when using a standard font.
void NXOpen::Annotations::AnnotationManager::SetWeldStandard ( NXOpen::Annotations::WeldStandard  standard)

Sets the weld standard for the part file.


Created in NX7.5.4.

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

Parameters
standardWeld standard
NXOpen::Annotations::SymbolFileCollection* NXOpen::Annotations::AnnotationManager::SymbolFiles ( )

Library Symbol collection
Created in NX8.0.0.


NXOpen::Annotations::TableCollection* NXOpen::Annotations::AnnotationManager::Tables ( )

Table collection
Created in NX8.0.0.


NXOpen::Annotations::TableSectionCollection* NXOpen::Annotations::AnnotationManager::TableSections ( )

Table section collection
Created in NX8.0.0.


tag_t NXOpen::Annotations::AnnotationManager::Tag ( ) const

Returns the tag of this object.

NXOpen::Annotations::TargetPointCollection* NXOpen::Annotations::AnnotationManager::TargetPoints ( )

TargetPoint collection
Created in NX3.0.0.


NXOpen::Annotations::WeldCollection* NXOpen::Annotations::AnnotationManager::Welds ( )

Weld collection
Created in NX3.0.0.


NXOpen::Annotations::WeldStandard NXOpen::Annotations::AnnotationManager::WeldStandard ( )

Returns the weld standard for the part file.


Created in NX7.5.4.

License requirements : None


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