NXOpen::Annotations::IdSymbolBuilder Class Reference

Represents a @link Annotations::IdSymbol Annotations::IdSymbol@endlink  builder  <br> To create a new instance of this class, use @link Annotations::IdSymbolCollection::CreateIdSymbolBuilder  Annotations::IdSymbolCollection::CreateIdSymbolBuilder @endlink  <br> 

Default values. More...

Inheritance diagram for NXOpen::Annotations::IdSymbolBuilder:

Public Types
enum	SymbolTypes {   SymbolTypesCircle, SymbolTypesDividedCircle, SymbolTypesTriangle, SymbolTypesTriangleUp,   SymbolTypesSquare, SymbolTypesDividedSquare, SymbolTypesHexagon, SymbolTypesDividedHexagon,   SymbolTypesQuadrantCircle, SymbolTypesRoundedBox, SymbolTypesUnderline }
	the valid types for an id symbol More...

Public Member Functions
NXOpen::SelectObject *	Inherit ()
	Returns the inherit The id symbol from which the style properties are inherited Created in NX5.0.0.
NXOpen::Annotations::LeaderBuilder *	Leader ()
	Returns the Annotations::LeaderBuilder for the annotation Created in NX6.0.0.
NXString	LowerText ()
	Returns the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.
NXOpen::Annotations::OriginBuilder *	Origin ()
	Returns the origin, where the symbol is going to be displayed Created in NX6.0.0.
NXOpen::Annotations::AnnotationPlacement *	Placement ()
	Returns an annotation placement object
void	SetLowerText (const NXString &lowerText)
	Sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.
void	SetLowerText (const char *lowerText)
	Sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.
void	SetPreviewObject (NXOpen::Annotations::IdSymbol *symbol)
	Sets the preview object for dialog creation of id symbols
void	SetSize (double size)
	Sets the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle Created in NX5.0.0.
void	SetSymbolType (NXOpen::Annotations::IdSymbolBuilder::SymbolTypes symbolType)
	Sets the symbol type
void	SetType (NXOpen::Annotations::IdSymbolBuilder::SymbolTypes type)
	Sets the symbol type Created in NX6.0.0.
void	SetUpperText (const NXString &upperText)
	Sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.
void	SetUpperText (const char *upperText)
	Sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.
double	Size ()
	Returns the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle Created in NX5.0.0.
NXOpen::Annotations::StyleBuilder *	Style ()
	Returns the style Created in NX6.0.0.
NXOpen::Annotations::IdSymbolBuilder::SymbolTypes	SymbolType ()
	Returns the symbol type
NXOpen::Annotations::IdSymbolBuilder::SymbolTypes	Type ()
	Returns the symbol type Created in NX6.0.0.
NXString	UpperText ()
	Returns the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.
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 @link Annotations::IdSymbol Annotations::IdSymbol@endlink  builder  <br> To create a new instance of this class, use @link Annotations::IdSymbolCollection::CreateIdSymbolBuilder  Annotations::IdSymbolCollection::CreateIdSymbolBuilder @endlink  <br> 

Default values.

Property	Value
Size	0

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::IdSymbolBuilder::SymbolTypes

the valid types for an id symbol

Enumerator:

SymbolTypesCircle	Circle.
SymbolTypesDividedCircle	Divided circle.
SymbolTypesTriangle	Triangle with point down.
SymbolTypesTriangleUp	Triangle with point up.
SymbolTypesSquare	Square.
SymbolTypesDividedSquare	Divided square.
SymbolTypesHexagon	Hexagon.
SymbolTypesDividedHexagon	Divided hexagon.
SymbolTypesQuadrantCircle	Quadrant circle.
SymbolTypesRoundedBox	Rounded box.
SymbolTypesUnderline	Underline.

Member Function Documentation

NXOpen::SelectObject* NXOpen::Annotations::IdSymbolBuilder::Inherit

(

)

Returns the inherit The id symbol from which the style properties are inherited
Created in NX5.0.0.

License requirements : None

NXOpen::Annotations::LeaderBuilder* NXOpen::Annotations::IdSymbolBuilder::Leader

(

)

Returns the Annotations::LeaderBuilder for the annotation
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Annotations::IdSymbolBuilder::LowerText

(

)

Returns the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.

Created in NX5.0.0.

License requirements : None

NXOpen::Annotations::OriginBuilder* NXOpen::Annotations::IdSymbolBuilder::Origin

(

)

Returns the origin, where the symbol is going to be displayed
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::AnnotationPlacement* NXOpen::Annotations::IdSymbolBuilder::Placement

(

)

Returns an annotation placement object

Deprecated:

Deprecated in NX6.0.0.

This functionality is no longer supported.

Created in NX5.0.0.

License requirements : None

void NXOpen::Annotations::IdSymbolBuilder::SetLowerText

(

const NXString &

lowerText

)

Sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.

Created in NX5.0.0.

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

Parameters

lowerText

lowertext

void NXOpen::Annotations::IdSymbolBuilder::SetLowerText

(

const char *

lowerText

)

Sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.

Created in NX5.0.0.

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

Parameters

lowerText

lowertext

void NXOpen::Annotations::IdSymbolBuilder::SetPreviewObject

(

NXOpen::Annotations::IdSymbol *

symbol

)

Sets the preview object for dialog creation of id symbols

Deprecated:

Deprecated in NX6.0.0.

This functionality is no longer supported.

Created in NX5.0.0.

License requirements : None

Parameters

symbol

rubberbanding symbol

void NXOpen::Annotations::IdSymbolBuilder::SetSize

(

double

size

)

Sets the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle
Created in NX5.0.0.

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

Parameters

size

size

void NXOpen::Annotations::IdSymbolBuilder::SetSymbolType

(

NXOpen::Annotations::IdSymbolBuilder::SymbolTypes

symbolType

)

Sets the symbol type

Deprecated:

Deprecated in NX6.0.0.

Use Annotations::IdSymbolBuilder::SetType instead.

Created in NX5.0.0.

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

Parameters

symbolType

symboltype

void NXOpen::Annotations::IdSymbolBuilder::SetType

(

NXOpen::Annotations::IdSymbolBuilder::SymbolTypes

type

)

Sets the symbol type
Created in NX6.0.0.

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

Parameters

type

type

void NXOpen::Annotations::IdSymbolBuilder::SetUpperText

(

const NXString &

upperText

)

Sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.

Created in NX5.0.0.

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

Parameters

upperText

uppertext

void NXOpen::Annotations::IdSymbolBuilder::SetUpperText

(

const char *

upperText

)

Sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.

Created in NX5.0.0.

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

Parameters

upperText

uppertext

double NXOpen::Annotations::IdSymbolBuilder::Size

(

)

Returns the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle
Created in NX5.0.0.

License requirements : None

NXOpen::Annotations::StyleBuilder* NXOpen::Annotations::IdSymbolBuilder::Style

(

)

Returns the style
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::IdSymbolBuilder::SymbolTypes NXOpen::Annotations::IdSymbolBuilder::SymbolType

(

)

Returns the symbol type

Deprecated:

Deprecated in NX6.0.0.

Use Annotations::IdSymbolBuilder::Type instead.

Created in NX5.0.0.

License requirements : None

NXOpen::Annotations::IdSymbolBuilder::SymbolTypes NXOpen::Annotations::IdSymbolBuilder::Type

(

)

Returns the symbol type
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Annotations::IdSymbolBuilder::UpperText

(

)

Returns the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.

Created in NX5.0.0.

License requirements : None

---

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

• Annotations_IdSymbolBuilder.hxx