desmoj.extensions.space3D

Interface SpatialObject

All Known Subinterfaces:

MovableSpatialObject

All Known Implementing Classes:

MovableSpatialEntity, MovableSpatialSimProcess, SimpleLocation, SpatialEntity, SpatialProcessQueue, SpatialQueue, SpatialSimProcess

public interface SpatialObject

The basic interface of the SpatialObject. It contains simple setting and getting methods of coordinates for every visible object in the simulation.

Every SpatialObject may contain several or none entry or exit point. They define the specific coordinates where an MovableSpatialObject move to or get out, if they navigate into or out of this SpatialObject.

Author:

Fred Sun

Method Summary

Modifier and Type	Method and Description
void	addEntryPoint(java.lang.String name, Length xPos, Length yPos, Length zPos) Adds an entry point to this SpatialObject.
void	addExitPoint(java.lang.String name, Length xPos, Length yPos, Length zPos) Adds an exit point to this SpatialObject.
Length[]	getEntryPoint(java.lang.String name) Gets the position of the given entry point.
Length[]	getEntryPointGlobal(java.lang.String name) Gets the position of the entry point in global coordinates.
java.util.Set<java.lang.String>	getEntryPointNames() Gets a set of names of all the entry points this SpatialObject contains.
Length[]	getExitPoint(java.lang.String name) Gets the position of the given exit point.
Length[]	getExitPointGlobal(java.lang.String name) Gets the position of the exit point in global coordinates.
java.util.Set<java.lang.String>	getExitPointNames() Gets a set of names of all the exit points this SpatialObject contains.
Matrix4d	getMatrix() Gets a 4x4 double matrix object which contains the spatial data of the SpatialObejct.
java.lang.String	getName() Returns the name of the named object.
Length	getPosX()
Length	getPosY()
Length	getPosZ()
boolean	isMovable() Check whether this Object is a MovableSpatialObject or not.
void	resetRotation() Resets the rotation of the object.
void	rotX(double angle) Adds a rotation about the x-axis to the current orientation.
void	rotY(double angle) Adds a rotation about the y-axis to the current orientation.
void	rotZ(double angle) Adds a rotation about the z-axis to the current orientation.
void	setPosition(Length x, Length y, Length z) It sets the new position for the object

Method Detail

addEntryPoint

void addEntryPoint(java.lang.String name,
                   Length xPos,
                   Length yPos,
                   Length zPos)

Adds an entry point to this SpatialObject. The given position should refer to the local coordinates of this SpatialObject.

Parameters:

name - The name of this entry point.

xPos - The x-position of this entry point in local coordinates.

yPos - The y-position of this entry point in local coordinates.

zPos - The z-position of this entry point in local coordinates.

addExitPoint

void addExitPoint(java.lang.String name,
                  Length xPos,
                  Length yPos,
                  Length zPos)

Adds an exit point to this SpatialObject. The given position should refer to the local coordinates of this SpatialObject.

Parameters:

name - The name of this exit point.

xPos - The x-position of this exit point in local coordinates.

yPos - The y-position of this exit point in local coordinates.

zPos - The z-position of this exit point in local coordinates.

getEntryPointNames

java.util.Set<java.lang.String> getEntryPointNames()

Gets a set of names of all the entry points this SpatialObject contains.

Returns:

A set of names of the entry points.

getExitPointNames

java.util.Set<java.lang.String> getExitPointNames()

Gets a set of names of all the exit points this SpatialObject contains.

Returns:

A set of names of the exit points.

getEntryPoint

Length[] getEntryPoint(java.lang.String name)

Gets the position of the given entry point.

Parameters:

name - The name of the entry point.

Returns:

The position of the entry point in local coordinates. The first element of the array represents the x-position, the second the y-position and the third the z-position. It returns null if the SpatialObject doesn't contain the entry point with the given name.

getEntryPointGlobal

Length[] getEntryPointGlobal(java.lang.String name)

Gets the position of the entry point in global coordinates.

Parameters:

name - The name of the entry point.

Returns:

The position of the entry point in global coordinates. The first element of the array represents the x-position, the second the y-position and the third the z-position. It returns null if the SpatialObject doesn't contain the entry point with the given name.

getExitPoint

Length[] getExitPoint(java.lang.String name)

Gets the position of the given exit point.

Parameters:

name - The name of the exit point.

Returns:

The position of the exit point in local coordinates. The first element of the array represents the x-position, the second the y-position and the third the z-position. It returns null if the SpatialObject doesn't contain the exit point with the given name.

getExitPointGlobal

Length[] getExitPointGlobal(java.lang.String name)

Gets the position of the exit point in global coordinates.

Parameters:

name - The name of the exit point.

Returns:

The position of the exit point in global coordinates. The first element of the array represents the x-position, the second the y-position and the third the z-position. It returns null if the SpatialObject doesn't contain the exit point with the given name.

getMatrix

Matrix4d getMatrix()

Gets a 4x4 double matrix object which contains the spatial data of the SpatialObejct.

Returns:

The Matrix4d object.

getName

java.lang.String getName()

Returns the name of the named object. This is the same name displayed in reports and trace files when this named object is shown in those reports or trace files.

Returns:

The name of the named object.

getPosX

Length getPosX()

Returns:

It returns the x-position of the object.

getPosY

Length getPosY()

Returns:

It returns the y-position of the object.

getPosZ

Length getPosZ()

Returns:

It returns the z-position of the object.

isMovable

boolean isMovable()

Check whether this Object is a MovableSpatialObject or not.

Returns:

Return true if this SpatialObject is also a MovableSpatialObject. Else, false.

resetRotation

void resetRotation()

Resets the rotation of the object.

rotX

void rotX(double angle)

Adds a rotation about the x-axis to the current orientation.

Parameters:

angle - The rotation angle in radians

rotY

void rotY(double angle)

Adds a rotation about the y-axis to the current orientation.

Parameters:

angle - The rotation angle in radians

rotZ

void rotZ(double angle)

Adds a rotation about the z-axis to the current orientation.

Parameters:

angle - The rotation angle in radians

setPosition

void setPosition(Length x,
                 Length y,
                 Length z)

It sets the new position for the object. *

Parameters:

x - The ExtendedLength which contains the new x-position.

y - The ExtendedLength which contains the new y-position.

z - The ExtendedLength which contains the new z-position.