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

Class ContainmentBehavior

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

All Implemented Interfaces:

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

public class ContainmentBehavior
extends AbstractStrengthSteeringBehavior

"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

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
ContainmentBehavior(Agent agent, com.jme3.scene.Node containmentArea)
ContainmentBehavior(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	calculateRawSteering() If a behavior class extend from CompoundSteeringBehaviour instead of AbstractSteeringBehavior, it must implement this method instead of calculateSteering().
protected void	processExitSurface()

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

Constructor Detail

ContainmentBehavior

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

Parameters:

containmentArea - Area where the agent will be restricted

Throws:

SteeringExceptions.InvalidAreaException - If containmentArea is null

See Also:

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

ContainmentBehavior

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

Parameters:

containmentArea - Area where the agent will be restricted

See Also:

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

Method Detail

calculateRawSteering

protected com.jme3.math.Vector3f calculateRawSteering()

Description copied from class: AbstractStrengthSteeringBehavior

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

Specified by:

calculateRawSteering in class AbstractStrengthSteeringBehavior

Returns:

See Also:

AbstractStrengthSteeringBehavior.calculateRawSteering()

processExitSurface

protected void processExitSurface()