Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

CollisionHandler Class Reference

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

#include <collisionHandler.h>

Inheritance diagram for CollisionHandler:

TypedReferenceCount TypedObject ReferenceCount CollisionHandlerEvent CollisionHandlerQueue CollisionHandlerPhysical CollisionHandlerFloor CollisionHandlerPusher List of all members.

Public Member Functions

virtual void begin_group ()
 Will be called by the CollisionTraverser before a new traversal is begun.

virtual void add_entry (CollisionEntry *entry)
 Called between a begin_group() ..

virtual bool end_group ()
 Called by the CollisionTraverser at the completion of all collision detections for this traversal.

virtual TypeHandle get_type () const
virtual TypeHandle force_init_type ()
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type.

bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly.

int get_ref_count () const
 Returns the current reference count.

int ref () const
 Explicitly increments the reference count.

int unref () const
 Explicitly decrements the reference count.

void test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus.


Static Public Member Functions

TypeHandle get_class_type ()
void init_type ()

Static Private Attributes

TypeHandle _type_handle

Friends

class CollisionTraverser

Detailed Description

The abstract interface to a number of classes that decide what to do what 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 46 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, CollisionHandlerPhysical, and CollisionHandlerQueue.

Definition at line 55 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, CollisionHandlerPhysical, and CollisionHandlerQueue.

Definition at line 41 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, and CollisionHandlerPhysical.

Definition at line 83 of file collisionHandler.cxx.

virtual TypeHandle CollisionHandler::force_init_type (  void   )  [inline, virtual]
 

Reimplemented from TypedReferenceCount.

Reimplemented in CollisionHandlerEvent, CollisionHandlerFloor, CollisionHandlerPhysical, CollisionHandlerPusher, and CollisionHandlerQueue.

Definition at line 67 of file collisionHandler.h.

TypeHandle CollisionHandler::get_class_type (  void   )  [inline, static]
 

Reimplemented from TypedReferenceCount.

Reimplemented in CollisionHandlerEvent, CollisionHandlerFloor, CollisionHandlerPhysical, CollisionHandlerPusher, and CollisionHandlerQueue.

Definition at line 54 of file collisionHandler.h.

References TypedReferenceCount::get_class_type().

Referenced by CollisionHandlerQueue::get_class_type(), and CollisionHandlerEvent::get_class_type().

int ReferenceCount::get_ref_count (   )  const [inline, inherited]
 

Returns the current reference count.

Definition at line 183 of file referenceCount.I.

Referenced by RenderState::determine_bin_index(), RenderEffects::determine_show_bounds(), FontPool::ns_garbage_collect(), TexturePool::ns_garbage_collect(), MaterialPool::ns_get_material(), and TexturePool::ns_release_texture().

virtual TypeHandle CollisionHandler::get_type (  void   )  const [inline, virtual]
 

Reimplemented from TypedReferenceCount.

Reimplemented in CollisionHandlerEvent, CollisionHandlerFloor, CollisionHandlerPhysical, CollisionHandlerPusher, and CollisionHandlerQueue.

Definition at line 64 of file collisionHandler.h.

int TypedObject::get_type_index (   )  const [inline, inherited]
 

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

This is equivalent to get_type().get_index().

Definition at line 71 of file typedObject.I.

References TypeHandle::get_name(), TypedObject::get_type(), and INLINE.

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

Reimplemented from TypedReferenceCount.

Reimplemented in CollisionHandlerEvent, CollisionHandlerFloor, CollisionHandlerPhysical, CollisionHandlerPusher, and CollisionHandlerQueue.

Definition at line 59 of file collisionHandler.h.

Referenced by CollisionHandlerQueue::get_class_type(), and CollisionHandlerEvent::get_class_type().

bool TypedObject::is_exact_type (  TypeHandle  handle  )  const [inline, inherited]
 

Returns true if the current object is the indicated type exactly.

Definition at line 101 of file typedObject.I.

Referenced by PT(), and CollisionNode::xform().

bool TypedObject::is_of_type (  TypeHandle  handle  )  const [inline, inherited]
 

Returns true if the current object is or derives from the indicated type.

Definition at line 86 of file typedObject.I.

Referenced by EggMaterialCollection::collapse_equivalent_materials(), EggTextureCollection::collapse_equivalent_textures(), DeferredNodeProperty::compose(), AnimBundleMaker::create_s_channel(), CharacterMaker::create_slider(), ProjectionScreen::cull_callback(), DataNode::define_output(), EggNode::determine_draw_order(), CharacterMaker::egg_to_index(), EggGroupUniquifier::EggGroupUniquifier(), EggPoolUniquifier::EggPoolUniquifier(), EggGroupNode::find_textures(), StaticTextFont::get_glyph(), EggMaterialCollection::insert_materials(), EggTextureCollection::insert_textures(), CharacterJoint::make_copy(), PT(), EggGroupNode::r_flatten_transforms(), EggGroupNode::r_transform_vertices(), EggGroupNode::recompute_polygon_normals(), CollisionLevelState::reserve(), PandaFramework::reset_frame_rate(), PandaFramework::set_texture(), EggGroupNode::steal_children(), and DataGraphTraverser::traverse().

int ReferenceCount::ref (   )  const [inline, inherited]
 

Explicitly increments the reference count.

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is the new reference count.

Definition at line 225 of file referenceCount.I.

Referenced by ClientDevice::ClientDevice(), EggGroupNode::find_textures(), EggGroupNode::r_apply_texmats(), EggGroupNode::r_flatten_transforms(), and EggGroupNode::reverse_vertex_ordering().

void ReferenceCount::test_ref_count_integrity (   )  const [inline, inherited]
 

Does some easy checks to make sure that the reference count isn't completely bogus.

Definition at line 328 of file referenceCount.I.

References INLINE.

Referenced by EggNode::determine_bin(), and ReferenceCount::~ReferenceCount().

int ReferenceCount::unref (   )  const [inline, inherited]
 

Explicitly decrements the reference count.

Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete().

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is the new reference count.

Definition at line 293 of file referenceCount.I.

References INLINE.

Referenced by RenderState::determine_bin_index(), and RenderEffects::determine_show_bounds().

Friends And Related Function Documentation

friend class CollisionTraverser [friend]
 

Definition at line 72 of file collisionHandler.h.

Member Data Documentation

TypeHandle CollisionHandler::_type_handle [static, private]
 

Reimplemented from TypedReferenceCount.

Reimplemented in CollisionHandlerEvent, CollisionHandlerFloor, CollisionHandlerPhysical, CollisionHandlerPusher, and CollisionHandlerQueue.

Definition at line 24 of file collisionHandler.cxx.

The documentation for this class was generated from the following files:
Generated on Fri May 2 00:48:27 2003 for Panda by doxygen1.3