Represents a NXOpen::Annotations::TextWithSymbolsBuilder which collects internationalized text strings from the user for processing on an annotation object. More...

Inheritance diagram for NXOpen::Annotations::TextWithSymbolsBuilder:

Public Types
enum	SymbolAlignmentType { SymbolAlignmentTypeNone, SymbolAlignmentTypeTop, SymbolAlignmentTypeMiddle, SymbolAlignmentTypeBottom, SymbolAlignmentTypeAnchorPoint }
	Enum for the symbol alignment. More...

enum	SymbolPreferencesType { SymbolPreferencesTypeUseCurrent, SymbolPreferencesTypeUseDefinition }
	Enum for the symbol preferences. More...

enum	SymbolSizingMethod { SymbolSizingMethodScaleAndAspectRatio, SymbolSizingMethodLengthAndHeight }
	sizing method for embedded user-defined symbols More...

Public Member Functions
void	AddAttributeReference (NXOpen::NXObject *ownerTag, const NXString &title, bool displayTokens, int lineNo, int cursorPos)
	Adds an attribute reference Created in NX8.0.0. More...

void	AddAttributeReference (NXOpen::NXObject ownerTag, const char title, bool displayTokens, int lineNo, int cursorPos)
	Adds an attribute reference Created in NX8.0.0. More...

void	AddExpressionReference (const NXString &expName, const NXString &format, int lineNo, int cursorPos)
	Adds an expression reference Created in NX8.0.0. More...

void	AddExpressionReference (const char expName, const char format, int lineNo, int cursorPos)
	Adds an expression reference Created in NX8.0.0. More...

void	AddSymbol (NXOpen::NXObject *newObject, const NXString &name, int lineNo, int cursorPos)
	Adds a symbol Created in NX7.0.0. More...

void	AddSymbol (NXOpen::NXObject newObject, const char name, int lineNo, int cursorPos)
	Adds a symbol Created in NX7.0.0. More...

double	CustomSymbolScale ()
	Returns the scale of the custom symbols Created in NX7.5.0. More...

std::vector < NXOpen::Annotations::BaseCustomSymbol * >	GetEmbeddedCustomSymbols ()
	Retrieves the embedded custom symbols. More...

NXOpen::Annotations::TextWithSymbolsBuilder::SymbolAlignmentType	GetSymbolAlignment (const NXString &symbolName)
	Get the alignement of embedded symbol correspoding to symbol name. More...

NXOpen::Annotations::TextWithSymbolsBuilder::SymbolAlignmentType	GetSymbolAlignment (const char *symbolName)
	Get the alignement of embedded symbol correspoding to symbol name. More...

std::vector< NXString >	GetText ()
	Returns the text of the annotation. More...

void	RemoveSymbol (const NXString &path)
	Removes specified symbol Created in NX7.0.0. More...

void	RemoveSymbol (const char *path)
	Removes specified symbol Created in NX7.0.0. More...

void	SetCustomSymbolScale (double customSymbolScale)
	Sets the scale of the custom symbols Created in NX7.5.0. More...

void	SetSymbolAlignment (const NXString &symbolName, NXOpen::Annotations::TextWithSymbolsBuilder::SymbolAlignmentType symbolAlignment)
	Set the alignement on embedded symbol correspoding to symbol name Created in NX11.0.1. More...

void	SetSymbolAlignment (const char *symbolName, NXOpen::Annotations::TextWithSymbolsBuilder::SymbolAlignmentType symbolAlignment)
	Set the alignement on embedded symbol correspoding to symbol name Created in NX11.0.1. More...

void	SetSymbolAspectRatio (double symbolAspectRatio)
	Sets the aspect ratio of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio Created in NX6.0.0. More...

void	SetSymbolHeight (double symbolHeight)
	Sets the height of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight Created in NX6.0.0. More...

void	SetSymbolLength (double symbolLength)
	Sets the length of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight Created in NX6.0.0. More...

void	SetSymbolPreferences (NXOpen::Annotations::TextWithSymbolsBuilder::SymbolPreferencesType symbolPreferences)
	Sets the symbol preferences Created in NX8.0.0. More...

void	SetSymbolScale (double symbolScale)
	Sets the scale of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio Created in NX6.0.0. More...

void	SetSymbolSizeMethod (NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethod symbolSizeMethod)
	Sets the method in which embedded user-defined symbols are scaled Created in NX6.0.0. More...

void	SetText (const std::vector< NXString > &text)
	Sets the text of the annotation Created in NX6.0.0. More...

double	SymbolAspectRatio ()
	Returns the aspect ratio of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio Created in NX6.0.0. More...

double	SymbolHeight ()
	Returns the height of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight Created in NX6.0.0. More...

double	SymbolLength ()
	Returns the length of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight Created in NX6.0.0. More...

NXOpen::Annotations::TextWithSymbolsBuilder::SymbolPreferencesType	SymbolPreferences ()
	Returns the symbol preferences Created in NX8.0.0. More...

double	SymbolScale ()
	Returns the scale of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio Created in NX6.0.0. More...

NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethod	SymbolSizeMethod ()
	Returns the method in which embedded user-defined symbols are scaled Created in NX6.0.0. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen::Annotations::TextWithSymbolsBuilder which collects internationalized text strings from the user for processing on an annotation object.

This is a sub-builder class and cannot be directly instantiated

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::TextWithSymbolsBuilder::SymbolAlignmentType

Enum for the symbol alignment.

Enumerator
SymbolAlignmentTypeNone	None.
SymbolAlignmentTypeTop	Top.
SymbolAlignmentTypeMiddle	Middle.
SymbolAlignmentTypeBottom	Bottom.
SymbolAlignmentTypeAnchorPoint	Anchor Point.

enum NXOpen::Annotations::TextWithSymbolsBuilder::SymbolPreferencesType

Enum for the symbol preferences.

Enumerator
SymbolPreferencesTypeUseCurrent	Use Current.
SymbolPreferencesTypeUseDefinition	Use Definition.

enum NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethod

sizing method for embedded user-defined symbols

Enumerator
SymbolSizingMethodScaleAndAspectRatio	Size using scale and aspect ratio.
SymbolSizingMethodLengthAndHeight	Size using length and height.

Member Function Documentation

void NXOpen::Annotations::TextWithSymbolsBuilder::AddAttributeReference	(	NXOpen::NXObject *	ownerTag,
		const NXString &	title,
		bool	displayTokens,
		int	lineNo,
		int	cursorPos
	)

Adds an attribute reference
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

ownerTag	object that owns the attribute. If we are trying to reference a part attribute then this should be the part object
title	title of attribute
displayTokens	True to display using TC tokens. False to display as plain text.
lineNo	line number to insert token with index from 1
cursorPos	cursor position in the line with index from 1

void NXOpen::Annotations::TextWithSymbolsBuilder::AddAttributeReference	(	NXOpen::NXObject *	ownerTag,
		const char *	title,
		bool	displayTokens,
		int	lineNo,
		int	cursorPos
	)

Adds an attribute reference
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

ownerTag	object that owns the attribute. If we are trying to reference a part attribute then this should be the part object
title	title of attribute
displayTokens	True to display using TC tokens. False to display as plain text.
lineNo	line number to insert token with index from 1
cursorPos	cursor position in the line with index from 1

void NXOpen::Annotations::TextWithSymbolsBuilder::AddExpressionReference	(	const NXString &	expName,
		const NXString &	format,
		int	lineNo,
		int	cursorPos
	)

Adds an expression reference
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

expName	expression name
format	format to use for displaying an expression. 'A' for displaying the expression formula, or 'm.n' where 'm' is the minimum number of characters displayed and 'n' is the number of decimal places to display
lineNo	line number to insert token with index from 1
cursorPos	cursor position in the line with index from 1

void NXOpen::Annotations::TextWithSymbolsBuilder::AddExpressionReference	(	const char *	expName,
		const char *	format,
		int	lineNo,
		int	cursorPos
	)

Adds an expression reference
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

expName	expression name
format	format to use for displaying an expression. 'A' for displaying the expression formula, or 'm.n' where 'm' is the minimum number of characters displayed and 'n' is the number of decimal places to display
lineNo	line number to insert token with index from 1
cursorPos	cursor position in the line with index from 1

void NXOpen::Annotations::TextWithSymbolsBuilder::AddSymbol	(	NXOpen::NXObject *	newObject,
		const NXString &	name,
		int	lineNo,
		int	cursorPos
	)

Adds a symbol
Created in NX7.0.0.

License requirements : drafting ("DRAFTING")

Parameters

newObject	symbol instance object
name	symbol name
lineNo	line number to insert token with index from 1
cursorPos	cursor position in the line with index from 1

void NXOpen::Annotations::TextWithSymbolsBuilder::AddSymbol	(	NXOpen::NXObject *	newObject,
		const char *	name,
		int	lineNo,
		int	cursorPos
	)

Adds a symbol
Created in NX7.0.0.

License requirements : drafting ("DRAFTING")

Parameters

newObject	symbol instance object
name	symbol name
lineNo	line number to insert token with index from 1
cursorPos	cursor position in the line with index from 1

double NXOpen::Annotations::TextWithSymbolsBuilder::CustomSymbolScale ( )

Returns the scale of the custom symbols
Created in NX7.5.0.

License requirements : None

std::vector<NXOpen::Annotations::BaseCustomSymbol *> NXOpen::Annotations::TextWithSymbolsBuilder::GetEmbeddedCustomSymbols ( )

Retrieves the embedded custom symbols.

Returns: Created in NX10.0.0.

License requirements : None

NXOpen::Annotations::TextWithSymbolsBuilder::SymbolAlignmentType NXOpen::Annotations::TextWithSymbolsBuilder::GetSymbolAlignment ( const NXString & symbolName )

Get the alignement of embedded symbol correspoding to symbol name.

Returns: Symbol Alignment
Created in NX11.0.1.

License requirements : None

Parameters

symbolName Symbol Name

NXOpen::Annotations::TextWithSymbolsBuilder::SymbolAlignmentType NXOpen::Annotations::TextWithSymbolsBuilder::GetSymbolAlignment ( const char * symbolName )

Get the alignement of embedded symbol correspoding to symbol name.

Returns: Symbol Alignment
Created in NX11.0.1.

License requirements : None

Parameters

symbolName Symbol Name

std::vector<NXString> NXOpen::Annotations::TextWithSymbolsBuilder::GetText ( )

Returns the text of the annotation.

Returns: Created in NX6.0.0.

License requirements : None

void NXOpen::Annotations::TextWithSymbolsBuilder::RemoveSymbol ( const NXString & path )

Removes specified symbol
Created in NX7.0.0.

License requirements : drafting ("DRAFTING")

Parameters

path	Symbol name

void NXOpen::Annotations::TextWithSymbolsBuilder::RemoveSymbol ( const char * path )

Removes specified symbol
Created in NX7.0.0.

License requirements : drafting ("DRAFTING")

Parameters

path	Symbol name

void NXOpen::Annotations::TextWithSymbolsBuilder::SetCustomSymbolScale ( double customSymbolScale )

Sets the scale of the custom symbols
Created in NX7.5.0.

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

Parameters

customSymbolScale customsymbolscale

void NXOpen::Annotations::TextWithSymbolsBuilder::SetSymbolAlignment	(	const NXString &	symbolName,
		NXOpen::Annotations::TextWithSymbolsBuilder::SymbolAlignmentType	symbolAlignment
	)

Set the alignement on embedded symbol correspoding to symbol name
Created in NX11.0.1.

License requirements : drafting ("DRAFTING")

Parameters

symbolName	Symbol Name
symbolAlignment	Symbol Alignment

void NXOpen::Annotations::TextWithSymbolsBuilder::SetSymbolAlignment	(	const char *	symbolName,
		NXOpen::Annotations::TextWithSymbolsBuilder::SymbolAlignmentType	symbolAlignment
	)

Set the alignement on embedded symbol correspoding to symbol name
Created in NX11.0.1.

License requirements : drafting ("DRAFTING")

Parameters

symbolName	Symbol Name
symbolAlignment	Symbol Alignment

void NXOpen::Annotations::TextWithSymbolsBuilder::SetSymbolAspectRatio ( double symbolAspectRatio )

Sets the aspect ratio of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio
Created in NX6.0.0.

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

Parameters

symbolAspectRatio symbolaspectratio

void NXOpen::Annotations::TextWithSymbolsBuilder::SetSymbolHeight ( double symbolHeight )

Sets the height of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight
Created in NX6.0.0.

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

Parameters

symbolHeight symbolheight

void NXOpen::Annotations::TextWithSymbolsBuilder::SetSymbolLength ( double symbolLength )

Sets the length of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight
Created in NX6.0.0.

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

Parameters

symbolLength symbollength

void NXOpen::Annotations::TextWithSymbolsBuilder::SetSymbolPreferences ( NXOpen::Annotations::TextWithSymbolsBuilder::SymbolPreferencesType symbolPreferences )

Sets the symbol preferences
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

symbolPreferences symbolpreferences

void NXOpen::Annotations::TextWithSymbolsBuilder::SetSymbolScale ( double symbolScale )

Sets the scale of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio
Created in NX6.0.0.

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

Parameters

symbolScale symbolscale

void NXOpen::Annotations::TextWithSymbolsBuilder::SetSymbolSizeMethod ( NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethod symbolSizeMethod )

Sets the method in which embedded user-defined symbols are scaled
Created in NX6.0.0.

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

Parameters

symbolSizeMethod symbolsizemethod

void NXOpen::Annotations::TextWithSymbolsBuilder::SetText ( const std::vector< NXString > & text )

Sets the text of the annotation
Created in NX6.0.0.

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

Parameters

text text

double NXOpen::Annotations::TextWithSymbolsBuilder::SymbolAspectRatio ( )

Returns the aspect ratio of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio
Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::TextWithSymbolsBuilder::SymbolHeight ( )

Returns the height of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight
Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::TextWithSymbolsBuilder::SymbolLength ( )

Returns the length of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodLengthAndHeight
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::TextWithSymbolsBuilder::SymbolPreferencesType NXOpen::Annotations::TextWithSymbolsBuilder::SymbolPreferences ( )

Returns the symbol preferences
Created in NX8.0.0.

License requirements : None

double NXOpen::Annotations::TextWithSymbolsBuilder::SymbolScale ( )

Returns the scale of the embedded user-defined symbols if the symbol size method is NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethodScaleAndAspectRatio
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizingMethod NXOpen::Annotations::TextWithSymbolsBuilder::SymbolSizeMethod ( )

Returns the method in which embedded user-defined symbols are scaled
Created in NX6.0.0.

License requirements : None

virtual bool NXOpen::Annotations::TextWithSymbolsBuilder::Validate ( )

virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns: Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

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

Annotations_TextWithSymbolsBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation