FaceClearanceCheckBuilder Class¶
-
class
NXOpen.CAE.ModelCheck.FaceClearanceCheckBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.CAE.ModelCheck.FaceClearanceCheckBuilderto perform polygon face interference or clearance check.You can do the check by
Builder.Commit()orNXOpen.CAE.ModelCheck.FaceClearanceCheckBuilder.DoCheck().Builder.Commit()performs the check and displays the failed faces in graphics window.NXOpen.CAE.ModelCheck.FaceClearanceCheckBuilder.DoCheck()performs the check and if faces are detected violating the check, returns the output group containing the failed faces.To create a new instance of this class, use
NXOpen.CAE.ModelCheckManager.CreateFaceClearanceCheckBuilder()New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| Clearance | Returns the clearance. |
| 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. |
| DoCheck | Perform the clearance check. |
| 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. |
Property Detail¶
Clearance¶
-
FaceClearanceCheckBuilder.Clearance¶ Returns the clearance.
If the clearance value is zero, an intersection check between faces will be performed. If the clearance value is non-zero, a clearance check will be performed. If a negative non-zero clearance is set, the absolute value will be used
-------------------------------------Getter Method
Signature
ClearanceReturns: Return type: NXOpen.ExpressionNew in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Method Detail¶
DoCheck¶
-
FaceClearanceCheckBuilder.DoCheck¶ Perform the clearance check.
All polygon faces on the current display are considered for the check. If polygon faces are detected as intersecting or violating the given clearance, they are placed in a group, which would be returned
Signature
DoCheck()Returns: the group contains the failed faces Return type: NXOpen.CAE.CaeGroupNew in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Validate¶
-
FaceClearanceCheckBuilder.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.