OdorWorldEntity (Simbrain API)

java.lang.Object
- org.simbrain.world.odorworld.entities.OdorWorldEntity

Direct Known Subclasses:

BasicEntity, RotatingEntity
```
public abstract class OdorWorldEntity
extends java.lang.Object
```
Parent class for all Odor World objects. Adapted and extended from From Developing Games in Java, by David Brackeen.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Behavior`	`behavior` Behavior.
`protected float`	`dx` X Velocity.
`protected float`	`dy` Y Velocity.
`protected float`	`x` X Position.
`protected float`	`y` Y Position.

Constructor Summary

Constructors
Constructor and Description
`OdorWorldEntity(Animation anim, OdorWorld world)` Construct an entity from an animation.
`OdorWorldEntity(OdorWorld world)` Construct an entity.
`OdorWorldEntity(java.lang.String imageLocation, OdorWorld world)` Construct an odor world entity from a single image location.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEffector(Effector effector)` Add an effector.
`void`	`addSensor(Sensor sensor)` Add a sensor.
`void`	`addTileSensors(int numTilesX, int numTilesY)` Add a grid of tile sensors.
`void`	`addTileSensors(int numTilesX, int numTilesY, int offset)` Add a grid of tile sensors, offset by some fraction of a tile's length.
`void`	`applyEffectors()` Apply impact of all effectors.
`void`	`collideHorizontal()` Called before update() if the creature collided with a tile horizontally.
`void`	`collideVertical()` Called before update() if the creature collided with a tile vertically.
`Animation`	`getAnimation()`
`Behavior`	`getBehavior()` Return the current behavior.
`java.awt.Rectangle`	`getBounds()` Get bounds, based on current image.
`double[]`	`getCenterLocation()` Returns the location of the center of this entity as a double array.
`double`	`getCenterX()` Returns the center x position of this entity.
`double`	`getCenterY()` Returns the center y position of this entity.
`java.util.List<java.lang.String>`	`getCurrentlyHeardPhrases()`
`double`	`getDoubleX()` Get the X position as a double.
`double`	`getDoubleY()` Get the Y position as a double.
`java.util.List<Effector>`	`getEffectors()`
`int`	`getHeight()` Gets this OdorWorldEntity's height, based on the size of the current image.
`java.lang.String`	`getId()`
`java.awt.Image`	`getImage()` Gets this OdorWorldEntity's current image.
`double[]`	`getLocation()` Returns the location of the entity as a double array.
`java.lang.String`	`getName()` Get the entity's name.
`OdorWorld`	`getParentWorld()`
`java.awt.Rectangle`	`getReducedBounds()` Reduced bounds used for some entities, to improve the look of collisions and blocking.
`java.util.List<Sensor>`	`getSensors()`
`SmellSource`	`getSmellSource()`
`float`	`getVelocityX()` Gets the horizontal velocity of this OdorWorldEntity in pixels per millisecond.
`float`	`getVelocityY()` Gets the vertical velocity of this OdorWorldEntity in pixels per millisecond.
`int`	`getWidth()` Gets this OdorWorldEntity's width, based on the size of the current image.
`float`	`getX()` Gets this OdorWorldEntity's current x position.
`float`	`getY()` Gets this OdorWorldEntity's current y position.
`boolean`	`hasCollided()`
`boolean`	`isBlocked()` Returns true if the entity is blocked from moving.
`boolean`	`isEffectorsEnabled()`
`boolean`	`isInBoundsX(float x)` Check whether, if the provided point is used to set the x (upper left) coordinate of the entity, the bounds of the object will be in bounds.
`boolean`	`isInBoundsY(float y)` Check whether, if the provided point is used to set the y (upper left) coordinate of the entity, the bounds of the object will be in bounds.
`boolean`	`isSensorsEnabled()`
`boolean`	`isShowSensors()`
`void`	`moveEast(double amount)` Move the object east by the specified amount in pixels.
`void`	`moveNorth(double amount)` Move the object north by the specified amount in pixels.
`void`	`moveSouth(double amount)` Move the object south by the specified amount in pixels.
`void`	`moveWest(double amount)` Move the object west by the specified amount in pixels.
`void`	`postSerializationInit()` Initialize the animation from stored image location(s).
`void`	`removeEffector(Effector effector)` Removes an effector.
`void`	`removeSensor(Sensor sensor)` Removes a sensor.
`void`	`setAnimation(Animation animation)`
`void`	`setCenterLocation(float x, float y)` Set the location of this entity.
`void`	`setEffectors(java.util.List<Effector> effectors)`
`void`	`setEffectorsEnabled(boolean effectorsEnabled)`
`void`	`setHasCollided(boolean collission)`
`void`	`setId(java.lang.String id)`
`void`	`setLocation(float x, float y)` Set the location of this entity.
`void`	`setName(java.lang.String name)` Set the entity's name.
`void`	`setSensors(java.util.List<Sensor> sensors)`
`void`	`setSensorsEnabled(boolean sensorsEnabled)`
`void`	`setShowSensors(boolean showSensors)`
`void`	`setSmellSource(SmellSource smellSource)`
`void`	`setVelocityX(float dx)` Sets the horizontal velocity of this OdorWorldEntity in pixels per millisecond.
`void`	`setVelocityY(float dy)` Sets the vertical velocity of this OdorWorldEntity in pixels per millisecond.
`void`	`setX(double x)`
`void`	`setX(float newx)` Sets this OdorWorldEntity's current x position.
`void`	`setY(double y)`
`void`	`setY(float newy)` Sets this OdorWorldEntity's current y position.
`void`	`speakToEntity(java.lang.String phrase)` Add a phrase to the list of things currently being said.
`void`	`update()` Updates this OdorWorldEntity's Animation and its position based on the velocity.
`void`	`updateSensors()` Update all sensors.
`void`	`updateSmellSource()` Update this object's smell source, if any.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - x
```
protected float x
```
    X Position.
  - y
```
protected float y
```
    Y Position.
  - dx
```
protected float dx
```
    X Velocity.
  - dy
```
protected float dy
```
    Y Velocity.
  - behavior
```
protected Behavior behavior
```
    Behavior.
- Constructor Detail
  - OdorWorldEntity
```
public OdorWorldEntity(Animation anim,
                       OdorWorld world)
```
    Construct an entity from an animation.
    
    Parameters:
    
    anim - animation to use.
    
    world - parent world
  - OdorWorldEntity
```
public OdorWorldEntity(java.lang.String imageLocation,
                       OdorWorld world)
```
    Construct an odor world entity from a single image location.
    
    Parameters:
    
    imageLocation - the image location
    
    world -
  - OdorWorldEntity
```
public OdorWorldEntity(OdorWorld world)
```
    Construct an entity.
    
    Parameters:
    
    world - parent world of entity
- Method Detail
  - update
```
public void update()
```
    Updates this OdorWorldEntity's Animation and its position based on the velocity.
  - collideHorizontal
```
public void collideHorizontal()
```
    Called before update() if the creature collided with a tile horizontally.
  - collideVertical
```
public void collideVertical()
```
    Called before update() if the creature collided with a tile vertically.
  - getX
```
public float getX()
```
    Gets this OdorWorldEntity's current x position.
    
    Returns:
  - getY
```
public float getY()
```
    Gets this OdorWorldEntity's current y position.
    
    Returns:
  - setX
```
public void setX(float newx)
```
    Sets this OdorWorldEntity's current x position.
    
    Parameters:
    
    newx -
  - setY
```
public void setY(float newy)
```
    Sets this OdorWorldEntity's current y position.
    
    Parameters:
    
    newy -
  - isInBoundsX
```
public boolean isInBoundsX(float x)
```
    Check whether, if the provided point is used to set the x (upper left) coordinate of the entity, the bounds of the object will be in bounds.
    
    Parameters:
    
    x - the point to check
    
    Returns:
    
    whether the point is in bounds or not.
  - isInBoundsY
```
public boolean isInBoundsY(float y)
```
    Check whether, if the provided point is used to set the y (upper left) coordinate of the entity, the bounds of the object will be in bounds.
    
    Parameters:
    
    y - the point to check
    
    Returns:
    
    whether the point is in bounds or not.
  - getWidth
```
public int getWidth()
```
    Gets this OdorWorldEntity's width, based on the size of the current image.
    
    Returns:
  - getHeight
```
public int getHeight()
```
    Gets this OdorWorldEntity's height, based on the size of the current image.
    
    Returns:
  - getVelocityX
```
public float getVelocityX()
```
    Gets the horizontal velocity of this OdorWorldEntity in pixels per millisecond.
    
    Returns:
  - getVelocityY
```
public float getVelocityY()
```
    Gets the vertical velocity of this OdorWorldEntity in pixels per millisecond.
    
    Returns:
  - setVelocityX
```
public void setVelocityX(float dx)
```
    Sets the horizontal velocity of this OdorWorldEntity in pixels per millisecond.
    
    Parameters:
    
    dx -
  - setVelocityY
```
public void setVelocityY(float dy)
```
    Sets the vertical velocity of this OdorWorldEntity in pixels per millisecond.
    
    Parameters:
    
    dy -
  - getName
```
public java.lang.String getName()
```
    Get the entity's name.
    
    Returns:
    
    entity's name.
  - setName
```
public void setName(java.lang.String name)
```
    Set the entity's name.
    
    Parameters:
    
    name - string name for entity.
  - getId
```
public java.lang.String getId()
```
    Returns:
    
    the id
  - setId
```
public void setId(java.lang.String id)
```
    Parameters:
    
    id - the id to set
  - getImage
```
public java.awt.Image getImage()
```
    Gets this OdorWorldEntity's current image.
    
    Returns:
  - getBounds
```
public java.awt.Rectangle getBounds()
```
    Get bounds, based on current image.
    
    Returns:
    
    bounds of this entity.
  - getReducedBounds
```
public java.awt.Rectangle getReducedBounds()
```
    Reduced bounds used for some entities, to improve the look of collisions and blocking. TODO: This may not work well when shapes (not pixel images) are used.
    
    Returns:
    
    reduced bounds.
  - addEffector
```
public void addEffector(Effector effector)
```
    Add an effector.
    
    Parameters:
    
    effector - effector to add
  - removeEffector
```
public void removeEffector(Effector effector)
```
    Removes an effector.
    
    Parameters:
    
    effector - effector to remove
  - addSensor
```
public void addSensor(Sensor sensor)
```
    Add a sensor.
    
    Parameters:
    
    sensor - sensor to add
  - removeSensor
```
public void removeSensor(Sensor sensor)
```
    Removes a sensor.
    
    Parameters:
    
    sensor - sensor to remove
  - applyEffectors
```
public void applyEffectors()
```
    Apply impact of all effectors.
  - updateSensors
```
public void updateSensors()
```
    Update all sensors.
  - addTileSensors
```
public void addTileSensors(int numTilesX,
                           int numTilesY)
```
    Add a grid of tile sensors.
    
    Parameters:
    
    numTilesX - number of rows in grid
    
    numTilesY - number of columns in grid
  - addTileSensors
```
public void addTileSensors(int numTilesX,
                           int numTilesY,
                           int offset)
```
    Add a grid of tile sensors, offset by some fraction of a tile's length.
    
    Parameters:
    
    numTilesX - number of rows in grid
    
    numTilesY - number of columns in grid
    
    offset - offset amount in pixels
  - getSmellSource
```
public SmellSource getSmellSource()
```
    Returns:
    
    the smellSource
  - setSmellSource
```
public void setSmellSource(SmellSource smellSource)
```
    Parameters:
    
    smellSource - the smellSource to set
  - getParentWorld
```
public OdorWorld getParentWorld()
```
    Returns:
    
    the parentWorld
  - getCenterLocation
```
public double[] getCenterLocation()
```
    Returns the location of the center of this entity as a double array.
    
    Returns:
    
    center location of the entity.
  - getCenterX
```
public double getCenterX()
```
    Returns the center x position of this entity.
    
    Returns:
    
    center x coordinate.
  - getCenterY
```
public double getCenterY()
```
    Returns the center y position of this entity.
    
    Returns:
    
    center y coordinate.
  - setCenterLocation
```
public void setCenterLocation(float x,
                              float y)
```
    Set the location of this entity.
    
    Parameters:
    
    x - x coordinate
    
    y - y coordinate
  - getLocation
```
public double[] getLocation()
```
    Returns the location of the entity as a double array.
    
    Returns:
    
    location of the entity.
  - setLocation
```
public void setLocation(float x,
                        float y)
```
    Set the location of this entity.
    
    Parameters:
    
    x - x coordinate
    
    y - y coordinate
  - getAnimation
```
public Animation getAnimation()
```
    Returns:
    
    the animation associated with this entity
  - setAnimation
```
public void setAnimation(Animation animation)
```
    Parameters:
    
    animation - the animation to set
  - postSerializationInit
```
public void postSerializationInit()
```
    Initialize the animation from stored image location(s).
  - getSensors
```
public java.util.List<Sensor> getSensors()
```
    Returns:
    
    the sensors
  - setSensors
```
public void setSensors(java.util.List<Sensor> sensors)
```
    Parameters:
    
    sensors - the sensors to set
  - getEffectors
```
public java.util.List<Effector> getEffectors()
```
    Returns:
    
    the effectors
  - setEffectors
```
public void setEffectors(java.util.List<Effector> effectors)
```
    Parameters:
    
    effectors - the effectors to set
  - hasCollided
```
public boolean hasCollided()
```
    Returns:
    
    true if a collision occurred
  - setHasCollided
```
public void setHasCollided(boolean collission)
```
    Parameters:
    
    collission - the collision to set
  - isSensorsEnabled
```
public boolean isSensorsEnabled()
```
    Returns:
    
    the sensorsEnabled
  - setSensorsEnabled
```
public void setSensorsEnabled(boolean sensorsEnabled)
```
    Parameters:
    
    sensorsEnabled - the sensorsEnabled to set
  - isEffectorsEnabled
```
public boolean isEffectorsEnabled()
```
    Returns:
    
    the effectorsEnabled
  - setEffectorsEnabled
```
public void setEffectorsEnabled(boolean effectorsEnabled)
```
    Parameters:
    
    effectorsEnabled - the effectorsEnabled to set
  - isShowSensors
```
public boolean isShowSensors()
```
    Returns:
    
    the showSensors
  - setShowSensors
```
public void setShowSensors(boolean showSensors)
```
    Parameters:
    
    showSensors - the showSensors to set
  - isBlocked
```
public boolean isBlocked()
```
    Returns true if the entity is blocked from moving.
    
    Returns:
    
    true if blocked, false otherwise.
  - getBehavior
```
public Behavior getBehavior()
```
    Return the current behavior.
    
    Returns:
    
    behavior object.
  - moveNorth
```
public void moveNorth(double amount)
```
    Move the object north by the specified amount in pixels.
    
    Parameters:
    
    amount - amount to move by
  - moveSouth
```
public void moveSouth(double amount)
```
    Move the object south by the specified amount in pixels.
    
    Parameters:
    
    amount - amount to move by
  - moveEast
```
public void moveEast(double amount)
```
    Move the object east by the specified amount in pixels.
    
    Parameters:
    
    amount - amount to move by
  - moveWest
```
public void moveWest(double amount)
```
    Move the object west by the specified amount in pixels.
    
    Parameters:
    
    amount - amount to move by
  - getDoubleX
```
public double getDoubleX()
```
    Get the X position as a double.
    
    Returns:
    
    the x position as a double.
  - getDoubleY
```
public double getDoubleY()
```
    Get the Y position as a double.
    
    Returns:
    
    the y position as a double.
  - setX
```
public void setX(double x)
```
    Parameters:
    
    x - the x to set
  - setY
```
public void setY(double y)
```
    Parameters:
    
    y - the y to set
  - updateSmellSource
```
public void updateSmellSource()
```
    Update this object's smell source, if any.
  - speakToEntity
```
public void speakToEntity(java.lang.String phrase)
```
    Add a phrase to the list of things currently being said.
    
    Parameters:
    
    phrase - the phrase to add
  - getCurrentlyHeardPhrases
```
public java.util.List<java.lang.String> getCurrentlyHeardPhrases()
```
    Returns:
    
    the currentlyHeardPhrases

Class OdorWorldEntity

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

x

y

dx

dy

behavior

Constructor Detail

OdorWorldEntity

OdorWorldEntity

OdorWorldEntity

Method Detail

update

collideHorizontal

collideVertical

getX

getY

setX

setY

isInBoundsX

isInBoundsY

getWidth

getHeight

getVelocityX

getVelocityY

setVelocityX

setVelocityY

getName

setName

getId

setId

getImage

getBounds

getReducedBounds

addEffector

removeEffector

addSensor

removeSensor

applyEffectors

updateSensors

addTileSensors

addTileSensors

getSmellSource

setSmellSource

getParentWorld

getCenterLocation

getCenterX

getCenterY

setCenterLocation

getLocation

setLocation

getAnimation

setAnimation

postSerializationInit

getSensors

setSensors

getEffectors

setEffectors

hasCollided

setHasCollided

isSensorsEnabled

setSensorsEnabled

isEffectorsEnabled

setEffectorsEnabled

isShowSensors

setShowSensors

isBlocked

getBehavior

moveNorth

moveSouth

moveEast

moveWest

getDoubleX

getDoubleY

setX

setY