Represents a base Builder for Drafting and PMI Custom Symbol
This is an abstract class, and cannot be instantiated. More...

Inheritance diagram for NXOpen::Annotations::BaseCustomSymbolBuilder:

Public Types
enum	AnnotationPreferences { AnnotationPreferencesUseCurrent, AnnotationPreferencesUseDefinition }
	Enum for Annotation Preferences This is used by Annotations::BaseCustomSymbolBuilder::AnnotationPreference and Annotations::BaseCustomSymbolBuilder::SetAnnotationPreference to set the annotation preferences for a symbol. More...

enum	GeometryPreferences { GeometryPreferencesUseCurrent, GeometryPreferencesUseDefinition }
	Enum for Geometric Preferences This is used by Annotations::BaseCustomSymbolBuilder::GeometryPreference and Annotations::BaseCustomSymbolBuilder::SetGeometryPreference to set the geometric preferences for a symbol. More...

Public Member Functions
NXOpen::Expression *	Angle ()
	Returns the angle Created in NX7.5.0.

NXOpen::Annotations::BaseCustomSymbolBuilder::AnnotationPreferences	AnnotationPreference ()
	Returns the enum annot pref.

int	ControlledNoteTitle ()
	Returns the controlled note title Created in NX7.5.0.

NXOpen::Annotations::BaseCustomSymbolBuilder::GeometryPreferences	GeometryPreference ()
	Returns the enum geom pref.

std::vector< NXString >	GetArbitraryNoteTitle ()
	Returns the arbitrary note title.

NXOpen::Annotations::BaseCustomSymbol *	GetSymbol ()
	Returns the custom symbol.

bool	HorizontalFlip ()
	Returns the horizontal flip Created in NX7.5.0.

int	Integer ()
	Returns the integer value of selected text Created in NX7.5.0.

bool	IsPartSymbol ()
	Returns the is part symbol.

NXOpen::Annotations::LeaderBuilder *	Leader ()
	Returns the Annotations::LeaderBuilder for the annotation Created in NX7.5.0.

bool	LockStatus ()
	Returns the get symbol lock property Created in NX8.0.0.

NXString	MasterSymbolName ()
	Returns the master symbol Name.

NXString	MasterSymbolPath ()
	Returns the master symbol path.

NXOpen::Annotations::OriginBuilder *	Origin ()
	Returns the origin Created in NX7.5.0.

NXString	PartiallyControlledNoteTitle ()
	Returns the partially controlled note title Created in NX7.5.0.

double	Real ()
	Returns the real value of selected text Created in NX7.5.0.

NXOpen::Expression *	Scale ()
	Returns the scale Created in NX7.5.0.

void	SelectPartSymbol (const NXString &name, const NXString &path)
	Selects part custom symbol Created in NX7.5.0.

void	SelectPartSymbol (const char name, const char path)
	Selects part custom symbol Created in NX7.5.0.

void	SelectSymbol (const NXString &name)
	Selects custom symbol Created in NX7.5.0.

void	SelectSymbol (const char *name)
	Selects custom symbol Created in NX7.5.0.

void	SelectText (int index)
	Selects custom symbol text Created in NX7.5.0.

void	SetAnnotationPreference (NXOpen::Annotations::BaseCustomSymbolBuilder::AnnotationPreferences enumAnnotPref)
	Sets the enum annot pref.

void	SetArbitraryNoteTitle (const std::vector< NXString > &arbitraryNoteTitle)
	Sets the arbitrary note title Created in NX7.5.0.

void	SetControlledNoteTitle (int controlledNoteTitle)
	Sets the controlled note title Created in NX7.5.0.

void	SetGeometryPreference (NXOpen::Annotations::BaseCustomSymbolBuilder::GeometryPreferences enumGeomPref)
	Sets the enum geom pref.

void	SetHorizontalFlip (bool horizontalFlip)
	Sets the horizontal flip Created in NX7.5.0.

void	SetInteger (int integer)
	Sets the integer value of selected text Created in NX7.5.0.

void	SetLockStatus (bool lockUpdate)
	Sets the get symbol lock property Created in NX8.0.0.

void	SetMasterSymbolName (const NXString &masterSymbolName)
	Sets the master symbol Name.

void	SetMasterSymbolName (const char *masterSymbolName)
	Sets the master symbol Name.

void	SetMasterSymbolPath (const NXString &masterSymbolPath)
	Sets the master symbol path.

void	SetMasterSymbolPath (const char *masterSymbolPath)
	Sets the master symbol path.

void	SetPartiallyControlledNoteTitle (const NXString &partiallyControlledNoteTitle)
	Sets the partially controlled note title Created in NX7.5.0.

void	SetPartiallyControlledNoteTitle (const char *partiallyControlledNoteTitle)
	Sets the partially controlled note title Created in NX7.5.0.

void	SetPartSymbol (bool isPartSymbol)
	Sets the is part symbol.

void	SetReal (double real)
	Sets the real value of selected text Created in NX7.5.0.

void	SetSmashSymbol (bool smashSymbol)
	Sets the smash symbol Created in NX7.5.0.

void	SetVerticalFlip (bool verticalFlip)
	Sets the vertical flip Created in NX7.5.0.

bool	SmashSymbol ()
	Returns the smash symbol Created in NX7.5.0.

NXOpen::Annotations::StyleBuilder *	Style ()
	Returns the style builder Created in NX7.5.0.

NXOpen::Annotations::MasterSymbolListItemBuilderList *	Texts ()
	Returns the texts Created in NX7.5.0.

bool	VerticalFlip ()
	Returns the vertical flip Created in NX7.5.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a base Builder for Drafting and PMI Custom Symbol
This is an abstract class, and cannot be instantiated.

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Annotations::BaseCustomSymbolBuilder::AnnotationPreferences

Enum for Annotation Preferences This is used by Annotations::BaseCustomSymbolBuilder::AnnotationPreference and Annotations::BaseCustomSymbolBuilder::SetAnnotationPreference to set the annotation preferences for a symbol.

Enumerator:

AnnotationPreferencesUseCurrent	Current preferences.
AnnotationPreferencesUseDefinition	Defined preferences.

enum NXOpen::Annotations::BaseCustomSymbolBuilder::GeometryPreferences

Enum for Geometric Preferences This is used by Annotations::BaseCustomSymbolBuilder::GeometryPreference and Annotations::BaseCustomSymbolBuilder::SetGeometryPreference to set the geometric preferences for a symbol.

Enumerator:

GeometryPreferencesUseCurrent	Current preferences.
GeometryPreferencesUseDefinition	Defined preferences.

Member Function Documentation

NXOpen::Expression* NXOpen::Annotations::BaseCustomSymbolBuilder::Angle ( )

Returns the angle
Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::BaseCustomSymbolBuilder::AnnotationPreferences NXOpen::Annotations::BaseCustomSymbolBuilder::AnnotationPreference ( )

Returns the enum annot pref.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : None

int NXOpen::Annotations::BaseCustomSymbolBuilder::ControlledNoteTitle ( )

Returns the controlled note title
Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::BaseCustomSymbolBuilder::GeometryPreferences NXOpen::Annotations::BaseCustomSymbolBuilder::GeometryPreference ( )

Returns the enum geom pref.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : None

std::vector<NXString> NXOpen::Annotations::BaseCustomSymbolBuilder::GetArbitraryNoteTitle ( )

Returns the arbitrary note title.

Returns: Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::BaseCustomSymbol* NXOpen::Annotations::BaseCustomSymbolBuilder::GetSymbol ( )

Returns the custom symbol.

Returns: The custom symbol
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

bool NXOpen::Annotations::BaseCustomSymbolBuilder::HorizontalFlip ( )

Returns the horizontal flip
Created in NX7.5.0.

License requirements : None

int NXOpen::Annotations::BaseCustomSymbolBuilder::Integer ( )

Returns the integer value of selected text
Created in NX7.5.0.

License requirements : None

bool NXOpen::Annotations::BaseCustomSymbolBuilder::IsPartSymbol ( )

Returns the is part symbol.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::LeaderBuilder* NXOpen::Annotations::BaseCustomSymbolBuilder::Leader ( )

Returns the Annotations::LeaderBuilder for the annotation
Created in NX7.5.0.

License requirements : None

bool NXOpen::Annotations::BaseCustomSymbolBuilder::LockStatus ( )

Returns the get symbol lock property
Created in NX8.0.0.

License requirements : None

NXString NXOpen::Annotations::BaseCustomSymbolBuilder::MasterSymbolName ( )

Returns the master symbol Name.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : None

NXString NXOpen::Annotations::BaseCustomSymbolBuilder::MasterSymbolPath ( )

Returns the master symbol path.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::OriginBuilder* NXOpen::Annotations::BaseCustomSymbolBuilder::Origin ( )

Returns the origin
Created in NX7.5.0.

License requirements : None

NXString NXOpen::Annotations::BaseCustomSymbolBuilder::PartiallyControlledNoteTitle ( )

Returns the partially controlled note title
Created in NX7.5.0.

License requirements : None

double NXOpen::Annotations::BaseCustomSymbolBuilder::Real ( )

Returns the real value of selected text
Created in NX7.5.0.

License requirements : None

NXOpen::Expression* NXOpen::Annotations::BaseCustomSymbolBuilder::Scale ( )

Returns the scale
Created in NX7.5.0.

License requirements : None

void NXOpen::Annotations::BaseCustomSymbolBuilder::SelectPartSymbol	(	const NXString &	name,
		const NXString &	path
	)

Selects part custom symbol
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

name	Name of symbol
path	PartSymbol full Path

void NXOpen::Annotations::BaseCustomSymbolBuilder::SelectPartSymbol	(	const char *	name,
		const char *	path
	)

Selects part custom symbol
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

name	Name of symbol
path	PartSymbol full Path

void NXOpen::Annotations::BaseCustomSymbolBuilder::SelectSymbol ( const NXString & name )

Selects custom symbol
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

name	Name of symbol

void NXOpen::Annotations::BaseCustomSymbolBuilder::SelectSymbol ( const char * name )

Selects custom symbol
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

name	Name of symbol

void NXOpen::Annotations::BaseCustomSymbolBuilder::SelectText ( int index )

Selects custom symbol text
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

index index of selected text

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetAnnotationPreference ( NXOpen::Annotations::BaseCustomSymbolBuilder::AnnotationPreferences enumAnnotPref )

Sets the enum annot pref.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

enumAnnotPref enumannotpref

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetArbitraryNoteTitle ( const std::vector< NXString > & arbitraryNoteTitle )

Sets the arbitrary note title
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

arbitraryNoteTitle arbitrarynotetitle

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetControlledNoteTitle ( int controlledNoteTitle )

Sets the controlled note title
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

controlledNoteTitle controllednotetitle

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetGeometryPreference ( NXOpen::Annotations::BaseCustomSymbolBuilder::GeometryPreferences enumGeomPref )

Sets the enum geom pref.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

enumGeomPref enumgeompref

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetHorizontalFlip ( bool horizontalFlip )

Sets the horizontal flip
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

horizontalFlip horizontalflip

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetInteger ( int integer )

Sets the integer value of selected text
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

integer integer

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetLockStatus ( bool lockUpdate )

Sets the get symbol lock property
Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

lockUpdate lockupdate

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetMasterSymbolName ( const NXString & masterSymbolName )

Sets the master symbol Name.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

masterSymbolName mastersymbolname

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetMasterSymbolName ( const char * masterSymbolName )

Sets the master symbol Name.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

masterSymbolName mastersymbolname

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetMasterSymbolPath ( const NXString & masterSymbolPath )

Sets the master symbol path.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

masterSymbolPath mastersymbolpath

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetMasterSymbolPath ( const char * masterSymbolPath )

Sets the master symbol path.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

masterSymbolPath mastersymbolpath

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetPartiallyControlledNoteTitle ( const NXString & partiallyControlledNoteTitle )

Sets the partially controlled note title
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

partiallyControlledNoteTitle partiallycontrollednotetitle

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetPartiallyControlledNoteTitle ( const char * partiallyControlledNoteTitle )

Sets the partially controlled note title
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

partiallyControlledNoteTitle partiallycontrollednotetitle

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetPartSymbol ( bool isPartSymbol )

Sets the is part symbol.

This is used while creating the object and it is non-editable property
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

isPartSymbol ispartsymbol

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetReal ( double real )

Sets the real value of selected text
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

real real

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetSmashSymbol ( bool smashSymbol )

Sets the smash symbol
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

smashSymbol smashsymbol

void NXOpen::Annotations::BaseCustomSymbolBuilder::SetVerticalFlip ( bool verticalFlip )

Sets the vertical flip
Created in NX7.5.0.

License requirements : drafting ("DRAFTING")

Parameters

verticalFlip verticalflip

bool NXOpen::Annotations::BaseCustomSymbolBuilder::SmashSymbol ( )

Returns the smash symbol
Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::StyleBuilder* NXOpen::Annotations::BaseCustomSymbolBuilder::Style ( )

Returns the style builder
Created in NX7.5.0.

License requirements : None

NXOpen::Annotations::MasterSymbolListItemBuilderList* NXOpen::Annotations::BaseCustomSymbolBuilder::Texts ( )

Returns the texts
Created in NX7.5.0.

License requirements : None

bool NXOpen::Annotations::BaseCustomSymbolBuilder::VerticalFlip ( )

Returns the vertical flip
Created in NX7.5.0.

License requirements : None

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

Annotations_BaseCustomSymbolBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation