Panda3D
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends

CollisionHandler Class Reference

The abstract interface to a number of classes that decide what to do when a collision is detected. More...

#include "collisionHandler.h"

Inheritance diagram for CollisionHandler:
TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase CollisionHandlerEvent CollisionHandlerQueue CollisionHandlerHighestEvent CollisionHandlerPhysical CollisionHandlerFloor CollisionHandlerGravity CollisionHandlerPusher CollisionHandlerFluidPusher PhysicsCollisionHandler

List of all members.

Public Member Functions

virtual void add_entry (CollisionEntry *entry)
 Called between a begin_group() .
virtual void begin_group ()
 Will be called by the CollisionTraverser before a new traversal is begun.
virtual bool end_group ()
 Called by the CollisionTraverser at the completion of all collision detections for this traversal.
virtual TypeHandle force_init_type ()
virtual TypeHandle get_type () const
void set_root (const NodePath &root)
 Sets the root of the collision traversal.
bool wants_all_potential_collidees () const
 Returns true if handler wants to know about all solids that are within the collider's bounding volume.

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96.

Protected Attributes

const NodePath_root
bool _wants_all_potential_collidees

Friends

class CollisionTraverser

Detailed Description

The abstract interface to a number of classes that decide what to do when a collision is detected.

One of these must be assigned to the CollisionTraverser that is processing collisions in order to specify how to dispatch detected collisions.

Definition at line 33 of file collisionHandler.h.


Member Function Documentation

void CollisionHandler::add_entry ( CollisionEntry entry) [virtual]

Called between a begin_group() .

. end_group() sequence for each collision that is detected.

Reimplemented in CollisionHandlerEvent, CollisionHandlerFluidPusher, CollisionHandlerHighestEvent, CollisionHandlerPhysical, and CollisionHandlerQueue.

Definition at line 48 of file collisionHandler.cxx.

void CollisionHandler::begin_group ( ) [virtual]

Will be called by the CollisionTraverser before a new traversal is begun.

It instructs the handler to reset itself in preparation for a number of CollisionEntries to be sent.

Reimplemented in CollisionHandlerEvent, CollisionHandlerHighestEvent, CollisionHandlerPhysical, and CollisionHandlerQueue.

Definition at line 38 of file collisionHandler.cxx.

bool CollisionHandler::end_group ( ) [virtual]

Called by the CollisionTraverser at the completion of all collision detections for this traversal.

It should do whatever finalization is required for the handler.

The return value is normally true, but if this returns value, the CollisionTraverser will remove the handler from its list, allowing the CollisionHandler itself to determine when it is no longer needed.

Reimplemented in CollisionHandlerEvent, CollisionHandlerHighestEvent, and CollisionHandlerPhysical.

Definition at line 65 of file collisionHandler.cxx.

static void CollisionHandler::init_type ( ) [inline, static]

This function is declared non-inline to work around a compiler bug in g++ 2.96.

Making it inline seems to cause problems in the optimizer.

Reimplemented from TypedReferenceCount.

Reimplemented in CollisionHandlerEvent, CollisionHandlerFloor, CollisionHandlerFluidPusher, CollisionHandlerGravity, CollisionHandlerHighestEvent, CollisionHandlerPhysical, CollisionHandlerPusher, CollisionHandlerQueue, and PhysicsCollisionHandler.

Definition at line 50 of file collisionHandler.h.

References TypedReferenceCount::init_type().

Referenced by CollisionHandlerQueue::init_type(), CollisionHandlerHighestEvent::init_type(), and CollisionHandlerEvent::init_type().

void CollisionHandler::set_root ( const NodePath root) [inline]

Sets the root of the collision traversal.

Only set if wants_all_potential_collidees is true

Definition at line 34 of file collisionHandler.I.

bool CollisionHandler::wants_all_potential_collidees ( ) const [inline]

Returns true if handler wants to know about all solids that are within the collider's bounding volume.

Definition at line 23 of file collisionHandler.I.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations