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

Class AbstractStrengthSteeringBehaviour

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AlignmentBehaviour, BoxExploreBehaviour, CohesionBehaviour, CompoundSteeringBehaviour, ContainmentBehaviour, FleeBehaviour, HideBehaviour, MoveBehaviour, ObstacleAvoidanceBehaviour, PathFollowBehaviour, QueuingBehaviour, SeekBehaviour, SeparationBehaviour, SlowBehaviour, SphereWanderBehaviour, WallApproachBehaviour, WanderBehaviour

public abstract class AbstractStrengthSteeringBehaviour
extends AbstractSteeringBehaviour

With this class it will be possible to increase or decrease the steering behaviour force.

It can be changed the length of this vector itself, multiplying it by a scalar or modifying the force on a especific axis (x, y, z)

This class also allows you force the steering to stay within a plane.

You need to call setupStrengthControl( ... ), otherwhise this class will work the same as AstractSteeringBehaviour.

Version:

2.1.0

Author:

Jesús Martín Berlanga

See Also:

SteerStrengthType, AbstractSteeringBehaviour

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	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
AbstractStrengthSteeringBehaviour(Agent agent)
AbstractStrengthSteeringBehaviour(Agent agent, com.jme3.scene.Spatial spatial)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract com.jme3.math.Vector3f	calculateFullSteering() If a bheaviour class extend from CompoundSteeringBehaviour instead of AbstractSteeringBehaviout, It must implement this method instead of calculateSteering().
protected com.jme3.math.Vector3f	calculateSteering() Calculates the steering force with the especified strength.
void	setupStrengthControl(float scalar) If you call this function you will be able to increase or decrease the steering behaviour force multiplying it by a scalar.
void	setupStrengthControl(float x, float y, float z) If you call this function you will be able to modify the full steering force on a especific axis (x, y, z)
void	setupStrengthControl(com.jme3.math.Plane plane) Forces the steer to stay inside a plane.
void	setupStrengthControl(com.jme3.math.Plane plane, float scalar)
void	turnOffStrengthControl() If this function is called, this class work as AbstractSteeringBehaviour.

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

AbstractStrengthSteeringBehaviour

public AbstractStrengthSteeringBehaviour(Agent agent)

See Also:

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

AbstractStrengthSteeringBehaviour

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

See Also:

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

Method Detail

setupStrengthControl

public void setupStrengthControl(float scalar)

If you call this function you will be able to increase or decrease the steering behaviour force multiplying it by a scalar.

Parameters:

scalar - Escalar that will multiply the full steer force.

Throws:

AbstractStrengthSteeringBehaviour.negativeScalarMultiplier - If scalar is lower than 0

setupStrengthControl

public void setupStrengthControl(float x,
                        float y,
                        float z)

If you call this function you will be able to modify the full steering force on a especific axis (x, y, z)

Parameters:

x - X axis multiplier

y - Y axis multiplier

z - Z axis multiplier

Throws:

AbstractStrengthSteeringBehaviour.negativeScalarMultiplier - If any axis multiplier is lower than 0

setupStrengthControl

public void setupStrengthControl(com.jme3.math.Plane plane)

Forces the steer to stay inside a plane.

Parameters:

Plane - plane where the steer will be

setupStrengthControl

public void setupStrengthControl(com.jme3.math.Plane plane,
                        float scalar)

See Also:

setupStrengthControl(float), setupStrengthControl(com.jme3.math.Plane)

turnOffStrengthControl

public void turnOffStrengthControl()

If this function is called, this class work as AbstractSteeringBehaviour.

See Also:

AbstractSteeringBehaviour

calculateSteering

protected com.jme3.math.Vector3f calculateSteering()

Calculates the steering force with the especified strength.

If the strength was not setted up it the return calculateSteering(), the unmodified force.

Specified by:

calculateSteering in class AbstractSteeringBehaviour

Returns:

The steering force with the especified strength.

calculateFullSteering

protected abstract com.jme3.math.Vector3f calculateFullSteering()

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

See Also:

AbstractSteeringBehaviour.calculateSteering()