com.jme3.ai.agents.behaviours.npc.steering

Class AlignmentBehaviour

java.lang.Object

com.jme3.scene.control.AbstractControl

com.jme3.ai.agents.behaviours.Behaviour

com.jme3.ai.agents.behaviours.npc.steering.AbstractSteeringBehaviour

com.jme3.ai.agents.behaviours.npc.steering.AbstractStrengthSteeringBehaviour

com.jme3.ai.agents.behaviours.npc.steering.AlignmentBehaviour

All Implemented Interfaces:

com.jme3.export.Savable, com.jme3.scene.control.Control

public class AlignmentBehaviour
extends AbstractStrengthSteeringBehaviour

Craig W. Reynolds: "Alignment steering behavior gives an character the ability to align itself with (that is, head in the same direction as) other nearby characters. Steering for alignment can be computed by finding all characters in the local neighborhood, averaging the unit forward vector of the nearby characters. This average is the “desired velocity,” and so the steering vector is the difference between the average and our character’s forward vector. This steering will tend to turn our character so it is aligned with its neighbors."

Version:

1.2

Author:

Jesús Martín Berlanga

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AlignmentBehaviour.negativeMaxDistance

Nested classes/interfaces inherited from class com.jme3.ai.agents.behaviours.npc.steering.AbstractStrengthSteeringBehaviour

AbstractStrengthSteeringBehaviour.negativeScalarMultiplier

Nested classes/interfaces inherited from class com.jme3.ai.agents.behaviours.npc.steering.AbstractSteeringBehaviour

AbstractSteeringBehaviour.IllegalBrakingFactor

Nested classes/interfaces inherited from class com.jme3.ai.agents.behaviours.Behaviour

Behaviour.behaviourNullAgentException

Field Summary

Fields inherited from class com.jme3.ai.agents.behaviours.npc.steering.AbstractSteeringBehaviour

velocity

Fields inherited from class com.jme3.ai.agents.behaviours.Behaviour

agent

Fields inherited from class com.jme3.scene.control.AbstractControl

enabled, spatial

Constructor Summary

Constructors

Constructor and Description
AlignmentBehaviour(Agent agent, java.util.List<Agent> neighbours) maxAngle is setted to PI / 2 by default and maxDistance to infinite.
AlignmentBehaviour(Agent agent, java.util.List<Agent> neighbours, float maxDistance, float maxAngle)
AlignmentBehaviour(Agent agent, java.util.List<Agent> neighbours, float maxDistance, float maxAngle, com.jme3.scene.Spatial spatial)
AlignmentBehaviour(Agent agent, java.util.List<Agent> neighbours, com.jme3.scene.Spatial spatial)

Method Summary

Methods

Modifier and Type	Method and Description
protected com.jme3.math.Vector3f	calculateFullSteering() If a bheaviour class extend from CompoundSteeringBehaviour instead of AbstractSteeringBehaviout, It must implement this method instead of calculateSteering().
protected void	controlRender(com.jme3.renderer.RenderManager rm, com.jme3.renderer.ViewPort vp)
void	setNeighbours(java.util.List<Agent> neighbours)

Methods inherited from class com.jme3.ai.agents.behaviours.npc.steering.AbstractStrengthSteeringBehaviour

calculateSteering, setupStrengthControl, setupStrengthControl, setupStrengthControl, setupStrengthControl, turnOffStrengthControl

Methods inherited from class com.jme3.ai.agents.behaviours.npc.steering.AbstractSteeringBehaviour

agentTotalMass, calculateNewVelocity, controlUpdate, getBrakingFactor, getTPF, getVelocity, rotateAgent, setBrakingFactor, setTPF, setVelocity

Methods inherited from class com.jme3.scene.control.AbstractControl

cloneForSpatial, getSpatial, isEnabled, read, render, setEnabled, setSpatial, update, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlignmentBehaviour

public AlignmentBehaviour(Agent agent,
                  java.util.List<Agent> neighbours)

maxAngle is setted to PI / 2 by default and maxDistance to infinite.

Parameters:

agent - To whom behaviour belongs.

neighbours - Neighbours, this agent is moving toward the center of this neighbours.

AlignmentBehaviour

public AlignmentBehaviour(Agent agent,
                  java.util.List<Agent> neighbours,
                  float maxDistance,
                  float maxAngle)

Parameters:

maxDistance - In order to consider a neihbour inside the neighbourhood

maxAngle - In order to consider a neihbour inside the neighbourhood

Throws:

AlignmentBehaviour.negativeMaxDistance - If maxDistance is lower than 0

See Also:

Agent#inBoidNeighborhoodMaxAngle(com.jme3.ai.agents.Agent, float, float, float), AlignmentBehaviour(com.jme3.ai.agents.Agent, java.util.List)

AlignmentBehaviour

public AlignmentBehaviour(Agent agent,
                  java.util.List<Agent> neighbours,
                  com.jme3.scene.Spatial spatial)

Parameters:

spatial - active spatial during excecution of behaviour

See Also:

AlignmentBehaviour(com.jme3.ai.agents.Agent, java.util.List)

AlignmentBehaviour

public AlignmentBehaviour(Agent agent,
                  java.util.List<Agent> neighbours,
                  float maxDistance,
                  float maxAngle,
                  com.jme3.scene.Spatial spatial)

See Also:

AlignmentBehaviour(com.jme3.ai.agents.Agent, java.util.List), AlignmentBehaviour(com.jme3.ai.agents.Agent, java.util.List, float, float)

Method Detail

setNeighbours

public void setNeighbours(java.util.List<Agent> neighbours)

calculateFullSteering

protected com.jme3.math.Vector3f calculateFullSteering()

Description copied from class: AbstractStrengthSteeringBehaviour

If a bheaviour class extend from CompoundSteeringBehaviour instead of AbstractSteeringBehaviout, It must implement this method instead of calculateSteering().

Specified by:

calculateFullSteering in class AbstractStrengthSteeringBehaviour

See Also:

AbstractSteeringBehaviour.calculateSteering()

controlRender

protected void controlRender(com.jme3.renderer.RenderManager rm,
                 com.jme3.renderer.ViewPort vp)

Specified by:

controlRender in class com.jme3.scene.control.AbstractControl