artofillusion
Interface Plugin


public interface Plugin


Field Summary
static int APPLICATION_STARTING
          This message is sent when the program first starts up.
static int APPLICATION_STOPPING
          This message is sent just before the program shuts down.
static int OBJECT_WINDOW_CLOSING
          This message is sent just after an object editing window is closed.
static int OBJECT_WINDOW_CREATED
          This message is sent when a new object editing window is created.
static int SCENE_SAVED
          This message is sent when a scene is saved to disk.
static int SCENE_WINDOW_CLOSING
          This message is sent just after a scene editing window is closed.
static int SCENE_WINDOW_CREATED
          This message is sent when a new scene editing window is created.
 
Method Summary
 void processMessage(int message, java.lang.Object[] args)
          This is the main method for the plugin.
 

Field Detail

APPLICATION_STARTING

static final int APPLICATION_STARTING
This message is sent when the program first starts up. It is sent after all initialization has happened, but before the first window has been displayed. It has no arguments.

See Also:
Constant Field Values

APPLICATION_STOPPING

static final int APPLICATION_STOPPING
This message is sent just before the program shuts down. This gives plugins a chance to do any necessary cleanup. It has no arguments.

See Also:
Constant Field Values

SCENE_WINDOW_CREATED

static final int SCENE_WINDOW_CREATED
This message is sent when a new scene editing window is created. It is sent after the new window has been fully initialized, and just before it is displayed. The LayoutWindow is passed as an argument

See Also:
Constant Field Values

SCENE_WINDOW_CLOSING

static final int SCENE_WINDOW_CLOSING
This message is sent just after a scene editing window is closed. The LayoutWindow is passed as an argument.

See Also:
Constant Field Values

SCENE_SAVED

static final int SCENE_SAVED
This message is sent when a scene is saved to disk. The arguments are the File that has just been created, and the LayoutWindow for the scene that was saved.

See Also:
Constant Field Values

OBJECT_WINDOW_CREATED

static final int OBJECT_WINDOW_CREATED
This message is sent when a new object editing window is created. It is sent after the new window has been fully initialized, and just before it is displayed. The ObjectEditorWindow is passed as an argument

See Also:
Constant Field Values

OBJECT_WINDOW_CLOSING

static final int OBJECT_WINDOW_CLOSING
This message is sent just after an object editing window is closed. The ObjectEditorWindow is passed as an argument.

See Also:
Constant Field Values
Method Detail

processMessage

void processMessage(int message,
                    java.lang.Object[] args)
This is the main method for the plugin. message indicates what event is taking place, and is represented by one of the constants defined above. args is a list of arguments, whose meaning depends on the message. This interface is designed to allow new messages to be created in the future. Therefore, processMessage() should ignore any messages it is not specifically intended to deal with.



Copyright © 1999-2011 by Peter Eastman.