Public API Reference

imesh/animnode/ragdoll2.h

Go to the documentation of this file.

/*
  Copyright (C) 2009-10 Christian Van Brussel, Communications and Remote
      Sensing Laboratory of the School of Engineering at the 
      Universite catholique de Louvain, Belgium
      http://www.tele.ucl.ac.be

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Library General Public License for more details.

  You should have received a copy of the GNU Library General Public
  License along with this library; if not, write to the Free
  Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef __CS_IMESH_ANIMNODE_RAGDOLL_H__
#define __CS_IMESH_ANIMNODE_RAGDOLL_H__

#include "csutil/scf_interface.h"

#include "ivaria/physics.h"
#include "imesh/bodymesh.h"

namespace CS {
namespace Mesh {

struct iAnimatedMesh;

} // namespace Mesh
} // namespace CS

namespace CS{
namespace Physics{

struct iPhysicalSystem;
struct iRigidBody;
struct iJoint;

}
}

namespace CS {
namespace Animation {

enum RagdollState
{
  STATE_INACTIVE = 0,   
  STATE_DYNAMIC,        
  STATE_KINEMATIC       
};

struct iSkeletonRagdollNodeFactory2;

struct iSkeletonRagdollNodeManager2
  : public virtual CS::Animation::iSkeletonAnimNodeManager<CS::Animation::iSkeletonRagdollNodeFactory2>
{
  SCF_ISKELETONANIMNODEMANAGER_INTERFACE (CS::Animation::iSkeletonRagdollNodeManager2, 1, 0, 0);
};

// * The physical state of a body chain.
// */
//enum RagdollState
//{
//  STATE_INACTIVE = 0,   /*!< The chain is physically inactive. */
//  STATE_DYNAMIC,        /*!< The chain is dynamic, ie the motion of 
//                        the chain is controlled by the dynamic simulation. */
//  STATE_KINEMATIC       /*!< The chain is kinematic, ie the motion 
//                        of the chain is controlled by the animation system,
//                        but its bones do interact with the dynamic simulation. */
//};

struct iSkeletonRagdollNodeFactory2 : public virtual iSkeletonAnimNodeFactory
{
  SCF_INTERFACE(CS::Animation::iSkeletonRagdollNodeFactory2, 1, 0, 0);

  virtual void SetBodySkeleton (CS::Animation::iBodySkeleton* skeleton) = 0;

  virtual CS::Animation::iBodySkeleton* GetBodySkeleton () const = 0;

  virtual void AddBodyChain (iBodyChain* chain, RagdollState state = STATE_INACTIVE) = 0;

  virtual void RemoveBodyChain (iBodyChain* chain) = 0;

  virtual void SetChildNode (iSkeletonAnimNodeFactory* node) = 0;

  virtual iSkeletonAnimNodeFactory* GetChildNode () const = 0;
};

struct iSkeletonRagdollNode2 : public virtual iSkeletonAnimNode
{
  SCF_INTERFACE(CS::Animation::iSkeletonRagdollNode2, 1, 0, 0);

  virtual void SetPhysicalSystem (CS::Physics::iPhysicalSystem* system) = 0;

  virtual CS::Physics::iPhysicalSystem* GetPhysicalSystem () const = 0;

  virtual void SetPhysicalSector (CS::Physics::iPhysicalSector* sector) = 0;

  virtual CS::Physics::iPhysicalSector* GetPhysicalSector () const = 0;

  virtual void SetBodyChainState (iBodyChain* chain, RagdollState state) = 0;

  virtual RagdollState GetBodyChainState (iBodyChain* chain) const = 0;

  virtual CS::Physics::iRigidBody* GetBoneRigidBody (BoneID bone) = 0;

  virtual CS::Physics::iJoint* GetBoneJoint (const BoneID bone) = 0;

  virtual uint GetBoneCount (RagdollState state) const = 0;

  virtual BoneID GetBone (RagdollState state, uint index) const = 0;

  virtual void ResetChainTransform (iBodyChain* chain) = 0;

  virtual BoneID GetRigidBodyBone (CS::Physics::iRigidBody* body) const = 0;
};

} // namespace Animation
} // namespace CS

#endif //__CS_IMESH_ANIMNODE_RAGDOLL_H__

---