BestFitAlignBuilder Class¶
-
class
NXOpen.Facet.BestFitAlignBuilder¶ Bases:
NXOpen.BuilderThis class performs the best fit alignment between objects
To create a new instance of this class, use
NXOpen.Facet.FacetedBodyCollection.CreateBestFitAlignBuilder()New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| DestinationObjects | Returns the destination objects |
| Direction | Returns or sets the plane or line direction |
| FitConstraints | Returns or sets the fit constraint |
| GlobalSearch | Returns or sets a value indicating whether to do a global search |
| MobileObjects | Returns the mobile objects |
| RotateCenter | Returns or sets the rotation center |
| SourceObjects | Returns the source objects |
| 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¶
| BestFitAlignBuilderConstraintOptions Enumeration | Represents the constraint options |
Property Detail¶
DestinationObjects¶
-
BestFitAlignBuilder.DestinationObjects¶ Returns the destination objects
-------------------------------------Getter Method
Signature
DestinationObjects()Returns: Return type: NXOpen.SelectNXObjectListNew in version NX6.0.0.
License requirements: None.
Direction¶
-
BestFitAlignBuilder.Direction¶ Returns or sets the plane or line direction
-------------------------------------Getter Method
Signature
Direction()Returns: Return type: NXOpen.DirectionNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Direction(direction)Parameters: direction ( NXOpen.Direction) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR nx_freeform_1 (“basic freeform modeling”)
FitConstraints¶
-
BestFitAlignBuilder.FitConstraints¶ Returns or sets the fit constraint
-------------------------------------Getter Method
Signature
FitConstraints()Returns: Return type: NXOpen.Facet.BestFitAlignBuilderConstraintOptionsNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FitConstraints(fitConstraints)Parameters: fitConstraints ( NXOpen.Facet.BestFitAlignBuilderConstraintOptions) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR nx_freeform_1 (“basic freeform modeling”)
GlobalSearch¶
-
BestFitAlignBuilder.GlobalSearch¶ Returns or sets a value indicating whether to do a global search
-------------------------------------Getter Method
Signature
GlobalSearch()Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
GlobalSearch(globalSearch)Parameters: globalSearch (bool) – New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR nx_freeform_1 (“basic freeform modeling”)
MobileObjects¶
-
BestFitAlignBuilder.MobileObjects¶ Returns the mobile objects
-------------------------------------Getter Method
Signature
MobileObjects()Returns: Return type: NXOpen.SelectNXObjectListNew in version NX6.0.0.
License requirements: None.
RotateCenter¶
-
BestFitAlignBuilder.RotateCenter¶ Returns or sets the rotation center
-------------------------------------Getter Method
Signature
RotateCenter()Returns: Return type: NXOpen.PointNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RotateCenter(rotateCenter)Parameters: rotateCenter ( NXOpen.Point) –New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR nx_freeform_1 (“basic freeform modeling”)
SourceObjects¶
-
BestFitAlignBuilder.SourceObjects¶ Returns the source objects
-------------------------------------Getter Method
Signature
SourceObjects()Returns: Return type: NXOpen.SelectNXObjectListNew in version NX6.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
BestFitAlignBuilder.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.