Drag[en]gine Game Engine  1.0
deColliderCollisionTest Class Reference

Collider collision test. More...

#include <deColliderCollisionTest.h>

Inheritance diagram for deColliderCollisionTest:
deObject

Public Member Functions

Constructors and Destructors
 deColliderCollisionTest ()
 Create collider collision test. More...
 
 deColliderCollisionTest (const deColliderCollisionTest &collisionTester)
 Create copy of a collider collision test. More...
 
virtual ~deColliderCollisionTest ()
 Clean up collider collision test. More...
 
Management
deTouchSensorGetTouchSensor () const
 Touch sensor to use for testing or NULL to use the parent collider world. More...
 
void SetTouchSensor (deTouchSensor *touchSensor)
 Set touch sensor to use for testing or NULL to use the parent collider world. More...
 
int GetTouchSensorShape () const
 Touch sensor shape to use for testing. More...
 
void SetTouchSensorShape (int shape)
 Set touch sensor shape to use for testing. More...
 
deColliderGetCollider () const
 Collider or NULL to test using a ray. More...
 
void SetCollider (deCollider *collider)
 Set collider or NULL to test using a ray. More...
 
const decCollisionFilterGetCollisionFilter () const
 Collision filter. More...
 
void SetCollisionFilter (const decCollisionFilter &filter)
 Set collision filter. More...
 
deComponentGetComponent () const
 Component to use to retrieve bone position from or NULL if not used. More...
 
void SetComponent (deComponent *component)
 Set component to use to retrieve bone position from or NULL if not used. More...
 
const decStringGetBone () const
 Bone to apply origin to for testing or empty string to use parent collider position. More...
 
void SetBone (const char *name)
 Set bone to apply origin to for testing or empty string to use parent collider position. More...
 
const decVectorGetOrigin () const
 Cast origin. More...
 
void SetOrigin (const decVector &origin)
 Set cast origin. More...
 
const decVectorGetDirection () const
 Cast direction. More...
 
void SetDirection (const decVector &direction)
 Set cast direction. More...
 
bool GetLocalDirection () const
 Local direction. More...
 
void SetLocalDirection (bool localDirection)
 Set if direction is local. More...
 
bool GetEnabled () const
 Collision test is enabled. More...
 
void SetEnabled (bool enabled)
 Set if collision test is enabled. More...
 
deCollisionInfoGetCollisionInfo () const
 Collision info or NULL if no collision has been found. More...
 
void SetCollisionInfo (deCollisionInfo *collisionInfo)
 Set collision info or NULL if no collision has been found. More...
 
const decDVectorGetTestOrigin () const
 Test origin used by physics module. More...
 
void SetTestOrigin (const decDVector &testOrigin)
 Set test origin used by physics module. More...
 
const decDVectorGetTestDirection () const
 Test direction used by physics module. More...
 
void SetTestDirection (const decDVector &testDirection)
 Set test direction used by physics module. More...
 
bool GetHasCollision () const
 Collision has been found. More...
 
void SetHasCollision (bool hasCollision)
 Set if collision has been found. More...
 
Operator
deColliderCollisionTestoperator= (const deColliderCollisionTest &collisionTest)
 Copy a collider collision test to this collider collision test. More...
 
- Public Member Functions inherited from deObject
 deObject ()
 
virtual ~deObject ()
 
int GetRefCount () const
 
void AddReference ()
 
void FreeReference ()
 

Detailed Description

Collider collision test.

The collision information instance is created by the constructor. It is not changed for the lifetime of the object. See GetHasCollision() to determine if the collision information object contains valid collision information.

If ray testing is used (collider is NULL) all CanHitCollider calls are send to the parent collider CanHitCollider call.

The parent collider is ignored during collision tests. It is therefore not required to explicitly exclude it from CanHitCollider call.

Author
Pl├╝ss Roland
Version
1.0
Date
2015

Constructor & Destructor Documentation

deColliderCollisionTest::deColliderCollisionTest ( )

Create collider collision test.

deColliderCollisionTest::deColliderCollisionTest ( const deColliderCollisionTest collisionTester)

Create copy of a collider collision test.

virtual deColliderCollisionTest::~deColliderCollisionTest ( )
virtual

Clean up collider collision test.

Member Function Documentation

const decString& deColliderCollisionTest::GetBone ( ) const
inline

Bone to apply origin to for testing or empty string to use parent collider position.

References SetBone().

deCollider* deColliderCollisionTest::GetCollider ( ) const
inline

Collider or NULL to test using a ray.

References SetCollider().

const decCollisionFilter& deColliderCollisionTest::GetCollisionFilter ( ) const
inline

Collision filter.

References SetCollisionFilter().

deCollisionInfo* deColliderCollisionTest::GetCollisionInfo ( ) const
inline

Collision info or NULL if no collision has been found.

References SetCollisionInfo().

deComponent* deColliderCollisionTest::GetComponent ( ) const
inline

Component to use to retrieve bone position from or NULL if not used.

References SetComponent().

const decVector& deColliderCollisionTest::GetDirection ( ) const
inline

Cast direction.

References SetDirection().

bool deColliderCollisionTest::GetEnabled ( ) const
inline

Collision test is enabled.

References SetEnabled().

bool deColliderCollisionTest::GetHasCollision ( ) const
inline

Collision has been found.

References operator=(), and SetHasCollision().

bool deColliderCollisionTest::GetLocalDirection ( ) const
inline

Local direction.

References SetLocalDirection().

const decVector& deColliderCollisionTest::GetOrigin ( ) const
inline

Cast origin.

References SetOrigin().

const decDVector& deColliderCollisionTest::GetTestDirection ( ) const
inline

Test direction used by physics module.

References SetTestDirection().

const decDVector& deColliderCollisionTest::GetTestOrigin ( ) const
inline

Test origin used by physics module.

References SetTestOrigin().

deTouchSensor* deColliderCollisionTest::GetTouchSensor ( ) const
inline

Touch sensor to use for testing or NULL to use the parent collider world.

References SetTouchSensor().

int deColliderCollisionTest::GetTouchSensorShape ( ) const
inline

Touch sensor shape to use for testing.

References SetTouchSensorShape().

deColliderCollisionTest& deColliderCollisionTest::operator= ( const deColliderCollisionTest collisionTest)

Copy a collider collision test to this collider collision test.

Referenced by GetHasCollision().

void deColliderCollisionTest::SetBone ( const char *  name)

Set bone to apply origin to for testing or empty string to use parent collider position.

Referenced by GetBone().

void deColliderCollisionTest::SetCollider ( deCollider collider)

Set collider or NULL to test using a ray.

Referenced by GetCollider().

void deColliderCollisionTest::SetCollisionFilter ( const decCollisionFilter filter)

Set collision filter.

Referenced by GetCollisionFilter().

void deColliderCollisionTest::SetCollisionInfo ( deCollisionInfo collisionInfo)

Set collision info or NULL if no collision has been found.

Referenced by GetCollisionInfo().

void deColliderCollisionTest::SetComponent ( deComponent component)

Set component to use to retrieve bone position from or NULL if not used.

Referenced by GetComponent().

void deColliderCollisionTest::SetDirection ( const decVector direction)

Set cast direction.

Referenced by GetDirection().

void deColliderCollisionTest::SetEnabled ( bool  enabled)

Set if collision test is enabled.

Referenced by GetEnabled().

void deColliderCollisionTest::SetHasCollision ( bool  hasCollision)

Set if collision has been found.

Referenced by GetHasCollision().

void deColliderCollisionTest::SetLocalDirection ( bool  localDirection)

Set if direction is local.

Referenced by GetLocalDirection().

void deColliderCollisionTest::SetOrigin ( const decVector origin)

Set cast origin.

Referenced by GetOrigin().

void deColliderCollisionTest::SetTestDirection ( const decDVector testDirection)

Set test direction used by physics module.

Referenced by GetTestDirection().

void deColliderCollisionTest::SetTestOrigin ( const decDVector testOrigin)

Set test origin used by physics module.

Referenced by GetTestOrigin().

void deColliderCollisionTest::SetTouchSensor ( deTouchSensor touchSensor)

Set touch sensor to use for testing or NULL to use the parent collider world.

Referenced by GetTouchSensor().

void deColliderCollisionTest::SetTouchSensorShape ( int  shape)

Set touch sensor shape to use for testing.

Referenced by GetTouchSensorShape().


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