ClearanceBuilder Class¶
-
class
NXOpen.Die.ClearanceBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a builder that is used to create or edit a
NXOpen.Die.Clearancefeature.To create a new instance of this class, use
NXOpen.Die.DieCollection.CreateClearanceBuilder()Default values.
Property Value ClearanceGeometryType Solid Distance.Value 0 (millimeters part), 0 (inches part) Offset.Value 5 (millimeters part), 0.2 (inches part) New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| AngleTolerance | Returns or sets the angle tolerance. |
| Attributes | Returns the attribute title, value and face color to apply to the clearance faces. |
| ClearanceDirection | Returns the direction to use when extruding to create the clearance areas. |
| ClearanceGeometryType | Returns or sets the input type of the clearance geometry. |
| Distance | Returns the expression containing the distance value for extrusions when defining the clearance area. |
| DistanceTolerance | Returns or sets the distance tolerance. |
| Geometry | Returns the solid to use for the basis of the clearance area. |
| Offset | Returns the expression containing the offset value to apply to create a clearance area around the solid or closed profile definitions. |
| Orientation | Returns the projection plane for the closed profiles to define the clearance areas. |
| 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 |
| Section | Returns the closed profile sections to use for the basis of the clearance area. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| Target | Returns the target solid the clearance will be subtracted from. |
| Type | Returns or sets the identification of the clearance type (NXOpen.Die.ClearanceBuilderTypes.Gage, NXOpen.Die.ClearanceBuilderTypes.Gripper, or NXOpen.Die.ClearanceBuilderTypes.Lifter) to create in the target solid. |
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. |
| 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. |
| 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¶
| ClearanceBuilderClearanceGeometryTypes Enumeration | Identifies which type of input defines the clearance. |
| ClearanceBuilderTypes Enumeration | Identifies which clearance type is being created in the casting. |
Property Detail¶
AngleTolerance¶
-
ClearanceBuilder.AngleTolerance¶ Returns or sets the angle tolerance.
-------------------------------------Getter Method
Signature
AngleToleranceReturns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AngleToleranceParameters: angleTolerance (float) – New in version NX7.5.0.
License requirements: ug_die_design (“Die Design”)
Attributes¶
-
ClearanceBuilder.Attributes¶ Returns the attribute title, value and face color to apply to the clearance faces.
-------------------------------------Getter Method
Signature
AttributesReturns: Return type: NXOpen.Die.DieAttributesBuilderNew in version NX7.5.0.
License requirements: None.
ClearanceDirection¶
-
ClearanceBuilder.ClearanceDirection¶ Returns the direction to use when extruding to create the clearance areas.
-------------------------------------Getter Method
Signature
ClearanceDirectionReturns: Return type: NXOpen.Die.DieDirectionBuilderNew in version NX7.5.0.
License requirements: None.
ClearanceGeometryType¶
-
ClearanceBuilder.ClearanceGeometryType¶ Returns or sets the input type of the clearance geometry.
-------------------------------------Getter Method
Signature
ClearanceGeometryTypeReturns: Return type: NXOpen.Die.ClearanceBuilderClearanceGeometryTypesNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ClearanceGeometryTypeParameters: clearanceGeometryType ( NXOpen.Die.ClearanceBuilderClearanceGeometryTypes) –New in version NX7.5.0.
License requirements: ug_die_design (“Die Design”)
Distance¶
-
ClearanceBuilder.Distance¶ Returns the expression containing the distance value for extrusions when defining the clearance area.
If the value is 0.0, then a value will be generated from the target solid.
-------------------------------------Getter Method
Signature
DistanceReturns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
DistanceTolerance¶
-
ClearanceBuilder.DistanceTolerance¶ Returns or sets the distance tolerance.
-------------------------------------Getter Method
Signature
DistanceToleranceReturns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DistanceToleranceParameters: distanceTolerance (float) – New in version NX7.5.0.
License requirements: ug_die_design (“Die Design”)
Geometry¶
-
ClearanceBuilder.Geometry¶ Returns the solid to use for the basis of the clearance area.
Only valid when type is
NXOpen.Die.ClearanceBuilderClearanceGeometryTypes.Solid.-------------------------------------Getter Method
Signature
GeometryReturns: Return type: NXOpen.SelectBodyListNew in version NX7.5.0.
License requirements: None.
Offset¶
-
ClearanceBuilder.Offset¶ Returns the expression containing the offset value to apply to create a clearance area around the solid or closed profile definitions.
-------------------------------------Getter Method
Signature
OffsetReturns: Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
Orientation¶
-
ClearanceBuilder.Orientation¶ Returns the projection plane for the closed profiles to define the clearance areas.
Only valid when type is
NXOpen.Die.ClearanceBuilderClearanceGeometryTypes.Section.-------------------------------------Getter Method
Signature
OrientationReturns: Return type: NXOpen.Die.DiePlaneBuilderNew in version NX7.5.0.
License requirements: None.
Section¶
-
ClearanceBuilder.Section¶ Returns the closed profile sections to use for the basis of the clearance area.
Only valid when type is
NXOpen.Die.ClearanceBuilderClearanceGeometryTypes.Section.-------------------------------------Getter Method
Signature
SectionReturns: Return type: NXOpen.SectionNew in version NX7.5.0.
License requirements: None.
Target¶
-
ClearanceBuilder.Target¶ Returns the target solid the clearance will be subtracted from.
-------------------------------------Getter Method
Signature
TargetReturns: Return type: NXOpen.SelectBodyNew in version NX7.5.0.
License requirements: None.
Type¶
-
ClearanceBuilder.Type¶ Returns or sets the identification of the clearance type (
NXOpen.Die.ClearanceBuilderTypes.Gage,NXOpen.Die.ClearanceBuilderTypes.Gripper, orNXOpen.Die.ClearanceBuilderTypes.Lifter) to create in the target solid.-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.Die.ClearanceBuilderTypesNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TypeParameters: type ( NXOpen.Die.ClearanceBuilderTypes) –New in version NX7.5.0.
License requirements: ug_die_design (“Die Design”)
Method Detail¶
Validate¶
-
ClearanceBuilder.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.