DimensionData Class¶
-
class
NXOpen.Annotations.
DimensionData
¶ Bases:
NXOpen.TransientObject
Represents dimension data
New in version NX4.0.0.
Properties¶
Property | Description |
---|---|
LeaderOrientation | Returns or sets the leader orientation for the dimension |
MeasurementDirection | Returns or sets the measurement direction |
MeasurementDirectionView | Returns or sets the measurement direction view |
Methods¶
Method | Description |
---|---|
Dispose | Frees the object from memory. |
GetAngularTolerance | Returns the angular tolerances @return Angular tolerance |
GetAppendedText | Returns the appended text @return Appended text |
GetAssociativity | Returns the associativity at specified index. |
GetDimensionPreferences | Returns the dimension preferences @return Dimension preferences |
GetInferredPlane | Get inferred annotation plane. |
GetLetteringPreferences | Returns the lettering preferences @return Lettering preferences |
GetLineAndArrowPreferences | Returns the line and arrow preferences @return Line and arrow preferences |
GetLinearTolerance | Returns the linear tolerances @return Linear tolerance |
GetUserSymbolPreferences | Returns the user defined symbol preferences @return User symbol preferences |
SetAngularTolerance | Sets the angular tolerances |
SetAppendedText | Sets the appended text |
SetAssociativity | Sets the associativity at specified index. |
SetDimensionPreferences | Sets the dimension preferences |
SetLetteringPreferences | Sets the lettering preferences |
SetLineAndArrowPreferences | Sets the line and arrow preferences |
SetLinearTolerance | Sets the linear tolerances |
SetUserSymbolPreferences | Sets the user defined symbol preferences |
Property Detail¶
LeaderOrientation¶
-
DimensionData.
LeaderOrientation
¶ Returns or sets the leader orientation for the dimension
-------------------------------------
Getter Method
Signature
LeaderOrientation()
Returns: Leader orientation Return type: NXOpen.Annotations.LeaderOrientation
New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LeaderOrientation(leaderOrientation)
Parameters: leaderOrientation ( NXOpen.Annotations.LeaderOrientation
) – New leader orientationNew in version NX4.0.0.
License requirements: None.
MeasurementDirection¶
-
DimensionData.
MeasurementDirection
¶ Returns or sets the measurement direction
-------------------------------------
Getter Method
Signature
MeasurementDirection()
Returns: Direction Return type: NXOpen.Direction
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MeasurementDirection(vector)
Parameters: vector ( NXOpen.Direction
) – DirectionNew in version NX7.5.0.
License requirements: None.
MeasurementDirectionView¶
-
DimensionData.
MeasurementDirectionView
¶ Returns or sets the measurement direction view
-------------------------------------
Getter Method
Signature
MeasurementDirectionView()
Returns: Measurement direction view Return type: NXOpen.View
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MeasurementDirectionView(view)
Parameters: view ( NXOpen.View
) – Measurement direction viewNew in version NX7.5.0.
License requirements: None.
Method Detail¶
Dispose¶
-
DimensionData.
Dispose
¶ 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.
Signature
Dispose()
New in version NX4.0.0.
License requirements: None.
GetAngularTolerance¶
-
DimensionData.
GetAngularTolerance
¶ Returns the angular tolerances
Signature
GetAngularTolerance()
Returns: Angular tolerance Return type: NXOpen.Annotations.AngularTolerance
New in version NX4.0.0.
License requirements: None.
GetAppendedText¶
-
DimensionData.
GetAppendedText
¶ Returns the appended text
Signature
GetAppendedText()
Returns: Appended text Return type: NXOpen.Annotations.AppendedText
New in version NX4.0.0.
License requirements: None.
GetAssociativity¶
-
DimensionData.
GetAssociativity
¶ 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 -
- Fold location for the folded radius dimension
- Margin data for the ordinate dimensions
Signature
GetAssociativity(associativityIndex)
Parameters: associativityIndex (int) – Associativity index Returns: List of associativity objects Return type: list of NXOpen.Annotations.Associativity
New in version NX4.0.0.
License requirements: None.
GetDimensionPreferences¶
-
DimensionData.
GetDimensionPreferences
¶ Returns the dimension preferences
Signature
GetDimensionPreferences()
Returns: Dimension preferences Return type: NXOpen.Annotations.DimensionPreferences
New in version NX4.0.0.
License requirements: None.
GetInferredPlane¶
-
DimensionData.
GetInferredPlane
¶ Get inferred annotation plane.
Before calling this method, you must fill in the associativities for the Dimension by calling
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.
Signature
GetInferredPlane(jaDefaultPlane, dimType)
Parameters: - jaDefaultPlane (
NXOpen.Annotations.PmiDefaultPlane
) – - dimType (
NXOpen.Annotations.DimensionType
) –
Returns: Return type: New in version NX4.0.0.
License requirements: None.
- jaDefaultPlane (
GetLetteringPreferences¶
-
DimensionData.
GetLetteringPreferences
¶ Returns the lettering preferences
Signature
GetLetteringPreferences()
Returns: Lettering preferences Return type: NXOpen.Annotations.LetteringPreferences
New in version NX4.0.0.
License requirements: None.
GetLineAndArrowPreferences¶
-
DimensionData.
GetLineAndArrowPreferences
¶ Returns the line and arrow preferences
Signature
GetLineAndArrowPreferences()
Returns: Line and arrow preferences Return type: NXOpen.Annotations.LineAndArrowPreferences
New in version NX4.0.0.
License requirements: None.
GetLinearTolerance¶
-
DimensionData.
GetLinearTolerance
¶ Returns the linear tolerances
Signature
GetLinearTolerance()
Returns: Linear tolerance Return type: NXOpen.Annotations.LinearTolerance
New in version NX4.0.0.
License requirements: None.
GetUserSymbolPreferences¶
-
DimensionData.
GetUserSymbolPreferences
¶ Returns the user defined symbol preferences
Signature
GetUserSymbolPreferences()
Returns: User symbol preferences Return type: NXOpen.Annotations.UserSymbolPreferences
New in version NX4.0.0.
License requirements: None.
SetAngularTolerance¶
-
DimensionData.
SetAngularTolerance
¶ Sets the angular tolerances
Signature
SetAngularTolerance(tolerance)
Parameters: tolerance ( NXOpen.Annotations.AngularTolerance
) – New angular toleranceNew in version NX4.0.0.
License requirements: None.
SetAppendedText¶
-
DimensionData.
SetAppendedText
¶ Sets the appended text
Signature
SetAppendedText(appendedText)
Parameters: appendedText ( NXOpen.Annotations.AppendedText
) – New appended textNew in version NX4.0.0.
License requirements: None.
SetAssociativity¶
-
DimensionData.
SetAssociativity
¶ 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 -
- Fold location for the folded radius dimension
- Margin data for the ordinate dimensions
Signature
SetAssociativity(associativityIndex, associativity)
Parameters: - associativityIndex (int) – Associativity index
- associativity (list of
NXOpen.Annotations.Associativity
) – List of new associativity objects
New in version NX4.0.0.
License requirements: None.
SetDimensionPreferences¶
-
DimensionData.
SetDimensionPreferences
¶ Sets the dimension preferences
Signature
SetDimensionPreferences(preferences)
Parameters: preferences ( NXOpen.Annotations.DimensionPreferences
) – New dimension preferencesNew in version NX4.0.0.
License requirements: None.
SetLetteringPreferences¶
-
DimensionData.
SetLetteringPreferences
¶ Sets the lettering preferences
Signature
SetLetteringPreferences(letteringPrefs)
Parameters: letteringPrefs ( NXOpen.Annotations.LetteringPreferences
) – New lettering preferencesNew in version NX4.0.0.
License requirements: None.
SetLineAndArrowPreferences¶
-
DimensionData.
SetLineAndArrowPreferences
¶ Sets the line and arrow preferences
Signature
SetLineAndArrowPreferences(prefs)
Parameters: prefs ( NXOpen.Annotations.LineAndArrowPreferences
) – New line and arrow preferencesNew in version NX4.0.0.
License requirements: None.
SetLinearTolerance¶
-
DimensionData.
SetLinearTolerance
¶ Sets the linear tolerances
Signature
SetLinearTolerance(tolerance)
Parameters: tolerance ( NXOpen.Annotations.LinearTolerance
) – New linear toleranceNew in version NX4.0.0.
License requirements: None.
SetUserSymbolPreferences¶
-
DimensionData.
SetUserSymbolPreferences
¶ Sets the user defined symbol preferences
Signature
SetUserSymbolPreferences(userSymbolPrefs)
Parameters: userSymbolPrefs ( NXOpen.Annotations.UserSymbolPreferences
) – New user symbol preferencesNew in version NX4.0.0.
License requirements: None.