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 "collisionHandlerGravity.h"

Inheritance diagram for CollisionHandlerGravity:

Public Member Functions
void	add_velocity (PN_stdfloat velocity)
	Adds the sepcified amount to the current velocity. More...

virtual TypeHandle	force_init_type ()

PN_stdfloat	get_airborne_height () const

const LVector3 &	get_contact_normal () const

PN_stdfloat	get_gravity () const

PN_stdfloat	get_impact_velocity () const

bool	get_legacy_mode () const
	returns true if legacy mode is enabled More...

PN_stdfloat	get_max_velocity () const

PN_stdfloat	get_offset () const

PN_stdfloat	get_reach () const

virtual TypeHandle	get_type () const

PN_stdfloat	get_velocity () const

bool	is_on_ground () const

void	set_gravity (PN_stdfloat gravity)

void	set_legacy_mode (bool legacy_mode)
	Enables old behavior required by Toontown (Sellbot Factory lava room is good test case, lava and conveyor belt specifically). More...

void	set_max_velocity (PN_stdfloat max_vel)

void	set_offset (PN_stdfloat offset)

void	set_reach (PN_stdfloat reach)

void	set_velocity (PN_stdfloat velocity)

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 NodePath &	get_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

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

const TypedObject *	as_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...

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_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...

WeakReferenceList *	weak_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_airborne_height
	Return the height of the object from the ground. More...

	get_contact_normal

	get_gravity
	Gets the linear gravity force (always plumb). More...

	get_impact_velocity
	How hard did the object hit the ground. More...

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

	get_velocity
	Gets the current vertical velocity. More...

	is_on_ground
	Is the object at rest? More...

	set_gravity
	Sets the linear gravity force (always plumb). 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...

	set_velocity
	Sets the current vertical velocity. 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 collisionHandlerGravity.h.

Member Function Documentation

◆ add_velocity()

void CollisionHandlerGravity::add_velocity ( PN_stdfloat velocity )

inline

Adds the sepcified amount to the current velocity.

This is mostly here allow this common operation to be faster for scripting, but it's also more concise even in cpp.

Definition at line 99 of file collisionHandlerGravity.I.

◆ get_legacy_mode()

bool CollisionHandlerGravity::get_legacy_mode ( ) const

inline

returns true if legacy mode is enabled

Definition at line 176 of file collisionHandlerGravity.I.

◆ set_legacy_mode()

void CollisionHandlerGravity::set_legacy_mode ( bool legacy_mode )

inline

Enables old behavior required by Toontown (Sellbot Factory lava room is good test case, lava and conveyor belt specifically).

Behavior is to throw enter/exit events only for floor that the toon is in contact with

Definition at line 168 of file collisionHandlerGravity.I.

Member Data Documentation

◆ get_airborne_height

PN_stdfloat CollisionHandlerGravity::get_airborne_height

inline

Return the height of the object from the ground.

The object might not necessarily be at rest. Use is_on_ground() if you want to know whether the object is on the ground and at rest.

◆ get_gravity

PN_stdfloat CollisionHandlerGravity::get_gravity

inline

Gets the linear gravity force (always plumb).

Definition at line 64 of file collisionHandlerGravity.h.

◆ get_impact_velocity

PN_stdfloat CollisionHandlerGravity::get_impact_velocity

inline

How hard did the object hit the ground.

This value is set on impact with the ground. You may want to watch (poll) on is_on_groun() and when that is true, call get_impact_velocity(). Normally I avoid polling, but we are calling is_on_ground() frequently anyway.

Definition at line 61 of file collisionHandlerGravity.h.

◆ get_max_velocity

PN_stdfloat CollisionHandlerGravity::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 65 of file collisionHandlerGravity.h.

◆ get_offset

PN_stdfloat CollisionHandlerGravity::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 57 of file collisionHandlerGravity.h.

◆ get_reach

PN_stdfloat CollisionHandlerGravity::get_reach

inline

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

Definition at line 58 of file collisionHandlerGravity.h.

◆ get_velocity

PN_stdfloat CollisionHandlerGravity::get_velocity

inline

Gets the current vertical velocity.

Generally, negative values mean the object is in free fall; while postive values mean the object has vertical thrust.

A zero value does not necessarily mean the object on the ground, it may also be weightless and/or at the apex of its jump.

See Also: is_on_ground() and get_gravity()

Definition at line 63 of file collisionHandlerGravity.h.

◆ is_on_ground

bool CollisionHandlerGravity::is_on_ground

inline

Is the object at rest?

Definition at line 60 of file collisionHandlerGravity.h.

◆ set_gravity

void CollisionHandlerGravity::set_gravity

inline

Sets the linear gravity force (always plumb).

Definition at line 64 of file collisionHandlerGravity.h.

◆ set_max_velocity

void CollisionHandlerGravity::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 65 of file collisionHandlerGravity.h.

◆ set_offset

void CollisionHandlerGravity::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 57 of file collisionHandlerGravity.h.

◆ set_reach

void CollisionHandlerGravity::set_reach

inline

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

Definition at line 58 of file collisionHandlerGravity.h.

◆ set_velocity

void CollisionHandlerGravity::set_velocity

inline

Sets the current vertical velocity.

Definition at line 63 of file collisionHandlerGravity.h.

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

panda/src/collide/collisionHandlerGravity.h
panda/src/collide/collisionHandlerGravity.cxx
panda/src/collide/collisionHandlerGravity.I

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ add_velocity()

◆ get_legacy_mode()

◆ set_legacy_mode()

Member Data Documentation

◆ get_airborne_height

◆ get_gravity

◆ get_impact_velocity

◆ get_max_velocity

◆ get_offset

◆ get_reach

◆ get_velocity

◆ is_on_ground

◆ set_gravity

◆ set_max_velocity

◆ set_offset

◆ set_reach

◆ set_velocity