Public Member Functions
KinematicState Class Reference

Detailed Description

The KinematicState represents the current pose of an X3DObject object whereas the base pose of an object is represented by the StaticKinematicState.

See also:
Kinematics::GetGlobal, Kinematics::GetLocal, StaticKinematicState
        using namespace XSI;
        Application app;
        Model root = app.GetActiveSceneRoot();

        Null myNull;
        root.AddNull( L"", myNull );

        app.LogMessage( myNull.GetKinematics().GetGlobal().GetClassIDName() );

#include <xsi_kinematicstate.h>

Inheritance diagram for KinematicState:
Inheritance graph

List of all members.

Public Member Functions

 KinematicState ()
 ~KinematicState ()
 KinematicState (const CRef &in_ref)
 KinematicState (const KinematicState &in_obj)
bool IsA (siClassID in_ClassID) const
siClassID GetClassID () const
KinematicStateoperator= (const KinematicState &in_obj)
KinematicStateoperator= (const CRef &in_ref)
MATH::CTransformation GetTransform (double in_dFrame=DBL_MAX) const
CStatus PutTransform (const MATH::CTransformation &in_transf, double in_dFrame=DBL_MAX)

Constructor & Destructor Documentation

Default constructor.

Default destructor.

KinematicState ( const CRef in_ref)


in_refconstant reference object.
KinematicState ( const KinematicState in_obj)

Copy constructor.

in_objconstant class object.

Member Function Documentation

bool IsA ( siClassID  in_ClassID) const [virtual]

Returns true if a given class type is compatible with this API class.

in_ClassIDclass type.
true if the class is compatible, false otherwise.

Reimplemented from Parameter.

siClassID GetClassID ( ) const [virtual]

Returns the type of the API class.

The class type.

Reimplemented from Parameter.

KinematicState& operator= ( const KinematicState in_obj)

Creates an object from another object. The newly created object is set to empty if the input object is not compatible.

in_objconstant class object.
The new KinematicState object.
KinematicState& operator= ( const CRef in_ref)

Creates an object from a reference object. The newly created object is set to empty if the input reference object is not compatible.

in_refconstant class object.
The new KinematicState object.

Reimplemented from Parameter.

MATH::CTransformation GetTransform ( double  in_dFrame = DBL_MAX) const

Returns the transformation of an object.

in_dFrameFrame at which to get the transform, it defaults to the current frame (DBL_MAX indicates the current frame).
The Transformation object.
CStatus PutTransform ( const MATH::CTransformation in_transf,
double  in_dFrame = DBL_MAX 

Sets the transformation of an object. Currently you cannot set the transform at a different time other than the current time.

in_transfThe transformation object.
in_dFrameFrame at which to set the transform (not supported yet).
CStatus::OK success
CStatus::Fail failure

The documentation for this class was generated from the following file: