NX Open C++ Reference Guide
|
Represents a base custom symbol
This is an abstract class and cannot be directly instantiated
Created in NX4.0.0.
More...
Public Member Functions | |
void | AddLeader (NXOpen::Annotations::LeaderBundle *leader) |
Adds leaders to the custom symbol. | |
void | FlipSymbol (NXOpen::Annotations::FlipOption flipOption) |
Flips the custom symbol horizontally/vertically. | |
NXOpen::Point * | GetAnchor () |
Returns the master custom symbol anchor point. | |
virtual NXOpen::Annotations::AssociatedObject * | GetAssociatedObject () |
Returns the associated object. | |
virtual std::vector < NXOpen::Annotations::BusinessModifier * > | GetBusinessModifiers () |
Returns the business modifiers. | |
NXOpen::Annotations::CustomSymbolData * | GetSymbolData () |
Returns the custom symbol data. | |
virtual int | Index () |
Returns the index. | |
void | RemoveLeader (int nthLeader) |
Removes leader from the custom symbol. | |
void | ReplaceSymbol (const NXString &name, const NXString &path, bool isPartSymbol) |
Replace custom symbol with the given master symbol name and path. | |
void | SetAnchor (NXOpen::Point *anchorPoint) |
Sets the master custom symbol anchor point Created in NX4.0.0. | |
virtual void | SetAssociatedObject (NXOpen::Annotations::AssociatedObject *assocObj) |
Sets the associated object Created in NX4.0.0. | |
virtual void | SetBusinessModifiers (const std::vector< NXOpen::Annotations::BusinessModifier * > &businessModifiers) |
Sets the business modifiers Created in NX4.0.0. | |
virtual void | SetIndex (int index) |
Sets the index. | |
void | SetSymbolData (NXOpen::Annotations::CustomSymbolData *data) |
Sets the custom symbol data Created in NX4.0.0. | |
NXString | SymbolName () |
Returns the symbol name. | |
void | SynchronizeSymbol () |
Synchronize associative custom symbol. | |
void | UpdateFromRule () |
Updates the specified symbol from the KF rule. | |
void | UpdateSymbolGeometry (const NXOpen::Point3d &origin, double scale, double angle) |
Sets the origin, scale and angle for a custom symbol instance and updates the leaders (if any) as needed. |
Represents a base custom symbol
This is an abstract class and cannot be directly instantiated
Created in NX4.0.0.
Adds leaders to the custom symbol.
Created in NX5.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
leader | Specifies the leaders to add |
void NXOpen::Annotations::BaseCustomSymbol::FlipSymbol | ( | NXOpen::Annotations::FlipOption | flipOption | ) |
Flips the custom symbol horizontally/vertically.
This is only available when editing. This option is unavailable for symbols with leaders.
Created in NX4.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
flipOption | New flip option |
Returns the master custom symbol anchor point.
virtual NXOpen::Annotations::AssociatedObject* NXOpen::Annotations::BaseCustomSymbol::GetAssociatedObject | ( | ) | [virtual] |
Returns the associated object.
Implements NXOpen::Annotations::IPmi.
virtual std::vector<NXOpen::Annotations::BusinessModifier *> NXOpen::Annotations::BaseCustomSymbol::GetBusinessModifiers | ( | ) | [virtual] |
Returns the business modifiers.
Implements NXOpen::Annotations::IPmi.
Returns the custom symbol data.
virtual int NXOpen::Annotations::BaseCustomSymbol::Index | ( | ) | [virtual] |
Returns the index.
It is a unique integer assigned to a PMI object.
Created in NX4.0.0.
License requirements : None
Implements NXOpen::Annotations::IPmi.
void NXOpen::Annotations::BaseCustomSymbol::RemoveLeader | ( | int | nthLeader | ) |
Removes leader from the custom symbol.
Created in NX5.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
nthLeader | Specifies which leader to remove |
void NXOpen::Annotations::BaseCustomSymbol::ReplaceSymbol | ( | const NXString & | name, |
const NXString & | path, | ||
bool | isPartSymbol | ||
) |
Replace custom symbol with the given master symbol name and path.
Created in NX8.0.0.
License requirements : drafting ("DRAFTING")
name | Master symbol name |
path | Master symbol path |
isPartSymbol | true if part symbol else false |
void NXOpen::Annotations::BaseCustomSymbol::SetAnchor | ( | NXOpen::Point * | anchorPoint | ) |
Sets the master custom symbol anchor point
Created in NX4.0.0.
License requirements : None
anchorPoint | Custom Symbol Anchor Point |
virtual void NXOpen::Annotations::BaseCustomSymbol::SetAssociatedObject | ( | NXOpen::Annotations::AssociatedObject * | assocObj | ) | [virtual] |
Sets the associated object
Created in NX4.0.0.
License requirements : geometric_tol ("GDT")
assocObj | New associated object |
Implements NXOpen::Annotations::IPmi.
virtual void NXOpen::Annotations::BaseCustomSymbol::SetBusinessModifiers | ( | const std::vector< NXOpen::Annotations::BusinessModifier * > & | businessModifiers | ) | [virtual] |
Sets the business modifiers
Created in NX4.0.0.
License requirements : geometric_tol ("GDT")
businessModifiers | List of new business modifiers |
Implements NXOpen::Annotations::IPmi.
virtual void NXOpen::Annotations::BaseCustomSymbol::SetIndex | ( | int | index | ) | [virtual] |
Sets the index.
It is a unique integer assigned to a PMI object.
Created in NX4.0.0.
License requirements : geometric_tol ("GDT")
index | New integer for PMI object |
Implements NXOpen::Annotations::IPmi.
void NXOpen::Annotations::BaseCustomSymbol::SetSymbolData | ( | NXOpen::Annotations::CustomSymbolData * | data | ) |
Sets the custom symbol data
Created in NX4.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
data | New custom symbol data |
Returns the symbol name.
Created in NX6.0.0.
License requirements : None
Synchronize associative custom symbol.
Created in NX8.0.0.
License requirements : drafting ("DRAFTING")
Updates the specified symbol from the KF rule.
The changes are not applied till an update is performed by calling Update::DoUpdate .
Created in NX8.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
void NXOpen::Annotations::BaseCustomSymbol::UpdateSymbolGeometry | ( | const NXOpen::Point3d & | origin, |
double | scale, | ||
double | angle | ||
) |
Sets the origin, scale and angle for a custom symbol instance and updates the leaders (if any) as needed.
Created in NX5.0.0.
License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")
origin | New origin |
scale | New scale |
angle | New angle |