NX Open C++ Reference Guide
Public Member Functions
NXOpen::Annotations::BaseCustomSymbol Class Reference

Represents a base custom symbol
This is an abstract class and cannot be directly instantiated

Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Annotations::BaseCustomSymbol:
NXOpen::Annotations::DraftingAid NXOpen::Annotations::IPmi NXOpen::Annotations::Annotation NXOpen::INXObject NXOpen::DisplayableObject NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject NXOpen::Annotations::CustomSymbol NXOpen::Annotations::GeneralCustomSymbol NXOpen::Annotations::PmiCustomSymbol

List of all members.

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::PointGetAnchor ()
 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::CustomSymbolDataGetSymbolData ()
 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.

Detailed Description

Represents a base custom symbol
This is an abstract class and cannot be directly instantiated

Created in NX4.0.0.



Member Function Documentation

Adds leaders to the custom symbol.


Created in NX5.0.0.

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

Parameters:
leaderSpecifies the leaders to add

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")

Parameters:
flipOptionNew flip option

Returns the master custom symbol anchor point.

Returns:
Custom Symbol Anchor Point
Created in NX4.0.0.

License requirements : None

Returns the associated object.

Returns:
Associated object
Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IPmi.

Returns the business modifiers.

Returns:
List of business modifiers
Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IPmi.

Returns the custom symbol data.

Returns:
Custom symbol data
Created in NX4.0.0.

License requirements : None

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.

Removes leader from the custom symbol.


Created in NX5.0.0.

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

Parameters:
nthLeaderSpecifies 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")

Parameters:
nameMaster symbol name
pathMaster symbol path
isPartSymboltrue if part symbol else false

Sets the master custom symbol anchor point
Created in NX4.0.0.



License requirements : None

Parameters:
anchorPointCustom Symbol Anchor Point

Sets the associated object
Created in NX4.0.0.



License requirements : geometric_tol ("GDT")

Parameters:
assocObjNew 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")

Parameters:
businessModifiersList 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")

Parameters:
indexNew integer for PMI object

Implements NXOpen::Annotations::IPmi.

Sets the custom symbol data
Created in NX4.0.0.



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

Parameters:
dataNew 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")

Parameters:
originNew origin
scaleNew scale
angleNew angle

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