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

Class SphereWanderBehaviour

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

All Implemented Interfaces:

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

public class SphereWanderBehaviour
extends AbstractStrengthSteeringBehaviour

"Wander is a type of random steering. This idea can be implemented several ways, but one that has produced good results is to constrain the steering force to the surface of a sphere located slightly ahead of the character. To produce the steering force for the next frame: a random displacement is added to the previous value, and the sum is constrained again to the sphere's surface. The sphere's radius determines the maximum wandering strength and the magnitude of the random displacement determines the wander 'rate'."

The steer force is contained in the XY plane

Version:

1.0

Author:

Jesús Martín Berlanga

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SphereWanderBehaviour.SphereWanderInvalidRandomFactor
static class	SphereWanderBehaviour.SphereWanderInvalidRotationFactor
static class	SphereWanderBehaviour.SphereWanderWithoutRadius
static class	SphereWanderBehaviour.SphereWanderWithoutTimeInterval

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 com.jme3.math.Vector3f	targetPosition Position of target
protected float	time Current time.
protected float	timeInterval Time interval durring which target position doesn't change.

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
SphereWanderBehaviour(Agent agent, float timeInterval, float randomFactor, float rotationFactor) Constructor for wander behaviour.
SphereWanderBehaviour(Agent agent, float timeInterval, float randomFactor, float rotationFactor, com.jme3.scene.Spatial spatial)

Method Summary

Methods

Modifier and Type	Method and Description
protected com.jme3.math.Vector3f	calculateFullSteering() Calculate steering vector.
protected void	calculateNewRandomDir()
protected void	changeTargetPosition(float tpf) Metod for changing target position.
protected void	controlRender(com.jme3.renderer.RenderManager rm, com.jme3.renderer.ViewPort vp)
float	getTimeInterval() Get time interval for changing target position.
void	setSphereRadius(float sphereRadius) The sphere radius is 0.75 by default.
void	setTimeInterval(float timeInterval) Setting time interval for changing target position.

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

targetPosition

protected com.jme3.math.Vector3f targetPosition

Position of target

timeInterval

protected float timeInterval

Time interval durring which target position doesn't change.

time

protected float time

Current time.

Constructor Detail

SphereWanderBehaviour

public SphereWanderBehaviour(Agent agent,
                     float timeInterval,
                     float randomFactor,
                     float rotationFactor)

Constructor for wander behaviour.

Parameters:

agent - to whom behaviour belongs

timeInterval - Sets the time interval for changing target position.

randomFactor - Defines the maximum random value

rotationFactor - Defines the maximum random variaton for each iteration.

Throws:

SphereWanderBehaviour.SphereWanderWithoutTimeInterval - If timeInterval is lower or equals to 0

SphereWanderBehaviour.SphereWanderInvalidRandomFactor - If randomFactor is not contained in the [0,1] interval

SphereWanderBehaviour.SphereWanderInvalidRotationFactor - If rotationFactor is not contained in the [0,1] interval

SphereWanderBehaviour

public SphereWanderBehaviour(Agent agent,
                     float timeInterval,
                     float randomFactor,
                     float rotationFactor,
                     com.jme3.scene.Spatial spatial)

See Also:

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

Method Detail

setSphereRadius

public void setSphereRadius(float sphereRadius)

The sphere radius is 0.75 by default. Note that low radius values can cause unexpected errors.

Throws:

SphereWanderBehaviour.SphereWanderWithoutRadius - If sphereRadius is lower or equals to 0

controlRender

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

Specified by:

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

calculateFullSteering

protected com.jme3.math.Vector3f calculateFullSteering()

Calculate steering vector.

Specified by:

calculateFullSteering in class AbstractStrengthSteeringBehaviour

Returns:

steering vector

See Also:

AbstractSteeringBehaviour.calculateSteering()

changeTargetPosition

protected void changeTargetPosition(float tpf)

Metod for changing target position.

Parameters:

tpf - time per frame

calculateNewRandomDir

protected void calculateNewRandomDir()

getTimeInterval

public float getTimeInterval()

Get time interval for changing target position.

Returns:

setTimeInterval

public void setTimeInterval(float timeInterval)

Setting time interval for changing target position.

Parameters:

timeInterval -