NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Facet::BestFitAlignBuilder Class Reference

This class performs the best fit alignment between objects
To create a new instance of this class, use NXOpen::Facet::FacetedBodyCollection::CreateBestFitAlignBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Facet::BestFitAlignBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ConstraintOptions {
  ConstraintOptionsFree, ConstraintOptionsOnlyTranslation, ConstraintOptionsTranslationInPlane, ConstraintOptionsTranslationAlongDirection,
  ConstraintOptionsOnlyRotation, ConstraintOptionsRotationAroundPoint, ConstraintOptionsRotationAroundLine, ConstraintOptionsHoldToPlane,
  ConstraintOptionsHoldToLine
}
 Represents the constraint options. More...
 

Public Member Functions

NXOpen::SelectNXObjectListDestinationObjects ()
 Returns the destination objects
Created in NX6.0.0. More...
 
NXOpen::DirectionDirection ()
 Returns the plane or line direction
Created in NX6.0.0. More...
 
NXOpen::Facet::BestFitAlignBuilder::ConstraintOptions FitConstraints ()
 Returns the fit constraint
Created in NX6.0.0. More...
 
bool GlobalSearch ()
 Returns a value indicating whether to do a global search
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectListMobileObjects ()
 Returns the mobile objects
Created in NX6.0.0. More...
 
NXOpen::PointRotateCenter ()
 Returns the rotation center
Created in NX6.0.0. More...
 
void SetDirection (NXOpen::Direction *direction)
 Sets the plane or line direction
Created in NX6.0.0. More...
 
void SetFitConstraints (NXOpen::Facet::BestFitAlignBuilder::ConstraintOptions fitConstraints)
 Sets the fit constraint
Created in NX6.0.0. More...
 
void SetGlobalSearch (bool globalSearch)
 Sets a value indicating whether to do a global search
Created in NX6.0.0. More...
 
void SetRotateCenter (NXOpen::Point *rotateCenter)
 Sets the rotation center
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectListSourceObjects ()
 Returns the source objects
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

This class performs the best fit alignment between objects
To create a new instance of this class, use NXOpen::Facet::FacetedBodyCollection::CreateBestFitAlignBuilder

Created in NX6.0.0.


Member Enumeration Documentation

Represents the constraint options.

Enumerator
ConstraintOptionsFree 

No constraint.

ConstraintOptionsOnlyTranslation 

Only translation.

ConstraintOptionsTranslationInPlane 

Translation in the plane.

ConstraintOptionsTranslationAlongDirection 

Translation along direction.

ConstraintOptionsOnlyRotation 

Only rotation.

ConstraintOptionsRotationAroundPoint 

Rotation around specific point.

ConstraintOptionsRotationAroundLine 

Rotation around specific line.

ConstraintOptionsHoldToPlane 

Moving in the plane.

ConstraintOptionsHoldToLine 

Moving along the line.

Member Function Documentation

NXOpen::SelectNXObjectList* NXOpen::Facet::BestFitAlignBuilder::DestinationObjects ( )

Returns the destination objects
Created in NX6.0.0.



License requirements : None

NXOpen::Direction* NXOpen::Facet::BestFitAlignBuilder::Direction ( )

Returns the plane or line direction
Created in NX6.0.0.



License requirements : None

NXOpen::Facet::BestFitAlignBuilder::ConstraintOptions NXOpen::Facet::BestFitAlignBuilder::FitConstraints ( )

Returns the fit constraint
Created in NX6.0.0.



License requirements : None

bool NXOpen::Facet::BestFitAlignBuilder::GlobalSearch ( )

Returns a value indicating whether to do a global search
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Facet::BestFitAlignBuilder::MobileObjects ( )

Returns the mobile objects
Created in NX6.0.0.



License requirements : None

NXOpen::Point* NXOpen::Facet::BestFitAlignBuilder::RotateCenter ( )

Returns the rotation center
Created in NX6.0.0.



License requirements : None

void NXOpen::Facet::BestFitAlignBuilder::SetDirection ( NXOpen::Direction direction)

Sets the plane or line direction
Created in NX6.0.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
directiondirection
void NXOpen::Facet::BestFitAlignBuilder::SetFitConstraints ( NXOpen::Facet::BestFitAlignBuilder::ConstraintOptions  fitConstraints)

Sets the fit constraint
Created in NX6.0.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
fitConstraintsfitconstraints
void NXOpen::Facet::BestFitAlignBuilder::SetGlobalSearch ( bool  globalSearch)

Sets a value indicating whether to do a global search
Created in NX6.0.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
globalSearchglobalsearch
void NXOpen::Facet::BestFitAlignBuilder::SetRotateCenter ( NXOpen::Point rotateCenter)

Sets the rotation center
Created in NX6.0.0.



License requirements : studio_free_form ("STUDIO FREE FORM")

Parameters
rotateCenterrotatecenter
NXOpen::SelectNXObjectList* NXOpen::Facet::BestFitAlignBuilder::SourceObjects ( )

Returns the source objects
Created in NX6.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.