com.badlogic.gdx.ai.steer.behaviors

Class Face<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.Face<T>

Type Parameters:

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

Direct Known Subclasses:

Wander

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

Face behavior makes the owner look at its target. It delegates to the ReachOrientation behavior to perform the rotation but calculates the target orientation first based on target and owner position.

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
Face(Steerable<T> owner) Creates a Face behavior for the specified owner.
Face(Steerable<T> owner, Location<T> target) Creates a Face 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.
protected SteeringAcceleration<T>	face(SteeringAcceleration<T> steering, T targetPosition)
Face<T>	setAlignTolerance(float alignTolerance) Sets the tolerance for aligning to the target without letting small errors keep the owner swinging.
Face<T>	setDecelerationRadius(float decelerationRadius) Sets the radius for beginning to slow down
Face<T>	setEnabled(boolean enabled) Sets this steering behavior on/off.
Face<T>	setLimiter(Limiter limiter) Sets the limiter of this steering behavior.
Face<T>	setOwner(Steerable<T> owner) Sets the owner of this steering behavior.
Face<T>	setTarget(Location<T> target) Sets the target to align to.
Face<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

Face

public Face(Steerable<T> owner)

Creates a Face behavior for the specified owner.

Parameters:

owner - the owner of this behavior.

Face

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

Creates a Face behavior for the specified owner and target.

Parameters:

owner - the owner of this behavior

target - the target 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.

face

protected SteeringAcceleration<T> face(SteeringAcceleration<T> steering,
                                       T targetPosition)

setOwner

public Face<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 Face<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 Face<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 Face<T> setTarget(Location<T> target)

Description copied from class: ReachOrientation

Sets the target to align to.

Overrides:

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

Returns:

this behavior for chaining.

setAlignTolerance

public Face<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 Face<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 Face<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.