Represents a collection of NXOpen::Annotations::BaseCustomSymbol objects
To obtain an instance of this class, refer to NXOpen::Annotations::AnnotationManager
Created in NX4.0.0.
More...
Classes | |
| class | iterator |
| Iterator for accessing the contents of the collection. More... | |
Detailed Description
Represents a collection of NXOpen::Annotations::BaseCustomSymbol objects
To obtain an instance of this class, refer to NXOpen::Annotations::AnnotationManager
Created in NX4.0.0.
Member Function Documentation
| iterator NXOpen::Annotations::CustomSymbolCollection::begin | ( | ) |
Returns an iterator addressing the first element.
| NXOpen::Annotations::CustomSymbol* NXOpen::Annotations::CustomSymbolCollection::CreateCustomSymbol | ( | NXOpen::Annotations::CustomSymbolData * | customSymbolData, |
| const NXOpen::Point3d & | origin, | ||
| NXOpen::Annotations::LeaderBundle * | leader | ||
| ) |
Creates a custom symbol.
- Returns
- New custom symbol
- Deprecated:
- Deprecated in NX9.0.0. Use NXOpen::Annotations::DraftingCustomSymbolBuilder instead.
Created in NX4.0.0.
License requirements : drafting ("DRAFTING")
- Parameters
-
customSymbolData custom symbol data origin Origin for the custom symbol leader Specifies the leaders for the custom symbol
| NXOpen::Annotations::DraftingCustomSymbolBuilder* NXOpen::Annotations::CustomSymbolCollection::CreateDraftingCustomSymbolBuilder | ( | NXOpen::Annotations::CustomSymbol * | symbolTag | ) |
Creates the Drafting Symbol placement builder.
- Returns
- DraftingCustomSymbolBuilder object
Created in NX7.5.0.
License requirements : None
- Parameters
-
symbolTag Symbol as input
| NXOpen::Annotations::MasterSymbolBuilder* NXOpen::Annotations::CustomSymbolCollection::CreateMasterSymbolBuilder | ( | NXOpen::Annotations::MasterSymbol * | masterSymbolTag | ) |
Creates the Master Symbol builder.
- Returns
- MasterSymbolBuilder object
Created in NX7.5.0.
License requirements : None
- Parameters
-
masterSymbolTag NXOpen::Annotations::MasterSymbol to be set as master symbol
| NXOpen::Annotations::MasterSymbolListItemBuilder* NXOpen::Annotations::CustomSymbolCollection::CreateMasterSymbolListItemBuilder | ( | ) |
Creates the Master Symbol List Item builder.
- Returns
- CustomSymbolListItemBuilder object
Created in NX7.5.0.
License requirements : None
| NXOpen::Annotations::PmiCustomSymbol* NXOpen::Annotations::CustomSymbolCollection::CreatePmiCustomSymbol | ( | NXOpen::Annotations::CustomSymbolData * | customSymbolData, |
| NXOpen::Annotations::PmiData * | pmiData, | ||
| NXOpen::Xform * | annotationPlane, | ||
| const NXOpen::Point3d & | origin, | ||
| NXOpen::Annotations::LeaderBundle * | leader | ||
| ) |
Creates a PMI custom symbol.
- Returns
- New PMI custom symbol
- Deprecated:
- Deprecated in NX9.0.0. Use NXOpen::Annotations::PmiCustomSymbolBuilder instead.
Created in NX4.0.0.
License requirements : geometric_tol ("GDT")
- Parameters
-
customSymbolData custom symbol data pmiData PMI data annotationPlane Annotation plane on which the custom symbol lies origin Origin for the custom symbol leader Specifies the leaders for the custom symbol
| NXOpen::Annotations::PmiCustomSymbolBuilder* NXOpen::Annotations::CustomSymbolCollection::CreatePmiCustomSymbolBuilder | ( | NXOpen::Annotations::PmiCustomSymbol * | symbolTag | ) |
Creates the PMI Symbol Placement builder.
- Returns
- PMICustomSymbolBuilder object
Created in NX7.5.0.
License requirements : None
- Parameters
-
symbolTag Symbol as input
| NXOpen::Annotations::ReplaceSymbolBuilder* NXOpen::Annotations::CustomSymbolCollection::CreateReplaceSymbolBuilder | ( | ) |
Creates a NXOpen::Annotations::ReplaceSymbolBuilder.
- Returns
Created in NX8.0.1.
License requirements : drafting ("DRAFTING")
| NXOpen::Annotations::SmashCustomSymbolBuilder* NXOpen::Annotations::CustomSymbolCollection::CreateSmashCustomSymbolBuilder | ( | ) |
Smashes a custom symbol.
- Returns
Created in NX6.0.0.
License requirements : None
| NXOpen::Annotations::SymbolCatalogBuilder* NXOpen::Annotations::CustomSymbolCollection::CreateSymbolCatalogBuilder | ( | ) |
Creates a symbol catalog dialog builder.
- Returns
Created in NX8.0.0.
License requirements : nx_layout ("NX Layout")
| NXOpen::Annotations::EditSymbolDisplayBuilder* NXOpen::Annotations::CustomSymbolCollection::EditSymbolDisplayBuilder | ( | NXOpen::Annotations::BaseCustomSymbol * | symbolTag | ) |
Creates a edit custom symbol dialog builder.
- Returns
Created in NX7.5.0.
License requirements : None
- Parameters
-
symbolTag Symbol as input
| iterator NXOpen::Annotations::CustomSymbolCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
| NXOpen::Annotations::MasterSymbol* NXOpen::Annotations::CustomSymbolCollection::FindObject | ( | const NXString & | name | ) |
Finds the NXOpen::Annotations::MasterSymbol with the given name.
An exception will be thrown if no object can be found with the given name.
- Returns
- Master custom symbol object
Created in NX7.5.0.
License requirements : None
- Parameters
-
name Master custom symbol name
| NXOpen::Annotations::MasterSymbol* NXOpen::Annotations::CustomSymbolCollection::FindObject | ( | const char * | name | ) |
Finds the NXOpen::Annotations::MasterSymbol with the given name.
An exception will be thrown if no object can be found with the given name.
- Returns
- Master custom symbol object
Created in NX7.5.0.
License requirements : None
- Parameters
-
name Master custom symbol name
| NXOpen::Annotations::CustomSymbolData* NXOpen::Annotations::CustomSymbolCollection::NewCustomSymbolData | ( | const NXString & | masterFileName | ) |
Creates new CustomSymbolData object.
- Returns
- New CustomSymbolData
- Deprecated:
- Deprecated in NX9.0.0. Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.
Created in NX4.0.0.
License requirements : None
- Parameters
-
masterFileName Absolute path of the master symbol(with .sym.prt extension)
| NXOpen::Annotations::CustomSymbolData* NXOpen::Annotations::CustomSymbolCollection::NewCustomSymbolData | ( | const char * | masterFileName | ) |
Creates new CustomSymbolData object.
- Returns
- New CustomSymbolData
- Deprecated:
- Deprecated in NX9.0.0. Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.
Created in NX4.0.0.
License requirements : None
- Parameters
-
masterFileName Absolute path of the master symbol(with .sym.prt extension)
| NXOpen::Annotations::CustomSymbolData* NXOpen::Annotations::CustomSymbolCollection::NewPartSymbolData | ( | const NXString & | partSymbolName | ) |
Creates new CustomSymbolData object to create a part symbol instance.
- Returns
- New CustomSymbolData
- Deprecated:
- Deprecated in NX9.0.0. Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.
Created in NX4.0.0.
License requirements : None
- Parameters
-
partSymbolName Part symbol name. Part symbol is a master symbol that is created and instantiated in the same part.
| NXOpen::Annotations::CustomSymbolData* NXOpen::Annotations::CustomSymbolCollection::NewPartSymbolData | ( | const char * | partSymbolName | ) |
Creates new CustomSymbolData object to create a part symbol instance.
- Returns
- New CustomSymbolData
- Deprecated:
- Deprecated in NX9.0.0. Use NXOpen::Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and NXOpen::Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.
Created in NX4.0.0.
License requirements : None
- Parameters
-
partSymbolName Part symbol name. Part symbol is a master symbol that is created and instantiated in the same part.
| tag_t NXOpen::Annotations::CustomSymbolCollection::Tag | ( | ) | const |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- Annotations_CustomSymbolCollection.hxx