edu.utdallas.mavs.divas.core.sim.common.state

Class HumanAgentState

java.lang.Object

edu.utdallas.mavs.divas.core.sim.common.state.AbstractState

edu.utdallas.mavs.divas.core.sim.common.state.VirtualState

edu.utdallas.mavs.divas.core.sim.common.state.AgentState

edu.utdallas.mavs.divas.core.sim.common.state.HumanAgentState

All Implemented Interfaces:

Audible, AudioPerceptor, SmellPerceptor, Visible, VisionPerceptor, State, java.io.Serializable, java.lang.Cloneable

public class HumanAgentState
extends AgentState
implements Visible, Audible, VisionPerceptor, AudioPerceptor, SmellPerceptor

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HumanAgentState.VisionShape Enumeration for vision shape of the agent.

Constructor Summary

Constructors

Constructor and Description
HumanAgentState()

Method Summary

Modifier and Type	Method and Description
java.awt.Shape	calculateVisibleRegion() Calculates the visible region of the agent represented by a spherical cone.
void	copyFrom(HumanAgentState agent) Changes the agent type, control type, heading, max speed, desired speed, visible distance, field of view, min audible threshold, acoustic emission, smell sensitivity, reach distance, posture, vision algorithm, olfactory enabled and auditory enabled of the agent with such properties from the given agent state.
float	getAcousticEmission() Gets the acoustic emission of the event's sound.
float	getAgentSize() The size of the agent
com.jme3.math.Vector3f	getAudiblePosition() Gets the position of the origin of the event's sound.
float	getCurrentSoundRadius() Gets the radius of the event's sound.
float	getDesiredSpeed() Gets the desired speed of the agent.
com.jme3.math.Vector3f	getEyePosition() Gets the eyes position of the agent
float	getFOV() Gets the field of view of the agent.
float	getHeight() Gets the height of the agent.
float	getMaxSpeed() Gets the maximum speed of the agent.
float	getMinAudibleThreshold() Gets the minimum audible threshold the agent can perceive using its hearing sense.
float	getSmellSensitivity() Gets the smell sensitivity the agent has when using its smell sense.
float	getVisibleDistance() Gets the visible distance of the agent.
com.jme3.math.Vector3f	getVisiblePosition() Gets the visible position of the event.
java.util.List<com.jme3.math.Ray>	getVisibleRegion() Returns the an array of vectors representing the agent's visible region
com.jme3.math.Vector3f	getVisibleScale() Gets the visible scale of the event.
VisionAlgorithm	getVisionAlgorithm() Gets the vision algorithm of the agent.
float	getVisionHeight() Gets the eyes level height of the agent.
boolean	isAuditoryEnabled() Flag indicating if the agent auditory sense is enabled.
boolean	isOlfactoryEnabled() Flag indicating if the agent olfactory sense is enabled.
void	setAcousticEmission(float acousticEmission) Changes the acoustic emission of sound emitted by the agent.
void	setAuditoryEnabled(boolean auditoryEnabled) Changes the flag indicating whether the agent auditory sense is enabled or not enabled.
void	setDesiredSpeed(float velocity) Changes the desired speed of the agent.
void	setFOV(float fov) Changes the field of view of the agent
void	setMaxSpeed(float maxVelocity) Changes the maximum speed of the agent.
void	setMinAudibleThreshold(float minAudibleThreshold) Changes the minimum audible threshold of the agent.
void	setOlfactoryEnabled(boolean olfactoryEnabled) Changes the flag indicating whether the agent olfactory sense is enabled or not enabled.
void	setSmellSensitivity(float smellSensitivity) Changes the smell sensitivity of the agent.
void	setVisibleDistance(float visibleDistance) Changes the visible distance of the agent.
void	setVisiblePosition(com.jme3.math.Vector3f visiblePosition) Changes the position of the agent for which other entities can perceive it.
void	setVisionAlgorithm(VisionAlgorithm visionAlgorithmName) Changes the vision algorithm of the agent.

Methods inherited from class edu.utdallas.mavs.divas.core.sim.common.state.AgentState

addCollision, canHear, canSee, canSmell, copyFrom, getAgentType, getCollisions, getControlType, getHeading, getPosition2D, getTaskNames, isAlive, setAgentType, setAlive, setControlType, setHeading, setTaskNames

Methods inherited from class edu.utdallas.mavs.divas.core.sim.common.state.VirtualState

clone, contains2D, copyFrom, getAcceleration, getBoundingArea, getBoundingVolume, getModelName, getPosition, getRotation, getScale, getVelocity, getVelocity2D, intersects, isAudible, isCollidable, isSmellable, isVisible, isVisualized, setAcceleration, setBoundingShape, setCollidable, setModelName, setPosition, setRotation, setScale, setVelocity, setVisualized, toString, updateBoundings

Methods inherited from class edu.utdallas.mavs.divas.core.sim.common.state.AbstractState

equals, getID, setID

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HumanAgentState

public HumanAgentState()

Method Detail

getMinAudibleThreshold

public float getMinAudibleThreshold()

Gets the minimum audible threshold the agent can perceive using its hearing sense.

Specified by:

getMinAudibleThreshold in interface AudioPerceptor

Returns:

the minimum audible threshold of the agent.

getSmellSensitivity

public float getSmellSensitivity()

Gets the smell sensitivity the agent has when using its smell sense.

Returns:

the smell sensitivity of the agent.

getDesiredSpeed

public float getDesiredSpeed()

Gets the desired speed of the agent.

Returns:

the desired speed of the agent.

getMaxSpeed

public float getMaxSpeed()

Gets the maximum speed of the agent.

Returns:

the desired speed of the agent.

getVisionAlgorithm

public VisionAlgorithm getVisionAlgorithm()

Gets the vision algorithm of the agent. The algorithm the agent uses to perceive with its vision sense.

Returns:

the vision algorithm.

getVisibleDistance

public float getVisibleDistance()

Gets the visible distance of the agent. Everything within this distance can be perceived by the agent using its vision sense.

Specified by:

getVisibleDistance in interface VisionPerceptor

Returns:

The visible distance.

getAcousticEmission

public float getAcousticEmission()

Description copied from interface: Audible

Gets the acoustic emission of the event's sound.

Specified by:

getAcousticEmission in interface Audible

Returns:

the acoustic emission.

getAudiblePosition

public com.jme3.math.Vector3f getAudiblePosition()

Description copied from interface: Audible

Gets the position of the origin of the event's sound.

Specified by:

getAudiblePosition in interface Audible

Returns:

the origin of the sound.

setAcousticEmission

public void setAcousticEmission(float acousticEmission)

Changes the acoustic emission of sound emitted by the agent.

Parameters:

acousticEmission - the new acoustic emission for the agent.

getVisiblePosition

public com.jme3.math.Vector3f getVisiblePosition()

Description copied from interface: Visible

Gets the visible position of the event.

Specified by:

getVisiblePosition in interface Visible

Returns:

the visible position of the event.

getVisibleScale

public com.jme3.math.Vector3f getVisibleScale()

Description copied from interface: Visible

Gets the visible scale of the event.

Specified by:

getVisibleScale in interface Visible

Returns:

the visible scale of the event.

getCurrentSoundRadius

public float getCurrentSoundRadius()

Description copied from interface: Audible

Gets the radius of the event's sound.

Specified by:

getCurrentSoundRadius in interface Audible

Returns:

the radius of the event's sound.

setMinAudibleThreshold

public void setMinAudibleThreshold(float minAudibleThreshold)

Changes the minimum audible threshold of the agent.

Parameters:

minAudibleThreshold - The new minimum audible threshold.

setSmellSensitivity

public void setSmellSensitivity(float smellSensitivity)

Changes the smell sensitivity of the agent.

Parameters:

smellSensitivity - The new smell sensitivity for the agent.

setDesiredSpeed

public void setDesiredSpeed(float velocity)

Changes the desired speed of the agent.

Parameters:

velocity - The new desired speed for the agent.

setMaxSpeed

public void setMaxSpeed(float maxVelocity)

Changes the maximum speed of the agent.

Parameters:

maxVelocity - The new maximum speed for the agent.

setVisionAlgorithm

public void setVisionAlgorithm(VisionAlgorithm visionAlgorithmName)

Changes the vision algorithm of the agent.

Specified by:

setVisionAlgorithm in interface VisionPerceptor

Parameters:

visionAlgorithmName - The new vision algorithm for the agent.

setVisibleDistance

public void setVisibleDistance(float visibleDistance)

Changes the visible distance of the agent.

Specified by:

setVisibleDistance in interface VisionPerceptor

Parameters:

visibleDistance - The new visible distance for the agent.

setVisiblePosition

public void setVisiblePosition(com.jme3.math.Vector3f visiblePosition)

Changes the position of the agent for which other entities can perceive it.

Parameters:

visiblePosition - The new visible position for the agent.

getFOV

public float getFOV()

Gets the field of view of the agent.

Specified by:

getFOV in interface VisionPerceptor

Returns:

the field of view for the agent.

setFOV

public void setFOV(float fov)

Changes the field of view of the agent

Specified by:

setFOV in interface VisionPerceptor

Parameters:

fov - The new field of view for the agent.

isOlfactoryEnabled

public boolean isOlfactoryEnabled()

Flag indicating if the agent olfactory sense is enabled.

Specified by:

isOlfactoryEnabled in interface SmellPerceptor

Returns:

true if the agent olfactory sense is enabled and false otherwise.

setOlfactoryEnabled

public void setOlfactoryEnabled(boolean olfactoryEnabled)

Changes the flag indicating whether the agent olfactory sense is enabled or not enabled.

Specified by:

setOlfactoryEnabled in interface SmellPerceptor

Parameters:

olfactoryEnabled - Flag indicating if the agent olfactory sense is enabled.

isAuditoryEnabled

public boolean isAuditoryEnabled()

Flag indicating if the agent auditory sense is enabled.

Specified by:

isAuditoryEnabled in interface AudioPerceptor

Returns:

true if the agent auditory sense is enabled and false otherwise.

setAuditoryEnabled

public void setAuditoryEnabled(boolean auditoryEnabled)

Changes the flag indicating whether the agent auditory sense is enabled or not enabled.

Specified by:

setAuditoryEnabled in interface AudioPerceptor

Parameters:

auditoryEnabled - Flag indicating if the agent auditory sense is enabled.

calculateVisibleRegion

public java.awt.Shape calculateVisibleRegion()

Calculates the visible region of the agent represented by a spherical cone.

Specified by:

calculateVisibleRegion in interface VisionPerceptor

Returns:

the visible region for the agent.

getVisibleRegion

public java.util.List<com.jme3.math.Ray> getVisibleRegion()

Returns the an array of vectors representing the agent's visible region

Returns:

visible region

getVisionHeight

public float getVisionHeight()

Gets the eyes level height of the agent.

Specified by:

getVisionHeight in interface VisionPerceptor

Returns:

the agent eyes level height.

getEyePosition

public com.jme3.math.Vector3f getEyePosition()

Gets the eyes position of the agent

Returns:

the agent eyes position

getAgentSize

public float getAgentSize()

The size of the agent

Returns:

the agent's size

getHeight

public float getHeight()

Gets the height of the agent.

Returns:

The agent height.

copyFrom

public void copyFrom(HumanAgentState agent)

Changes the agent type, control type, heading, max speed, desired speed, visible distance, field of view, min audible threshold, acoustic emission, smell sensitivity, reach distance, posture, vision algorithm, olfactory enabled and auditory enabled of the agent with such properties from the given agent state.

Parameters:

agent - The agent state to copy properties from (i.e., agent type, control type, heading) to this agent state.