desmoj.extensions.visualization3d

Class SpatialVis3DModule

java.lang.Object

desmoj.extensions.visualization3d.SpatialVis3DModule

All Implemented Interfaces:

VisualModule

public class SpatialVis3DModule
extends java.lang.Object
implements VisualModule

This Module visualize the 3D-spatial objects using Java3D.

Author:

Fred Sun

Constructor Summary

Constructors

Constructor and Description
SpatialVis3DModule(java.lang.String name, java.lang.String filePath) Constructs a SpatialVix3DModule and load the decoration models into the scene.
SpatialVis3DModule(java.lang.String name, java.lang.String filePath, boolean createFrame)

Method Summary

Modifier and Type	Method and Description
void	createFrame(java.lang.String name)
java.lang.String	getModuleName() Gets the name of the VisualModule.
void	handleEvent(VisualEvent event) Handle the received event.
void	registerNewVisualEventListener(VisualEventListener listener) Registers a customized VisualEventListener to this module.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpatialVis3DModule

public SpatialVis3DModule(java.lang.String name,
                          java.lang.String filePath)

Constructs a SpatialVix3DModule and load the decoration models into the scene.

Parameters:

name - the name of this module.

filePath - The file path to the XML-file, where the model data is specified.

SpatialVis3DModule

public SpatialVis3DModule(java.lang.String name,
                          java.lang.String filePath,
                          boolean createFrame)

Method Detail

createFrame

public void createFrame(java.lang.String name)

getModuleName

public java.lang.String getModuleName()

Description copied from interface: VisualModule

Gets the name of the VisualModule.

Specified by:

getModuleName in interface VisualModule

Returns:

The name of the VisualModule.

handleEvent

public void handleEvent(VisualEvent event)

Description copied from interface: VisualModule

Handle the received event.

Specified by:

handleEvent in interface VisualModule

Parameters:

event - The event to be handled.

setVisualizationControl

public void setVisualizationControl(VisualizationControl visCon)

Description copied from interface: VisualModule

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

Specified by:

setVisualizationControl in interface VisualModule

Parameters:

visCon - The owner of this module

registerNewVisualEventListener

public void registerNewVisualEventListener(VisualEventListener listener)

Registers a customized VisualEventListener to this module.

Parameters:

listener - The listener to be registered.

removeVisualizationControl

public void removeVisualizationControl()

Description copied from interface: VisualModule

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.

Specified by:

removeVisualizationControl in interface VisualModule