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

Class SphereWanderBehavior

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

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

All Implemented Interfaces:

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

public class SphereWanderBehavior
extends AbstractWanderBehavior

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

See Also:

AbstractWander

Field Summary

Fields

Modifier and Type	Field and Description
protected com.jme3.math.Vector3f	targetPosition Position of target.
protected float	time Current time.

Fields inherited from class com.jme3.ai.agents.behaviors.npc.steering.AbstractWanderBehavior

timeInterval

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	calculateNewRandomDir()
protected com.jme3.math.Vector3f	calculateRawSteering() Calculate steering vector.
protected void	changeTargetPosition(float tpf) Metod for changing target position.
void	setSphereRadius(float sphereRadius) The sphere radius is 0.75 by default.

Methods inherited from class com.jme3.ai.agents.behaviors.npc.steering.AbstractWanderBehavior

getTimeInterval, setTimeInterval

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

Field Detail

targetPosition

protected com.jme3.math.Vector3f targetPosition

Position of target.

time

protected float time

Current time.

Constructor Detail

SphereWanderBehavior

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

Constructor for wander behavior.

Parameters:

agent - to whom behavior 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:

SteeringExceptions.NegativeValueException - If timeInterval is lower or equals to 0

SteeringExceptions.IllegalIntervalException - If randomFactor is not contained in the [0,1] interval or if rotationFactor is not contained in the [0,1] interval

SphereWanderBehavior

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

See Also:

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

Method Detail

calculateRawSteering

protected com.jme3.math.Vector3f calculateRawSteering()

Calculate steering vector.

Specified by:

calculateRawSteering in class AbstractStrengthSteeringBehavior

Returns:

steering vector

See Also:

AbstractSteeringBehavior.calculateSteering()

changeTargetPosition

protected void changeTargetPosition(float tpf)

Metod for changing target position.

Parameters:

tpf - time per frame

calculateNewRandomDir

protected void calculateNewRandomDir()

setSphereRadius

public void setSphereRadius(float sphereRadius)

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

Throws:

SteeringExceptions.NegativeValueException - If sphereRadius is lower or equals to 0