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

Class CompoundSteeringBehavior

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

All Implemented Interfaces:

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

Direct Known Subclasses:

BalancedCompoundSteeringBehavior

public class CompoundSteeringBehavior
extends AbstractStrengthSteeringBehavior

A steer compound behavior contains one or more steer behaviors. This class should be used to avoid bugs when adding several steer behaviors directly to SimpleMainBehavior.

First add several behaviors to make an CompoundBehavior and then add this compoundBehavior to an SimpleMainBehavior.

All the steer behaviors added to this class must extend from AbstractSteeringBehavior.

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 behaviors 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	CompoundSteeringBehavior.steerBehaviorsLayerList Ordered list.

Field Summary

Fields

Modifier and Type	Field and Description
protected CompoundSteeringBehavior.steerBehaviorsLayerList	behaviors Partial behaviors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addSteerBehavior(AbstractSteeringBehavior behavior) Adds a behavior to the compound behavior.
void	addSteerBehavior(AbstractSteeringBehavior behavior, int priority, float minLengthToInvalidSteer) To optimize the process speed add the behaviors with the lowest priority first.
protected com.jme3.math.Vector3f	calculatePartialForce(AbstractSteeringBehavior behavior) Calculates the steering force of a single behavior
protected com.jme3.math.Vector3f	calculateRawSteering() Calculates the composed steering force.
protected void	controlUpdate(float tpf) Usual update pattern for steering behaviors.
void	removeSteerBehavior(AbstractSteeringBehavior behavior) Removes a behavior from the compound steer behavior.

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

Field Detail

behaviors

protected CompoundSteeringBehavior.steerBehaviorsLayerList behaviors

Partial behaviors

Constructor Detail

CompoundSteeringBehavior

public CompoundSteeringBehavior(Agent agent)

See Also:

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

CompoundSteeringBehavior

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

See Also:

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

Method Detail

addSteerBehavior

public void addSteerBehavior(AbstractSteeringBehavior behavior)

Adds a behavior to the compound behavior.

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

Parameters:

behavior - Behavior that you want to add

removeSteerBehavior

public void removeSteerBehavior(AbstractSteeringBehavior behavior)

Removes a behavior from the compound steer behavior.

Parameters:

behavior - Behavior that you want to remove

addSteerBehavior

public void addSteerBehavior(AbstractSteeringBehavior behavior,
                    int priority,
                    float minLengthToInvalidSteer)

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

Parameters:

priority - This behavior will be processed If all higher priority behaviors can be considered inactives

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

See Also:

addSteerBehavior(com.jme3.ai.agents.behaviors.npc.steering.AbstractSteeringBehavior)

calculateRawSteering

protected com.jme3.math.Vector3f calculateRawSteering()

Calculates the composed steering force. The composed force is the summatory of the behaviors steering forces.

Specified by:

calculateRawSteering in class AbstractStrengthSteeringBehavior

Returns:

The composed steering force.

See Also:

AbstractSteeringBehavior.calculateSteering()

calculatePartialForce

protected com.jme3.math.Vector3f calculatePartialForce(AbstractSteeringBehavior behavior)

Calculates the steering force of a single behavior

Parameters:

behavior - The behavior.

Returns:

The steering force of that behavior

controlUpdate

protected void controlUpdate(float tpf)

Usual update pattern for steering behaviors.

Overrides:

controlUpdate in class AbstractSteeringBehavior

Parameters:

tpf -