NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::AnimationDesigner::InverseKinematicsBuilder Class Reference

Represents a AnimationDesigner::InverseKinematicsBuilder
To create a new instance of this class, use NXOpen::AnimationDesigner::AnimationDesignerManager::CreateInverseKinematicsBuilder

Created in NX1847.0.0. More...

Inheritance diagram for NXOpen::AnimationDesigner::InverseKinematicsBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Result { ResultNotSolved, ResultSuccess, ResultApproximate, ResultLimits }
 Specifies the result of the inverse kinematics solver. More...
 

Public Member Functions

bool AvoidCollision ()
 Returns the collision option. More...
 
void GetOrientation (NXOpen::Matrix3x3 *startOrit, NXOpen::Matrix3x3 *targetOrit)
 Gets the orientations. More...
 
NXOpen::AnimationDesigner::InverseKinematicsBuilder::Result GetResult ()
 Returns the solver result. More...
 
NXOpen::SelectNXObjectRigidGroup ()
 Returns the rigid group. More...
 
void SetAvoidCollision (bool avoidCollision)
 Sets the collision option. More...
 
void SetOrientation (const NXOpen::Matrix3x3 &startOrit, const NXOpen::Matrix3x3 &targetOrit)
 Sets the orientations. More...
 
void SetStartPoint (NXOpen::Point *startPoint)
 Sets the start point. More...
 
void SetTargetPoint (NXOpen::Point *targetPoint)
 Sets the target point. More...
 
NXOpen::PointStartPoint ()
 Returns the start point. More...
 
NXOpen::PointTargetPoint ()
 Returns the target point. 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

Represents a AnimationDesigner::InverseKinematicsBuilder
To create a new instance of this class, use NXOpen::AnimationDesigner::AnimationDesignerManager::CreateInverseKinematicsBuilder

Created in NX1847.0.0.


Member Enumeration Documentation

Specifies the result of the inverse kinematics solver.

Enumerator
ResultNotSolved 

Could not solve due to error.

ResultSuccess 

Successfully solved.

ResultApproximate 

The target is not reachable, closest solution is returned.

ResultLimits 

The target is not reachable due to limits, closest solution is returned.

Member Function Documentation

bool NXOpen::AnimationDesigner::InverseKinematicsBuilder::AvoidCollision ( )

Returns the collision option.


Created in NX1847.0.0.

License requirements : None

void NXOpen::AnimationDesigner::InverseKinematicsBuilder::GetOrientation ( NXOpen::Matrix3x3 startOrit,
NXOpen::Matrix3x3 targetOrit 
)

Gets the orientations.


Created in NX1847.0.0.

License requirements : None

Parameters
startOritThe start orientation matrix.
targetOritThe target orientation matrix.
NXOpen::AnimationDesigner::InverseKinematicsBuilder::Result NXOpen::AnimationDesigner::InverseKinematicsBuilder::GetResult ( )

Returns the solver result.

Returns
The result of the inverse kinematics solver
Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")
NXOpen::SelectNXObject* NXOpen::AnimationDesigner::InverseKinematicsBuilder::RigidGroup ( )

Returns the rigid group.


Created in NX1847.0.0.

License requirements : None

void NXOpen::AnimationDesigner::InverseKinematicsBuilder::SetAvoidCollision ( bool  avoidCollision)

Sets the collision option.


Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
avoidCollisionavoidcollision
void NXOpen::AnimationDesigner::InverseKinematicsBuilder::SetOrientation ( const NXOpen::Matrix3x3 startOrit,
const NXOpen::Matrix3x3 targetOrit 
)

Sets the orientations.


Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
startOritThe start orientation matrix.
targetOritThe target orientation matrix.
void NXOpen::AnimationDesigner::InverseKinematicsBuilder::SetStartPoint ( NXOpen::Point startPoint)

Sets the start point.


Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
startPointstartpoint
void NXOpen::AnimationDesigner::InverseKinematicsBuilder::SetTargetPoint ( NXOpen::Point targetPoint)

Sets the target point.


Created in NX1847.0.0.

License requirements : nx_animationdesigner (" NX Animation Designer")

Parameters
targetPointtargetpoint
NXOpen::Point* NXOpen::AnimationDesigner::InverseKinematicsBuilder::StartPoint ( )

Returns the start point.


Created in NX1847.0.0.

License requirements : None

NXOpen::Point* NXOpen::AnimationDesigner::InverseKinematicsBuilder::TargetPoint ( )

Returns the target point.


Created in NX1847.0.0.

License requirements : None


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