com.badlogic.gdx.ai.steer.behaviors

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

java.lang.Object

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

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

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

Type Parameters:

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

public class LookWhereYouAreGoing<T extends com.badlogic.gdx.math.Vector<T>>
extends ReachOrientation<T>

The entire steering framework assumes that the direction a character is facing does not have to be its direction of motion. In many cases, however, you would like the character to face in the direction it is moving. To do this you can manually align the orientation of the character to its linear velocity on each frame update or you can use the LookWhereYouAreGoing behavior.

LookWhereYouAreGoing behavior gives the owner angular acceleration to make it face in the direction it is moving. In this way the owner changes facing gradually, which can look more natural, especially for aerial vehicles such as helicopters or for human characters that can move sideways.

This is a process similar to the Face behavior. The target orientation is calculated using the current velocity of the owner. If there is no velocity, then the target orientation is set to the current orientation. We have no preference in this situation for any orientation.

Field Summary

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

alignTolerance, decelerationRadius, target, timeToTarget

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

enabled, limiter, owner

Constructor Summary

Constructors

Constructor and Description
LookWhereYouAreGoing(Steerable<T> owner) Creates a LookWhereYouAreGoing behavior for the specified owner.

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.
LookWhereYouAreGoing<T>	setAlignTolerance(float alignTolerance) Sets the tolerance for aligning to the target without letting small errors keep the owner swinging.
LookWhereYouAreGoing<T>	setDecelerationRadius(float decelerationRadius) Sets the radius for beginning to slow down
LookWhereYouAreGoing<T>	setEnabled(boolean enabled) Sets this steering behavior on/off.
LookWhereYouAreGoing<T>	setLimiter(Limiter limiter) Sets the limiter of this steering behavior.
LookWhereYouAreGoing<T>	setOwner(Steerable<T> owner) Sets the owner of this steering behavior.
LookWhereYouAreGoing<T>	setTarget(Location<T> target) Sets the target to align to.
LookWhereYouAreGoing<T>	setTimeToTarget(float timeToTarget) Sets the time over which to achieve target rotation speed

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

getAlignTolerance, getDecelerationRadius, getTarget, getTimeToTarget, reachOrientation

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

Constructor Detail

LookWhereYouAreGoing

public LookWhereYouAreGoing(Steerable<T> owner)

Creates a LookWhereYouAreGoing behavior for the specified owner.

Parameters:

owner - the owner of this behavior.

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.

Overrides:

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

Parameters:

steering - the steering acceleration to be calculated.

Returns:

the calculated steering acceleration for chaining.

setOwner

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

Description copied from class: SteeringBehavior

Sets the owner of this steering behavior.

Overrides:

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

Returns:

this behavior for chaining.

setEnabled

public LookWhereYouAreGoing<T> setEnabled(boolean enabled)

Description copied from class: SteeringBehavior

Sets this steering behavior on/off.

Overrides:

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

Returns:

this behavior for chaining.

setLimiter

public LookWhereYouAreGoing<T> setLimiter(Limiter limiter)

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

Overrides:

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

Returns:

this behavior for chaining.

setTarget

public LookWhereYouAreGoing<T> setTarget(Location<T> target)

Sets the target to align to. Notice that this method is inherited from ReachOrientation, but is completely useless for LookWhereYouAreGoing because the target orientation is determined by the velocity of the owner itself.

Overrides:

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

Returns:

this behavior for chaining.

setAlignTolerance

public LookWhereYouAreGoing<T> setAlignTolerance(float alignTolerance)

Description copied from class: ReachOrientation

Sets the tolerance for aligning to the target without letting small errors keep the owner swinging.

Overrides:

setAlignTolerance in class ReachOrientation<T extends com.badlogic.gdx.math.Vector<T>>

Returns:

this behavior for chaining.

setDecelerationRadius

public LookWhereYouAreGoing<T> setDecelerationRadius(float decelerationRadius)

Description copied from class: ReachOrientation

Sets the radius for beginning to slow down

Overrides:

setDecelerationRadius in class ReachOrientation<T extends com.badlogic.gdx.math.Vector<T>>

Returns:

this behavior for chaining.

setTimeToTarget

public LookWhereYouAreGoing<T> setTimeToTarget(float timeToTarget)

Description copied from class: ReachOrientation

Sets the time over which to achieve target rotation speed

Overrides:

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

Returns:

this behavior for chaining.