FollowFlowField (libGDX AI)

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

Type Parameters:

T - Type of vector, either 2D or 3D, implementing the Vector interface
```
public class FollowFlowField<T extends com.badlogic.gdx.math.Vector<T>>
extends SteeringBehavior<T>
```
The FollowFlowField behavior produces a linear acceleration that tries to align the motion of the owner with the local tangent of a flow field. The flow field defines a mapping from a location in space to a flow vector. Any flow field can be used as the basis of this steering behavior, although it is sensitive to discontinuities in the field.
For instance, flow fields can be used for simulating various effects, such as magnetic fields, an irregular gust of wind or the meandering path of a river. They can be generated by a simple random algorithm, a Perlin noise or a complicated image processing. And of course flow fields can be dynamic. The only limit is your imagination.
Like FollowPath, this behavior can work in a predictive manner when its predictionTime is greater than 0.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FollowFlowField.FlowField<T extends com.badlogic.gdx.math.Vector<T>>` A `FlowField` defines a mapping from a location in space to a flow vector.

Field Summary

Fields
Modifier and Type	Field and Description
`protected FollowFlowField.FlowField<T>`	`flowField` The flow field to follow.
`protected float`	`predictionTime` The time in the future to predict the owner's position.

Fields inherited from class com.badlogic.gdx.ai.steer.SteeringBehavior
enabled, limiter, owner

Constructor Summary

Constructors
Constructor and Description
`FollowFlowField(Steerable<T> owner)` Creates a non-predictive `FollowFlowField` for the specified owner.
`FollowFlowField(Steerable<T> owner, FollowFlowField.FlowField<T> flowField)` Creates a non-predictive `FollowFlowField` for the specified owner and flow field.
`FollowFlowField(Steerable<T> owner, FollowFlowField.FlowField<T> flowField, float predictionTime)` Creates a `FollowFlowField` with the specified owner, flow field and prediction time.

Method Summary

All Methods Instance Methods Concrete Methods
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.
`FollowFlowField.FlowField<T>`	`getFlowField()` Returns the flow field of this behavior
`float`	`getPredictionTime()` Returns the prediction time.
`FollowFlowField<T>`	`setEnabled(boolean enabled)` Sets this steering behavior on/off.
`FollowFlowField<T>`	`setFlowField(FollowFlowField.FlowField<T> flowField)` Sets the flow field of this behavior
`FollowFlowField<T>`	`setLimiter(Limiter limiter)` Sets the limiter of this steering behavior.
`FollowFlowField<T>`	`setOwner(Steerable<T> owner)` Sets the owner of this steering behavior.
`FollowFlowField<T>`	`setPredictionTime(float predictionTime)` Sets the prediction time.

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
  - flowField
```
protected FollowFlowField.FlowField<T extends com.badlogic.gdx.math.Vector<T>> flowField
```
    The flow field to follow.
  - predictionTime
```
protected float predictionTime
```
    The time in the future to predict the owner's position. Set it to 0 for non-predictive flow field following.
- Constructor Detail
  - FollowFlowField
```
public FollowFlowField(Steerable<T> owner)
```
    Creates a non-predictive FollowFlowField for the specified owner.
    
    Parameters:
    
    owner - the owner of this behavior
  - FollowFlowField
```
public FollowFlowField(Steerable<T> owner,
                       FollowFlowField.FlowField<T> flowField)
```
    Creates a non-predictive FollowFlowField for the specified owner and flow field. Prediction time defaults to 0.
    
    Parameters:
    
    owner - the owner of this behavior
    
    flowField - the flow field to follow
  - FollowFlowField
```
public FollowFlowField(Steerable<T> owner,
                       FollowFlowField.FlowField<T> flowField,
                       float predictionTime)
```
    Creates a FollowFlowField with the specified owner, flow field and prediction time.
    
    Parameters:
    
    owner - the owner of this behavior
    
    flowField - the flow field to follow
    
    predictionTime - the time in the future to predict the owner's position. Can be 0 for non-predictive flow field following.
- 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.
  - getFlowField
```
public FollowFlowField.FlowField<T> getFlowField()
```
    Returns the flow field of this behavior
  - setFlowField
```
public FollowFlowField<T> setFlowField(FollowFlowField.FlowField<T> flowField)
```
    Sets the flow field of this behavior
    
    Parameters:
    
    flowField - the flow field to set
    
    Returns:
    
    this behavior for chaining
  - getPredictionTime
```
public float getPredictionTime()
```
    Returns the prediction time.
  - setPredictionTime
```
public FollowFlowField<T> setPredictionTime(float predictionTime)
```
    Sets the prediction time. Set it to 0 for non-predictive flow field following.
    
    Parameters:
    
    predictionTime - the predictionTime to set
    
    Returns:
    
    this behavior for chaining.
  - setOwner
```
public FollowFlowField<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 FollowFlowField<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 FollowFlowField<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 FollowFlowField<T extends com.badlogic.gdx.math.Vector<T>>

Nested Class Summary

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

flowField

predictionTime

Constructor Detail

FollowFlowField

FollowFlowField

FollowFlowField

Method Detail

calculateRealSteering

getFlowField

setFlowField

getPredictionTime

setPredictionTime

setOwner

setEnabled

setLimiter