NXOpen::Annotations::SimpleDraftingAid Class Reference

Represents a simple drafting aid. More...

Inheritance diagram for NXOpen::Annotations::SimpleDraftingAid:

Public Member Functions
std::vector< NXString >	GetText ()
	Returns the drafting aid's text.
NXOpen::Annotations::UserSymbolPreferences *	GetUserSymbolPreferences ()
	Returns the user symbol preferences.
void	GetUserSymbolSize (NXOpen::Annotations::UserSymbolPreferences::SizeType *sizeType, double *lengthOrScale, double *heightOrAspectRatio)
	Gets the user symbol size Created in NX3.0.0.
void	SetText (std::vector< NXString > &lines)
	Sets the drafting aid's text.
void	SetUserSymbolPreferences (NXOpen::Annotations::UserSymbolPreferences *usymPrefs)
	Sets the user symbol preferences.
void	SetUserSymbolSize (NXOpen::Annotations::UserSymbolPreferences::SizeType sizeType, double lengthOrScale, double heightOrAspectRatio)
	Sets the user symbol size.

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 simple drafting aid.

In all edit methods, the changes are not applied to the system until an update is performed. An update can be performed by calling Update::DoUpdate .
This is an abstract class.

Created in NX3.0.0.

Member Function Documentation

std::vector<NXString> NXOpen::Annotations::SimpleDraftingAid::GetText

(

)

Returns the drafting aid's text.

Returns

Created in NX3.0.0.

License requirements : None

NXOpen::Annotations::UserSymbolPreferences* NXOpen::Annotations::SimpleDraftingAid::GetUserSymbolPreferences

(

)

Returns the user symbol preferences.

Returns

Created in NX3.0.0.

License requirements : None

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

Gets the user symbol size
Created in NX3.0.0.

License requirements : None

Parameters

sizeType	Whether the length and height or scale and aspect ratio is used
lengthOrScale	length or scale
heightOrAspectRatio	height or aspect ratio

void NXOpen::Annotations::SimpleDraftingAid::SetText

(

std::vector< NXString > &

lines

)

Sets the drafting aid's text.

       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.
       NOTE: This method may require an additional update for correct symbol display. 

Created in NX3.0.0.

License requirements : drafting ("DRAFTING") OR cam_base ("CAM BASE")

Parameters

lines

the new text

void NXOpen::Annotations::SimpleDraftingAid::SetUserSymbolPreferences

(

NXOpen::Annotations::UserSymbolPreferences *

usymPrefs

)

Sets the user symbol preferences.

       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 NX3.0.0.

License requirements : drafting ("DRAFTING") OR cam_base ("CAM BASE")

Parameters

usymPrefs

usym prefs

void NXOpen::Annotations::SimpleDraftingAid::SetUserSymbolSize	(	NXOpen::Annotations::UserSymbolPreferences::SizeType	sizeType,
		double	lengthOrScale,
		double	heightOrAspectRatio
	)

Sets the user symbol size.

       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 NX3.0.0.

License requirements : drafting ("DRAFTING") OR cam_base ("CAM BASE")

Parameters

sizeType	Whether to use length and height or scale and aspect ratio
lengthOrScale	length or scale
heightOrAspectRatio	height or aspect ratio

---

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

• Annotations_SimpleDraftingAid.hxx