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

Class AbstractStrengthSteeringBehavior

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractWanderBehavior, AlignmentBehavior, BoxExploreBehavior, CohesionBehavior, CompoundSteeringBehavior, ContainmentBehavior, FleeBehavior, HideBehavior, MoveBehavior, ObstacleAvoidanceBehavior, PathFollowBehavior, QueuingBehavior, SeekBehavior, SeparationBehavior, WallApproachBehavior

public abstract class AbstractStrengthSteeringBehavior
extends AbstractSteeringBehavior

With this class it will be possible to increase or decrease the steering behavior 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 AstractSteeringBehavior.

Version:

2.1.1

Author:

Jesús Martín Berlanga, Tihomir Radosavljević - Javadoc, renaming and exceptions (contained in an external class) updates by Tihomir Radosavljević

See Also:

SteerStrengthType, AbstractSteeringBehavior

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

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract com.jme3.math.Vector3f	calculateRawSteering() If a behavior class extend from CompoundSteeringBehaviour instead of AbstractSteeringBehavior, it must implement this method instead of calculateSteering().
protected com.jme3.math.Vector3f	calculateSteering() Calculates the steering force with the specified strength.
void	setupStrengthControl(float scalar) If you call this function you will be able to increase or decrease the steering behavior 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 raw steering force on the specific 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	setupStrengthControl(com.jme3.math.Vector3f vector) If you call this function you will be able to modify the raw steering force on the specific axis (x, y, z).
void	turnOffStrengthControl() If this function is called, this class work as AbstractSteeringBehavior.

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

AbstractStrengthSteeringBehavior

public AbstractStrengthSteeringBehavior(Agent agent)

See Also:

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

AbstractStrengthSteeringBehavior

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

See Also:

AbstractSteeringBehavior.AbstractSteeringBehavior(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 behavior force multiplying it by a scalar.

Parameters:

scalar - Scalar that will multiply the raw steer force.

Throws:

SteeringExceptions.NegativeValueException - 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 raw steering force on the specific axis (x, y, z).

Parameters:

x - X axis multiplier

y - Y axis multiplier

z - Z axis multiplier

Throws:

SteeringExceptions.NegativeValueException - If any axis multiplier is lower than 0

setupStrengthControl

public void setupStrengthControl(com.jme3.math.Vector3f vector)

If you call this function you will be able to modify the raw steering force on the specific axis (x, y, z).

Parameters:

x - X axis multiplier

y - Y axis multiplier

z - Z axis multiplier

Throws:

SteeringExceptions.NegativeValueException - 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 AbstractSteeringBehavior.

See Also:

AbstractSteeringBehavior

calculateSteering

protected com.jme3.math.Vector3f calculateSteering()

Calculates the steering force with the specified strength.

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

Specified by:

calculateSteering in class AbstractSteeringBehavior

Returns:

The steering force with the specified strength.

calculateRawSteering

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

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

Returns:

See Also:

AbstractSteeringBehavior.calculateSteering()