Public API Reference

ivaria/colliders.h

Go to the documentation of this file.

/*
    Copyright (C) 2011-2012 Christian Van Brussel, Institute of Information
      and Communication Technologies, Electronics and Applied Mathematics
      at Universite catholique de Louvain, Belgium
      http://www.uclouvain.be/en-icteam.html
    Copyright (C) 2012 by Dominik Seifert
    Copyright (C) 2011 by Liu Lu

    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_IVARIA_COLLIDERS_H__
#define __CS_IVARIA_COLLIDERS_H__

#include "csutil/scf.h"
#include "csutil/csstring.h"
#include "csgeom/vector2.h"
#include "csgeom/vector3.h"
#include "csgeom/matrix3.h"
#include "csgeom/transfrm.h"
#include "csgeom/plane3.h"
#include "iutil/object.h"

struct iCamera;
struct iMeshWrapper;
struct iMovable;
struct iPortal;
struct iSector;
struct iTerrainCell;
struct iTerrainSystem;
struct iTriangleMesh;
struct iView;

namespace CS {
namespace Physics {

struct iPhysicalBody;

}
}

namespace CS {
namespace Collisions {
  
enum ColliderType
{
  COLLIDER_INVALID = 0,            
  COLLIDER_BOX,                    
  COLLIDER_SPHERE,                 
  COLLIDER_CYLINDER,               
  COLLIDER_CAPSULE,                
  COLLIDER_CONE,                   
  COLLIDER_PLANE,                  
  COLLIDER_CONVEX_MESH,            
  COLLIDER_CONCAVE_MESH,           
  COLLIDER_CONCAVE_MESH_SCALED,    
  COLLIDER_TERRAIN_CELL,           
  COLLIDER_COMPOUND                
};

struct iCollider : public virtual iBase
{
  SCF_INTERFACE (CS::Collisions::iCollider, 1, 0, 0);

  virtual ColliderType GetColliderType () const = 0;

  virtual void SetLocalScale (const csVector3& scale) = 0;

  virtual csVector3 GetLocalScale () const = 0;
  
  virtual float GetVolume () const = 0;

  virtual bool IsDynamic () const = 0;

  virtual void AddChild (iCollider* collider,
                         const csOrthoTransform& transform = csOrthoTransform ()) = 0;

  virtual void RemoveChild (iCollider* collider) = 0;

  virtual void RemoveChild (size_t index) = 0;

  virtual size_t GetChildrenCount () const = 0;

  virtual iCollider* GetChild (size_t index) = 0; 

  virtual void SetChildTransform (size_t index, const csOrthoTransform& transform) = 0;

  virtual const csOrthoTransform& GetChildTransform (size_t index) const = 0;
};

struct iColliderBox : public virtual iCollider
{
  SCF_INTERFACE (CS::Collisions::iColliderBox, 1, 0, 0);

  virtual const csVector3& GetBoxGeometry () const = 0;
};

struct iColliderSphere : public virtual iCollider
{
  SCF_INTERFACE (CS::Collisions::iColliderSphere, 1, 0, 0);

  virtual float GetSphereGeometry () const = 0;
};

struct iColliderCylinder : public virtual iCollider
{
  SCF_INTERFACE (CS::Collisions::iColliderCylinder, 1, 0, 0);

  virtual void GetCylinderGeometry (float& length, float& radius) const = 0;
};

struct iColliderCapsule : public virtual iCollider
{
  SCF_INTERFACE (CS::Collisions::iColliderCapsule, 1, 0, 0);

  virtual void GetCapsuleGeometry (float& length, float& radius) const = 0;
};

struct iColliderCone : public virtual iCollider
{
  SCF_INTERFACE (CS::Collisions::iColliderCone, 1, 0, 0);

  virtual void GetConeGeometry (float& length, float& radius) const = 0;
};

struct iColliderPlane : public virtual iCollider
{
  SCF_INTERFACE (CS::Collisions::iColliderPlane, 1, 0, 0);

  virtual const csPlane3& GetPlaneGeometry () const = 0;
};

struct iColliderConvexMesh : public virtual iCollider
{
  SCF_INTERFACE (CS::Collisions::iColliderConvexMesh, 1, 0, 0);

  virtual iTriangleMesh* GetMesh () const = 0;
};

struct iColliderConcaveMesh : public virtual iCollider
{
  SCF_INTERFACE (CS::Collisions::iColliderConcaveMesh, 1, 0, 0);

  virtual iTriangleMesh* GetMesh () const = 0;
};

struct iColliderConcaveMeshScaled : public virtual iCollider
{
  SCF_INTERFACE (CS::Collisions::iColliderConcaveMeshScaled, 1, 0, 0);

  virtual iColliderConcaveMesh* GetCollider () const = 0;

  virtual const csVector3& GetScale () const = 0;
};

struct iColliderTerrain : public virtual iCollider
{
  SCF_INTERFACE (CS::Collisions::iColliderTerrain, 1, 0, 0);

  virtual iTerrainCell* GetCell () const = 0;
};

}
}

#endif

---