PlaneSearchTermBuilder Class¶
-
class
NXOpen.Assemblies.PlaneSearchTermBuilder¶ Bases:
NXOpen.Assemblies.SearchTermBuilderA PlaneSearchTermBuilder is used to create or edit an
NXOpen.Assemblies.PlaneSearchTerm.To create a new instance of this class, use
NXOpen.Assemblies.SubsetCollection.CreatePlaneSearchTermBuilder()New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| Displacement | Returns or sets the displacement of the plane from the origin. |
| Normal | Returns or sets the normal of the plane. |
| PlaneOverlapLogic | Returns or sets the plane overlap logic. |
| PointOnPlane | Returns or sets the normal of the plane. |
| SearchTermLogic | Returns or sets the search term logic. |
| Tag | Returns the Tag for this object. |
| TrueShapeRefinement | Returns or sets the true-shape refinement. |
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. |
Property Detail¶
Displacement¶
-
PlaneSearchTermBuilder.Displacement¶ Returns or sets the displacement of the plane from the origin.
-------------------------------------Getter Method
Signature
DisplacementReturns: Return type: float New in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
-------------------------------------Setter Method
Signature
DisplacementParameters: displacement (float) – New in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
Normal¶
-
PlaneSearchTermBuilder.Normal¶ Returns or sets the normal of the plane.
-------------------------------------Getter Method
Signature
NormalReturns: Return type: NXOpen.Vector3dNew in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
-------------------------------------Setter Method
Signature
NormalParameters: normal ( NXOpen.Vector3d) –New in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
PlaneOverlapLogic¶
-
PlaneSearchTermBuilder.PlaneOverlapLogic¶ Returns or sets the plane overlap logic.
-------------------------------------Getter Method
Signature
PlaneOverlapLogicReturns: Return type: NXOpen.Assemblies.PlaneSearchTermPlaneOverlapLogicTypeNew in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
-------------------------------------Setter Method
Signature
PlaneOverlapLogicParameters: planeOverlapLogic ( NXOpen.Assemblies.PlaneSearchTermPlaneOverlapLogicType) –New in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
PointOnPlane¶
-
PlaneSearchTermBuilder.PointOnPlane¶ Returns or sets the normal of the plane.
-------------------------------------Getter Method
Signature
PointOnPlaneReturns: Return type: NXOpen.Point3dNew in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
-------------------------------------Setter Method
Signature
PointOnPlaneParameters: pointOnPlane ( NXOpen.Point3d) –New in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
SearchTermLogic¶
-
PlaneSearchTermBuilder.SearchTermLogic¶ Returns or sets the search term logic.
-------------------------------------Getter Method
Signature
SearchTermLogicReturns: Return type: NXOpen.Assemblies.SearchTermSearchTermLogicTypeNew in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
-------------------------------------Setter Method
Signature
SearchTermLogicParameters: searchTermLogic ( NXOpen.Assemblies.SearchTermSearchTermLogicType) –New in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
TrueShapeRefinement¶
-
PlaneSearchTermBuilder.TrueShapeRefinement¶ Returns or sets the true-shape refinement.
-------------------------------------Getter Method
Signature
TrueShapeRefinementReturns: Return type: bool New in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
-------------------------------------Setter Method
Signature
TrueShapeRefinementParameters: trueShapeRefinement (bool) – New in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
Method Detail¶
Validate¶
-
PlaneSearchTermBuilder.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.