AutoDimensionBuilder Class¶
-
class
NXOpen.Tooling.
AutoDimensionBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Tooling.AutoDimensionBuilder
which is used to create or edit the Auto Dimension.To create a new instance of this class, use
NXOpen.Tooling.ToolingDrawingCollection.CreateAutoDimensionBuilder
Default values.
Property Value DimensionCharacterSize 3.5 InnerDimensionOffsetValue 20 MaxDistanceToOuterMargin 60 OffsetValueForMargin 20 SelectHolesAutomatically 0 TextAngle 0.0 TextFont First TextOrientation Horizontal Tolerance NoTolerance ToleranceCharacterSize 3.5 ToleranceLowerValue -0.001 ToleranceUpperValue 0.001 ToleranceValue 0.001 Type CreateOrdinateDimension ValuePrecision NominalMinusX New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
CreateXDimensions | Returns or sets the option whether to create X dimensions |
CreateYDimensions | Returns or sets the option whether to create Y dimensions |
CreatedOrdinateOrigin | Returns or sets the created ordinate origin tag |
DimensionCharacterSize | Returns or sets the tolerance character size |
DimensionColor | Returns or sets the dimension color |
Dimensions | Returns the selected dimensions to edit |
FirstMargin | Returns or sets the first margin tag |
FourthMargin | Returns or sets the fourth margin tag |
InnerDimensionOffsetValue | Returns or sets the inner dimension offset value |
MaxDistanceToOuterMargin | Returns or sets the max distance to outer margin |
ObjectToDimension | Returns the objects to dimension |
OffsetValueForMargin | Returns or sets the offset value of margins |
OrdinateDimensionStyle | Returns the ordinate dimension style |
OrdinateView | Returns or sets the ordinate view tag |
OriginPoint | Returns the ordinate origin point |
SecondMargin | Returns or sets the second margin tag |
SelectHolesAutomatically | Returns or sets the option whether to select holes automatically |
Tag | Returns the Tag for this object. |
TextAngle | Returns or sets the text angle |
TextFont | Returns or sets the text orientation |
TextOrientation | Returns or sets the text orientation |
ThirdMargin | Returns or sets the third margin tag |
Tolerance | Returns or sets the tolerance type |
ToleranceCharacterSize | Returns or sets the tolerance character size |
ToleranceColor | Returns or sets the tolerance color |
ToleranceLowerValue | Returns or sets the tolerance lower value |
ToleranceUpperValue | Returns or sets the tolerance upper value |
ToleranceValue | Returns or sets the tolerance value |
Type | Returns or sets the type create or edit ordinate dimension |
ValuePrecision | Returns or sets the value precision |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CreateOrdinateOrigin | The method to create ordinate origin @return |
CreateOrdinateOriginMargins | The method to create ordinate origin margins |
CycleObjectsInView | The method to cycle objects in view @return Output object |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
AutoDimensionBuilderMainType Enumeration | create or edit ordinate dimension |
AutoDimensionBuilderTextFontType Enumeration | text font type |
AutoDimensionBuilderTextOrientationType Enumeration | text orientation type |
AutoDimensionBuilderToleranceType Enumeration | tolerance type |
AutoDimensionBuilderValuePrecisionType Enumeration | value precision type |
Property Detail¶
CreateXDimensions¶
-
AutoDimensionBuilder.
CreateXDimensions
¶ Returns or sets the option whether to create X dimensions
-------------------------------------
Getter Method
Signature
CreateXDimensions()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateXDimensions(createXDimensions)
Parameters: createXDimensions (bool) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
CreateYDimensions¶
-
AutoDimensionBuilder.
CreateYDimensions
¶ Returns or sets the option whether to create Y dimensions
-------------------------------------
Getter Method
Signature
CreateYDimensions()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateYDimensions(createYDimensions)
Parameters: createYDimensions (bool) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
CreatedOrdinateOrigin¶
-
AutoDimensionBuilder.
CreatedOrdinateOrigin
¶ Returns or sets the created ordinate origin tag
-------------------------------------
Getter Method
Signature
CreatedOrdinateOrigin()
Returns: Returns the created ordinate origin Return type: NXOpen.NXObject
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreatedOrdinateOrigin(ordinateOriginTag)
Parameters: ordinateOriginTag ( NXOpen.NXObject
) – Sets the created ordinate originNew in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
DimensionCharacterSize¶
-
AutoDimensionBuilder.
DimensionCharacterSize
¶ Returns or sets the tolerance character size
-------------------------------------
Getter Method
Signature
DimensionCharacterSize()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionCharacterSize(dimensionCharacterSize)
Parameters: dimensionCharacterSize (float) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
DimensionColor¶
-
AutoDimensionBuilder.
DimensionColor
¶ Returns or sets the dimension color
-------------------------------------
Getter Method
Signature
DimensionColor()
Returns: Return type: Id New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DimensionColor(dimensionColor)
Parameters: dimensionColor (Id) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
Dimensions¶
-
AutoDimensionBuilder.
Dimensions
¶ Returns the selected dimensions to edit
-------------------------------------
Getter Method
Signature
Dimensions()
Returns: Return type: NXOpen.Annotations.SelectOrdinateDimensionList
New in version NX8.5.0.
License requirements: None.
FirstMargin¶
-
AutoDimensionBuilder.
FirstMargin
¶ Returns or sets the first margin tag
-------------------------------------
Getter Method
Signature
FirstMargin()
Returns: Returns the first margin tag Return type: NXOpen.NXObject
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FirstMargin(firstMarginTag)
Parameters: firstMarginTag ( NXOpen.NXObject
) – Sets the first margin tagNew in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
FourthMargin¶
-
AutoDimensionBuilder.
FourthMargin
¶ Returns or sets the fourth margin tag
-------------------------------------
Getter Method
Signature
FourthMargin()
Returns: Returns the fourth margin tag Return type: NXOpen.NXObject
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FourthMargin(fourthMarginTag)
Parameters: fourthMarginTag ( NXOpen.NXObject
) – Sets the fourth margin tagNew in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
InnerDimensionOffsetValue¶
-
AutoDimensionBuilder.
InnerDimensionOffsetValue
¶ Returns or sets the inner dimension offset value
-------------------------------------
Getter Method
Signature
InnerDimensionOffsetValue()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InnerDimensionOffsetValue(innerDimensionOffsetValue)
Parameters: innerDimensionOffsetValue (float) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
MaxDistanceToOuterMargin¶
-
AutoDimensionBuilder.
MaxDistanceToOuterMargin
¶ Returns or sets the max distance to outer margin
-------------------------------------
Getter Method
Signature
MaxDistanceToOuterMargin()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaxDistanceToOuterMargin(maxDistanceToOuterMargin)
Parameters: maxDistanceToOuterMargin (float) – New in version NX9.0.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ObjectToDimension¶
-
AutoDimensionBuilder.
ObjectToDimension
¶ Returns the objects to dimension
-------------------------------------
Getter Method
Signature
ObjectToDimension()
Returns: Return type: NXOpen.SelectNXObjectList
New in version NX8.5.0.
License requirements: None.
OffsetValueForMargin¶
-
AutoDimensionBuilder.
OffsetValueForMargin
¶ Returns or sets the offset value of margins
-------------------------------------
Getter Method
Signature
OffsetValueForMargin()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OffsetValueForMargin(offsetValueForMargin)
Parameters: offsetValueForMargin (float) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
OrdinateDimensionStyle¶
-
AutoDimensionBuilder.
OrdinateDimensionStyle
¶ Returns the ordinate dimension style
-------------------------------------
Getter Method
Signature
OrdinateDimensionStyle()
Returns: Return type: NXOpen.Annotations.StyleBuilder
New in version NX10.0.0.
License requirements: None.
OrdinateView¶
-
AutoDimensionBuilder.
OrdinateView
¶ Returns or sets the ordinate view tag
-------------------------------------
Getter Method
Signature
OrdinateView()
Returns: Returns the ordinate view tag Return type: NXOpen.NXObject
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OrdinateView(ordinateViewTag)
Parameters: ordinateViewTag ( NXOpen.NXObject
) – Sets the ordinate view tagNew in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
OriginPoint¶
-
AutoDimensionBuilder.
OriginPoint
¶ Returns the ordinate origin point
-------------------------------------
Getter Method
Signature
OriginPoint()
Returns: Return type: NXOpen.SelectNXObject
New in version NX8.5.0.
License requirements: None.
SecondMargin¶
-
AutoDimensionBuilder.
SecondMargin
¶ Returns or sets the second margin tag
-------------------------------------
Getter Method
Signature
SecondMargin()
Returns: Returns the second margin tag Return type: NXOpen.NXObject
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SecondMargin(secondMarginTag)
Parameters: secondMarginTag ( NXOpen.NXObject
) – Sets the second margin tagNew in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
SelectHolesAutomatically¶
-
AutoDimensionBuilder.
SelectHolesAutomatically
¶ Returns or sets the option whether to select holes automatically
-------------------------------------
Getter Method
Signature
SelectHolesAutomatically()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SelectHolesAutomatically(selectHolesAutomatically)
Parameters: selectHolesAutomatically (bool) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
TextAngle¶
-
AutoDimensionBuilder.
TextAngle
¶ Returns or sets the text angle
-------------------------------------
Getter Method
Signature
TextAngle()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TextAngle(textAngle)
Parameters: textAngle (float) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
TextFont¶
-
AutoDimensionBuilder.
TextFont
¶ Returns or sets the text orientation
-------------------------------------
Getter Method
Signature
TextFont()
Returns: Return type: NXOpen.Tooling.AutoDimensionBuilderTextFontType
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TextFont(textFont)
Parameters: textFont ( NXOpen.Tooling.AutoDimensionBuilderTextFontType
) –New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
TextOrientation¶
-
AutoDimensionBuilder.
TextOrientation
¶ Returns or sets the text orientation
-------------------------------------
Getter Method
Signature
TextOrientation()
Returns: Return type: NXOpen.Tooling.AutoDimensionBuilderTextOrientationType
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TextOrientation(textOrientation)
Parameters: textOrientation ( NXOpen.Tooling.AutoDimensionBuilderTextOrientationType
) –New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ThirdMargin¶
-
AutoDimensionBuilder.
ThirdMargin
¶ Returns or sets the third margin tag
-------------------------------------
Getter Method
Signature
ThirdMargin()
Returns: Returns the third margin tag Return type: NXOpen.NXObject
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ThirdMargin(thirdMarginTag)
Parameters: thirdMarginTag ( NXOpen.NXObject
) – Sets the third margin tagNew in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
Tolerance¶
-
AutoDimensionBuilder.
Tolerance
¶ Returns or sets the tolerance type
-------------------------------------
Getter Method
Signature
Tolerance()
Returns: Return type: NXOpen.Tooling.AutoDimensionBuilderToleranceType
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Tolerance(toleranceType)
Parameters: toleranceType ( NXOpen.Tooling.AutoDimensionBuilderToleranceType
) –New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ToleranceCharacterSize¶
-
AutoDimensionBuilder.
ToleranceCharacterSize
¶ Returns or sets the tolerance character size
-------------------------------------
Getter Method
Signature
ToleranceCharacterSize()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceCharacterSize(toleranceCharacterSize)
Parameters: toleranceCharacterSize (float) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ToleranceColor¶
-
AutoDimensionBuilder.
ToleranceColor
¶ Returns or sets the tolerance color
-------------------------------------
Getter Method
Signature
ToleranceColor()
Returns: Return type: Id New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceColor(toleranceColor)
Parameters: toleranceColor (Id) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ToleranceLowerValue¶
-
AutoDimensionBuilder.
ToleranceLowerValue
¶ Returns or sets the tolerance lower value
-------------------------------------
Getter Method
Signature
ToleranceLowerValue()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceLowerValue(toleranceLowerValue)
Parameters: toleranceLowerValue (float) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ToleranceUpperValue¶
-
AutoDimensionBuilder.
ToleranceUpperValue
¶ Returns or sets the tolerance upper value
-------------------------------------
Getter Method
Signature
ToleranceUpperValue()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceUpperValue(toleranceUpperValue)
Parameters: toleranceUpperValue (float) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ToleranceValue¶
-
AutoDimensionBuilder.
ToleranceValue
¶ Returns or sets the tolerance value
-------------------------------------
Getter Method
Signature
ToleranceValue()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToleranceValue(toleranceValue)
Parameters: toleranceValue (float) – New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
Type¶
-
AutoDimensionBuilder.
Type
¶ Returns or sets the type create or edit ordinate dimension
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.Tooling.AutoDimensionBuilderMainType
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type(type)
Parameters: type ( NXOpen.Tooling.AutoDimensionBuilderMainType
) –New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
ValuePrecision¶
-
AutoDimensionBuilder.
ValuePrecision
¶ Returns or sets the value precision
-------------------------------------
Getter Method
Signature
ValuePrecision()
Returns: Return type: NXOpen.Tooling.AutoDimensionBuilderValuePrecisionType
New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ValuePrecision(valuePrecision)
Parameters: valuePrecision ( NXOpen.Tooling.AutoDimensionBuilderValuePrecisionType
) –New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
Method Detail¶
CreateOrdinateOrigin¶
-
AutoDimensionBuilder.
CreateOrdinateOrigin
¶ The method to create ordinate origin
Signature
CreateOrdinateOrigin(viewTag, pointData)
Parameters: - viewTag (
NXOpen.NXObject
) – - pointData (
NXOpen.Point3d
) –
Returns: Return type: New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
- viewTag (
CreateOrdinateOriginMargins¶
-
AutoDimensionBuilder.
CreateOrdinateOriginMargins
¶ The method to create ordinate origin margins
Signature
CreateOrdinateOriginMargins(ordinateOrigin, viewTag)
Parameters: - ordinateOrigin (
NXOpen.NXObject
) – - viewTag (
NXOpen.NXObject
) –
New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
- ordinateOrigin (
CycleObjectsInView¶
-
AutoDimensionBuilder.
CycleObjectsInView
¶ The method to cycle objects in view
Signature
CycleObjectsInView(viewTag, vseqNumber, isDrawing, inObject)
Parameters: - viewTag (
NXOpen.NXObject
) – The view to cycle - vseqNumber (int) – The View Sequence Number of the View must NOT be DSS_ALL_VIEWS or DSS_NO_VIEWS
- isDrawing (bool) – Is this view a drawing
- inObject (
NXOpen.NXObject
) – Input object
Returns: Output object
Return type: New in version NX8.5.0.
License requirements: ug_mold_design (“UG MOLD”) OR prog_die_wizard (“UG/Progressive Die Wizard”)
- viewTag (
Validate¶
-
AutoDimensionBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.