com.jme3.ai.agents.behaviors.npc.steering

Class AlignmentBehavior

java.lang.Object

com.jme3.scene.control.AbstractControl

com.jme3.ai.agents.behaviors.Behavior

com.jme3.ai.agents.behaviors.npc.steering.AbstractSteeringBehavior

com.jme3.ai.agents.behaviors.npc.steering.AbstractStrengthSteeringBehavior

com.jme3.ai.agents.behaviors.npc.steering.AlignmentBehavior

All Implemented Interfaces:

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

public class AlignmentBehavior
extends AbstractStrengthSteeringBehavior

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.1

Author:

Jesús Martín Berlanga

Field Summary

Fields inherited from class com.jme3.ai.agents.behaviors.npc.steering.AbstractSteeringBehavior

timePerFrame, velocity

Fields inherited from class com.jme3.ai.agents.behaviors.Behavior

agent

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

enabled, spatial

Constructor Summary

Constructors

Constructor and Description
AlignmentBehavior(Agent agent) maxAngle is setted to PI / 2 by default and maxDistance to infinite.
AlignmentBehavior(Agent agent, float maxDistance, float maxAngle) Neighbours of agent will be his team members.
AlignmentBehavior(Agent agent, float maxDistance, float maxAngle, com.jme3.scene.Spatial spatial) Neighbours of agent will be his team members.
AlignmentBehavior(Agent agent, java.util.List<GameEntity> neighbours) maxAngle is setted to PI / 2 by default and maxDistance to infinite.
AlignmentBehavior(Agent agent, java.util.List<GameEntity> neighbours, float maxDistance, float maxAngle)
AlignmentBehavior(Agent agent, java.util.List<GameEntity> neighbours, float maxDistance, float maxAngle, com.jme3.scene.Spatial spatial)
AlignmentBehavior(Agent agent, java.util.List<GameEntity> neighbours, com.jme3.scene.Spatial spatial)

Method Summary

Methods

Modifier and Type	Method and Description
protected com.jme3.math.Vector3f	calculateRawSteering() If a behavior class extend from CompoundSteeringBehaviour instead of AbstractSteeringBehavior, it must implement this method instead of calculateSteering().
void	setNeighbours(java.util.List<GameEntity> neighbours)
void	setNeighboursFromTeam(Team team)

Methods inherited from class com.jme3.ai.agents.behaviors.npc.steering.AbstractStrengthSteeringBehavior

calculateSteering, setupStrengthControl, setupStrengthControl, setupStrengthControl, setupStrengthControl, setupStrengthControl, turnOffStrengthControl

Methods inherited from class com.jme3.ai.agents.behaviors.npc.steering.AbstractSteeringBehavior

agentTotalMass, calculateNewVelocity, controlUpdate, convertToGameEntities, getBrakingFactor, getTimePerFrame, getVelocity, rotateAgent, setBrakingFactor, setTimePerFrame, setVelocity

Methods inherited from class com.jme3.ai.agents.behaviors.Behavior

controlRender

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

AlignmentBehavior

public AlignmentBehavior(Agent agent)

maxAngle is setted to PI / 2 by default and maxDistance to infinite. Neighbours of agent will be his team members.

Parameters:

agent -

AlignmentBehavior

public AlignmentBehavior(Agent agent,
                 float maxDistance,
                 float maxAngle)

Neighbours of agent will be his team members.

Parameters:

maxDistance - In order to consider a neighbour inside the neighbourhood

maxAngle - In order to consider a neighbour inside the neighbourhood

agent -

AlignmentBehavior

public AlignmentBehavior(Agent agent,
                 float maxDistance,
                 float maxAngle,
                 com.jme3.scene.Spatial spatial)

Neighbours of agent will be his team members.

Parameters:

maxDistance - In order to consider a neighbour inside the neighbourhood

maxAngle - In order to consider a neighbour inside the neighbourhood Neighbours of agent will be his team members.

spatial - active spatial during excecution of behavior

agent -

AlignmentBehavior

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

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

Parameters:

agent - To whom behavior belongs.

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

AlignmentBehavior

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

Parameters:

maxDistance - In order to consider a neighbour inside the neighbourhood

maxAngle - In order to consider a neighbour inside the neighbourhood

Throws:

NegativeMaxDistanceException - If maxDistance is lower than 0

See Also:

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

AlignmentBehavior

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

Parameters:

spatial - active spatial during excecution of behavior

See Also:

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

AlignmentBehavior

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

See Also:

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

Method Detail

calculateRawSteering

protected com.jme3.math.Vector3f calculateRawSteering()

Description copied from class: AbstractStrengthSteeringBehavior

If a behavior class extend from CompoundSteeringBehaviour instead of AbstractSteeringBehavior, it must implement this method instead of calculateSteering().

Specified by:

calculateRawSteering in class AbstractStrengthSteeringBehavior

Returns:

See Also:

AbstractSteeringBehaviour#calculateSteering()

setNeighbours

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

setNeighboursFromTeam

public void setNeighboursFromTeam(Team team)