interfaces
Interface SimObject

All Known Implementing Classes:
SimSensor, BasicSimObject

public interface SimObject

Interface class for all objects in a SimWorld

Author:
Graham Ritchie

Method Summary
 double getActualBearingVelocityXY()
          Returns this objects actual bearing velocity in the XY plane
 double getActualBearingVelocityXZ()
          Returns this objects actual bearing velocity in the XZ plane
 double getActualBearingXY()
          Returns this objects actual bearing in the XY plane
 double getActualBearingXZ()
          Returns this objects actual bearing in the XZ plane
 double getActualVelocity()
          Returns this objects actual velocity.
 double getDesiredBearingVelocityXY()
          Returns this objects desired bearing velocity in the XY plane
 double getDesiredBearingVelocityXZ()
          Returns this objects desired bearing velocity in the XZ plane
 double getDesiredVelocity()
          Returns this objects desired velocity.
 double getHeight()
          Returns this object's height
 double getLength()
          Returns this object's length
 java.lang.String getType()
          Returns a string describing this object's type
 double getWidth()
          Returns this object's width
 double getXCoord()
          Returns this objects X coordinate
 double getYCoord()
          Returns this objects Y coordinate
 double getZCoord()
          Returns this objects Z coordinate
 void setActualBearingVelocityXY(double b)
          Sets the actual 'bearing velocity' of this object in the XY plane.
 void setActualBearingVelocityXZ(double b)
          Sets the actual 'bearing velocity' of this object in the XZ plane.
 void setActualBearingXY(double b)
          Sets the actual bearing of this object in the XY plane
 void setActualBearingXZ(double b)
          Sets the actual bearing of this object in the XZ plane
 void setActualVelocity(double v)
          Sets the actual velocity of this object.
 void setDesiredBearingVelocityXY(double v)
          Sets the desired 'bearing velocity' of this object in the XY plane.
 void setDesiredBearingVelocityXZ(double v)
          Sets the desired 'bearing velocity' of this object in the XZ plane - a bearing velocity is the rate at which the object wants to turn.
 void setDesiredVelocity(double v)
          Sets the desired velocity of this object - the SimWorld will then set its actual velocity accordingly (depending on wheher the object is colliding with another object etc.) Positive values mean the objet wants to move forward, and negative values mean the object wants to move backward.
 void setXCoord(double x)
          Sets this objects X coordinate
 void setYCoord(double y)
          Sets this objects Y coordinate
 void setZCoord(double z)
          Sets this objects Z coordinate
 

Method Detail

setDesiredVelocity

public void setDesiredVelocity(double v)
Sets the desired velocity of this object - the SimWorld will then set its actual velocity accordingly (depending on wheher the object is colliding with another object etc.) Positive values mean the objet wants to move forward, and negative values mean the object wants to move backward. A velocity of 0 means the object wants to stop.
Parameters:
v - the desired velocity

setActualVelocity

public void setActualVelocity(double v)
Sets the actual velocity of this object.
Parameters:
v - the actual velocity

setXCoord

public void setXCoord(double x)
Sets this objects X coordinate
Parameters:
x - the X coordinate

setYCoord

public void setYCoord(double y)
Sets this objects Y coordinate
Parameters:
y - the Y coordinate

setZCoord

public void setZCoord(double z)
Sets this objects Z coordinate
Parameters:
z - the Z coordinate

getDesiredVelocity

public double getDesiredVelocity()
Returns this objects desired velocity. This may not be equal to its actual velocity.
Returns:
the desired velocity as a double

getActualVelocity

public double getActualVelocity()
Returns this objects actual velocity.
Returns:
the actual velocity as a double

getXCoord

public double getXCoord()
Returns this objects X coordinate
Returns:
the X coordinate as a double

getYCoord

public double getYCoord()
Returns this objects Y coordinate
Returns:
the Y coordinate as a double

getZCoord

public double getZCoord()
Returns this objects Z coordinate
Returns:
the Z coordinate as a double

setDesiredBearingVelocityXZ

public void setDesiredBearingVelocityXZ(double v)
Sets the desired 'bearing velocity' of this object in the XZ plane - a bearing velocity is the rate at which the object wants to turn. Positive values mean the object wants to turn clockwise, negative values mean the object wants to turn antoclockwise and a deisred bearing velocity of 0 means the object does not want to turn at all.
Parameters:
v - the desired bearing velocity in the XZ plane

setDesiredBearingVelocityXY

public void setDesiredBearingVelocityXY(double v)
Sets the desired 'bearing velocity' of this object in the XY plane.
Parameters:
v - the desired bearing velocity in the XY plane

setActualBearingVelocityXZ

public void setActualBearingVelocityXZ(double b)
Sets the actual 'bearing velocity' of this object in the XZ plane.
Parameters:
b - the actual bearing velocity in the XZ plane

setActualBearingVelocityXY

public void setActualBearingVelocityXY(double b)
Sets the actual 'bearing velocity' of this object in the XY plane.
Parameters:
b - the actual bearing velocity in the XY plane

setActualBearingXZ

public void setActualBearingXZ(double b)
Sets the actual bearing of this object in the XZ plane
Parameters:
b - the bearing

setActualBearingXY

public void setActualBearingXY(double b)
Sets the actual bearing of this object in the XY plane
Parameters:
b - the bearing

getDesiredBearingVelocityXZ

public double getDesiredBearingVelocityXZ()
Returns this objects desired bearing velocity in the XZ plane
Returns:
the desired bearing velocity as a double

getDesiredBearingVelocityXY

public double getDesiredBearingVelocityXY()
Returns this objects desired bearing velocity in the XY plane
Returns:
the desired bearing velocity as a double

getActualBearingVelocityXZ

public double getActualBearingVelocityXZ()
Returns this objects actual bearing velocity in the XZ plane
Returns:
the actual bearing velocity as a double

getActualBearingVelocityXY

public double getActualBearingVelocityXY()
Returns this objects actual bearing velocity in the XY plane
Returns:
the actual bearing velocity as a double

getActualBearingXZ

public double getActualBearingXZ()
Returns this objects actual bearing in the XZ plane
Returns:
the actual bearing as a double

getActualBearingXY

public double getActualBearingXY()
Returns this objects actual bearing in the XY plane
Returns:
the actual bearing as a double

getHeight

public double getHeight()
Returns this object's height
Returns:
the height as a double

getWidth

public double getWidth()
Returns this object's width
Returns:
the width as a double

getLength

public double getLength()
Returns this object's length
Returns:
the length as a double

getType

public java.lang.String getType()
Returns a string describing this object's type
Returns:
the type as a string