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

CollisionHandlerPhysical Class Reference

The abstract base class for a number of CollisionHandlers that have some physical effect on their moving bodies: they need to update the nodes' positions based on the effects of the collision. More...

#include <collisionHandlerPhysical.h>

Inheritance diagram for CollisionHandlerPhysical:

List of all members.


Public Member Functions
	CollisionHandlerPhysical ()
virtual	~CollisionHandlerPhysical ()
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.
void	add_collider_drive (CollisionNode node, DriveInterface drive_interface)
	Adds a new collider to the list with a DriveInterface pointer that needs to be told about the collider's new position, or updates the existing collider with a new DriveInterface pointer.
void	add_collider_node (CollisionNode node, PandaNode target)
	Adds a new collider to the list with a PandaNode pointer that will be updated with the collider's new position, or updates the existing collider with a new PandaNode pointer.
bool	remove_collider (CollisionNode *node)
	Removes the collider from the list of colliders that this handler knows about.
bool	has_collider (CollisionNode *node) const
	Returns true if the handler knows about the indicated collider, false otherwise.
void	clear_colliders ()
	Completely empties the list of colliders this handler knows about.
virtual TypeHandle	get_type () const
virtual TypeHandle	force_init_type ()
void	set_in_pattern (const string &pattern)
	Sets the pattern string that indicates how the event names are generated for each collision detected.
string	get_in_pattern () const
	Returns the pattern string that indicates how the event names are generated for each collision detected.
void	set_again_pattern (const string &pattern)
	Sets the pattern string that indicates how the event names are generated when a collision between two particular nodes is still* detected.*
string	get_again_pattern () const
	Returns the pattern string that indicates how the event names are generated when a collision between two particular nodes is still* detected.*
void	set_out_pattern (const string &pattern)
	Sets the pattern string that indicates how the event names are generated when a collision between two particular nodes is no longer* detected.*
string	get_out_pattern () const
	Returns the pattern string that indicates how the event names are generated when a collision between two particular nodes is no longer* detected.*
void	clear ()
	Empties the list of elements that all colliders are known to be colliding with.
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 ()
Protected Types
typedef pvector< PointerTo< CollisionEntry > >	Entries
typedef pmap< PointerTo< CollisionNode >, Entries >	FromEntries
typedef pmap< PointerTo< CollisionNode >, ColliderDef >	Colliders
Protected Member Functions
virtual bool	handle_entries ()=0
Protected Attributes
FromEntries	_from_entries
Colliders	_colliders
Static Private Attributes
TypeHandle	_type_handle

Detailed Description

The abstract base class for a number of CollisionHandlers that have some physical effect on their moving bodies: they need to update the nodes' positions based on the effects of the collision.

Definition at line 47 of file collisionHandlerPhysical.h.

Member Typedef Documentation

typedef pmap<PointerTo< CollisionNode >, ColliderDef> CollisionHandlerPhysical::Colliders [protected]

Definition at line 84 of file collisionHandlerPhysical.h.

typedef pvector< PointerTo< CollisionEntry > > CollisionHandlerPhysical::Entries [protected]

Definition at line 67 of file collisionHandlerPhysical.h.

typedef pmap<PointerTo< CollisionNode >, Entries> CollisionHandlerPhysical::FromEntries [protected]

Definition at line 68 of file collisionHandlerPhysical.h.

Constructor & Destructor Documentation

CollisionHandlerPhysical::CollisionHandlerPhysical ( )

Definition at line 87 of file collisionHandlerPhysical.cxx.
References _from_entries, and CollisionHandlerEvent::begin_group().

CollisionHandlerPhysical::~CollisionHandlerPhysical ( ) [virtual]

Definition at line 98 of file collisionHandlerPhysical.cxx.

Member Function Documentation

void CollisionHandlerPhysical::add_collider_drive ( CollisionNode * node,

DriveInterface * drive_interface

)

Adds a new collider to the list with a DriveInterface pointer that needs to be told about the collider's new position, or updates the existing collider with a new DriveInterface pointer.

Definition at line 178 of file collisionHandlerPhysical.cxx.
References _colliders.

void CollisionHandlerPhysical::add_collider_node ( CollisionNode * node,

PandaNode * target

)

Adds a new collider to the list with a PandaNode pointer that will be updated with the collider's new position, or updates the existing collider with a new PandaNode pointer.

Definition at line 197 of file collisionHandlerPhysical.cxx.

void CollisionHandlerPhysical::add_entry ( CollisionEntry * entry ) [virtual]

Called between a begin_group() ..
end_group() sequence for each collision that is detected.
Reimplemented from CollisionHandlerEvent.
Definition at line 132 of file collisionHandlerPhysical.cxx.
References _colliders.

void CollisionHandlerPhysical::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 from CollisionHandlerEvent.
Definition at line 116 of file collisionHandlerPhysical.cxx.
References CollisionHandlerEvent::end_group(), and handle_entries().

void CollisionHandlerEvent::clear ( ) [inherited]

Empties the list of elements that all colliders are known to be colliding with.
No "out" events will be thrown; if the same collision is detected next frame, a new "in" event will be thrown for each collision.
This can be called each frame to defeat the persistent "in" event mechanism, which prevents the same "in" event from being thrown repeatedly. However, also see set_again_pattern(), which can be used to set the event that is thrown when a collision is detected for two or more consecutive frames.
Definition at line 199 of file collisionHandlerEvent.cxx.

void CollisionHandlerPhysical::clear_colliders ( )

Completely empties the list of colliders this handler knows about.

Definition at line 248 of file collisionHandlerPhysical.cxx.

bool CollisionHandlerPhysical::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.
Reimplemented from CollisionHandlerEvent.
Definition at line 157 of file collisionHandlerPhysical.cxx.
References _colliders.

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

Reimplemented from CollisionHandlerEvent.
Reimplemented in CollisionHandlerFloor, and CollisionHandlerPusher.
Definition at line 100 of file collisionHandlerPhysical.h.

string CollisionHandlerEvent::get_again_pattern ( ) const [inline, inherited]

Returns the pattern string that indicates how the event names are generated when a collision between two particular nodes is *still* detected.
See set_again_pattern() and set_in_pattern().
Definition at line 189 of file collisionHandlerEvent.I.

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

Reimplemented from CollisionHandlerEvent.
Reimplemented in CollisionHandlerFloor, and CollisionHandlerPusher.
Definition at line 89 of file collisionHandlerPhysical.h.
Referenced by CollisionHandlerFloor::get_class_type().

string CollisionHandlerEvent::get_in_pattern ( ) const [inline, inherited]

Returns the pattern string that indicates how the event names are generated for each collision detected.
See set_in_pattern().
Definition at line 131 of file collisionHandlerEvent.I.
References CollisionHandlerEvent::_out_pattern, and INLINE.

string CollisionHandlerEvent::get_out_pattern ( ) const [inline, inherited]

Returns the pattern string that indicates how the event names are generated when a collision between two particular nodes is *no longer* detected.
See set_out_pattern() and set_in_pattern().
Definition at line 242 of file collisionHandlerEvent.I.

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 CollisionHandlerPhysical::get_type ( void ) const [inline, virtual]

Reimplemented from CollisionHandlerEvent.
Reimplemented in CollisionHandlerFloor, and CollisionHandlerPusher.
Definition at line 97 of file collisionHandlerPhysical.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.

virtual bool CollisionHandlerPhysical::handle_entries ( ) [protected, pure virtual]

Implemented in CollisionHandlerFloor, and CollisionHandlerPusher.
Referenced by begin_group().

bool CollisionHandlerPhysical::has_collider ( CollisionNode * node ) const

Returns true if the handler knows about the indicated collider, false otherwise.

Definition at line 232 of file collisionHandlerPhysical.cxx.

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

Reimplemented from CollisionHandlerEvent.
Reimplemented in CollisionHandlerFloor, and CollisionHandlerPusher.
Definition at line 92 of file collisionHandlerPhysical.h.
Referenced by CollisionHandlerFloor::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().

bool CollisionHandlerPhysical::remove_collider ( CollisionNode * node )

Removes the collider from the list of colliders that this handler knows about.

Definition at line 212 of file collisionHandlerPhysical.cxx.

void CollisionHandlerEvent::set_again_pattern ( const string & pattern ) [inline, inherited]

Sets the pattern string that indicates how the event names are generated when a collision between two particular nodes is *still* detected.
This event is thrown each consecutive time a collision between two particular nodes is detected, starting with the second time.
In general, the in_pattern event is thrown on the first detection of a collision between two particular nodes. In subsequent passes, as long as a collision between those two nodes continues to be detected each frame, the again_pattern is thrown. The first frame in which the collision is no longer detected, the out_pattern event is thrown.
Definition at line 170 of file collisionHandlerEvent.I.

void CollisionHandlerEvent::set_in_pattern ( const string & pattern ) [inline, inherited]

Sets the pattern string that indicates how the event names are generated for each collision detected.
This is a string that may contain any of the following:
fn - the name of the "from" object's node in - the name of the "into" object's node ft - 't' if "from" is tangible, 'i' if intangible it - 't' if "into" is tangible, 'i' if intangible
The event name will be based on the in_pattern string specified here, with all occurrences of the above strings replaced with the corresponding values.
In general, the in_pattern event is thrown on the first detection of a collision between two particular nodes. In subsequent passes, as long as a collision between those two nodes continues to be detected each frame, the again_pattern is thrown. The first frame in which the collision is no longer detected, the out_pattern event is thrown.
Definition at line 114 of file collisionHandlerEvent.I.

void CollisionHandlerEvent::set_out_pattern ( const string & pattern ) [inline, inherited]

Sets the pattern string that indicates how the event names are generated when a collision between two particular nodes is *no longer* detected.
In general, the in_pattern event is thrown on the first detection of a collision between two particular nodes. In subsequent passes, as long as a collision between those two nodes continues to be detected each frame, the again_pattern is thrown. The first frame in which the collision is no longer detected, the out_pattern event is thrown.
Definition at line 223 of file collisionHandlerEvent.I.

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().