SketchDimensionBuilder Class¶
-
class
NXOpen.SketchDimensionBuilder¶ Bases:
NXOpen.BuilderEdit the geometry references of an existing sketch dimension.
For active dimensions, the driving expression can be kept or reset to the measured value of the new geometry.
To create a new instance of this class, use
NXOpen.SketchCollection.CreateDimensionBuilder()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| ExpressionOption | Returns or sets the expression option |
| FirstGeometry | Returns the first geometry |
| SecondGeometry | Returns the second geometry. |
| SnapRadius | Returns or sets the snap radius. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| 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¶
| SketchDimensionBuilderExpOption Enumeration | This enum determines the expression behavior when a dimension is attached to new geometry |
Property Detail¶
ExpressionOption¶
-
SketchDimensionBuilder.ExpressionOption¶ Returns or sets the expression option
-------------------------------------Getter Method
Signature
ExpressionOptionReturns: Return type: NXOpen.SketchDimensionBuilderExpOptionNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ExpressionOptionParameters: option ( NXOpen.SketchDimensionBuilderExpOption) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
FirstGeometry¶
-
SketchDimensionBuilder.FirstGeometry¶ Returns the first geometry
-------------------------------------Getter Method
Signature
FirstGeometryReturns: Return type: NXOpen.SelectNXObjectNew in version NX5.0.0.
License requirements: None.
SecondGeometry¶
-
SketchDimensionBuilder.SecondGeometry¶ Returns the second geometry.
This will be NULL for Radius or Diameter dimensions.
-------------------------------------Getter Method
Signature
SecondGeometryReturns: Return type: NXOpen.SelectNXObjectNew in version NX5.0.0.
License requirements: None.
SnapRadius¶
-
SketchDimensionBuilder.SnapRadius¶ Returns or sets the snap radius.
This is used to determine if the geometry is selected at a control point.
-------------------------------------Getter Method
Signature
SnapRadiusReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SnapRadiusParameters: radius (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
SketchDimensionBuilder.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.