NXOpen::Annotations::UserSymbolPreferences Class Reference

Represents preferences related to user-defined symbols
Created in NX3.0.0. More...

Inheritance diagram for NXOpen::Annotations::UserSymbolPreferences:

Public Types
enum	SizeType { SizeTypeLengthHeight, SizeTypeScaleAspectRatio }
	Specifies whether length and height or scale and aspect ratio is used in specifying the size of the symbol. More...

Public Member Functions
void	GetSize (NXOpen::Annotations::UserSymbolPreferences::SizeType *sizeType, double *lengthOrScale, double *heightOrAspectRatio)
	Gets the size preference Created in NX3.0.0. More...
void	SetLengthAndHeight (double length, double height)
	Sets the length and height Created in NX3.0.0. More...
void	SetScaleAndAspectRatio (double scale, double aspectRatio)
	Sets the scale and aspect ratio Created in NX3.0.0. More...
virtual	~UserSymbolPreferences ()
	Frees the object from memory. More...
Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object. More...

Detailed Description

Represents preferences related to user-defined symbols
Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::UserSymbolPreferences::SizeType

Specifies whether length and height or scale and aspect ratio is used in specifying the size of the symbol.

Enumerator
SizeTypeLengthHeight	length and height
SizeTypeScaleAspectRatio	scale and aspect ratio

Constructor & Destructor Documentation

virtual NXOpen::Annotations::UserSymbolPreferences::~UserSymbolPreferences ( )

virtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Created in NX3.0.0.

License requirements : None

Member Function Documentation

void NXOpen::Annotations::UserSymbolPreferences::GetSize	(	NXOpen::Annotations::UserSymbolPreferences::SizeType *	sizeType,
		double *	lengthOrScale,
		double *	heightOrAspectRatio
	)

Gets the size preference
Created in NX3.0.0.

License requirements : None

Parameters

sizeType	Specifies whether length and height or scale and aspect ratio is used
lengthOrScale	Length or scale
heightOrAspectRatio	Height or aspect ratio

void NXOpen::Annotations::UserSymbolPreferences::SetLengthAndHeight	(	double	length,
		double	height
	)

Sets the length and height
Created in NX3.0.0.

License requirements : None

Parameters

length	length
height	height

void NXOpen::Annotations::UserSymbolPreferences::SetScaleAndAspectRatio	(	double	scale,
		double	aspectRatio
	)

Sets the scale and aspect ratio
Created in NX3.0.0.

License requirements : None

Parameters

scale	scale
aspectRatio	aspect ratio

---

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

• Annotations_UserSymbolPreferences.hxx