/*-------------------------------------------------------------------
        The example shows how to register and implement an event plug-in.
        README: Copy and paste the example into the script editor 
        and run (F5).
        The events will now be listed in the plugin manager's pluginitem
        tab and under the plugin node in the plugin browser tab.
        The events will fire whenever there the user creates a newscene,
        either from the menu File->New Scene or from scripting using
        the NewScene() command.
-------------------------------------------------------------------*/
function  XSILoadPlugin( in_reg )
{
        in_reg.Author = "Softimage Co." 
        in_reg.Name = "PluginRegistrar.RegisterEvent Example" 
        // register the event plug-in item 
        in_reg.RegisterEvent( "ExRegisterEvent_BeginNewScene", siOnBeginNewScene );
        in_reg.RegisterEvent( "ExRegisterEvent_EndNewScene", siOnEndNewScene );
        // register a command to illustrate events firing.
        in_reg.RegisterCommand( "ExRegisterEventDemo", "ExRegisterEventDemo" );
        return true;
} 
function  ExRegisterEvent_BeginNewScene_OnEvent( in_context )
{
        Application.LogMessage( "ExRegisterEvent_BeginNewScene_OnEvent called" );
}
function  ExRegisterEvent_EndNewScene_OnEvent( in_context )
{
        Application.LogMessage( "ExRegisterEvent_EndNewScene_OnEvent called");
}
function  ExRegisterEventDemo_Execute()
{
        NewScene();
}
//--------------------------------------------------------------------
// Code to bootstrap example into system
//--------------------------------------------------------------------
function ExampleSourceCode()
{
        return "//XSISDK Doc Example\n" +
                ExRegisterEvent_BeginNewScene_OnEvent.toString() + "\n" + 
                ExRegisterEvent_EndNewScene_OnEvent.toString() + "\n" + 
                ExRegisterEventDemo_Execute.toString() + "\n" + 
                XSILoadPlugin.toString();
}
// if we are running from script editor save code to 
// examples addon folder in the user's directory.
if (GetUserPref("ScriptingSessionActive"))
{
        var ex_name             = "ExPluginRegistrarRegisterEvent";
        var ex_subfolder        = "Plugins";
        var ex_folder           = "XSISDKDocExamples";
        var ex_langsuffix       = ".js";
        CreateAddonDirectories( InstallationPath(siUserPath), ex_folder );
        var fso = XSIFactory.CreateActiveXObject("Scripting.FileSystemObject");
        var filename = XSIUtils.BuildPath( 
                InstallationPath(siUserAddonPath), 
                ex_folder,
                "Application",
                ex_subfolder,
                ex_name+ex_langsuffix );
        if (!fso.FileExists(filename))
        {
                var f = fso.CreateTextFile ( filename );
                f.write( ExampleSourceCode() );
                f.close();
                Application.LoadPlugin(filename);       
        }
        // run demo
        ExRegisterEventDemo();
}