CrystalSpace

Public API Reference

CS::Collisions::iCollider Struct Reference

A base interface for colliders. More...

#include <ivaria/colliders.h>

Inheritance diagram for CS::Collisions::iCollider:

List of all members.

Public Member Functions

virtual void AddChild (iCollider *collider, const csOrthoTransform &transform=csOrthoTransform())=0
 Add a child collider, with a fixed relative transform regarding this collider.
virtual iColliderGetChild (size_t index)=0
 Get the collider with the given index.
virtual size_t GetChildrenCount () const =0
 Get the count of child colliders in this collider.
virtual const csOrthoTransformGetChildTransform (size_t index) const =0
 Get the relative transform of the collider with the given index.
virtual ColliderType GetColliderType () const =0
 Get the type of this collider.
virtual csVector3 GetLocalScale () const =0
 Get the scale along the X/Y/Z axes.
virtual float GetVolume () const =0
 Get the volume of this collider.
virtual bool IsDynamic () const =0
 Whether this collider (and all its children) can potentially be animated dynamically by the physical simulation.
virtual void RemoveChild (size_t index)=0
 Remove the child collider with the given index from this collider.
virtual void RemoveChild (iCollider *collider)=0
 Remove the given child collider from this collider.
virtual void SetChildTransform (size_t index, const csOrthoTransform &transform)=0
 Set the relative transform of the collider with the given index.
virtual void SetLocalScale (const csVector3 &scale)=0
 Set the scale of the collider shape on X/Y/Z axis.

Detailed Description

A base interface for colliders.

Other colliders will be derived from this one.

Definition at line 84 of file colliders.h.


Member Function Documentation

virtual void CS::Collisions::iCollider::AddChild ( iCollider collider,
const csOrthoTransform transform = csOrthoTransform() 
) [pure virtual]

Add a child collider, with a fixed relative transform regarding this collider.

virtual iCollider* CS::Collisions::iCollider::GetChild ( size_t  index  )  [pure virtual]

Get the collider with the given index.

virtual size_t CS::Collisions::iCollider::GetChildrenCount (  )  const [pure virtual]

Get the count of child colliders in this collider.

virtual const csOrthoTransform& CS::Collisions::iCollider::GetChildTransform ( size_t  index  )  const [pure virtual]

Get the relative transform of the collider with the given index.

virtual ColliderType CS::Collisions::iCollider::GetColliderType (  )  const [pure virtual]

Get the type of this collider.

virtual csVector3 CS::Collisions::iCollider::GetLocalScale (  )  const [pure virtual]

Get the scale along the X/Y/Z axes.

virtual float CS::Collisions::iCollider::GetVolume (  )  const [pure virtual]

Get the volume of this collider.

virtual bool CS::Collisions::iCollider::IsDynamic (  )  const [pure virtual]

Whether this collider (and all its children) can potentially be animated dynamically by the physical simulation.

All colliders are potentially dynamic, excepted the concave and scaled concave meshes, the planes, and the terrains.

virtual void CS::Collisions::iCollider::RemoveChild ( size_t  index  )  [pure virtual]

Remove the child collider with the given index from this collider.

virtual void CS::Collisions::iCollider::RemoveChild ( iCollider collider  )  [pure virtual]

Remove the given child collider from this collider.

virtual void CS::Collisions::iCollider::SetChildTransform ( size_t  index,
const csOrthoTransform transform 
) [pure virtual]

Set the relative transform of the collider with the given index.

virtual void CS::Collisions::iCollider::SetLocalScale ( const csVector3 scale  )  [pure virtual]

Set the scale of the collider shape on X/Y/Z axis.


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

Generated for Crystal Space 2.1 by doxygen 1.6.1