//-------------------------------------------------------------------

// JScript implementation example of a custom menu plug-in.

//

// README: Copy and paste the example into the script editor 

// and run (F5).

//

// The menu will install itself into the modelling toolbar

// in the modify deform section.

//-------------------------------------------------------------------

// This function is required to register the menu in Softimage

function XSILoadPlugin( in_reg )

{

	// register plug-in information

	in_reg.Author = "Softimage Corp.";

	in_reg.Name = "Menu Example";

	// var the version number of this plug-in

	in_reg.Major = 1;

	in_reg.Minor = 0;

	// install a dynamic custom menu in the spatial section in the deform menu (model toolbar)

	in_reg.RegisterMenu( siMenuTbDeformSpatialID, "MenuExample", true, true );

	return true;

}

// This is the callbackfunction used for building the menu. Since the menu is

// dynamic, thefunction is called each time the menu opens.

function MenuExample_Init( in_ctxt )	

{

	// retrieve the menu object to build 

	var menu = in_ctxt.Source;

	// var the menu caption

	menu.Name = "&Custom Deform";

	// attach the Twist command to the first menu item

	menu.AddCommandItem( "&Twist", "Twist" );

	// adds a separator	

	menu.AddSeparatorItem();

	// adds other menu items and attach afunction callback

	var item = menu.AddItem( "Custom &1", siMenuItem );

	item.Callback = "OnMenuItem";

	menu.AddCallbackItem( "Custom &2", "OnMenuItem" );

	menu.AddCallbackItem( "Custom &3", "OnMenuItem" );

	menu.AddSeparatorItem();

	var submenu = menu.AddSubMenu( "&function menu" );

	submenu.AddCommandItem( "Sub&divide", "Subdivide" );

	// var the submenu menu with a polygon filter, the menu will be enabled only 

	// if polygons are selected.

	submenu.Filter = "Polygon";

	return true;

}

// This callbackfunction is called by Softimage when the menu item 1 or 2 are 

// selected

function OnMenuItem( in_ctxt )

{

	var menuitem = in_ctxt.source;

	LogMessage( menuitem.name + ":" + menuitem.callback );

}

//--------------------------------------------------------------------

// Code to bootstrap example into system

//--------------------------------------------------------------------

function ExampleSourceCode()

{

	return "// XSISDK Doc Example\n" +	

		MenuExample_Init.toString() + "\n" + 

		OnMenuItem.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 		= "ExMenu";

	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);	

	}

}