NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Annotations::DimensionData Class Reference

Represents dimension data
Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Annotations::DimensionData:
NXOpen::TransientObject

Public Member Functions

NXOpen::Annotations::AngularToleranceGetAngularTolerance ()
 Returns the angular tolerances. More...
 
NXOpen::Annotations::AppendedTextGetAppendedText ()
 Returns the appended text. More...
 
std::vector
< NXOpen::Annotations::Associativity * > 
GetAssociativity (int associativityIndex)
 Returns the associativity at specified index. More...
 
NXOpen::Annotations::DimensionPreferencesGetDimensionPreferences ()
 Returns the dimension preferences. More...
 
NXOpen::XformGetInferredPlane (NXOpen::Annotations::PmiDefaultPlane jaDefaultPlane, NXOpen::Annotations::DimensionType dimType)
 Get inferred annotation plane. More...
 
NXOpen::Annotations::LetteringPreferencesGetLetteringPreferences ()
 Returns the lettering preferences. More...
 
NXOpen::Annotations::LineAndArrowPreferencesGetLineAndArrowPreferences ()
 Returns the line and arrow preferences. More...
 
NXOpen::Annotations::LinearToleranceGetLinearTolerance ()
 Returns the linear tolerances. More...
 
NXOpen::Annotations::UserSymbolPreferencesGetUserSymbolPreferences ()
 Returns the user defined symbol preferences. More...
 
NXOpen::Annotations::LeaderOrientation LeaderOrientation ()
 Returns the leader orientation for the dimension
Created in NX4.0.0. More...
 
NXOpen::DirectionMeasurementDirection ()
 Returns the measurement direction
Created in NX7.5.0. More...
 
NXOpen::ViewMeasurementDirectionView ()
 Returns the measurement direction view
Created in NX7.5.0. More...
 
void SetAngularTolerance (NXOpen::Annotations::AngularTolerance *tolerance)
 Sets the angular tolerances
Created in NX4.0.0. More...
 
void SetAppendedText (NXOpen::Annotations::AppendedText *appendedText)
 Sets the appended text
Created in NX4.0.0. More...
 
void SetAssociativity (int associativityIndex, const std::vector< NXOpen::Annotations::Associativity * > &associativity)
 Sets the associativity at specified index. More...
 
void SetDimensionPreferences (NXOpen::Annotations::DimensionPreferences *preferences)
 Sets the dimension preferences
Created in NX4.0.0. More...
 
void SetLeaderOrientation (NXOpen::Annotations::LeaderOrientation leaderOrientation)
 Sets the leader orientation for the dimension
Created in NX4.0.0. More...
 
void SetLetteringPreferences (NXOpen::Annotations::LetteringPreferences *letteringPrefs)
 Sets the lettering preferences
Created in NX4.0.0. More...
 
void SetLineAndArrowPreferences (NXOpen::Annotations::LineAndArrowPreferences *prefs)
 Sets the line and arrow preferences
Created in NX4.0.0. More...
 
void SetLinearTolerance (NXOpen::Annotations::LinearTolerance *tolerance)
 Sets the linear tolerances
Created in NX4.0.0. More...
 
void SetMeasurementDirection (NXOpen::Direction *vector)
 Sets the measurement direction
Created in NX7.5.0. More...
 
void SetMeasurementDirectionView (NXOpen::View *view)
 Sets the measurement direction view
Created in NX7.5.0. More...
 
void SetUserSymbolPreferences (NXOpen::Annotations::UserSymbolPreferences *userSymbolPrefs)
 Sets the user defined symbol preferences
Created in NX4.0.0. More...
 
virtual ~DimensionData ()
 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 dimension data
Created in NX4.0.0.


Constructor & Destructor Documentation

virtual NXOpen::Annotations::DimensionData::~DimensionData ( )
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 NX4.0.0.

License requirements : None

Member Function Documentation

NXOpen::Annotations::AngularTolerance* NXOpen::Annotations::DimensionData::GetAngularTolerance ( )

Returns the angular tolerances.

Returns
Angular tolerance
Created in NX4.0.0.

License requirements : None
NXOpen::Annotations::AppendedText* NXOpen::Annotations::DimensionData::GetAppendedText ( )

Returns the appended text.

Returns
Appended text
Created in NX4.0.0.

License requirements : None
std::vector<NXOpen::Annotations::Associativity *> NXOpen::Annotations::DimensionData::GetAssociativity ( int  associativityIndex)

Returns the associativity at specified index.

Valid index values are {1, 2, 3}.
For ordinate dimensions, -

the associativity at index 1 stores the ordinate origin dimension associativity data. -

the associativity at index 2 stores the ordinate dimension associativity data.


The associativity at index 3 stores the following -

1. Fold location for the folded radius dimension

2. Margin data for the ordinate dimensions

Returns
List of associativity objects
Created in NX4.0.0.

License requirements : None
Parameters
associativityIndexAssociativity index
NXOpen::Annotations::DimensionPreferences* NXOpen::Annotations::DimensionData::GetDimensionPreferences ( )

Returns the dimension preferences.

Returns
Dimension preferences
Created in NX4.0.0.

License requirements : None
NXOpen::Xform* NXOpen::Annotations::DimensionData::GetInferredPlane ( NXOpen::Annotations::PmiDefaultPlane  jaDefaultPlane,
NXOpen::Annotations::DimensionType  dimType 
)

Get inferred annotation plane.

Before calling this method, you must fill in the associativities for the Dimension by calling NXOpen::Annotations::DimensionData::SetAssociativity for the correct number of objects based on the type of Dimension you wish to create.

Also, you must specify the particular type of Dimension to be created as the inferred Dimension plane depends on the type of the Dimension as well as the geometry being measured.

Returns

Created in NX4.0.0.

License requirements : None
Parameters
jaDefaultPlaneja default plane
dimTypedim type
NXOpen::Annotations::LetteringPreferences* NXOpen::Annotations::DimensionData::GetLetteringPreferences ( )

Returns the lettering preferences.

Returns
Lettering preferences
Created in NX4.0.0.

License requirements : None
NXOpen::Annotations::LineAndArrowPreferences* NXOpen::Annotations::DimensionData::GetLineAndArrowPreferences ( )

Returns the line and arrow preferences.

Returns
Line and arrow preferences
Created in NX4.0.0.

License requirements : None
NXOpen::Annotations::LinearTolerance* NXOpen::Annotations::DimensionData::GetLinearTolerance ( )

Returns the linear tolerances.

Returns
Linear tolerance
Created in NX4.0.0.

License requirements : None
NXOpen::Annotations::UserSymbolPreferences* NXOpen::Annotations::DimensionData::GetUserSymbolPreferences ( )

Returns the user defined symbol preferences.

Returns
User symbol preferences
Created in NX4.0.0.

License requirements : None
NXOpen::Annotations::LeaderOrientation NXOpen::Annotations::DimensionData::LeaderOrientation ( )

Returns the leader orientation for the dimension
Created in NX4.0.0.



License requirements : None

NXOpen::Direction* NXOpen::Annotations::DimensionData::MeasurementDirection ( )

Returns the measurement direction
Created in NX7.5.0.



License requirements : None

NXOpen::View* NXOpen::Annotations::DimensionData::MeasurementDirectionView ( )

Returns the measurement direction view
Created in NX7.5.0.



License requirements : None

void NXOpen::Annotations::DimensionData::SetAngularTolerance ( NXOpen::Annotations::AngularTolerance tolerance)

Sets the angular tolerances
Created in NX4.0.0.



License requirements : None

Parameters
toleranceNew angular tolerance
void NXOpen::Annotations::DimensionData::SetAppendedText ( NXOpen::Annotations::AppendedText appendedText)

Sets the appended text
Created in NX4.0.0.



License requirements : None

Parameters
appendedTextNew appended text
void NXOpen::Annotations::DimensionData::SetAssociativity ( int  associativityIndex,
const std::vector< NXOpen::Annotations::Associativity * > &  associativity 
)

Sets the associativity at specified index.

Valid index values are {1, 2, 3}.


For ordinate dimensions, the associativity at index 1 stores the ordinate origin data.


The associativity at index 3 stores the following -

1. Fold location for the folded radius dimension

2. Margin data for the ordinate dimensions

Created in NX4.0.0.

License requirements : None

Parameters
associativityIndexAssociativity index
associativityList of new associativity objects
void NXOpen::Annotations::DimensionData::SetDimensionPreferences ( NXOpen::Annotations::DimensionPreferences preferences)

Sets the dimension preferences
Created in NX4.0.0.



License requirements : None

Parameters
preferencesNew dimension preferences
void NXOpen::Annotations::DimensionData::SetLeaderOrientation ( NXOpen::Annotations::LeaderOrientation  leaderOrientation)

Sets the leader orientation for the dimension
Created in NX4.0.0.



License requirements : None

Parameters
leaderOrientationNew leader orientation
void NXOpen::Annotations::DimensionData::SetLetteringPreferences ( NXOpen::Annotations::LetteringPreferences letteringPrefs)

Sets the lettering preferences
Created in NX4.0.0.



License requirements : None

Parameters
letteringPrefsNew lettering preferences
void NXOpen::Annotations::DimensionData::SetLineAndArrowPreferences ( NXOpen::Annotations::LineAndArrowPreferences prefs)

Sets the line and arrow preferences
Created in NX4.0.0.



License requirements : None

Parameters
prefsNew line and arrow preferences
void NXOpen::Annotations::DimensionData::SetLinearTolerance ( NXOpen::Annotations::LinearTolerance tolerance)

Sets the linear tolerances
Created in NX4.0.0.



License requirements : None

Parameters
toleranceNew linear tolerance
void NXOpen::Annotations::DimensionData::SetMeasurementDirection ( NXOpen::Direction vector)

Sets the measurement direction
Created in NX7.5.0.



License requirements : None

Parameters
vectorDirection
void NXOpen::Annotations::DimensionData::SetMeasurementDirectionView ( NXOpen::View view)

Sets the measurement direction view
Created in NX7.5.0.



License requirements : None

Parameters
viewMeasurement direction view
void NXOpen::Annotations::DimensionData::SetUserSymbolPreferences ( NXOpen::Annotations::UserSymbolPreferences userSymbolPrefs)

Sets the user defined symbol preferences
Created in NX4.0.0.



License requirements : None

Parameters
userSymbolPrefsNew user symbol preferences

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