OnEndSceneOpen (XSIApplication)
Description
Fired after a scene open operation is performed, such as a OpenScene command
This event is installed using the XSIApplication.Advise method and can be removed using the XSIApplication.Unadvise method, please see these methods for a detailed example of installing and uninstalling events.
The event may be temporarily muted via the EventInfo.Mute property. All installed events can be viewed in the plugin manager dialog's event tab.
NOTE: The prefered and alternative method of installing this is event is as a self-installing plugin. See PluginRegistrar.RegisterEvent method for more details.
Scripting Syntax
XSIApplication.OnEndSceneOpen ([CustomData], [Filename])
Parameters
|
Parameter |
Type |
Description |
|
CustomData |
Variant |
Custom data passed to the event handler. This argument is optional; you can specify one when binding an event with XSIApplication.Advise. The data is passed to the event handler whenever the event is fired, an empty value is passed if no custom data is specified. |
|
Filename |
String |
The name of the scene to open. |
Examples
1. VBScript Example
function XSIApplication_OnEndSceneOpen( CustomData, FileName ) call Application.LogMessage( "*** VBScript Event - XSIApplication_OnEndSceneOpen ***") end function
2. JScript Example
function XSIApplication::OnEndSceneOpen( CustomData, FileName )
{
Application.LogMessage( "*** JScript Event - XSIApplication::OnEndSceneOpen ***");
// your code here
}3. PerlScript Example
sub XSIApplication_OnEndSceneOpen
{
my ($CustomData, $FileName) = @_;
$Application->LogMessage( "*** PerlScript Event - XSIApplication_OnEndSceneOpen ***");
# your code here
}4. Python Example
def XSIApplication_OnEndSceneOpen( CustomData, FileName ):
Application.LogMessage( '*** PythonScript Event - XSIApplication_OnEndSceneOpen ***')
# your code here
return 05. C++ Example
// // This example illustrates how to implement an event handler for the // OnEndSceneOpen event in C++/COM. // HRESULT WINAPI XSIOnEvent ( LONG in_lEventID, LPVARIANT in_pVar, LONG in_lNum ) { switch (in_lEventID) { case siOnEndSceneOpen: { SetupMyScene( in_pVar[0], in_pVar[1] ) } break; }; return S_OK; }
See Also
|
PluginRegistrar.RegisterEvent |
|||
|
XSIApplication.EventInfos |
|
|
|