QPlatformerBody provides a ready-to-use foundation for character physics in platformer games. It includes behaviors such as gravity, walking on slopes, and jumping. Additionally, it offers helper methods and properties for further customization. More...

#include <qplatformerbody.h>

Inheritance diagram for QPlatformerBody:

[legend]

Collaboration diagram for QPlatformerBody:

[legend]

Classes
struct	CollisionTestInfo

Public Member Functions
QPlatformerBody *	SetMovingFloorSnapOffset (float value)
	Sets the snap offset for moving floors. More...

float	GetMovingFloorSnapOffset ()
	Gets the snap offset for moving floors. More...

QPlatformerBody *	SetFloorMaxAngle (float value)
	Sets the maximum angle for the floor. More...

float	GetFloorMaxAngle ()
	Gets the maximum angle for the floor. More...

QPlatformerBody *	SetFloorMaxAngleDegree (float value)
	Sets the maximum angle for the floor in degrees. More...

float	GetFloorMaxAngleDegree ()
	Gets the maximum angle for the floor in degrees. More...

bool	GetIsOnFloor ()
	Checks if the body is currently on the floor. More...

bool	GetIsOnCeiling ()
	Checks if the body is currently touching the ceiling. More...

QPlatformerBody *	SetGravity (QVector value)
	Sets the gravity vector. More...

QVector	GetGravity ()
	Gets the gravity vector. More...

QPlatformerBody *	SetGravityMultiplier (float value)
	Sets the gravity multiplier. More...

float	GetGravityMultiplier ()
	Gets the gravity multiplier. More...

QPlatformerBody *	SetWalkSpeed (float value)
	Sets the walking speed of the body. More...

float	GetWalkSpeed ()
	Gets the walking speed of the body. More...

QPlatformerBody *	SetWalkAcelerationRate (float value)
	Sets the walking acceleration rate. More...

float	GetWalkAcelerationRate ()
	Gets the walking acceleration rate. More...

QPlatformerBody *	SetWalkDecelerationRate (float value)
	Sets the walking deceleration rate. More...

float	GetWalkDecelerationRate ()
	Gets the walking deceleration rate. More...

QPlatformerBody *	Walk (int side)
	Moves the body in a specified horizontal direction. More...

QPlatformerBody *	SetControllerHorizontalVelocity (QVector value)
	Sets the horizontal velocity controlled by the character physics. More...

QVector	GetControllerHorizontalVelocity ()
	Gets the horizontal velocity controlled by the character physics. More...

QPlatformerBody *	SetControllerVerticalVelocity (QVector value)
	Sets the vertical velocity controlled by the character physics. More...

QVector	GetControllerVerticalVelocity ()
	Gets the vertical velocity controlled by the character physics. More...

bool	GetIsFalling ()
	Checks if the body is falling. More...

bool	GetIsRising ()
	Checks if the body is rising. More...

QPlatformerBody *	SetJumpDurationFrameCount (int value)
	Sets the duration for a jump in frames. More...

int	GetJumpDurationFrameCount ()
	Gets the duration for a jump in frames. More...

QPlatformerBody *	SetJumpGravityMultiplier (float value)
	Sets the gravity multiplier during a jump. More...

float	GetJumpGravityMultiplier ()
	Gets the gravity multiplier during a jump. More...

QPlatformerBody *	SetJumpFallGravityMultiplier (float value)
	Sets the gravity multiplier for the falling phase of a jump. More...

float	GetJumpFallGravityMultiplier ()
	Gets the gravity multiplier for the falling phase of a jump. More...

QPlatformerBody *	SetMaxJumpCount (int value)
	Sets the maximum number of jumps allowed. More...

int	GetMaxJumpCount ()
	Gets the maximum number of jumps allowed. More...

QPlatformerBody *	Jump (float force, bool unconditional=false)
	Initiates a jump with the specified force. More...

QPlatformerBody *	ReleaseJump ()
	Releases the jump phase. More...

bool	GetIsJumping ()
	Checks if the body is currently jumping. More...

bool	GetIsJumpReleased ()
	Checks if the jump phase has been released. More...

QPlatformerBody *	SetSpecificPlatformLayers (int layersBit)
	Sets specific platform layers bit. This determines which platform layers the platformer physics will apply to, such as sloped surfaces, ceilings, walls, etc. The default value is 0, which disables this functionality. More...

int	GetSpecificPlatformLayers ()
	Gets specific platform layers bit. This determines which platform layers the platformer physics will apply to, such as sloped surfaces, ceilings, walls, etc. The default value is 0, which disables this functionality. More...

QPlatformerBody::CollisionTestInfo	GetPlatformCollisions (QVector testPosition, QVector nearestOnAxis=QVector::Zero())
	Performs a platform collision test. More...

QPlatformerBody::CollisionTestInfo	GetRightWall (float offset)
	Checks for a collision with a wall on the right. More...

QPlatformerBody::CollisionTestInfo	GetLeftWall (float offset)
	Checks for a collision with a wall on the left. More...

QPlatformerBody::CollisionTestInfo	GetFloor (float offset)
	Checks for a collision with the floor. More...

QPlatformerBody::CollisionTestInfo	GetCeiling (float offset)
	Checks for a collision with the ceiling. More...

Public Member Functions inherited from QRigidBody
bool	GetFixedRotationEnabled ()

bool	GetKinematicEnabled ()

bool	GetKinematicCollisionsEnabled ()

QVector	GetForce ()

float	GetAngularForce ()

QRigidBody *	SetFixedRotationEnabled (bool value)

QRigidBody *	SetKinematicEnabled (bool value)

QRigidBody *	SetKinematicCollisionsEnabled (bool value)

QRigidBody *	SetPositionAndCollide (QVector value, bool withPreviousPosition=true)

QRigidBody *	ApplyForce (QVector force, QVector r, bool updateMeshTransforms=true)

QRigidBody *	ApplyImpulse (QVector impulse, QVector r)

QRigidBody *	SetForce (QVector value)

QRigidBody *	AddForce (QVector value)

QRigidBody *	SetAngularForce (float value)

QRigidBody *	AddAngularForce (float value)

virtual void	Update ()

Public Member Functions inherited from QBody
virtual void	OnPreStep ()

virtual void	OnStep ()

virtual bool	OnCollision (CollisionInfo)

BodyTypes	GetBodyType ()

QWorld *	GetWorld ()

QVector	GetPosition ()

QVector	GetPreviousPosition ()

float	GetRotation ()

float	GetRotationDegree ()

float	GetPreviousRotation ()

QAABB	GetAABB () const

float	GetTotalInitialArea ()

float	GetTotalPolygonsInitialArea ()

float	GetTotalArea ()

float	GetTotalPolygonsArea ()

Modes	GetMode ()

float	GetInertia ()

int	GetLayersBit ()

int	GetCollidableLayersBit ()

bool	GetOverlapWithCollidableLayersBit (int layersBit)

bool	GetOverlapWithLayersBit (int layersBit)

bool	GetIsSleeping ()

bool	GetCanSleep ()

SimulationModels	GetSimulationModel ()

float	GetFriction ()

float	GetStaticFriction ()

float	GetAirFriction ()

virtual float	GetMass ()

float	GetRestitution ()

float	GetCircumference ()

bool	GetBodySpecificTimeScaleEnabled ()

float	GetBodySpesificTimeScale ()

bool	GetEnabled ()

float	GetVelocityLimit ()

bool	GetIntegratedVelocitiesEnabled ()

QBody *	SetPosition (QVector value, bool withPreviousPosition=true)

QBody *	AddPosition (QVector value, bool withPreviousPosition=true)

QBody *	SetPreviousPosition (QVector value)

QBody *	AddPreviousPosition (QVector value)

QBody *	SetRotation (float angleRadian, bool withPreviousRotation=true)

QBody *	SetRotationDegree (float degree, bool withPreviousRotation=true)

QBody *	AddRotation (float angleRadian, bool withPreviousRotation=true)

QBody *	SetPreviousRotation (float angleRadian)

QBody *	AddPreviousRotation (float angleRadian)

QBody *	SetLayersBit (int value)

QBody *	SetCollidableLayersBit (int value)

QBody *	SetCanSleep (bool value)

QBody *	SetMode (QBody::Modes bodyMode)

QBody *	SetSimulationModel (SimulationModels model)

QBody *	SetFriction (float value)

QBody *	SetStaticFriction (float value)

QBody *	SetAirFriction (float value)

QBody *	SetMass (float value)

QBody *	SetRestitution (float value)

QBody *	SetBodySpecificTimeScaleEnabled (bool value)

QBody *	SetBodySpecificTimeScale (float value)

QBody *	SetEnabled (bool value)

QBody *	SetIntegratedVelocitiesEnabled (bool value)

QBody *	AddMesh (QMesh *mesh)

QBody *	RemoveMeshAt (int index)

QMesh *	GetMeshAt (int index)

int	GetMeshCount ()

vector< QMesh * > *	GetMeshes ()

QBody *	AddMeshesFromFile (string filePath)

QBody *	WakeUp ()

QBody *	SetVelocityLimit (float value)

Protected Member Functions
virtual void	PostUpdate ()

Protected Member Functions inherited from QBody
void	UpdateAABB ()

void	UpdateMeshTransforms ()

virtual bool	CanGiveCollisionResponseTo (QBody *otherBody)

Protected Attributes
bool	onFloor =false

bool	onCeiling =false

int	platformLayersBit =0

float	maxFloorAngle =M_PI*0.25

float	movingFloorSnapOffset =10.0f

QRigidBody *	lastMovableFloor =nullptr

QVector	gravity =QVector(0,0.3)

float	gravityMultiplier =1.0f

QVector	velocity =QVector::Zero()

QVector	upDirection =QVector::Up()

QVector	rightDirection =QVector::Right()

float	walkSpeed =3.0

QVector	horizontalVelocity =QVector::Zero()

QVector	verticalVelocity =QVector::Zero()

bool	isFalling =false

bool	isRising =false

int	walkSide =0

float	walkAccelerationRate =0.1f

float	walkDecelerationRate =0.1f

bool	prevJumpMode =false

bool	jumpMode =false

float	jumpForce =5.0f

int	maxJumpCount =2

int	currentJumpCount =0

int	jumpDurationFrameCount =30

int	jumpFrameCountDown =0

float	jumpGravityMultiplier =0.4f

float	jumpFallGravityMultiplier =1.0f

bool	jumpReleased =true

Protected Attributes inherited from QRigidBody
float	angularForce =0.0f

QVector	force =QVector::Zero()

Protected Attributes inherited from QBody
QWorld *	world

QVector	position =QVector(0,0)

QVector	prevPosition =QVector::Zero()

float	rotation =0.0f

float	prevRotation =0.0f

QAABB	aabb

Modes	mode =QBody::Modes::DYNAMIC

bool	inertiaNeedsUpdate =true

bool	circumferenceNeedsUpdate =true

bool	enableBodySpecificTimeScale =false

float	bodySpecificTimeScale =1.0f

BodyTypes	bodyType =BodyTypes::RIGID

bool	enabled =true

float	velocityLimit =0.0f

bool	enableIntegratedVelocities =true

float	friction =0.2f

float	staticFriction =0.5f

float	airFriction =0.01f

float	mass =1.0f

float	restitution =0.0f

int	layersBit =1

int	collidableLayersBit =1

bool	isKinematic =false

bool	allowKinematicCollisions =false

bool	isSleeping =false

int	sleepTick =120

int	fixedVelocityTick =0

int	fixedAngularTick =0

bool	canSleep =true

vector< QMesh * >	_meshes =vector<QMesh*>()

SimulationModels	simulationModel =SimulationModels::RIGID_BODY

Additional Inherited Members
Public Types inherited from QBody
enum	Modes { DYNAMIC , STATIC }

enum	BodyTypes { RIGID , AREA , SOFT }

enum	SimulationModels { MASS_SPRING , RIGID_BODY }

Public Attributes inherited from QBody
std::function< void(QBody *body)>	PreStepEventListener

std::function< void(QBody *body)>	StepEventListener

std::function< bool(QBody *body, CollisionInfo)>	CollisionEventListener

Static Protected Member Functions inherited from QBody
static QVector	ComputeFriction (QBody bodyA, QBody bodyB, QVector &normal, float penetration, QVector &relativeVelocity)

static bool	CanCollide (QBody bodyA, QBody bodyB, bool checkBodiesAreEnabled=true)

Detailed Description

QPlatformerBody provides a ready-to-use foundation for character physics in platformer games. It includes behaviors such as gravity, walking on slopes, and jumping. Additionally, it offers helper methods and properties for further customization.

Member Function Documentation

◆ GetCeiling()

QPlatformerBody::CollisionTestInfo QPlatformerBody::GetCeiling ( float offset )

Checks for a collision with the ceiling.

Parameters

offset The offset to apply during the check.

Returns: A CollisionTestInfo structure with the collision details.

◆ GetControllerHorizontalVelocity()

QVector QPlatformerBody::GetControllerHorizontalVelocity ( )

Gets the horizontal velocity controlled by the character physics.

Returns: The horizontal velocity vector.

◆ GetControllerVerticalVelocity()

QVector QPlatformerBody::GetControllerVerticalVelocity ( )

Gets the vertical velocity controlled by the character physics.

Returns: The vertical velocity vector.

◆ GetFloor()

QPlatformerBody::CollisionTestInfo QPlatformerBody::GetFloor ( float offset )

Checks for a collision with the floor.

Parameters

offset The offset to apply during the check.

Returns: A CollisionTestInfo structure with the collision details.

◆ GetFloorMaxAngle()

float QPlatformerBody::GetFloorMaxAngle ( )

Gets the maximum angle for the floor.

Returns: The maximum angle in radians.

◆ GetFloorMaxAngleDegree()

float QPlatformerBody::GetFloorMaxAngleDegree ( )

Gets the maximum angle for the floor in degrees.

Returns: The maximum angle in degrees.

◆ GetGravity()

QVector QPlatformerBody::GetGravity ( )

Gets the gravity vector.

Returns: The gravity vector.

◆ GetGravityMultiplier()

float QPlatformerBody::GetGravityMultiplier ( )

Gets the gravity multiplier.

Returns: The gravity multiplier.

◆ GetIsFalling()

bool QPlatformerBody::GetIsFalling ( )

Checks if the body is falling.

Returns: True if the body is falling, false otherwise.

◆ GetIsJumping()

bool QPlatformerBody::GetIsJumping ( )

Checks if the body is currently jumping.

Returns: True if the body is jumping, false otherwise.

◆ GetIsJumpReleased()

bool QPlatformerBody::GetIsJumpReleased ( )

Checks if the jump phase has been released.

Returns: True if the jump phase is released, false otherwise.

◆ GetIsOnCeiling()

bool QPlatformerBody::GetIsOnCeiling ( )

Checks if the body is currently touching the ceiling.

Returns: True if the body is on the ceiling, false otherwise.

◆ GetIsOnFloor()

bool QPlatformerBody::GetIsOnFloor ( )

Checks if the body is currently on the floor.

Returns: True if the body is on the floor, false otherwise.

◆ GetIsRising()

bool QPlatformerBody::GetIsRising ( )

Checks if the body is rising.

Returns: True if the body is rising, false otherwise.

◆ GetJumpDurationFrameCount()

int QPlatformerBody::GetJumpDurationFrameCount ( )

Gets the duration for a jump in frames.

Returns: The jump duration in frames.

◆ GetJumpFallGravityMultiplier()

float QPlatformerBody::GetJumpFallGravityMultiplier ( )

Gets the gravity multiplier for the falling phase of a jump.

Returns: The gravity multiplier.

◆ GetJumpGravityMultiplier()

float QPlatformerBody::GetJumpGravityMultiplier ( )

Gets the gravity multiplier during a jump.

Returns: The gravity multiplier.

◆ GetLeftWall()

QPlatformerBody::CollisionTestInfo QPlatformerBody::GetLeftWall ( float offset )

Checks for a collision with a wall on the left.

Parameters

offset The offset to apply during the check.

Returns: A CollisionTestInfo structure with the collision details.

◆ GetMaxJumpCount()

int QPlatformerBody::GetMaxJumpCount ( )

Gets the maximum number of jumps allowed.

Returns: The maximum jump count.

◆ GetMovingFloorSnapOffset()

float QPlatformerBody::GetMovingFloorSnapOffset ( )

Gets the snap offset for moving floors.

Returns: The snap offset value.

◆ GetPlatformCollisions()

QPlatformerBody::CollisionTestInfo QPlatformerBody::GetPlatformCollisions	(	QVector	testPosition,
		QVector	nearestOnAxis = `QVector::Zero()`
	)

Performs a platform collision test.

Parameters

testPosition	The position to test for collisions.
nearestOnAxis	The axis for prioritizing the nearest collision.

Returns: A CollisionTestInfo structure with the collision details.

◆ GetRightWall()

QPlatformerBody::CollisionTestInfo QPlatformerBody::GetRightWall ( float offset )

Checks for a collision with a wall on the right.

Parameters

offset The offset to apply during the check.

Returns: A CollisionTestInfo structure with the collision details.

◆ GetSpecificPlatformLayers()

int QPlatformerBody::GetSpecificPlatformLayers ( )

Gets specific platform layers bit. This determines which platform layers the platformer physics will apply to, such as sloped surfaces, ceilings, walls, etc. The default value is 0, which disables this functionality.

Note: The object can still interact with objects in the physics world that are set to the layers specified for collision, but platformer-specific behavior (like gravity and movement on slopes) will be applied only to the specified platform layers.

Returns: The bitmask representing the platform layers.

◆ GetWalkAcelerationRate()

float QPlatformerBody::GetWalkAcelerationRate ( )

Gets the walking acceleration rate.

Returns: The acceleration rate.

◆ GetWalkDecelerationRate()

float QPlatformerBody::GetWalkDecelerationRate ( )

Gets the walking deceleration rate.

Returns: The deceleration rate.

◆ GetWalkSpeed()

float QPlatformerBody::GetWalkSpeed ( )

Gets the walking speed of the body.

Returns: The walking speed

◆ Jump()

QPlatformerBody * QPlatformerBody::Jump	(	float	force,
		bool	unconditional = `false`
	)

Initiates a jump with the specified force.

Parameters

force	The force of the jump.
unconditional	If true, the jump will execute regardless of current conditions.

Returns: A pointer to the body itself.

◆ PostUpdate()

void QPlatformerBody::PostUpdate ( )

protectedvirtual

Called after all bodies have completed their Update step to perform post-update operations.

Reimplemented from QRigidBody.

◆ ReleaseJump()

QPlatformerBody * QPlatformerBody::ReleaseJump ( )

Releases the jump phase.

Returns: A pointer to the body itself.

◆ SetControllerHorizontalVelocity()

QPlatformerBody * QPlatformerBody::SetControllerHorizontalVelocity ( QVector value )

Sets the horizontal velocity controlled by the character physics.

Parameters

value The horizontal velocity vector.

Returns: A pointer to the body itself.

◆ SetControllerVerticalVelocity()

QPlatformerBody * QPlatformerBody::SetControllerVerticalVelocity ( QVector value )

Sets the vertical velocity controlled by the character physics.

Parameters

value The vertical velocity vector.

Returns: A pointer to the body itself.

◆ SetFloorMaxAngle()

QPlatformerBody * QPlatformerBody::SetFloorMaxAngle ( float value )

Sets the maximum angle for the floor.

Parameters

value The maximum angle in radians.

Returns: A pointer to the body itself.

◆ SetFloorMaxAngleDegree()

QPlatformerBody * QPlatformerBody::SetFloorMaxAngleDegree ( float value )

Sets the maximum angle for the floor in degrees.

Parameters

value The maximum angle in degrees.

Returns: A pointer to the body itself.

◆ SetGravity()

QPlatformerBody * QPlatformerBody::SetGravity ( QVector value )

Sets the gravity vector.

Parameters

value The gravity vector.

Returns: A pointer to the body itself.

◆ SetGravityMultiplier()

QPlatformerBody * QPlatformerBody::SetGravityMultiplier ( float value )

Sets the gravity multiplier.

Parameters

value The gravity multiplier.

Returns: A pointer to the body itself.

◆ SetJumpDurationFrameCount()

QPlatformerBody * QPlatformerBody::SetJumpDurationFrameCount ( int value )

Sets the duration for a jump in frames.

Parameters

value The jump duration in frames.

Returns: A pointer to the body itself.

◆ SetJumpFallGravityMultiplier()

QPlatformerBody * QPlatformerBody::SetJumpFallGravityMultiplier ( float value )

Sets the gravity multiplier for the falling phase of a jump.

Parameters

value The gravity multiplier.

Returns: A pointer to the body itself.

◆ SetJumpGravityMultiplier()

QPlatformerBody * QPlatformerBody::SetJumpGravityMultiplier ( float value )

Sets the gravity multiplier during a jump.

Parameters

value The gravity multiplier.

Returns: A pointer to the body itself.

◆ SetMaxJumpCount()

QPlatformerBody * QPlatformerBody::SetMaxJumpCount ( int value )

Sets the maximum number of jumps allowed.

Parameters

value The maximum jump count.

Returns: A pointer to the body itself.

◆ SetMovingFloorSnapOffset()

QPlatformerBody * QPlatformerBody::SetMovingFloorSnapOffset ( float value )

Sets the snap offset for moving floors.

Parameters

value The snap offset value.

Returns: A pointer to the body itself.

◆ SetSpecificPlatformLayers()

QPlatformerBody * QPlatformerBody::SetSpecificPlatformLayers ( int layersBit )

Sets specific platform layers bit. This determines which platform layers the platformer physics will apply to, such as sloped surfaces, ceilings, walls, etc. The default value is 0, which disables this functionality.

Note: The object can still interact with objects in the physics world that are set to the layers specified for collision, but platformer-specific behavior (like gravity and movement on slopes) will be applied only to the specified platform layers.

Parameters

layersBit The bitmask representing the platform layers.

Returns: A pointer to the body itself.

◆ SetWalkAcelerationRate()

QPlatformerBody * QPlatformerBody::SetWalkAcelerationRate ( float value )

Sets the walking acceleration rate.

Parameters

value The acceleration rate.

Returns: A pointer to the body itself.

◆ SetWalkDecelerationRate()

QPlatformerBody * QPlatformerBody::SetWalkDecelerationRate ( float value )

Sets the walking deceleration rate.

Parameters

value The deceleration rate.

Returns: A pointer to the body itself.

◆ SetWalkSpeed()

QPlatformerBody * QPlatformerBody::SetWalkSpeed ( float value )

Sets the walking speed of the body.

Parameters

value The walking speed.

Returns: A pointer to the body itself.

◆ Walk()

QPlatformerBody * QPlatformerBody::Walk ( int side )

Moves the body in a specified horizontal direction.

Parameters

side	The direction (-1 for left, 1 for right, 0 for no movement).

Returns: A pointer to the body itself.

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

QuarkPhysics/extensions/qplatformerbody.h
QuarkPhysics/extensions/qplatformerbody.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetCeiling()

◆ GetControllerHorizontalVelocity()

◆ GetControllerVerticalVelocity()

◆ GetFloor()

◆ GetFloorMaxAngle()

◆ GetFloorMaxAngleDegree()

◆ GetGravity()

◆ GetGravityMultiplier()

◆ GetIsFalling()

◆ GetIsJumping()

◆ GetIsJumpReleased()

◆ GetIsOnCeiling()

◆ GetIsOnFloor()

◆ GetIsRising()

◆ GetJumpDurationFrameCount()

◆ GetJumpFallGravityMultiplier()

◆ GetJumpGravityMultiplier()

◆ GetLeftWall()

◆ GetMaxJumpCount()

◆ GetMovingFloorSnapOffset()

◆ GetPlatformCollisions()

◆ GetRightWall()

◆ GetSpecificPlatformLayers()

◆ GetWalkAcelerationRate()

◆ GetWalkDecelerationRate()

◆ GetWalkSpeed()

◆ Jump()

◆ PostUpdate()

◆ ReleaseJump()

◆ SetControllerHorizontalVelocity()

◆ SetControllerVerticalVelocity()

◆ SetFloorMaxAngle()

◆ SetFloorMaxAngleDegree()

◆ SetGravity()

◆ SetGravityMultiplier()

◆ SetJumpDurationFrameCount()

◆ SetJumpFallGravityMultiplier()

◆ SetJumpGravityMultiplier()

◆ SetMaxJumpCount()

◆ SetMovingFloorSnapOffset()

◆ SetSpecificPlatformLayers()

◆ SetWalkAcelerationRate()

◆ SetWalkDecelerationRate()

◆ SetWalkSpeed()

◆ Walk()