jadex.extension.envsupport.environment.space2d

Class Space2D

java.lang.Object

jadex.commons.SimplePropertyObject

jadex.commons.meta.TypedPropertyObject

jadex.extension.envsupport.environment.SynchronizedPropertyObject

jadex.extension.envsupport.environment.AbstractEnvironmentSpace

jadex.extension.envsupport.environment.space2d.Space2D

All Implemented Interfaces:

IExtensionInstance, IPropertyObject, ITypedPropertyObject, IEnvironmentSpace

Direct Known Subclasses:

ContinuousSpace2D, Grid2D

public abstract class Space2D
extends AbstractEnvironmentSpace

General 2D space.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BORDER_STRICT Border strict mode.
static String	BORDER_TORUS Border torus behavior.
static String	PROPERTY_BORDER The constant for the border property.
static String	PROPERTY_POSITION The constant for the position property.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSpaceObjectType(String typename, IPropertyMetaDataSet mobjecttype) Add a space type.
IVector2	adjustPosition(IVector2 pos) Calculate a position according to the space borders.
IVector1	calculateDistance(IVector1 dx, IVector1 dy) Calculate the distance in the space.
void	disableKdTree(String type) Disables kd-tree NN-Search optimization for a specific object type.
void	enableKdTree(String type) Enables kd-tree NN-Search optimization for a specific object type.
IVector2	getAreaSize() Returns the size of the simulated area.
String	getBorderMode() Get the border mode.
IVector1	getDistance(IVector1 pos1, IVector1 pos2, boolean isx) Get the distance between two coordinates (x or y).
IVector1	getDistance(IVector2 pos1, IVector2 pos2) Get the distance between two positions.
ISpaceObject	getNearestObject(IVector2 position, IVector1 maxdist, String type) Returns the nearest object to the given position within a maximum distance from the position.
Set	getNearObjects(IVector2 position, IVector1 maxdist) Retrieve all objects in the distance for a position
Set	getNearObjects(IVector2 position, IVector1 maxdist, IFilter filter) Retrieve all objects in the distance for a position
Set	getNearObjects(IVector2 position, IVector1 maxdist, String type) Retrieve all objects in the distance for a position
Set	getNearObjects(IVector2 position, IVector1 maxdist, String type, IFilter filter) Retrieve all objects in the distance for a position
IVector2	getRandomPosition(IVector2 distance) Retrieves a random position within the simulation area with a minimum distance from the edge.
Object[]	getSpaceObjects() Get all space objects.
void	initSpaceObject(ISpaceObject ret) Init an object in this space.
void	setAreaSize(IVector2 areasize) Set the area size.
void	setPosition(Object id, IVector2 pos) Set the position of an object.

Methods inherited from class jadex.extension.envsupport.environment.AbstractEnvironmentSpace

addAvatarMappings, addDataConsumer, addDataProvider, addDataView, addDataViewMapping, addEnvironmentListener, addInitialAvatar, addObjectTaskType, addPerceptGenerator, addPerceptProcessor, addPerceptType, addSpaceAction, addSpaceProcessType, addTaskListener, componentAdded, componentRemoved, createObjectTask, createPercept, createSpaceObject, createSpaceObjectZombie, createSpaceProcess, destroySpaceObject, getAvatar, getAvatar, getAvatars, getComponentActionList, getComponents, getDataConsumer, getDataConsumers, getDataProvider, getDataView, getDataViews, getExternalAccess, getFetcher, getOwner, getPerceptList, getPerceptType, getProcesses, getProperty, getSpaceAction, getSpaceObject, getSpaceObject0, getSpaceObjectsByType, getSpaceObjectsCollection, getSpaceProcess, getSpaceProcessNames, getViews, init, initSpace, performSpaceAction, performSpaceAction, removeAvatarMappings, removeDataView, removeEnvironmentListener, removeObjectTask, removeObjectTaskType, removePerceptGenerator, removePerceptProcessor, removePerceptType, removeSpaceAction, removeSpaceObjectType, removeSpaceProcess, removeSpaceProcessType, removeTaskListener, setFetcher, setOwner, terminate

Methods inherited from class jadex.extension.envsupport.environment.SynchronizedPropertyObject

addPropertyChangeListener, getMonitor, getPropertyNames, hasProperty, removePropertyChangeListener, setProperty

Methods inherited from class jadex.commons.meta.TypedPropertyObject

getMetaData, getMetaDatas

Methods inherited from class jadex.commons.SimplePropertyObject

getProperties, setProperties, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface jadex.commons.IPropertyObject

getPropertyNames, hasProperty, setProperty

Field Detail

PROPERTY_POSITION

public static final String PROPERTY_POSITION

The constant for the position property.

See Also:

Constant Field Values

PROPERTY_BORDER

public static final String PROPERTY_BORDER

The constant for the border property.

See Also:

Constant Field Values

BORDER_STRICT

public static final String BORDER_STRICT

Border strict mode.

See Also:

Constant Field Values

BORDER_TORUS

public static final String BORDER_TORUS

Border torus behavior.

See Also:

Constant Field Values

Method Detail

getAreaSize

public IVector2 getAreaSize()

Returns the size of the simulated area.

Returns:

size of the simulated area

setAreaSize

public void setAreaSize(IVector2 areasize)

Set the area size.

Parameters:

areasize - The area size.

getBorderMode

public String getBorderMode()

Get the border mode.

Returns:

the border_mode

initSpaceObject

public void initSpaceObject(ISpaceObject ret)

Init an object in this space.

Overrides:

initSpaceObject in class AbstractEnvironmentSpace

addSpaceObjectType

public void addSpaceObjectType(String typename,
                      IPropertyMetaDataSet mobjecttype)

Description copied from class: AbstractEnvironmentSpace

Add a space type.

Specified by:

addSpaceObjectType in interface IEnvironmentSpace

Overrides:

addSpaceObjectType in class AbstractEnvironmentSpace

Parameters:

typename - The type name.

mobjecttype - The properties (map of maps with name->name/value/dynamic/event).

setPosition

public void setPosition(Object id,
               IVector2 pos)

Set the position of an object.

Parameters:

id - The object id.

pos - The object position.

getDistance

public IVector1 getDistance(IVector2 pos1,
                   IVector2 pos2)

Get the distance between two positions.

Parameters:

pos1 - The first position.

pos2 - The second position.

getDistance

public IVector1 getDistance(IVector1 pos1,
                   IVector1 pos2,
                   boolean isx)

Get the distance between two coordinates (x or y).

Parameters:

pos1 - The first position.

pos2 - The second position.

calculateDistance

public IVector1 calculateDistance(IVector1 dx,
                         IVector1 dy)

Calculate the distance in the space.

Parameters:

dx - The distance in x.

dy - The distance in y.

Returns:

The distance according to the distance metrics of the space.

adjustPosition

public IVector2 adjustPosition(IVector2 pos)

Calculate a position according to the space borders.

getRandomPosition

public IVector2 getRandomPosition(IVector2 distance)

Retrieves a random position within the simulation area with a minimum distance from the edge.

Parameters:

distance - minimum distance from the edge, null or zero for no distance

enableKdTree

public void enableKdTree(String type)

Enables kd-tree NN-Search optimization for a specific object type. This will increase space overhead but massively decreases restricted nearest-neighborsearches in cases of large amounts of (evenly distributed) objects.

Parameters:

String - type The type of object being optimized.

disableKdTree

public void disableKdTree(String type)

Disables kd-tree NN-Search optimization for a specific object type.

Parameters:

String - type The type of object for which the kd-tree is disabled.

getNearestObject

public ISpaceObject getNearestObject(IVector2 position,
                            IVector1 maxdist,
                            String type)

Returns the nearest object to the given position within a maximum distance from the position.

Parameters:

position - position the object should be nearest to

maxdist - maximum distance from the position, use null for unlimited distance

Returns:

nearest object's ID or null if none is found

getNearObjects

public Set getNearObjects(IVector2 position,
                 IVector1 maxdist)

Retrieve all objects in the distance for a position

Parameters:

position -

distance -

Returns:

The near objects.

getNearObjects

public Set getNearObjects(IVector2 position,
                 IVector1 maxdist,
                 String type)

Retrieve all objects in the distance for a position

Parameters:

position -

distance -

Returns:

The near objects.

getNearObjects

public Set getNearObjects(IVector2 position,
                 IVector1 maxdist,
                 IFilter filter)

Retrieve all objects in the distance for a position

Parameters:

position -

distance -

Returns:

The near objects.

getNearObjects

public Set getNearObjects(IVector2 position,
                 IVector1 maxdist,
                 String type,
                 IFilter filter)

Retrieve all objects in the distance for a position

Parameters:

position -

distance -

Returns:

The near objects.

getSpaceObjects

public Object[] getSpaceObjects()

Get all space objects.

Returns:

All space objects.