com.badlogic.gdx.ai.steer.behaviors

Class MatchVelocity<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>

Type Parameters:

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

Direct Known Subclasses:

Jump

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

This steering behavior produces a linear acceleration trying to match target's velocity. It does not produce any angular acceleration.

Field Summary

Fields

Modifier and Type	Field and Description
protected Steerable<T>	target The target of this behavior
protected float	timeToTarget The time over which to achieve target speed

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

enabled, limiter, owner

Constructor Summary

Constructors

Constructor and Description
MatchVelocity(Steerable<T> owner) Creates a MatchVelocity behavior for the given owner.
MatchVelocity(Steerable<T> owner, Steerable<T> target) Creates a MatchVelocity behavior for the given owner and target.
MatchVelocity(Steerable<T> owner, Steerable<T> target, float timeToTarget) Creates a MatchVelocity behavior for the given owner, target and timeToTarget.

Method Summary

Modifier and Type	Method and Description
protected SteeringAcceleration<T>	calculateRealSteering(SteeringAcceleration<T> steering) Calculates the steering acceleration produced by this behavior and writes it to the given steering output.
Steerable<T>	getTarget() Returns the target whose velocity should be matched.
float	getTimeToTarget() Returns the time over which to achieve target speed.
MatchVelocity<T>	setEnabled(boolean enabled) Sets this steering behavior on/off.
MatchVelocity<T>	setLimiter(Limiter limiter) Sets the limiter of this steering behavior.
MatchVelocity<T>	setOwner(Steerable<T> owner) Sets the owner of this steering behavior.
MatchVelocity<T>	setTarget(Steerable<T> target) Sets the target whose velocity should be matched.
MatchVelocity<T>	setTimeToTarget(float timeToTarget) Sets the time over which to achieve target speed.

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

target

protected Steerable<T extends com.badlogic.gdx.math.Vector<T>> target

The target of this behavior

timeToTarget

protected float timeToTarget

The time over which to achieve target speed

Constructor Detail

MatchVelocity

public MatchVelocity(Steerable<T> owner)

Creates a MatchVelocity behavior for the given owner. No target is set. The maxLinearAcceleration is set to 100. The timeToTarget is set to 0.1 seconds.

Parameters:

owner - the owner of this behavior.

MatchVelocity

public MatchVelocity(Steerable<T> owner,
                     Steerable<T> target)

Creates a MatchVelocity behavior for the given owner and target. The timeToTarget is set to 0.1 seconds.

Parameters:

owner - the owner of this behavior

target - the target of this behavior.

MatchVelocity

public MatchVelocity(Steerable<T> owner,
                     Steerable<T> target,
                     float timeToTarget)

Creates a MatchVelocity behavior for the given owner, target and timeToTarget.

Parameters:

owner - the owner of this behavior

target - the target of this behavior

timeToTarget - the time over which to achieve target speed.

Method Detail

calculateRealSteering

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

Specified by:

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

Parameters:

steering - the steering acceleration to be calculated.

Returns:

the calculated steering acceleration for chaining.

getTarget

public Steerable<T> getTarget()

Returns the target whose velocity should be matched.

setTarget

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

Sets the target whose velocity should be matched.

Parameters:

target - the target to set

Returns:

this behavior for chaining.

getTimeToTarget

public float getTimeToTarget()

Returns the time over which to achieve target speed.

setTimeToTarget

public MatchVelocity<T> setTimeToTarget(float timeToTarget)

Sets the time over which to achieve target speed.

Parameters:

timeToTarget - the time to set

Returns:

this behavior for chaining.

setOwner

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

Description copied from class: SteeringBehavior

Sets the owner of this steering behavior.

Overrides:

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

Returns:

this behavior for chaining.

setEnabled

public MatchVelocity<T> setEnabled(boolean enabled)

Description copied from class: SteeringBehavior

Sets this steering behavior on/off.

Overrides:

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

Returns:

this behavior for chaining.

setLimiter

public MatchVelocity<T> setLimiter(Limiter limiter)

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

Overrides:

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

Returns:

this behavior for chaining.