com.jme3.ai.agents

Class Agent<T>

java.lang.Object

com.jme3.scene.control.AbstractControl

com.jme3.ai.agents.util.GameEntity

com.jme3.ai.agents.Agent<T>

All Implemented Interfaces:

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

public final class Agent<T>
extends GameEntity

Class that represents Agent.

Version:

1.7.4

Author:

Jesús Martín Berlanga, Tihomir Radosavljević

Field Summary

Fields inherited from class com.jme3.ai.agents.util.GameEntity

acceleration, hitPoints, id, mass, maxForce, maxMoveSpeed, radius, rotationSpeed, velocity

Fields inherited from class com.jme3.scene.control.AbstractControl

enabled, spatial

Constructor Summary

Constructors

Constructor and Description
Agent()
Agent(com.jme3.scene.Spatial spatial)
Agent(java.lang.String name)
Agent(java.lang.String name, com.jme3.scene.Spatial spatial)

Method Summary

Methods

Modifier and Type	Method and Description
float	computeNearestApproachPositions(Agent agent, float time) Given the time until nearest approach (predictNearestApproachTime) determine position of each vehicle at that time, and the distance between them.
float	computeNearestApproachPositions(GameEntity gameEntity, float time, com.jme3.math.Vector3f ourPositionAtNearestApproach, com.jme3.math.Vector3f hisPositionAtNearestApproach) Given the time until nearest approach (predictNearestApproachTime) determine position of each vehicle at that time, and the distance between them.
protected void	controlUpdate(float tpf)
com.jme3.renderer.Camera	getCamera()
Inventory	getInventory()
Behavior	getMainBehavior()
T	getModel()
java.lang.String	getName()
Team	getTeam()
boolean	inBoidNeighborhood(GameEntity neighbour, float minDistance, float maxDistance, float maxAngle) Check if this agent is considered in the same "neighborhood" in relation with another agent.
boolean	isSameTeam(Agent agent) Check if this agent is in same team as another agent.
float	predictNearestApproachTime(GameEntity gameEntity) Given two vehicles, based on their current positions and velocities, determine the time until nearest approach.
void	setCamera(com.jme3.renderer.Camera camera) Setting camera for agent.
void	setInventory(Inventory inventory) Setting inventory system for agent to use.
void	setMainBehavior(Behavior mainBehavior) Setting main behavior to agent.
void	setModel(T model)
void	setTeam(Team team)
void	start() Method for starting agent.
void	stop() Method for stoping agent.
java.lang.String	toString()

Methods inherited from class com.jme3.ai.agents.util.GameEntity

controlRender, distanceFromPosition, distanceRelativeToGameEntity, distanceSquaredFromPosition, distanceSquaredRelativeToGameEntity, equals, fordwardVector, forwardness, forwardness, getAcceleration, getHitPoints, getId, getLocalRotation, getLocalTranslation, getMass, getMaxForce, getMaxMoveSpeed, getMoveSpeed, getPredictedPosition, getRadius, getRotationSpeed, getVelocity, hashCode, offset, offset, setAcceleration, setHitPoints, setId, setLocalRotation, setLocalTranslation, setLocalTranslation, setMass, setMaxForce, setMaxMoveSpeed, setMoveSpeed, setRadius, setRotationSpeed, setVelocity, validateRadius

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, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Agent

public Agent()

Agent

public Agent(java.lang.String name)

Parameters:

name - name of agent

Agent

public Agent(com.jme3.scene.Spatial spatial)

Parameters:

spatial - spatial that will agent have durring game

Agent

public Agent(java.lang.String name,
     com.jme3.scene.Spatial spatial)

Parameters:

name - name of agent

spatial - spatial that will agent have durring game

Method Detail

getMainBehavior

public Behavior getMainBehavior()

Returns:

main behavior of agent

setMainBehavior

public void setMainBehavior(Behavior mainBehavior)

Setting main behavior to agent. For more how should main behavior look like:

Parameters:

mainBehavior -

See Also:

SimpleMainBehavior

getName

public java.lang.String getName()

Returns:

unique name/id of agent

start

public void start()

Method for starting agent.

See Also:

AbstractControl.enabled

stop

public void stop()

Method for stoping agent. Note: It will not remove spatial, it will just stop agent from acting.

See Also:

AbstractControl.enabled

getModel

public T getModel()

Returns:

model of agent

setModel

public void setModel(T model)

Parameters:

model - of agent

controlUpdate

protected void controlUpdate(float tpf)

Specified by:

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

getTeam

public Team getTeam()

Returns:

team in which agent belongs

setTeam

public void setTeam(Team team)

Parameters:

team - in which agent belongs

isSameTeam

public boolean isSameTeam(Agent agent)

Check if this agent is in same team as another agent.

Parameters:

agent -

Returns:

true if they are in same team, false otherwise

getCamera

public com.jme3.renderer.Camera getCamera()

Returns:

camera that is attached to agent

setCamera

public void setCamera(com.jme3.renderer.Camera camera)

Setting camera for agent. It is recommended for use mouse input.

Parameters:

camera -

getInventory

public Inventory getInventory()

Returns:

inventory that agent is using

setInventory

public void setInventory(Inventory inventory)

Setting inventory system for agent to use.

Parameters:

inventory -

inBoidNeighborhood

public boolean inBoidNeighborhood(GameEntity neighbour,
                         float minDistance,
                         float maxDistance,
                         float maxAngle)

Check if this agent is considered in the same "neighborhood" in relation with another agent.

If the distance is lower than minDistance It is definitely considered in the same neighborhood.

If the distance is higher than maxDistance It is defenitely not considered in the same neighborhood.

If the distance is inside [minDistance. maxDistance] It is considered in the same neighborhood if the forwardness is higher than "1 - sinMaxAngle".

Parameters:

GameEntity - The other agent

minDistance - Min. distance to be in the same "neighborhood"

maxDistance - Max. distance to be in the same "neighborhood"

maxAngle - Max angle in radians

Returns:

If this agent is in the same "neighborhood" in relation with another agent.

Throws:

SteeringExceptions.NegativeValueException - If minDistance or maxDistance is lower than 0

predictNearestApproachTime

public float predictNearestApproachTime(GameEntity gameEntity)

Given two vehicles, based on their current positions and velocities, determine the time until nearest approach.

Parameters:

gameEntity - Other gameEntity

Returns:

The time until nearest approach

computeNearestApproachPositions

public float computeNearestApproachPositions(Agent agent,
                                    float time)

Given the time until nearest approach (predictNearestApproachTime) determine position of each vehicle at that time, and the distance between them.

Parameters:

agent - Other agent

time - The time until nearest approach

Returns:

The time until nearest approach

See Also:

Agent#predictNearestApproachTime(com.jme3.ai.agents.Agent)

computeNearestApproachPositions

public float computeNearestApproachPositions(GameEntity gameEntity,
                                    float time,
                                    com.jme3.math.Vector3f ourPositionAtNearestApproach,
                                    com.jme3.math.Vector3f hisPositionAtNearestApproach)

Given the time until nearest approach (predictNearestApproachTime) determine position of each vehicle at that time, and the distance between them.

Anotates the positions at nearest approach in the given vectors.

Parameters:

gameEntity - Other gameEntity

time - The time until nearest approach

ourPositionAtNearestApproach - Pointer to a vector, This bector will be changed to our position at nearest approach

hisPositionAtNearestApproach - Pointer to a vector, This bector will be changed to other position at nearest approach

Returns:

The time until nearest approach

See Also:

Agent#predictNearestApproachTime(com.jme3.ai.agents.Agent)

toString

public java.lang.String toString()

Overrides:

toString in class GameEntity