MovableSpatialObject (DESMO-J 2.5.1c API)

All Superinterfaces:

SpatialObject

All Known Implementing Classes:

MovableSpatialEntity, MovableSpatialSimProcess
```
public interface MovableSpatialObject
extends SpatialObject
```
This interface extends the SpatialObject interface by moving animation methods. The class which implements this is meant to be a movable object in the simulation. The methods cover the setting and getting spatial transformation data. A MovableSpatialObject (MSO) can contain other MovableSpatialObjects as components to simulate the movable extensions/parts of an object. The other way around, a MSO can also be the child-MSO of other MSOs. In this case, the Attach and Detach methods will be deactivated. All the getting methods will return the local attributes without considering the parent MSO. The position and the orientation are represented in the parent-MSO's local coordinates. For the move methods only the move(movement, focusOnTrack) will be remained usable. To declare a MSO as a child-MSO, the parent MSO must be give in the constructor. This is the only way to declare it and it can't be modified afterwards.

Author:

Fred Sun

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`attach(MovableSpatialObject host)` Snaps to another MovableSpatialObject.
`void`	`cancelMovement()` Cancel the movement if there is a movement performing.
`void`	`cancelRotation()` Cancel the rotation if there is a rotation performing.
`void`	`detach()` Releases from the host object if this object is attached to it.
`double`	`getAcc()` Gets the acceleration of the object.
`SpatialObject`	`getCurrentLocation()` Returns the SpatialObject where this MovableSpatialObject is currently located.
`Movement`	`getCurrentMovement()` Gets the current Movement object.
`Rotation`	`getCurrentRotation()` Gets the current Rotation object.
`double`	`getCurrentSpeed()` Gets the current moving speed of the object.
`double`	`getDec()` Gets the negative acceleration of the object.
`double`	`getMaxSpeed()` Gets the maximum speed of the object.
`boolean`	`isAttached()` IShows whether the MovableSpatialObject is attached.
`boolean`	`isFocusedOnTrack()` Returns whether the FocusOnTrack function is on.
`boolean`	`isMoving()` Shows whether the MovableSpatialObject is moving.
`boolean`	`isRotating()` Shows whether the MovableSpatialObject is rotating.
`void`	`move(Movement movement, boolean focusOnTrack)` Move the object to the destination according to the given movement object.
`void`	`move(SpatialObject destination, java.lang.String entryPointName, boolean focusOnTrack)` Move the object to the position of another SpatialObject without a specified duration.
`void`	`move(SpatialObject destination, java.lang.String entryPointName, TimeSpan duration, boolean focusOnTrack)` Move the object to the position of another SpatialObject with a specified duration.
`void`	`move(SpatialObject destination, java.lang.String entryPointName, TimeSpan duration, double maxSpeed, double acc, double dec, boolean focusOnTrack)` Move the object to the position of another SpatialObject with specific attributes.
`void`	`notifyMovingDone()` Notifies the MovableSpatialObject that the moving is finished and updates the new coordinates.
`void`	`notifyRotatingDone()` Notifies the MovableSpatialObject that the rotating is finished and updates the new coordinates.
`void`	`rotX(double angle, TimeSpan duration)` Rotates the object about the x-axis using an animation.
`void`	`rotY(double angle, TimeSpan duration)` Rotates the object about the y-axis using an animation.
`void`	`rotZ(double angle, TimeSpan duration)` Rotates the object about the z-axis using an animation.
`void`	`sendToLocation(SpatialObject destination)` Set this object to the position of the destination object and change the currentLocation to the destination object.
`void`	`sendToLocationEntryPoint(SpatialObject destination, java.lang.String entryPoint)` Set this object to the position of the given entry point of the destination object.
`void`	`sendToLocationExitPoint(SpatialObject destination, java.lang.String exitPoint)` Set this object to the position of the given exit point of the destination object.
`void`	`setAcc(double acc)` Sets the acceleration of the object.
`void`	`setDec(double dec)` Sets the negative acceleration of the object.
`void`	`setMaxSpeed(double maxSpeed)` Sets the maximum speed of this object

Methods inherited from interface desmoj.extensions.space3D.SpatialObject
addEntryPoint, addExitPoint, getEntryPoint, getEntryPointGlobal, getEntryPointNames, getExitPoint, getExitPointGlobal, getExitPointNames, getMatrix, getName, getPosX, getPosY, getPosZ, isMovable, resetRotation, rotX, rotY, rotZ, setPosition

- Method Detail
  - attach
```
void attach(MovableSpatialObject host)
```
    Snaps to another MovableSpatialObject. If the host moves, this object will be moved, too. The relative position to the host object will be kept. If attached, this object shouldn't be able to change its position and orientation itself anymore.
    
    Parameters:
    
    host - The MovableSpatialObject who to attach to.
  - cancelMovement
```
void cancelMovement()
```
    Cancel the movement if there is a movement performing.
  - cancelRotation
```
void cancelRotation()
```
    Cancel the rotation if there is a rotation performing.
  - detach
```
void detach()
```
    Releases from the host object if this object is attached to it.
  - getAcc
```
double getAcc()
```
    Gets the acceleration of the object. The default value is 0.
    
    Returns:
    
    The acceleration
  - getCurrentLocation
```
SpatialObject getCurrentLocation()
```
    Returns the SpatialObject where this MovableSpatialObject is currently located.
    
    Returns:
    
    The SpatialObject where this MovableSpatialObject is located. Null, if it isn't located at any SpatialObject.
  - getCurrentMovement
```
Movement getCurrentMovement()
```
    Gets the current Movement object.
    
    Returns:
    
    The current Movement object. Null, if this MovableSpatialObject isn't moving.
  - getCurrentRotation
```
Rotation getCurrentRotation()
```
    Gets the current Rotation object.
    
    Returns:
    
    The current Rotation object. Null, if this MovableSpatialObject isn't rotating.
  - getCurrentSpeed
```
double getCurrentSpeed()
```
    Gets the current moving speed of the object.
    
    Returns:
    
    The current moving speed.
  - getDec
```
double getDec()
```
    Gets the negative acceleration of the object. The default value is 0.
    
    Returns:
    
    The negative acceleration
  - getMaxSpeed
```
double getMaxSpeed()
```
    Gets the maximum speed of the object. If it's 0, the MovableSpatialObject won't have speed limitation. The default value is 0.
    
    Returns:
    
    The maximum speed of the object
  - isAttached
```
boolean isAttached()
```
    IShows whether the MovableSpatialObject is attached.
    
    Returns:
    
    Whether the MovableSpatialObejct is attached.
  - isFocusedOnTrack
```
boolean isFocusedOnTrack()
```
    Returns whether the FocusOnTrack function is on.
    
    Returns:
    
    True if it's set. False if it's not set.
  - isMoving
```
boolean isMoving()
```
    Shows whether the MovableSpatialObject is moving.
    
    Returns:
    
    whether the MovableSpatialObject is moving.
  - isRotating
```
boolean isRotating()
```
    Shows whether the MovableSpatialObject is rotating.
    
    Returns:
    
    whether the MovableSpatialObject is rotating.
  - move
```
void move(SpatialObject destination,
          java.lang.String entryPointName,
          boolean focusOnTrack)
   throws SuspendExecution
```
    Move the object to the position of another SpatialObject without a specified duration. It use the acceleration, deceleration and the maximum speed of the MovableSpatialObject. For this method the maximum speed of the object must be given or an IllegalMoveException will be thrown. If the acceleration is <= 0 OR deceleration of the object is >= 0, then the kinematical attributes won't be calculated and the movement will start with the maximum speed and break to zero immediately at the destination. If the object is already moving it will move to the new destination. (not for MovableSpatialSimProcess)
    
    Parameters:
    
    destination - The destination object we want to move to.
    
    enttryPointName - The name of the specific entry point at the destination object, which should be steered to.
    
    focusOnTrack - Whether the orientation of the moving object should focus to the moving direction.
    
    Throws:
    
    SuspendExecution
  - move
```
void move(SpatialObject destination,
          java.lang.String entryPointName,
          TimeSpan duration,
          boolean focusOnTrack)
   throws SuspendExecution
```
    Move the object to the position of another SpatialObject with a specified duration. It use the acceleration, deceleration and the maximum speed of the MovableSpatialObject. If the acceleration is <= 0 OR deceleration of the object is >= 0, then the kinematical attributes won't be calculated and the movement will start with the speed needed to arrive the destination in time. If the maximum speed of the object is initialized (>0), then an IllegalMoveException will be thrown if it is not possible to make to the destination in time. If the object is already moving it will move to the new destination. (not for MovableSpatialSimProcess)
    
    Parameters:
    
    destination - The destination object we want to move to.
    
    enttryPointName - The name of the specific entry point at the destination object, which should be steered to.
    
    duration - The duration of the movement in TimeSpan.
    
    focusOnTrack - Whether the orientation of the moving object should focus to the moving direction.
    
    Throws:
    
    SuspendExecution
  - move
```
void move(SpatialObject destination,
          java.lang.String entryPointName,
          TimeSpan duration,
          double maxSpeed,
          double acc,
          double dec,
          boolean focusOnTrack)
   throws SuspendExecution
```
    Move the object to the position of another SpatialObject with specific attributes. There are different varieties of movement modes depends on the initialized parameters (O = initialized, X = not initialized(means invalid or null)): case 1: duration O, maxSpeed O, acc & dec O: The movement will be performed according to the parameters. If the given parameters can't be satisfied, an IllegalMoveException will be thrown. case 2: duration X, maxSpeed O, acc & dec O: The object will be moved to the destination with the fastest speed possible. case 3: duration O, maxSpeed X, acc & dec O: The object will move to the destination with the given acceleration and deceleration and try to reach the destination in time. If the given parameters can't be satisfied, an IllegalMoveException will be thrown. case 4: duration X, maxSpeed X, acc & dec O: The object will be accelerated and followed by a deceleration. There's no constant phase in the movement. case 5: duration O, maxSpeed O, acc or dec X: The object will start with the speed needed to arrive the destination in the given time and break suddenly to zero at the end of the movement. The maxSpeed gives the speed limit of the movement. If the given parameters can't be satisfied, an IllegalMoveException will be thrown. case 6: duration X, maxSpeed O, acc or dec X: The movement will start with the maxSpeed and stops the destination. case 7: duration O, maxSpeed X, acc or dec X: The movement will start with the speed needed to arrive the destination with the duration given. All other combinations of these parameters will cause an IllegalMoveException. If the object is already moving it will move to the new destination. (not for MovableSpatialSimProcess)
    
    Parameters:
    
    destination - The destination object we want to move to.
    
    enttryPointName - The name of the specific entry point at the destination object, which should be steered to.
    
    duration - The duration of the movement in TimeSpan(optional).
    
    maxSpeed - The maximum speed of the movement(optional).
    
    acc - The acceleration of the movement(optional).
    
    dec - The deceleration of the movement(optional).
    
    focusOnTrack - Whether the orientation of the moving object should focus to the moving direction.
    
    Throws:
    
    SuspendExecution
  - move
```
void move(Movement movement,
          boolean focusOnTrack)
   throws SuspendExecution
```
    Move the object to the destination according to the given movement object. If the object is already moving it will move to the new destination. (not for MovableSpatialSimProcess) If this MovableSpatialObject is a child-MSO, the Track which is contained in the Movement parameter should be in the local coordinates of this object.
    
    Parameters:
    
    movement - The movement which should be performed.
    
    focusOnTrack - Whether the orientation of the moving object should focus to the moving direction.
    
    Throws:
    
    SuspendExecution
  - notifyMovingDone
```
void notifyMovingDone()
               throws SuspendExecution
```
    Notifies the MovableSpatialObject that the moving is finished and updates the new coordinates. This method shouldn't be called by user!
    
    Throws:
    
    SuspendExecution
  - notifyRotatingDone
```
void notifyRotatingDone()
                 throws SuspendExecution
```
    Notifies the MovableSpatialObject that the rotating is finished and updates the new coordinates. This method shouldn't be called by user!
    
    Throws:
    
    SuspendExecution
  - rotX
```
void rotX(double angle,
          TimeSpan duration)
   throws SuspendExecution
```
    Rotates the object about the x-axis using an animation.
    
    Parameters:
    
    angle - The start angle
    
    duration - The duration of the animation
    
    Throws:
    
    SuspendExecution
  - rotY
```
void rotY(double angle,
          TimeSpan duration)
   throws SuspendExecution
```
    Rotates the object about the y-axis using an animation.
    
    Parameters:
    
    angle - The start angle
    
    duration - The duration of the animation
    
    Throws:
    
    SuspendExecution
  - rotZ
```
void rotZ(double angle,
          TimeSpan duration)
   throws SuspendExecution
```
    Rotates the object about the z-axis using an animation.
    
    Parameters:
    
    angle - The start angle
    
    duration - The duration of the animation
    
    Throws:
    
    SuspendExecution
  - sendToLocation
```
void sendToLocation(SpatialObject destination)
```
    Set this object to the position of the destination object and change the currentLocation to the destination object.
    
    Parameters:
    
    destination - The destination this object will be send to.
  - sendToLocationEntryPoint
```
void sendToLocationEntryPoint(SpatialObject destination,
                              java.lang.String entryPoint)
```
    Set this object to the position of the given entry point of the destination object. The currentLocation will also be changed to the destination object.
    
    Parameters:
    
    destination - The destination object the currentLocation should be set to.
    
    entryPoint - The specific entry point of the destination object.
  - sendToLocationExitPoint
```
void sendToLocationExitPoint(SpatialObject destination,
                             java.lang.String exitPoint)
```
    Set this object to the position of the given exit point of the destination object. The currentLocation will also be changed to the destination object.
    
    Parameters:
    
    destination - The destination object the currentLocation should be set to.
    
    exitPoint - The specific exit point of the destination object this object will be send to.
  - setAcc
```
void setAcc(double acc)
```
    Sets the acceleration of the object.
    
    Parameters:
    
    acc - The acceleration
  - setDec
```
void setDec(double dec)
```
    Sets the negative acceleration of the object.
    
    Parameters:
    
    dec - The negative acceleration
  - setMaxSpeed
```
void setMaxSpeed(double maxSpeed)
```
    Sets the maximum speed of this object
    
    Parameters:
    
    maxSpeed - The maximum speed of the object

Interface MovableSpatialObject

Method Summary

Methods inherited from interface desmoj.extensions.space3D.SpatialObject

Method Detail

attach

cancelMovement

cancelRotation

detach

getAcc

getCurrentLocation

getCurrentMovement

getCurrentRotation

getCurrentSpeed

getDec

getMaxSpeed

isAttached

isFocusedOnTrack

isMoving

isRotating

move

move

move

move

notifyMovingDone

notifyRotatingDone

rotX

rotY

rotZ

sendToLocation

sendToLocationEntryPoint

sendToLocationExitPoint

setAcc

setDec

setMaxSpeed