desmoj.extensions.visualization3d

Interface VisualModule

All Known Implementing Classes:

SpatialVis3DModule

public interface VisualModule

This is the interface every visualization module should implement. It will be called from the VisualizationControl to handle the incoming events.

Author:

Fred Sun

Method Summary

Modifier and Type	Method and Description
java.lang.String	getModuleName() Gets the name of the VisualModule.
void	handleEvent(VisualEvent event) Handle the received event.
void	removeVisualizationControl() If a VisualizationControl is set, it will be removed from the module's local attribute by calling this method.
void	setVisualizationControl(VisualizationControl visCon) Saves the VisualizationControl this module as a local attribute.

Method Detail

getModuleName

java.lang.String getModuleName()

Gets the name of the VisualModule.

Returns:

The name of the VisualModule.

handleEvent

void handleEvent(VisualEvent event)

Handle the received event.

Parameters:

event - The event to be handled.

removeVisualizationControl

void removeVisualizationControl()

If a VisualizationControl is set, it will be removed from the module's local attribute by calling this method. This method will be called by VisualizationControl at the removing of the module.

setVisualizationControl

void setVisualizationControl(VisualizationControl visCon)

Saves the VisualizationControl this module as a local attribute. This method will be called by VisualizationControl at the registration of the module.

Parameters:

visCon - The owner of this module