Arrive (libGDX AI)

java.lang.Object
- com.badlogic.gdx.ai.steer.SteeringBehavior<T>
- - com.badlogic.gdx.ai.steer.behaviors.Arrive<T>

Type Parameters:

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

Direct Known Subclasses:

FollowPath, Hide, Interpose
```
public class Arrive<T extends com.badlogic.gdx.math.Vector<T>>
extends SteeringBehavior<T>
```
Arrive behavior moves the agent towards a target position. It is similar to seek but it attempts to arrive at the target position with a zero velocity.
Arrive behavior uses two radii. The arrivalTolerance lets the owner get near enough to the target without letting small errors keep it in motion. The decelerationRadius, usually much larger than the previous one, specifies when the incoming character will begin to slow down. The algorithm calculates an ideal speed for the owner. At the slowing-down radius, this is equal to its maximum linear speed. At the target point, it is zero (we want to have zero speed when we arrive). In between, the desired speed is an interpolated intermediate value, controlled by the distance from the target.
The direction toward the target is calculated and combined with the desired speed to give a target velocity. The algorithm looks at the current velocity of the character and works out the acceleration needed to turn it into the target velocity. We can't immediately change velocity, however, so the acceleration is calculated based on reaching the target velocity in a fixed time scale known as timeToTarget. This is usually a small value; it defaults to 0.1 seconds which is a good starting point.

Field Summary

Fields
Modifier and Type	Field and Description
`protected float`	`arrivalTolerance` The tolerance for arriving at the target.
`protected float`	`decelerationRadius` The radius for beginning to slow down
`protected Location<T>`	`target` The target to arrive to.
`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
`Arrive(Steerable<T> owner)` Creates an `Arrive` behavior for the specified owner.
`Arrive(Steerable<T> owner, Location<T> target)` Creates an `Arrive` behavior for the specified owner and target.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected SteeringAcceleration<T>`	`arrive(SteeringAcceleration<T> steering, T targetPosition)`
`protected SteeringAcceleration<T>`	`calculateRealSteering(SteeringAcceleration<T> steering)` Calculates the steering acceleration produced by this behavior and writes it to the given steering output.
`float`	`getArrivalTolerance()` Returns the tolerance for arriving at the target.
`float`	`getDecelerationRadius()` Returns the radius for beginning to slow down.
`Location<T>`	`getTarget()` Returns the target to arrive to.
`float`	`getTimeToTarget()` Returns the time over which to achieve target speed.
`Arrive<T>`	`setArrivalTolerance(float arrivalTolerance)` Sets the tolerance for arriving at the target.
`Arrive<T>`	`setDecelerationRadius(float decelerationRadius)` Sets the radius for beginning to slow down.
`Arrive<T>`	`setEnabled(boolean enabled)` Sets this steering behavior on/off.
`Arrive<T>`	`setLimiter(Limiter limiter)` Sets the limiter of this steering behavior.
`Arrive<T>`	`setOwner(Steerable<T> owner)` Sets the owner of this steering behavior.
`Arrive<T>`	`setTarget(Location<T> target)` Sets the target to arrive to.
`Arrive<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 Location<T extends com.badlogic.gdx.math.Vector<T>> target
```
    The target to arrive to.
  - arrivalTolerance
```
protected float arrivalTolerance
```
    The tolerance for arriving at the target. It lets the owner get near enough to the target without letting small errors keep it in motion.
  - decelerationRadius
```
protected float decelerationRadius
```
    The radius for beginning to slow down
  - timeToTarget
```
protected float timeToTarget
```
    The time over which to achieve target speed
- Constructor Detail
  - Arrive
```
public Arrive(Steerable<T> owner)
```
    Creates an Arrive behavior for the specified owner.
    
    Parameters:
    
    owner - the owner of this behavior
  - Arrive
```
public Arrive(Steerable<T> owner,
              Location<T> target)
```
    Creates an Arrive 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.
    
    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.
  - arrive
```
protected SteeringAcceleration<T> arrive(SteeringAcceleration<T> steering,
                                         T targetPosition)
```
  - getTarget
```
public Location<T> getTarget()
```
    Returns the target to arrive to.
  - setTarget
```
public Arrive<T> setTarget(Location<T> target)
```
    Sets the target to arrive to.
    
    Returns:
    
    this behavior for chaining.
  - getArrivalTolerance
```
public float getArrivalTolerance()
```
    Returns the tolerance for arriving at the target. It lets the owner get near enough to the target without letting small errors keep it in motion.
  - setArrivalTolerance
```
public Arrive<T> setArrivalTolerance(float arrivalTolerance)
```
    Sets the tolerance for arriving at the target. It lets the owner get near enough to the target without letting small errors keep it in motion.
    
    Returns:
    
    this behavior for chaining.
  - getDecelerationRadius
```
public float getDecelerationRadius()
```
    Returns the radius for beginning to slow down.
  - setDecelerationRadius
```
public Arrive<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 speed.
  - setTimeToTarget
```
public Arrive<T> setTimeToTarget(float timeToTarget)
```
    Sets the time over which to achieve target speed.
    
    Returns:
    
    this behavior for chaining.
  - setOwner
```
public Arrive<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 Arrive<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 Arrive<T> setLimiter(Limiter limiter)
```
    Sets the limiter of this steering behavior. The given limiter must at least take care of the maximum linear speed and acceleration.
    
    Overrides:
    
    setLimiter in class SteeringBehavior<T extends com.badlogic.gdx.math.Vector<T>>
    
    Returns:
    
    this behavior for chaining.

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

target

arrivalTolerance

decelerationRadius

timeToTarget

Constructor Detail

Arrive

Arrive

Method Detail

calculateRealSteering

arrive

getTarget

setTarget

getArrivalTolerance

setArrivalTolerance

getDecelerationRadius

setDecelerationRadius

getTimeToTarget

setTimeToTarget

setOwner

setEnabled

setLimiter