# CollisionHandlerEvent

from pandac.PandaModules import CollisionHandlerEvent

Class : CollisionHandlerEvent
Description : A specialized kind of CollisionHandler that throws an event for each collision detected. The event thrown may be based on the name of the moving object or the struck object, or both. The first parameter of the event will be a pointer to the CollisionEntry that triggered it.

## Inheritance:

CollisionHandlerEvent: CollisionHandler
CollisionHandler: TypedReferenceCount
TypedReferenceCount: TypedObject ReferenceCount
TypedObject:
ReferenceCount:

## Methods of CollisionHandlerEvent:

addAgainPattern
addInPattern
addOutPattern
clear
clearAgainPatterns
clearInPatterns
clearOutPatterns
getAgainPattern
getClassType
getInPattern
getNumAgainPatterns
getNumInPatterns
getNumOutPatterns
getOutPattern
setAgainPattern
setInPattern
setOutPattern

## Methods of CollisionHandler:

getClassType

## Methods of TypedReferenceCount:

getClassType

## Methods of TypedObject:

getClassType
getType
getTypeIndex
isExactType
isOfType

## Methods of ReferenceCount:

getClassType
getRefCount
ref
testRefCountIntegrity
testRefCountNonzero
unref

addAgainPattern void CollisionHandlerEvent::add_again_pattern(string const &again_pattern); Description: Adds 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.

addInPattern void CollisionHandlerEvent::add_in_pattern(string const &in_pattern); Description: Adds a pattern string to the list of events that will be generated in response to a collision. The pattern string describes how the event name will be composed. It 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 %fs - 't' if "from" is tangible, 'i' if intangible %is - 't' if "into" is tangible, 'i' if intangible %ig - 'c' if the collision is into a CollisionNode, 'g' if it is a geom. %(tag)fh - generate event only if "from" node has the indicated net tag. %(tag)fx - generate event only if "from" node does not have the indicated net tag. %(tag)ih - generate event only if "into" node has the indicated net tag. %(tag)ix - generate event only if "into" node does not have the indicated net tag. %(tag)ft - the indicated net tag value of the "from" node. %(tag)it - the indicated net tag value of the "into" node. Parentheses in the above are literal and should be included in the actual pattern. 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.

addOutPattern void CollisionHandlerEvent::add_out_pattern(string const &out_pattern); Description: Adds 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.

clear void CollisionHandlerEvent::clear(void); Description: 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 add_again_pattern(), which can be used to set the event that is thrown when a collision is detected for two or more consecutive frames.

clearAgainPatterns void CollisionHandlerEvent::clear_again_patterns(void); Description: Removes all of the previously-added in patterns. See add_again_pattern.

clearInPatterns void CollisionHandlerEvent::clear_in_patterns(void); Description: Removes all of the previously-added in patterns. See add_in_pattern.

clearOutPatterns void CollisionHandlerEvent::clear_out_patterns(void); Description: Removes all of the previously-added in patterns. See add_out_pattern.

getAgainPattern string CollisionHandlerEvent::get_again_pattern(int n) const; Description: Returns the nth pattern string that indicates how the event names are generated for each collision detected. See add_again_pattern().

getClassType static TypeHandle CollisionHandlerEvent::get_class_type(void); Undocumented function.

getInPattern string CollisionHandlerEvent::get_in_pattern(int n) const; Description: Returns the nth pattern string that indicates how the event names are generated for each collision detected. See add_in_pattern().

getNumAgainPatterns int CollisionHandlerEvent::get_num_again_patterns(void) const; Description: Returns the number of in pattern strings that have been added.

getNumInPatterns int CollisionHandlerEvent::get_num_in_patterns(void) const; Description: Returns the number of in pattern strings that have been added.

getNumOutPatterns int CollisionHandlerEvent::get_num_out_patterns(void) const; Description: Returns the number of in pattern strings that have been added.

getOutPattern string CollisionHandlerEvent::get_out_pattern(int n) const; Description: Returns the nth pattern string that indicates how the event names are generated for each collision detected. See add_out_pattern().

setAgainPattern void CollisionHandlerEvent::set_again_pattern(string const &again_pattern); Description: This method is deprecated; it completely replaces all the in patterns that have previously been set with the indicated pattern.

setInPattern void CollisionHandlerEvent::set_in_pattern(string const &in_pattern); Description: This method is deprecated; it completely replaces all the in patterns that have previously been set with the indicated pattern.

setOutPattern void CollisionHandlerEvent::set_out_pattern(string const &out_pattern); Description: This method is deprecated; it completely replaces all the in patterns that have previously been set with the indicated pattern.

getClassType static TypeHandle CollisionHandler::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedReferenceCount::get_class_type(void); Undocumented function.

getClassType static TypeHandle TypedObject::get_class_type(void); Undocumented function.

getType virtual TypeHandle TypedObject::get_type(void) const = 0; Derived classes should override this function to return get_class_type().

getTypeIndex int TypedObject::get_type_index(void) const; Description: 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().

isExactType bool TypedObject::is_exact_type(TypeHandle handle) const; Description: Returns true if the current object is the indicated type exactly.

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

getClassType static TypeHandle ReferenceCount::get_class_type(void); Undocumented function.

getRefCount int ReferenceCount::get_ref_count(void) const; Description: Returns the current reference count.

ref void ReferenceCount::ref(void) const; Description: 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.

testRefCountIntegrity bool ReferenceCount::test_ref_count_integrity(void) const; Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero bool ReferenceCount::test_ref_count_nonzero(void) const; Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref bool ReferenceCount::unref(void) const; Description: 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 true if the new reference count is nonzero, false if it is zero.