Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CollisionHandlerFloor Class Reference

A specialized kind of CollisionHandler that sets the Z height of the collider to a fixed linear offset from the highest detected collision point each frame. More...

#include "collisionHandlerFloor.h"

Inheritance diagram for CollisionHandlerFloor:
CollisionHandlerPhysical CollisionHandlerEvent CollisionHandler TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase

Public Member Functions

virtual TypeHandle force_init_type ()
 
PN_stdfloat get_max_velocity () const
 
PN_stdfloat get_offset () const
 
PN_stdfloat get_reach () const
 
virtual TypeHandle get_type () const
 
void set_max_velocity (PN_stdfloat max_vel)
 
void set_offset (PN_stdfloat offset)
 
void set_reach (PN_stdfloat reach)
 
- Public Member Functions inherited from CollisionHandlerPhysical
void add_collider (const NodePath &collider, const NodePath &target)
 Adds a new collider to the list with a NodePath that will be updated with the collider's new position, or updates the existing collider with a new NodePath object. More...
 
void add_collider (const NodePath &collider, const NodePath &target, DriveInterface *drive_interface)
 Adds a new collider to the list with a NodePath that will be updated with the collider's new position, or updates the existing collider with a new NodePath object. More...
 
virtual void add_entry (CollisionEntry *entry)
 Called between a begin_group() . More...
 
virtual void begin_group ()
 Will be called by the CollisionTraverser before a new traversal is begun. More...
 
void clear_center ()
 
void clear_colliders ()
 Completely empties the list of colliders this handler knows about. More...
 
virtual bool end_group ()
 Called by the CollisionTraverser at the completion of all collision detections for this traversal. More...
 
const NodePathget_center () const
 
bool has_center () const
 
bool has_collider (const NodePath &collider) const
 Returns true if the handler knows about the indicated collider, false otherwise. More...
 
bool has_contact () const
 Did the handler make any contacts with anything on the last collision pass? Depending on how your world is setup, this can be used to tell if the handler is out of the world (i.e. More...
 
bool remove_collider (const NodePath &collider)
 Removes the collider from the list of colliders that this handler knows about. More...
 
void set_center (const NodePath &center)
 
- Public Member Functions inherited from CollisionHandlerEvent
 CollisionHandlerEvent ()
 The default CollisionHandlerEvent will throw no events. More...
 
void add_again_pattern (const std::string &again_pattern)
 Adds the pattern string that indicates how the event names are generated when a collision between two particular nodes is *still* detected. More...
 
void add_in_pattern (const std::string &in_pattern)
 Adds a pattern string to the list of events that will be generated in response to a collision. More...
 
void add_out_pattern (const std::string &out_pattern)
 Adds the pattern string that indicates how the event names are generated when a collision between two particular nodes is *no longer* detected. More...
 
void clear ()
 Empties the list of elements that all colliders are known to be colliding with. More...
 
void clear_again_patterns ()
 Removes all of the previously-added in patterns. More...
 
void clear_in_patterns ()
 Removes all of the previously-added in patterns. More...
 
void clear_out_patterns ()
 Removes all of the previously-added in patterns. More...
 
void flush ()
 Same as clear() except "out" events are thrown. More...
 
std::string get_again_pattern (int n) const
 
std::string get_in_pattern (int n) const
 
int get_num_again_patterns () const
 
int get_num_in_patterns () const
 
int get_num_out_patterns () const
 
std::string get_out_pattern (int n) const
 
void set_again_pattern (const std::string &again_pattern)
 This method is deprecated; it completely replaces all the in patterns that have previously been set with the indicated pattern. More...
 
void set_in_pattern (const std::string &in_pattern)
 This method is deprecated; it completely replaces all the in patterns that have previously been set with the indicated pattern. More...
 
void set_out_pattern (const std::string &out_pattern)
 This method is deprecated; it completely replaces all the in patterns that have previously been set with the indicated pattern. More...
 
- Public Member Functions inherited from CollisionHandler
void set_root (const NodePath &root)
 Sets the root of the collision traversal. More...
 
bool wants_all_potential_collidees () const
 Returns true if handler wants to know about all solids that are within the collider's bounding volume. More...
 
- Public Member Functions inherited from TypedReferenceCount
 TypedReferenceCount (const TypedReferenceCount &copy)
 
void operator= (const TypedReferenceCount &copy)
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 

Static Public Member Functions

static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from CollisionHandlerPhysical
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from CollisionHandlerEvent
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from CollisionHandler
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
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. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

 get_max_velocity
 Retrieves the maximum speed at which the object will be allowed to descend towards a floor below it, in units per second. More...
 
 get_offset
 Returns the linear offset to add to (or subtract from) the highest detected collision point to determine the actual height at which to set the collider. More...
 
 get_reach
 Returns the reach to add to (or subtract from) the highest collision point. More...
 
 set_max_velocity
 Sets the maximum speed at which the object will be allowed to descend towards a floor below it, in units per second. More...
 
 set_offset
 Sets the linear offset to add to (or subtract from) the highest detected collision point to determine the actual height at which to set the collider. More...
 
 set_reach
 Sets the reach to add to (or subtract from) the highest collision point. More...
 
- Public Attributes inherited from CollisionHandlerPhysical
 clear_center
 Clears the center NodePath specified with set_center. More...
 
 get_center
 Returns the NodePath specified with set_center, or the empty NodePath if nothing has been specified. More...
 
 has_center
 Returns true if a NodePath has been specified with set_center(), false otherwise. More...
 
 set_center
 Specifies an arbitrary NodePath that the handler is always considered to be facing. More...
 
- Public Attributes inherited from CollisionHandlerEvent
 get_again_pattern
 Returns the nth pattern string that indicates how the event names are generated for each collision detected. More...
 
 get_in_pattern
 Returns the nth pattern string that indicates how the event names are generated for each collision detected. More...
 
 get_num_again_patterns
 Returns the number of in pattern strings that have been added. More...
 
 get_num_in_patterns
 Returns the number of in pattern strings that have been added. More...
 
 get_num_out_patterns
 Returns the number of in pattern strings that have been added. More...
 
 get_out_pattern
 Returns the nth pattern string that indicates how the event names are generated for each collision detected. More...
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 

Detailed Description

A specialized kind of CollisionHandler that sets the Z height of the collider to a fixed linear offset from the highest detected collision point each frame.

It's intended to implement walking around on a floor of varying height by casting a ray down from the avatar's head.

Definition at line 27 of file collisionHandlerFloor.h.

Member Data Documentation

◆ get_max_velocity

PN_stdfloat CollisionHandlerFloor::get_max_velocity
inline

Retrieves the maximum speed at which the object will be allowed to descend towards a floor below it, in units per second.

See set_max_velocity().

Definition at line 44 of file collisionHandlerFloor.h.

◆ get_offset

PN_stdfloat CollisionHandlerFloor::get_offset
inline

Returns the linear offset to add to (or subtract from) the highest detected collision point to determine the actual height at which to set the collider.

Definition at line 42 of file collisionHandlerFloor.h.

◆ get_reach

PN_stdfloat CollisionHandlerFloor::get_reach
inline

Returns the reach to add to (or subtract from) the highest collision point.

Definition at line 43 of file collisionHandlerFloor.h.

◆ set_max_velocity

void CollisionHandlerFloor::set_max_velocity
inline

Sets the maximum speed at which the object will be allowed to descend towards a floor below it, in units per second.

Set this to zero to allow it to instantly teleport any distance.

Definition at line 44 of file collisionHandlerFloor.h.

◆ set_offset

void CollisionHandlerFloor::set_offset
inline

Sets the linear offset to add to (or subtract from) the highest detected collision point to determine the actual height at which to set the collider.

Definition at line 42 of file collisionHandlerFloor.h.

◆ set_reach

void CollisionHandlerFloor::set_reach
inline

Sets the reach to add to (or subtract from) the highest collision point.

Definition at line 43 of file collisionHandlerFloor.h.


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