desmoj.extensions.visualization3d

Class VisualizationControl

java.lang.Object

desmoj.extensions.visualization3d.VisualizationControl

All Implemented Interfaces:

VisualEventListener, java.util.EventListener

public class VisualizationControl
extends java.lang.Object
implements VisualEventListener

This class provides the central control unit for the spatial visualization. It's the connector between the Visualevent-Producer and the VisualMudules. Each VisualModule is a different visualization implementation. The VisualModule to be used should be registered in the VisualizationControler. The controller will forward the events to each registered module.

Author:

Fred Sun

Constructor Summary

Constructors

Constructor and Description
VisualizationControl() Constructs a VisualControl.

Method Summary

Modifier and Type	Method and Description
void	addControlEventListener(ControlEventListener listener) Adds a ControlEventListener for receiving the ControlEvents from the VisualModules
void	addModule(VisualModule module) Registers a VisualModule to the VisualizationController.
void	fireControlEvent(ControlEvent evt) Fires a ControlEvent.
static VisualizationClock	getClock() Gets the clock instance which determines the time value for this VisualizationControl
VisualModule	getModule(java.lang.String name) Gets a registered VisualModule with the given name.
void	removeControlEventListener(ControlEventListener listener) Removes a registered ControlListener.
void	removeModule(java.lang.String name) Removes the VisualModule with the name from the VisualizationControl if present.
void	setExecutionSpeed(double rate) Sets the speed of the visualization clock to: real speed * rate.
void	visualEventReceived(VisualEvent evt) Invoked when a VisualEvent occurred.

Methods inherited from class java.lang.Object

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

Constructor Detail

VisualizationControl

public VisualizationControl()

Constructs a VisualControl.

Method Detail

addControlEventListener

public void addControlEventListener(ControlEventListener listener)

Adds a ControlEventListener for receiving the ControlEvents from the VisualModules

Parameters:

listener - The listener to be added.

addModule

public void addModule(VisualModule module)

Registers a VisualModule to the VisualizationController.

Parameters:

module - The VisualModule to be registered.

fireControlEvent

public void fireControlEvent(ControlEvent evt)

Fires a ControlEvent.

Parameters:

evt - The ControlEvent to be fired.

getClock

public static VisualizationClock getClock()

Gets the clock instance which determines the time value for this VisualizationControl

Returns:

The VisualizationClock.

getModule

public VisualModule getModule(java.lang.String name)

Gets a registered VisualModule with the given name. If no registered with the name can be found, null will be returned.

Parameters:

name - The name of the registered VisualModule to be get.

Returns:

The VisualModule with the name in this VisualizationControl. Null if there's none.

removeControlEventListener

public void removeControlEventListener(ControlEventListener listener)

Removes a registered ControlListener.

Parameters:

listener - The listener to be removed.

removeModule

public void removeModule(java.lang.String name)

Removes the VisualModule with the name from the VisualizationControl if present.

Parameters:

name - The name of the VisualModule to be removed.

setExecutionSpeed

public void setExecutionSpeed(double rate)

Sets the speed of the visualization clock to: real speed * rate.

Parameters:

speed - The execution speed rate. If the rate is <= 0, the clock will keep running with the old speed.

visualEventReceived

public void visualEventReceived(VisualEvent evt)

Description copied from interface: VisualEventListener

Invoked when a VisualEvent occurred.

Specified by:

visualEventReceived in interface VisualEventListener

Parameters:

evt - The occurred VisualEvent.