LinearDimensionBuilder Class¶
-
class
NXOpen.Features.LinearDimensionBuilder¶ Bases:
NXOpen.Features.DimensionBuilderRepresents a
NXOpen.Features.LinearDimensionbuilderTo create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateLinearDimensionBuilder()Default values.
Property Value OrientationOption OrientXpress Value.Value 0 (millimeters part), 0 (inches part) New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| DimensionLocation | Returns the dimension location/placement controlled by the annotation origin block |
| DimensionOrientation | Returns the OrientXpress that is employed in the ADM Linear Dimension Feature |
| DimensionOrientationVector | Returns or sets the dimension orientation vector for the Linear Dimension |
| FaceChangeOverflowBehavior | Returns the face change overflow behavior. |
| FacesToMove | Returns the faces being moved as part of the Linear Dimension command |
| MeasurementObject | Returns the measurement object to which the ADM Linear Dimension is measured to |
| OrientationOption | Returns or sets the option that controls whether the OrientXpress or whether the vector block Controls the orientation of the Linear Dimension |
| OriginObject | Returns the origin object from which the ADM Linear dimension is measured from |
| ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
| PatchSolutionFlag | Returns or sets the patch solution flag |
| PatchSurfaceFilename | Returns or sets the patch surface filename |
| SaveConstraints | Returns the SaveConstraints builder which is used by ADM Dimension Features. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| Value | Returns the value of the dimension |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CommitFeature | Commits the feature parameters and creates the feature |
| 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. |
| GetDimension | The drafting dimension which is used as UI tool for dimension display. |
| GetFeature | Returns the feature currently being edited by this builder. |
| GetObject | Returns the object currently being edited by this builder. |
| HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
| SetFaceToMove | The important face that is being moved through the ADM Linear Dimension Feature. |
| SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
| ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| LinearDimensionBuilderOrientationOptionType Enumeration | the option that controls whether the OrientXpress or whether the vector block Controls the orientation of the Linear Dimension |
Property Detail¶
DimensionOrientation¶
-
LinearDimensionBuilder.DimensionOrientation¶ Returns the OrientXpress that is employed in the ADM Linear Dimension Feature
-------------------------------------Getter Method
Signature
DimensionOrientationReturns: Return type: NXOpen.GeometricUtilities.OrientXpressBuilderNew in version NX6.0.0.
License requirements: None.
DimensionOrientationVector¶
-
LinearDimensionBuilder.DimensionOrientationVector¶ Returns or sets the dimension orientation vector for the Linear Dimension
-------------------------------------Getter Method
Signature
DimensionOrientationVectorReturns: Return type: NXOpen.DirectionNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DimensionOrientationVectorParameters: dimensionOrientationVector ( NXOpen.Direction) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
MeasurementObject¶
-
LinearDimensionBuilder.MeasurementObject¶ Returns the measurement object to which the ADM Linear Dimension is measured to
-------------------------------------Getter Method
Signature
MeasurementObjectReturns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
OrientationOption¶
-
LinearDimensionBuilder.OrientationOption¶ Returns or sets the option that controls whether the OrientXpress or whether the vector block Controls the orientation of the Linear Dimension
-------------------------------------Getter Method
Signature
OrientationOptionReturns: Return type: NXOpen.Features.LinearDimensionBuilderOrientationOptionTypeNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OrientationOptionParameters: orientationOption ( NXOpen.Features.LinearDimensionBuilderOrientationOptionType) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
OriginObject¶
-
LinearDimensionBuilder.OriginObject¶ Returns the origin object from which the ADM Linear dimension is measured from
-------------------------------------Getter Method
Signature
OriginObjectReturns: Return type: NXOpen.SelectNXObjectNew in version NX6.0.0.
License requirements: None.
Method Detail¶
SetFaceToMove¶
-
LinearDimensionBuilder.SetFaceToMove¶ The important face that is being moved through the ADM Linear Dimension Feature.
The system will try to silently infer one. But if the user wants to provide one, then he/she needs to pass in the face through this command
Signature
SetFaceToMove(face)Parameters: face ( NXOpen.Face) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)
Validate¶
-
LinearDimensionBuilder.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.