I3DExNewConstraint Struct Reference
[External Interfaces]

Inheritance diagram for I3DExNewConstraint:
IMCUnknown TBasicNewConstraint

List of all members.

Public Member Functions

virtual int16 MCCOMAPI GetNbrFreedom () const =0
virtual MCCOMErr MCCOMAPI IncrementFreedomValue (int16 index, real &increment)=0
virtual MCCOMErr MCCOMAPI GetMotionLimit (int16 index, ELimitType &limit) const =0
virtual MCCOMErr MCCOMAPI GetFreedomRange (int16 index, real &min, real &max) const =0
virtual MCCOMErr MCCOMAPI GetFreedomValue (int16 index, real &outValue) const =0
virtual MCCOMErr MCCOMAPI GetTransformPartialDerivate (int16 index, TTransform3D &transform) const =0
virtual MCCOMErr MCCOMAPI GetTransformSecondPartialDerivative (int16 index1, int16 index2, TTransform3D &transform) const =0
virtual void MCCOMAPI ConstrainsTransform (TTreeTransform &transform) const =0

Member Function Documentation

virtual void MCCOMAPI I3DExNewConstraint::ConstrainsTransform ( TTreeTransform transform  )  const [pure virtual]

Modify the tree transform to apply the contraints.

Parameters:
transform A reference to a tree transform (this parameter is in and out).

Implemented in TBasicNewConstraint.

virtual MCCOMErr MCCOMAPI I3DExNewConstraint::GetFreedomRange ( int16  index,
real min,
real max 
) const [pure virtual]

Returns the maximum range of increment and decrement for a given degree of freedom.

Parameters:
index The index of the degree of freedom
min The minimum value
max The maximum value

Implemented in TBasicNewConstraint.

virtual MCCOMErr MCCOMAPI I3DExNewConstraint::GetFreedomValue ( int16  index,
real outValue 
) const [pure virtual]

Get the current value of the given freedom

Parameters:
index The degree of freedom
See also:
EFreedomDegree
Parameters:
outValue The value of the freedom

Implemented in TBasicNewConstraint.

virtual MCCOMErr MCCOMAPI I3DExNewConstraint::GetMotionLimit ( int16  index,
ELimitType limit 
) const [pure virtual]

Returns the constraint for a given degree of freedom.

Implemented in TBasicNewConstraint.

virtual int16 MCCOMAPI I3DExNewConstraint::GetNbrFreedom (  )  const [pure virtual]

Returns the number of degrees of freedom. Because the freedom value can be limited, you have to give the range of values. This range is defined as a range of increment/decrement around the value.

Implemented in TBasicNewConstraint.

virtual MCCOMErr MCCOMAPI I3DExNewConstraint::GetTransformPartialDerivate ( int16  index,
TTransform3D transform 
) const [pure virtual]

To allow the inverse kinematics mechanism to work with a constraint, implement the GetTransfromPartialDerivate() function. A partial derivative transformation is a transformation where each element is derived by a freedom degree.

Parameters:
index The degree of freedom used to derivate the transform.
transform The partial derivative of the transform.

Implemented in TBasicNewConstraint.

virtual MCCOMErr MCCOMAPI I3DExNewConstraint::GetTransformSecondPartialDerivative ( int16  index1,
int16  index2,
TTransform3D transform 
) const [pure virtual]

Returns the second order partial derivative of the transform. A partial derivative transformation is a transformation where each element is derived by a freedom degree.

Parameters:
index1 The first degree of freedom used to derivate the transform.
index2 The second degree of freedom used to derivate the transform.
transform The partial derivative of the transform.

Implemented in TBasicNewConstraint.

virtual MCCOMErr MCCOMAPI I3DExNewConstraint::IncrementFreedomValue ( int16  index,
real increment 
) [pure virtual]

Modify the value of a degree of freedom by adding an increment

Parameters:
index The degree of freedom
See also:
EFreedomDegree
Parameters:
increment The increment value

Implemented in TBasicNewConstraint.


The documentation for this struct was generated from the following file:
Generated on Mon Apr 26 22:47:38 2010 for Carrara SDK Doc by  doxygen 1.6.3