com.badlogic.gdx.ai.steer.behaviors

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

Type Parameters:

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

Direct Known Subclasses:

Face, LookWhereYouAreGoing

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

ReachOrientation tries to align the owner to the target. It pays no attention to the position or velocity of the owner or target. This steering behavior does not produce any linear acceleration; it only responds by turning.

ReachOrientation behaves in a similar way to Arrive since it tries to reach the target orientation and tries to have zero rotation when it gets there. Like arrive, it uses two radii: decelerationRadius for slowing down and alignTolerance to make orientations near the target acceptable without letting small errors keep the owner swinging. Because we are dealing with a single scalar value, rather than a 2D or 3D vector, the radius acts as an interval.

Similarly to Arrive, there is a timeToTarget that defaults to 0.1 seconds.

Field Summary

Fields

Modifier and Type	Field and Description
protected float	alignTolerance The tolerance for aligning to the target without letting small errors keep the owner swinging.
protected float	decelerationRadius The radius for beginning to slow down
protected Location<T>	target The target to align to.
protected float	timeToTarget The time over which to achieve target rotation speed

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

enabled, limiter, owner

Constructor Summary

Constructors

Constructor and Description
ReachOrientation(Steerable<T> owner) Creates a ReachOrientation behavior for the specified owner.
ReachOrientation(Steerable<T> owner, Location<T> target) Creates a ReachOrientation behavior for the specified owner and target.

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.
float	getAlignTolerance() Returns the tolerance for aligning to the target without letting small errors keep the owner swinging.
float	getDecelerationRadius() Returns the radius for beginning to slow down
Location<T>	getTarget() Returns the target to align to.
float	getTimeToTarget() Returns the time over which to achieve target rotation speed
protected SteeringAcceleration<T>	reachOrientation(SteeringAcceleration<T> steering, float targetOrientation) Produces a steering that tries to align the owner to the target orientation.
ReachOrientation<T>	setAlignTolerance(float alignTolerance) Sets the tolerance for aligning to the target without letting small errors keep the owner swinging.
ReachOrientation<T>	setDecelerationRadius(float decelerationRadius) Sets the radius for beginning to slow down
ReachOrientation<T>	setEnabled(boolean enabled) Sets this steering behavior on/off.
ReachOrientation<T>	setLimiter(Limiter limiter) Sets the limiter of this steering behavior.
ReachOrientation<T>	setOwner(Steerable<T> owner) Sets the owner of this steering behavior.
ReachOrientation<T>	setTarget(Location<T> target) Sets the target to align to.
ReachOrientation<T>	setTimeToTarget(float timeToTarget) Sets the time over which to achieve target rotation 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 Location<T extends com.badlogic.gdx.math.Vector<T>> target

The target to align to.

alignTolerance

protected float alignTolerance

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

decelerationRadius

protected float decelerationRadius

The radius for beginning to slow down

timeToTarget

protected float timeToTarget

The time over which to achieve target rotation speed

Constructor Detail

ReachOrientation

public ReachOrientation(Steerable<T> owner)

Creates a ReachOrientation behavior for the specified owner.

Parameters:

owner - the owner of this behavior.

ReachOrientation

public ReachOrientation(Steerable<T> owner,
                        Location<T> target)

Creates a ReachOrientation behavior for the specified owner and target.

Parameters:

owner - the owner of this behavior

target - the target.

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.

reachOrientation

protected SteeringAcceleration<T> reachOrientation(SteeringAcceleration<T> steering,
                                                   float targetOrientation)

Produces a steering that tries to align the owner to the target orientation. This method is called by subclasses that want to align to a certain orientation.

Parameters:

steering - the steering to be calculated.

targetOrientation - the target orientation you want to align to.

Returns:

the calculated steering for chaining.

getTarget

public Location<T> getTarget()

Returns the target to align to.

setTarget

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

Sets the target to align to.

Returns:

this behavior for chaining.

getAlignTolerance

public float getAlignTolerance()

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

setAlignTolerance

public ReachOrientation<T> setAlignTolerance(float alignTolerance)

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

Returns:

this behavior for chaining.

getDecelerationRadius

public float getDecelerationRadius()

Returns the radius for beginning to slow down

setDecelerationRadius

public ReachOrientation<T> setDecelerationRadius(float decelerationRadius)

Sets the radius for beginning to slow down

Returns:

this behavior for chaining.

getTimeToTarget

public float getTimeToTarget()

Returns the time over which to achieve target rotation speed

setTimeToTarget

public ReachOrientation<T> setTimeToTarget(float timeToTarget)

Sets the time over which to achieve target rotation speed

Returns:

this behavior for chaining.

setOwner

public ReachOrientation<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 ReachOrientation<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 ReachOrientation<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 SteeringBehavior<T extends com.badlogic.gdx.math.Vector<T>>

Returns:

this behavior for chaining.