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:

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.

virtual NXOpen::Annotations::AssociatedObject *	GetSharedAssociatedObject ()
	Returns the shared associated objects.

NXOpen::Annotations::CustomSymbolData *	GetSymbolData ()
	Returns the custom symbol data.

virtual int	Index ()
	Returns the index.

virtual bool	IsMirrored ()
	Returns a flag indicating whether the annotation is mirrored Created in NX8.5.0.

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	ReplaceSymbol (const char name, const char 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.

virtual void	SetAssociatedObject (NXOpen::Annotations::AssociatedObject *assocObj)
	Sets the associated object.

virtual void	SetBusinessModifiers (const std::vector< NXOpen::Annotations::BusinessModifier * > &businessModifiers)
	Sets the business modifiers.

virtual void	SetIndex (int index)
	Sets the index.

void	SetSymbolData (NXOpen::Annotations::CustomSymbolData *data)
	Sets the custom symbol data.

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.

Additional Inherited Members
Public Types inherited from NXOpen::DisplayableObject
enum	ObjectFont { ObjectFontSolid = 1, ObjectFontDashed, ObjectFontPhantom, ObjectFontCenterline, ObjectFontDotted, ObjectFontLongDashed, ObjectFontDottedDashed }
	specifies the object font for objects such as lines Created in NX3.0.0. More...

enum	ObjectWidth { ObjectWidthNormal, ObjectWidthThick, ObjectWidthThin, ObjectWidthOne = 5, ObjectWidthTwo, ObjectWidthThree, ObjectWidthFour, ObjectWidthFive, ObjectWidthSix, ObjectWidthSeven, ObjectWidthEight, ObjectWidthNine }
	specifies object width for objects such as lines and text Created in NX3.0.0. More...

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

void NXOpen::Annotations::BaseCustomSymbol::AddLeader ( NXOpen::Annotations::LeaderBundle * leader )

Adds leaders to the custom symbol.

       NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

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.
       NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX4.0.0.

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

Parameters

flipOption New flip option

NXOpen::Point* NXOpen::Annotations::BaseCustomSymbol::GetAnchor ( )

Returns the master custom symbol anchor point.

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

License requirements : None

virtual NXOpen::Annotations::AssociatedObject* NXOpen::Annotations::BaseCustomSymbol::GetAssociatedObject ( )

virtual

Returns the associated object.

Returns: Associated object
Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IPmi.

virtual std::vector<NXOpen::Annotations::BusinessModifier *> NXOpen::Annotations::BaseCustomSymbol::GetBusinessModifiers ( )

virtual

Returns the business modifiers.

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

License requirements : None

Implements NXOpen::Annotations::IPmi.

virtual NXOpen::Annotations::AssociatedObject* NXOpen::Annotations::BaseCustomSymbol::GetSharedAssociatedObject ( )

virtual

Returns the shared associated objects.

Returns: Shared associated objects
Created in NX8.5.0.

License requirements : None

Implements NXOpen::Annotations::IPmi.

NXOpen::Annotations::CustomSymbolData* NXOpen::Annotations::BaseCustomSymbol::GetSymbolData ( )

Returns the custom symbol data.

Returns: Custom symbol data

Deprecated:: Deprecated in NX9.0.0. Use Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.

Created in NX4.0.0.

License requirements : None

virtual int NXOpen::Annotations::BaseCustomSymbol::Index ( )

virtual

Returns the index.

It is a unique integer assigned to a PMI object.

      NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
            If it is, the changes will be overridden when the part is updated.

Created in NX4.0.0.

License requirements : None

Implements NXOpen::Annotations::IPmi.

virtual bool NXOpen::Annotations::BaseCustomSymbol::IsMirrored ( )

virtual

Returns a flag indicating whether the annotation is mirrored
Created in NX8.5.0.

License requirements : None

Implements NXOpen::Annotations::IPmi.

void NXOpen::Annotations::BaseCustomSymbol::RemoveLeader ( int nthLeader )

Removes leader from the custom symbol.

       NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX5.0.0.

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

Parameters

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.

       NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

name	Master symbol name
path	Master symbol path
isPartSymbol	true if part symbol else false

void NXOpen::Annotations::BaseCustomSymbol::ReplaceSymbol	(	const char *	name,
		const char *	path,
		bool	isPartSymbol
	)

Replace custom symbol with the given master symbol name and path.

       NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

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.

       NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX4.0.0.

License requirements : None

Parameters

anchorPoint Custom Symbol Anchor Point

virtual void NXOpen::Annotations::BaseCustomSymbol::SetAssociatedObject ( NXOpen::Annotations::AssociatedObject * assocObj )

virtual

Sets the associated object.

       NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX4.0.0.

License requirements : geometric_tol ("GDT")

Parameters

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.

       NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Created in NX4.0.0.

License requirements : geometric_tol ("GDT")

Parameters

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.

      NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
            If it is, the changes will be overridden when the part is updated.

Created in NX4.0.0.

License requirements : geometric_tol ("GDT")

Parameters

index New integer for PMI object

Implements NXOpen::Annotations::IPmi.

void NXOpen::Annotations::BaseCustomSymbol::SetSymbolData ( NXOpen::Annotations::CustomSymbolData * data )

Sets the custom symbol data.

       NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object.
             If it is, the changes will be overridden when the part is updated.

Deprecated:: Deprecated in NX9.0.0. Use Annotations::DraftingCustomSymbolBuilder for Drafting Custom Symbol and Annotations::PmiCustomSymbolBuilder for PMI Custom Symbol objects.

Created in NX4.0.0.

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

Parameters

data	New custom symbol data

NXString NXOpen::Annotations::BaseCustomSymbol::SymbolName ( )

Returns the symbol name.

Created in NX6.0.0.

License requirements : None

void NXOpen::Annotations::BaseCustomSymbol::SynchronizeSymbol ( )

Synchronize associative custom symbol.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

void NXOpen::Annotations::BaseCustomSymbol::UpdateFromRule ( )

Updates the specified symbol from the KF rule.

    <br>   
       The changes are not applied till an update is performed by 
       calling @link Update::DoUpdate Update::DoUpdate@endlink  .
    <br>

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

origin	New origin
scale	New scale
angle	New angle

The documentation for this class was generated from the following file:

Annotations_BaseCustomSymbol.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation