NX Open C++ Reference Guide
Public Member Functions
NXOpen::Annotations::SimpleDraftingAid Class Reference

Represents a simple drafting aid. More...

Inheritance diagram for NXOpen::Annotations::SimpleDraftingAid:
NXOpen::Annotations::DraftingAid NXOpen::Annotations::Annotation NXOpen::DisplayableObject NXOpen::NXObject NXOpen::IFitTo NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject NXOpen::Annotations::Gdt NXOpen::Annotations::NoteBase NXOpen::Annotations::BaseDatum NXOpen::Annotations::BaseDatumTarget NXOpen::Annotations::BaseFcf NXOpen::Annotations::BaseNote NXOpen::Annotations::Label NXOpen::Annotations::DraftingDatum NXOpen::Annotations::DraftingDatumTarget NXOpen::Annotations::DraftingFcf NXOpen::Annotations::Fcf NXOpen::Annotations::GenericNote NXOpen::Annotations::Note NXOpen::Annotations::PmiNote NXOpen::Annotations::GeneralLabel NXOpen::Annotations::PmiLabel

List of all members.

Public Member Functions

std::vector< NXStringGetText ()
 Returns the drafting aid's text.
NXOpen::Annotations::UserSymbolPreferencesGetUserSymbolPreferences ()
 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
Created in NX3.0.0.
void SetUserSymbolPreferences (NXOpen::Annotations::UserSymbolPreferences *usymPrefs)
 Sets the user symbol preferences
Created in NX3.0.0.
void SetUserSymbolSize (NXOpen::Annotations::UserSymbolPreferences::SizeType sizeType, double lengthOrScale, double heightOrAspectRatio)
 Sets the user symbol size
Created in NX3.0.0.

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

Returns the drafting aid's text.

Returns:

Created in NX3.0.0.

License requirements : None

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:
sizeTypeWhether the length and height or scale and aspect ratio is used
lengthOrScalelength or scale
heightOrAspectRatioheight or aspect ratio

Sets the drafting aid's text
Created in NX3.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
linesthe new text

Sets the user symbol preferences
Created in NX3.0.0.



License requirements : drafting ("DRAFTING")

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

Sets the user symbol size
Created in NX3.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
sizeTypeWhether to use length and height or scale and aspect ratio
lengthOrScalelength or scale
heightOrAspectRatioheight or aspect ratio

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.