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

Class ContainmentBehaviour

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

All Implemented Interfaces:

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

public class ContainmentBehaviour
extends AbstractStrengthSteeringBehaviour

"Containment refers to motion which is restricted to remain within a certain region."

"To implement: first predict our character's future position, if it is inside the allowed region no corrective steering is necessary. Otherwise we steer towards the allowed region."

"Examples of containment include: fish swimming in an aquarium and hockey players skating within an ice rink."

Version:

1.0.1

Author:

Jesús Martín Berlanga

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContainmentBehaviour.ContainmentWithInvalidContainmenetArea
static class	ContainmentBehaviour.ContainmentWithoutContainmentArea

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

Method Summary

Methods

Modifier and Type	Method and Description
protected com.jme3.math.Vector3f	calculateFullSteering() If a bheaviour class extend from CompoundSteeringBehaviour instead of AbstractSteeringBehaviout, It must implement this method instead of calculateSteering().
protected void	controlRender(com.jme3.renderer.RenderManager rm, com.jme3.renderer.ViewPort vp)
protected void	processExitSurface()

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

Constructor Detail

ContainmentBehaviour

public ContainmentBehaviour(Agent agent,
                    com.jme3.scene.Node containmentArea)

Parameters:

containmentArea - Area where the agent will be restricted

Throws:

ContainmentBehaviour.ContainmentWithoutContainmentArea - If containmentArea is null

See Also:

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

ContainmentBehaviour

public ContainmentBehaviour(Agent agent,
                    com.jme3.scene.Node containmentArea,
                    com.jme3.scene.Spatial spatial)

Parameters:

containmentArea - Area where the agent will be restricted

See Also:

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

Method Detail

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()

Description copied from class: AbstractStrengthSteeringBehaviour

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

Specified by:

calculateFullSteering in class AbstractStrengthSteeringBehaviour

See Also:

AbstractStrengthSteeringBehaviour.calculateFullSteering()

processExitSurface

protected void processExitSurface()