Class APIModule

java.lang.Object

gaiasky.script.v2.impl.APIModule

Direct Known Subclasses:

BaseModule, CamcorderModule, CameraModule, DataModule, GeomModule, GraphicsModule, InputModule, InstancesModule, InteractiveCameraModule, OutputModule, RefsysModule, SceneModule, TimeModule, UiModule

public abstract class APIModule
extends Object

Abstract class which contains attributes and methods common to all API modules.

Field Summary

Fields

Modifier and Type	Field	Description
protected final APIv2	api	Reference to API object.
protected final EventManager	em	Reference to event manager.
protected final Logger.Log	logger
protected final APIModule	me	Reference to self.
protected final String	name	Module name.

Constructor Summary

Constructors

Constructor	Description
APIModule(EventManager em, APIv2 api, String name)	Create a new module with the given attributes.

Method Summary

Modifier and Type	Method	Description
void	dispose()	Method called whenever the module is disposed.

Methods inherited from class Object

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

Field Details

logger

protected final Logger.Log logger

me

protected final APIModule me

Reference to self.

em

protected final EventManager em

Reference to event manager.

api

protected final APIv2 api

Reference to API object.

name

protected final String name

Module name.

Constructor Details

APIModule

public APIModule(EventManager em,
 APIv2 api,
 String name)

Create a new module with the given attributes.

Parameters:

api - Reference to the API class.

name - Name of the module.

Method Details

dispose

public void dispose()

Method called whenever the module is disposed. To be overwritten if necessary.