com.badlogic.gdx.ai.steer.behaviors

Class Jump<T extends com.badlogic.gdx.math.Vector<T>>

java.lang.Object

com.badlogic.gdx.ai.steer.SteeringBehavior<T>

com.badlogic.gdx.ai.steer.behaviors.MatchVelocity<T>

com.badlogic.gdx.ai.steer.behaviors.Jump<T>

Type Parameters:

T - Type of vector, either 2D or 3D, implementing the Vector interface

public class Jump<T extends com.badlogic.gdx.math.Vector<T>>
extends MatchVelocity<T>

First the Jump behavior calculates the linear velocity required to achieve the jump. If the calculated velocity doesn't exceed the maximum linear velocity the jump is achievable; otherwise it's not. In either cases, the given callback gets informed through the reportAchievability method. Also, if the jump is achievable the run up phase begins and the Jump behavior will start to produce the linear acceleration required to match the calculated velocity. Once the jump point and the linear velocity are reached with a precision within the given tolerance the callback is told to jump through the takeoff method.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Jump.GravityComponentHandler<T extends com.badlogic.gdx.math.Vector<T>> A GravityComponentHandler is aware of the axis along which the gravity acts.
static interface	Jump.JumpCallback The JumpCallback allows you to know whether a jump is achievable and when to jump.
static class	Jump.JumpDescriptor<T extends com.badlogic.gdx.math.Vector<T>> A JumpDescriptor contains jump information like the take-off and the landing position.

Field Summary

Fields

Modifier and Type	Field and Description
protected float	airborneTime
protected Jump.JumpCallback	callback
static boolean	DEBUG_ENABLED
protected T	gravity The gravity vector to use.
protected Jump.GravityComponentHandler<T>	gravityComponentHandler
protected Jump.JumpDescriptor<T>	jumpDescriptor The jump descriptor to use
protected float	maxVerticalVelocity The maximum vertical component of jump velocity, where "vertical" stands for the axis where gravity operates.
protected float	takeoffPositionTolerance
protected float	takeoffVelocityTolerance

Fields inherited from class com.badlogic.gdx.ai.steer.behaviors.MatchVelocity

target, timeToTarget

Fields inherited from class com.badlogic.gdx.ai.steer.SteeringBehavior

enabled, limiter, owner

Constructor Summary

Constructors

Constructor and Description
Jump(Steerable<T> owner, Jump.JumpDescriptor<T> jumpDescriptor, T gravity, Jump.GravityComponentHandler<T> gravityComponentHandler, Jump.JumpCallback callback) Creates a Jump behavior.

Method Summary

Modifier and Type	Method and Description
float	calculateAirborneTimeAndVelocity(T outVelocity, Jump.JumpDescriptor<T> jumpDescriptor, float maxLinearSpeed) Returns the airborne time and sets the outVelocity vector to the airborne planar velocity required to achieve the jump.
SteeringAcceleration<T>	calculateRealSteering(SteeringAcceleration<T> steering) Calculates the steering acceleration produced by this behavior and writes it to the given steering output.
T	getGravity() Returns the gravity vector.
Jump.JumpDescriptor<T>	getJumpDescriptor() Returns the jump descriptor.
float	getMaxVerticalVelocity() Returns the maximum vertical component of jump velocity, where "vertical" stands for the axis where gravity operates.
float	getTakeoffPositionTolerance() Returns the tolerance used to check if the owner has reached the takeoff location.
float	getTakeoffVelocityTolerance() Returns the tolerance used to check if the owner has reached the takeoff velocity.
Jump<T>	setEnabled(boolean enabled) Sets this steering behavior on/off.
Jump<T>	setGravity(T gravity) Sets the gravity vector.
Jump<T>	setJumpDescriptor(Jump.JumpDescriptor<T> jumpDescriptor) Sets the jump descriptor to use.
Jump<T>	setLimiter(Limiter limiter) Sets the limiter of this steering behavior.
Jump<T>	setMaxVerticalVelocity(float maxVerticalVelocity) Sets the maximum vertical component of jump velocity, where "vertical" stands for the axis where gravity operates.
Jump<T>	setOwner(Steerable<T> owner) Sets the owner of this steering behavior.
Jump<T>	setTakeoffPositionTolerance(float takeoffPositionTolerance) Sets the tolerance used to check if the owner has reached the takeoff location.
Jump<T>	setTakeoffTolerance(float takeoffTolerance) Sets the the tolerance used to check if the owner has reached the takeoff location with the required velocity.
Jump<T>	setTakeoffVelocityTolerance(float takeoffVelocityTolerance) Sets the tolerance used to check if the owner has reached the takeoff velocity.
Jump<T>	setTarget(Steerable<T> target) Sets the target whose velocity should be matched.
Jump<T>	setTimeToTarget(float timeToTarget) Sets the time over which to achieve target speed.

Methods inherited from class com.badlogic.gdx.ai.steer.behaviors.MatchVelocity

getTarget, getTimeToTarget

Methods inherited from class com.badlogic.gdx.ai.steer.SteeringBehavior

calculateSteering, getActualLimiter, getLimiter, getOwner, isEnabled, newVector

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG_ENABLED

public static boolean DEBUG_ENABLED

jumpDescriptor

protected Jump.JumpDescriptor<T extends com.badlogic.gdx.math.Vector<T>> jumpDescriptor

The jump descriptor to use

gravity

protected T extends com.badlogic.gdx.math.Vector<T> gravity

The gravity vector to use. Notice that this behavior only supports gravity along a single axis, which must be the one returned by the Jump.GravityComponentHandler.getComponent(Vector) method.

gravityComponentHandler

protected Jump.GravityComponentHandler<T extends com.badlogic.gdx.math.Vector<T>> gravityComponentHandler

callback

protected Jump.JumpCallback callback

takeoffPositionTolerance

protected float takeoffPositionTolerance

takeoffVelocityTolerance

protected float takeoffVelocityTolerance

maxVerticalVelocity

protected float maxVerticalVelocity

The maximum vertical component of jump velocity, where "vertical" stands for the axis where gravity operates.

airborneTime

protected float airborneTime

Constructor Detail

Jump

public Jump(Steerable<T> owner,
            Jump.JumpDescriptor<T> jumpDescriptor,
            T gravity,
            Jump.GravityComponentHandler<T> gravityComponentHandler,
            Jump.JumpCallback callback)

Creates a Jump behavior.

Parameters:

owner - the owner of this behavior

jumpDescriptor - the descriptor of the jump to make

gravity - the gravity vector

gravityComponentHandler - the handler giving access to the vertical axis

callback - the callback that gets informed about jump achievability and when to jump

Method Detail

calculateRealSteering

public SteeringAcceleration<T> calculateRealSteering(SteeringAcceleration<T> steering)

Description copied from class: SteeringBehavior

Calculates the steering acceleration produced by this behavior and writes it to the given steering output.

This method is called by SteeringBehavior.calculateSteering(SteeringAcceleration) when this steering behavior is enabled.

Overrides:

calculateRealSteering in class MatchVelocity<T extends com.badlogic.gdx.math.Vector<T>>

Parameters:

steering - the steering acceleration to be calculated.

Returns:

the calculated steering acceleration for chaining.

calculateAirborneTimeAndVelocity

public float calculateAirborneTimeAndVelocity(T outVelocity,
                                              Jump.JumpDescriptor<T> jumpDescriptor,
                                              float maxLinearSpeed)

Returns the airborne time and sets the outVelocity vector to the airborne planar velocity required to achieve the jump. If the jump is not achievable -1 is returned and the outVelocity vector remains unchanged.

Be aware that you should avoid using unlimited or very high max velocity, because this might produce a time of flight close to 0. Actually, the motion equation for T has 2 solutions and Jump always try to use the fastest time.

Parameters:

outVelocity - the output vector where the airborne planar velocity is calculated

jumpDescriptor - the jump descriptor

maxLinearSpeed - the maximum linear speed that can be used to achieve the jump

Returns:

the time of flight or -1 if the jump is not achievable using the given max linear speed.

getJumpDescriptor

public Jump.JumpDescriptor<T> getJumpDescriptor()

Returns the jump descriptor.

setJumpDescriptor

public Jump<T> setJumpDescriptor(Jump.JumpDescriptor<T> jumpDescriptor)

Sets the jump descriptor to use.

Parameters:

jumpDescriptor - the jump descriptor to set

Returns:

this behavior for chaining.

getGravity

public T getGravity()

Returns the gravity vector.

setGravity

public Jump<T> setGravity(T gravity)

Sets the gravity vector.

Parameters:

gravity - the gravity to set

Returns:

this behavior for chaining.

getMaxVerticalVelocity

public float getMaxVerticalVelocity()

Returns the maximum vertical component of jump velocity, where "vertical" stands for the axis where gravity operates.

setMaxVerticalVelocity

public Jump<T> setMaxVerticalVelocity(float maxVerticalVelocity)

Sets the maximum vertical component of jump velocity, where "vertical" stands for the axis where gravity operates.

Parameters:

maxVerticalVelocity - the maximum vertical velocity to set

Returns:

this behavior for chaining.

getTakeoffPositionTolerance

public float getTakeoffPositionTolerance()

Returns the tolerance used to check if the owner has reached the takeoff location.

setTakeoffPositionTolerance

public Jump<T> setTakeoffPositionTolerance(float takeoffPositionTolerance)

Sets the tolerance used to check if the owner has reached the takeoff location.

Parameters:

takeoffPositionTolerance - the takeoff position tolerance to set

Returns:

this behavior for chaining.

getTakeoffVelocityTolerance

public float getTakeoffVelocityTolerance()

Returns the tolerance used to check if the owner has reached the takeoff velocity.

setTakeoffVelocityTolerance

public Jump<T> setTakeoffVelocityTolerance(float takeoffVelocityTolerance)

Sets the tolerance used to check if the owner has reached the takeoff velocity.

Parameters:

takeoffVelocityTolerance - the takeoff velocity tolerance to set

Returns:

this behavior for chaining.

setTakeoffTolerance

public Jump<T> setTakeoffTolerance(float takeoffTolerance)

Sets the the tolerance used to check if the owner has reached the takeoff location with the required velocity.

Parameters:

takeoffTolerance - the takeoff tolerance for both position and velocity

Returns:

this behavior for chaining.

setOwner

public Jump<T> setOwner(Steerable<T> owner)

Description copied from class: SteeringBehavior

Sets the owner of this steering behavior.

Overrides:

setOwner in class MatchVelocity<T extends com.badlogic.gdx.math.Vector<T>>

Returns:

this behavior for chaining.

setEnabled

public Jump<T> setEnabled(boolean enabled)

Description copied from class: SteeringBehavior

Sets this steering behavior on/off.

Overrides:

setEnabled in class MatchVelocity<T extends com.badlogic.gdx.math.Vector<T>>

Returns:

this behavior for chaining.

setLimiter

public Jump<T> setLimiter(Limiter limiter)

Sets the limiter of this steering behavior. The given limiter must at least take care of the maximum linear acceleration and speed.

Overrides:

setLimiter in class MatchVelocity<T extends com.badlogic.gdx.math.Vector<T>>

Returns:

this behavior for chaining.

setTarget

public Jump<T> setTarget(Steerable<T> target)

Sets the target whose velocity should be matched. Notice that this method is inherited from MatchVelocity. Usually with Jump you should never call it because a specialized internal target has already been created implicitly.

Overrides:

setTarget in class MatchVelocity<T extends com.badlogic.gdx.math.Vector<T>>

Parameters:

target - the target to set

Returns:

this behavior for chaining.

setTimeToTarget

public Jump<T> setTimeToTarget(float timeToTarget)

Description copied from class: MatchVelocity

Sets the time over which to achieve target speed.

Overrides:

setTimeToTarget in class MatchVelocity<T extends com.badlogic.gdx.math.Vector<T>>

Parameters:

timeToTarget - the time to set

Returns:

this behavior for chaining.