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

Class CompoundSteeringBehaviour

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BalancedCompoundSteeringBehaviour

public class CompoundSteeringBehaviour
extends AbstractStrengthSteeringBehaviour

A steer compound behaviour contains one or more steer behaviours. This class should be used to avoid bugs when adding several steer behaviours to SimpleMainBehaviour.

Fist add several behaviours to make an CompoundBehaviour and then add this compoundBehaviour to an SimpleMainBehaviour.

All the steer behaviours added to this class must extend from AbstractSteeringBehaviour.

If you have issues related with components cancelling each other out, that "can be addressed by assigning a priority to components (For example: first priority is obstacle avoidance, second is evasion ...)."

The steering controller first checks the higher layer to see if all the behaviours returns a value higher than 'minLengthToInvalidSteer', if so it uses that layer. Otherwise, it moves on to the second layer, and so on.

Version:

2.1

Author:

Jesús Martín Berlanga

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	CompoundSteeringBehaviour.steerBehavioursLayerList Ordered list.

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

Modifier and Type	Field and Description
protected CompoundSteeringBehaviour.steerBehavioursLayerList	behaviours Partial behaviours

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
CompoundSteeringBehaviour(Agent agent)
CompoundSteeringBehaviour(Agent agent, com.jme3.scene.Spatial spatial)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSteerBehaviour(AbstractSteeringBehaviour behaviour) Adds a behaviour to the compound behaviour.
void	addSteerBehaviour(AbstractSteeringBehaviour behaviour, int priority, float minLengthToInvalidSteer) To optimize the process speed add the behaviours with the lowest priority first.
protected com.jme3.math.Vector3f	calculateFullSteering() Calculates the composed steering force.
protected com.jme3.math.Vector3f	calculatePartialForce(AbstractSteeringBehaviour behaviour) Calculates the steering force of a single behaviour
protected void	controlRender(com.jme3.renderer.RenderManager rm, com.jme3.renderer.ViewPort vp)
protected void	controlUpdate(float tpf) Usual update pattern for steering behaviours.
void	removeSteerBehaviour(AbstractSteeringBehaviour behaviour) Removes a behaviour from the compound steer behaviour.

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, 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

Field Detail

behaviours

protected CompoundSteeringBehaviour.steerBehavioursLayerList behaviours

Partial behaviours

Constructor Detail

CompoundSteeringBehaviour

public CompoundSteeringBehaviour(Agent agent)

See Also:

AbstractSteeringBehaviour.AbstractSteeringBehaviour(com.jme3.ai.agents.Agent)

CompoundSteeringBehaviour

public CompoundSteeringBehaviour(Agent agent,
                         com.jme3.scene.Spatial spatial)

See Also:

AbstractSteeringBehaviour.AbstractSteeringBehaviour(com.jme3.ai.agents.Agent, com.jme3.scene.Spatial)

Method Detail

addSteerBehaviour

public void addSteerBehaviour(AbstractSteeringBehaviour behaviour)

Adds a behaviour to the compound behaviour.

Layer and the min length to consider the behaviour invalid are 0 by default.

Parameters:

behaviour - Behaviour that you want to add

removeSteerBehaviour

public void removeSteerBehaviour(AbstractSteeringBehaviour behaviour)

Removes a behaviour from the compound steer behaviour.

Parameters:

behaviour - Behaviour that you want to remove

addSteerBehaviour

public void addSteerBehaviour(AbstractSteeringBehaviour behaviour,
                     int priority,
                     float minLengthToInvalidSteer)

To optimize the process speed add the behaviours with the lowest priority first.

Parameters:

priority - This behaviour will be processed If all higher priority behaviours can be considered inactives

minLengthToInvalidSteer - If the behaviour steer force length is less than this value It will be considered inactive

See Also:

addSteerBehaviour(com.jme3.ai.agents.behaviours.npc.steering.AbstractSteeringBehaviour)

calculateFullSteering

protected com.jme3.math.Vector3f calculateFullSteering()

Calculates the composed steering force. The composed force is the sumatory of the behaviours steering forces.

Specified by:

calculateFullSteering in class AbstractStrengthSteeringBehaviour

Returns:

The composed steering force.

See Also:

AbstractSteeringBehaviour.calculateSteering()

calculatePartialForce

protected com.jme3.math.Vector3f calculatePartialForce(AbstractSteeringBehaviour behaviour)

Calculates the steering force of a single behaviour

Parameters:

behaviour - The behaviour.

Returns:

The steering force of that behaviour

controlRender

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

Specified by:

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

controlUpdate

protected void controlUpdate(float tpf)

Usual update pattern for steering behaviours.

Overrides:

controlUpdate in class AbstractSteeringBehaviour

Parameters:

tpf -