siEventID Enum


Enumerations

enum   siEventID {
  siOnActivate = 542179359,
  siOnBeginFileExport = 542179347,
  siOnBeginFileImport = 542179349,
  siOnBeginFrame = 542179338,
  siOnBeginNewScene = 542179328,
  siOnBeginPassChange = 542179369,
  siOnBeginRefModelModLoad = 542179364,
  siOnBeginSceneOpen = 542179330,
  siOnBeginSceneSave = 542179332,
  siOnBeginSceneSave2 = 542179356,
  siOnBeginSceneSaveAs = 542179334,
  siOnBeginSequence = 542179340,
  siOnChangeProject = 542179362,
  siOnCloseScene = 542179358,
  siOnCustomFileExport = 542179367,
  siOnCustomFileImport = 542179366,
  siOnDragAndDrop = 542179368,
  siOnEndFileExport = 542179348,
  siOnEndFileImport = 542179350,
  siOnEndFrame = 542179339,
  siOnEndNewScene = 542179329,
  siOnEndPassChange = 542179370,
  siOnEndRefModelModLoad = 542179365,
  siOnEndSceneOpen = 542179331,
  siOnEndSceneSave = 542179333,
  siOnEndSceneSave2 = 542179357,
  siOnEndSceneSaveAs = 542179335,
  siOnEndSequence = 542179341,
  siOnKeyDown = 542179343,
  siOnKeyUp = 542179342,
  siOnMaximize = 542179360,
  siOnMinimize = 542179361,
  siOnObjectAdded = 542179353,
  siOnObjectRemoved = 542179354,
  siOnRefModelModSave = 542179363,
  siOnSelectionChange = 542179337,
  siOnSourcePathChange = 542179352,
  siOnStartup = 542179351,
  siOnTerminate = 542179336,
  siOnTimeChange = 542179345,
  siOnTimer = 542179355,
  siOnValueChange = 542179344,
  siOnWindowEvent = 542179346
}

Detailed Description

This enumerator provides the identifiers for the Softimage events, they can be used for implementing C++ event handlers in order to identify the events fired by Softimage.
See also:
PluginRegistrar::RegisterConverterEvent, PluginRegistrar::RegisterEvent, PluginRegistrar::RegisterEvent, ViewContext::GetNotificationData

siSourcePathType, SIObject::Type, OnEvent callback


Enumeration Type Documentation

enum siEventID

Enumerator:
siOnActivate  [542179359] OnActivate event identifier. Fired when the Softimage application is activated or deactivated. The Softimage application is activated when a window belonging to a different application than Softimage is about to be deactivated. This results typically from a user action such as changing the focus or closing the window. See the list of available Context Attributes for this event.
siOnBeginFileExport  [542179347] OnBeginFileExport event identifier. This event occurs at the beginning of a file export.

See the list of available Context Attributes for this event.
siOnBeginFileImport  [542179349] OnBeginFileImport event identifier. Fired after a user clicks OK in an Import dialog box. One of the following file formats is then imported:

- Model (.emdl)

- dotXSI (.xsi)

- mixer (.mixer)

- IGES (.iges)

- material library (.matlib)

See the list of available Context Attributes for this event.
siOnBeginFrame  [542179338] OnBeginFrame event identifier. Fired when a frame is rendered. See the list of available Context Attributes for this event.
siOnBeginNewScene  [542179328] OnBeginNewScene event identifier. Fired when a new scene is created.
siOnBeginPassChange  [542179369] OnBeginPassChange event identifier. Fired before a renderpass is changed. See the list of available Context Attributes for this event.
siOnBeginRefModelModLoad  [542179364] OnRefModelPostLoad event identifier. Fired just before loading the modification of the current reference model resolution.
siOnBeginSceneOpen  [542179330] OnBeginSceneOpen event identifier. Fired after a user clicks OK in the Load Scene dialog box. See the list of available Context Attributes for this event.
siOnBeginSceneSave  [542179332] OnBeginSceneSave event identifier. Fired when a scene is saved.
siOnBeginSceneSave2  [542179356] OnBeginSceneSave2 event identifier. Same as siOnBeginSceneSave except this version allows you to pass in the full path name of the scene via Context Attributes.
siOnBeginSceneSaveAs  [542179334] OnBeginSceneSaveAs event identifier. Fired when a scene is saved using File > Save As. Fired after the scene is loaded. See the list of available Context Attributes for this event.
siOnBeginSequence  [542179340] OnBeginSequence event identifier. Fired before the first OnBeginFrame event when a sequence is rendered. See the list of available Context Attributes for this event.
siOnChangeProject  [542179362] OnChangeProject event identifier. Fired when the project changes in Softimage. This can occur when one of the following actions takes place:

- a new project is created<br>
- a project is activated<br>
- a new scene is loaded<br>
- during a crash recovery operation<br>
Note: The event is not fired when a project gets closed due to Softimage terminating.

See the list of available Context Attributes for this event.
siOnCloseScene  [542179358] OnCloseScene event identifier. Fired when a scene is closing. This event occurs before a new scene or a new project is created, or before a scene is loaded.
siOnCustomFileExport  [542179367] OnCustomFileExport event identifier. Fired when exporting an asset with a custom file-extension.
siOnCustomFileImport  [542179366] OnCustomFileImport event identifier. Fired when importing an asset with a custom file-extension.
siOnDragAndDrop  [542179368] OnDragAndDrop event identifier. Fired when a source is dragged over or dropped in a view and no default Softimage handlers dealt with it. See the list of available Context Attributes for this event.
siOnEndFileExport  [542179348] OnEndFileExport event identifier. This event occurs at the end of a file export.

See the list of available Context Attributes for this event.
siOnEndFileImport  [542179350] OnEndFileImport event identifier. Fired after one of the following file formats is imported:

- Model (.emdl)

- dotXSI (.xsi)

- mixer (.mixer)

- IGES (.iges)

- material library (.matlib)

See the list of available Context Attributes for this event.
siOnEndFrame  [542179339] OnEndFrame event identifier. Fired when a frame is rendered. See the list of available Context Attributes for this event.
siOnEndNewScene  [542179329] OnEndNewScene event identifier. Fired when a new scene is created.
siOnEndPassChange  [542179370] OnEndPassChange event identifier. Fired after a renderpass has been changed. See the list of available Context Attributes for this event.
siOnEndRefModelModLoad  [542179365] siOnRefModelPostLoadAfterMod event identifier. Fired just after loading the modification of the current reference model resolution.
siOnEndSceneOpen  [542179331] OnEndSceneOpen event identifier. Fired after the scene is loaded. See the list of available Context Attributes for this event.
siOnEndSceneSave  [542179333] OnEndSceneSave event identifier. Fired when a scene is saved.
siOnEndSceneSave2  [542179357] OnEndSceneSave2 event identifier. Same as siOnEndSceneSave except this version allows you to pass in the full path name of the scene via Context Attributes.
siOnEndSceneSaveAs  [542179335] OnEndSceneSaveAs event identifier. Fired when a scene is saved using File > Save As. See the list of available Context Attributes for this event.
siOnEndSequence  [542179341] OnEndSequence event identifier. Fired after the last OnEndFrame event when a sequence is rendered. See the list of available Context Attributes for this event.
siOnKeyDown  [542179343] OnKeyDown event identifier. Fired when a user presses a key. OnKeyDown is not fired if the window with the focus handles keyboard events. See the list of available Context Attributes for this event.
siOnKeyUp  [542179342] OnKeyUp event identifier. Fired when a user releases a key. OnKeyUp is not fired if the window with the focus handles keyboard events. See the list of available Context Attributes for this event.
siOnMaximize  [542179360] OnMaximize event identifier. Fired when the Softimage application window is maximized. The Maximize action activates the application which therefore triggers an siOnActivate event with a state set to true.
siOnMinimize  [542179361] OnMinimize event identifier. Fired when the Softimage application window is minimized. The Minimize action de-activates the application which therefore triggers an siOnActivate event with a state set to false.
siOnObjectAdded  [542179353] OnObjectAdded event identifier. Fired when an object has been added to the scene. See the list of available Context Attributes.or this event.

Note: Prior to v6.5 this was only available for the Custom Display Host.
siOnObjectRemoved  [542179354] OnObjectRemoved event identifier. Fired when an object has been removed from the scene. See the list of available Context Attributes.or this event.

Note: Prior to v6.5 this was only available for the Custom Display Host.
siOnRefModelModSave  [542179363] OnRefModelPreModSave event identifier. Fired just before saving the modification of the current reference model resolution.
siOnSelectionChange  [542179337] OnSelectionChange event identifier. Fired when the selection lists change. See the list of available Context Attributes.or this event. This event is supported only by the Custom Display Host.
siOnSourcePathChange  [542179352] OnSourcePathChange event identifier. Fired when a Softimage source path is changed. See the list of available Context Attributes for this event.
siOnStartup  [542179351] OnStartup event identifier. Fired when Softimage starts.
siOnTerminate  [542179336] OnTerminate event identifier. Fired when Softimage exits.
siOnTimeChange  [542179345] OnTimeChange event identifier. Fired when the time line changes. See the list of available Context Attributes for this event.
siOnTimer  [542179355] OnTimer event identifier. Fired when a timer elapses.
siOnValueChange  [542179344] OnValueChange event identifier. Fired when a parameter value or scene object is changed. See the list of available Context Attributes.or this event.

Note: This event is a regular Softimage event but is also supported by the Custom Display Host.
siOnWindowEvent  [542179346] OnWindowEvent event identifier. Fired when a custom display changes position or get refreshed. This event is supported only by the Custom Display Host.