com.speckled.specksim.imp.motion
Class SpeckledBodyModel

java.lang.Object
  com.speckled.specksim.imp.motion.CacheingMovementModel
      com.speckled.specksim.imp.motion.SpeckledBodyModel

All Implemented Interfaces:

Configurable, MovementModel

Direct Known Subclasses:

ExcitedHenge, PerspecksModel

public abstract class SpeckledBodyModel
extends CacheingMovementModel

This movement model simulates a number rigid, convex bodies, each with its own path. Specks are distributed accross the surface or within the volume of these bodies.

Author:

ryanm

Nested Class Summary

class

SpeckledBodyModel.BodiesState This class encapsulates the vertex and face information for some time, of the bodies in this model.

Constructor Summary

SpeckledBodyModel()

Method Summary

void	addBody(Body body, BodyPath path) Adds a body to this movement model
SpeckPosition	computeLocation(Speck speck, float time) Override this to compute a speck's location
Vector3d	computeVelocity(Speck speck, float time) Override this to compute a speck's velocity
void	deInit() Called when this model is replaced as the current model
protected abstract Configurator	getConcreteConfigurator() This should be implemented to return a configurator for the variables of the subclass
Configurator	getConfigurator() Gets a Configurator object that describes and can manipulate the variables of this Configurable.
double	getMaxSpeed() Gets the maximum possible speed that any Speck can move under this movement model.
SerializableState	getState(float time) Gets a state object from this model.
void	init(SpeckSim simulator) Called when this model is set to be the current model, or when the simulator is reset.
void	removeBody(Body body) Removes a body from the scene.
void	removeSpeck(Speck speck) Called when a speck is removed from the simulator.

Methods inherited from class com.speckled.specksim.imp.motion.CacheingMovementModel

clearCache, getSpeckOrientation, getSpeckVelocity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.speckled.specksim.MovementModel

getName

Constructor Detail

SpeckledBodyModel

public SpeckledBodyModel()

Method Detail

addBody

public void addBody(Body body,
                    BodyPath path)

Adds a body to this movement model

Parameters:

body - The body to add

path - The path that this body follows

removeBody

public void removeBody(Body body)

Removes a body from the scene. All specks currently inhabiting the body will be rehomed

Parameters:

body - The body to be removed

init

public void init(SpeckSim simulator)

Description copied from interface: MovementModel

Called when this model is set to be the current model, or when the simulator is reset. As such, this method must clear any old state as well as set up the new state

Parameters:

simulator - The simulator that this model is current in.

deInit

public void deInit()

Description copied from interface: MovementModel

Called when this model is replaced as the current model

removeSpeck

public void removeSpeck(Speck speck)

Description copied from interface: MovementModel

Called when a speck is removed from the simulator. Could be useful if the model maintain any state for each speck.

computeLocation

public SpeckPosition computeLocation(Speck speck,
                                     float time)

Description copied from class: CacheingMovementModel

Override this to compute a speck's location

Specified by:

computeLocation in class CacheingMovementModel

Parameters:

speck - The speck to locate

time - The time to locate at

Returns:

The location of the speck at the given time

computeVelocity

public Vector3d computeVelocity(Speck speck,
                                float time)

Description copied from class: CacheingMovementModel

Override this to compute a speck's velocity

Specified by:

computeVelocity in class CacheingMovementModel

Parameters:

speck - The speck to compute for

time - The time to compute at

Returns:

The velocity of the speck at the given time

getMaxSpeed

public double getMaxSpeed()

Description copied from interface: MovementModel

Gets the maximum possible speed that any Speck can move under this movement model. Enables some performance optimisations when looking for broadcast recipients. If we cannot define a maximum speed, we should return -1. Also, if you cannot guarantee that specks will not leave the unit cube,-1 should be returned

Returns:

The maximum possible speed of any speck, in units per second, or -1 if we cannot define a max speed, or if specks may possibly leave the unit cube

getState

public SerializableState getState(float time)

Description copied from interface: MovementModel

Gets a state object from this model. This will be placed in the SimulatorState object that is passed to the GUI, consequently, this is useful for providing some data to be visualised. For instance, SpeckledBodyModels use it to pass the vertices of their bodies for visualisation. Feel free to pass null if you want to. This implementation of this method should not assume that the init() method has been called, so return an empty instance of the state object if this is the case

Parameters:

time - The time at which the state should be captured

Returns:

The interesting state of the movement model, or null if no state is needed

getConfigurator

public Configurator getConfigurator()

Description copied from interface: Configurable

Gets a Configurator object that describes and can manipulate the variables of this Configurable. This method must only return null if the Configurable object is Annotated such that an AnnotatedConfigurator can be built from it.

Returns:

A configurator object, or null if annotated

getConcreteConfigurator

protected abstract Configurator getConcreteConfigurator()

This should be implemented to return a configurator for the variables of the subclass

Returns:

The configurator for the subclass