ユーザ独自のメニューの作成方法

siMenuAnchorPoints 列挙型の形態を分析する

始めに、siMenuAnchorPoints 列挙型のすべてのメンバは、siMenu で開始し、ID で終了します。 各メンバは、アンカー ポイントのタイプを次の規則(ボールド体)のいずれかを基準に識別します。

• ツールバー メニュー: siMenuTb___ID

• ウィンドウ メニュー: siMenuMain___ID

• コンテキスト メニュー: siMenu___ContextID

また、ビュー コンテキストに対応しているコンテキスト メニューには、次の 2 種類があります。

• Scene Explorer: siMenuSE___ContextID

• 3D ビュー: siMenu3DView___ContextID

残りの列挙名(___)には、サブメニューのパスが含まれます。 たとえば、siMenuTbCreateRigidBodyConstraintID は、次のように分類されます。

数種類のアンカー ポイントに同じメニューを追加する

さまざまなメニューに同じメニュー プラグイン項目を追加する必要のある場合があります。 たとえば、プリミティブの新しいタイプを作成するカスタム コマンドを作成した場合、[アプリケーション][コマンド]および[モデル]［作成] [ポリゴンメッシュ］。(Model > Create > Poly. Mesh) ウィンドウ メニュー、[取得](get)[プリミティブ](Primitive)[ポリゴン メッシュ](Polygon Mesh)ツールバー メニューおよび 1 つ以上のコンテキスト メニューにコマンド メニュー エントリを追加できます。

エントリをいくつかのポイントに追加するには、メニュー アンカー ポイントごとに 1 つの RegisterMenu(PluginRegistrar) 呼び出しを追加する必要がありますが、それぞれのアンカー ポイントに同じメニュー プラグイン項目を使用します。 たとえば、プラグインに MooMooCow という名前のカスタム コマンド プラグイン項目が実装されていて、そのコマンドを Scene Explorer の[アプリケーション](Application)[設定](Preferences)ウィンドウ メニューおよび[設定](Preferences)コンテキスト メニューに表示したい場合は、XSILoadPlugin コールバックには、次のような呼び出しを含める必要があります。

// Register the Moo command 
	in_reg.RegisterCommand( "MooMooCow", "Moo" );
	
	// The Moo command will appear in the Application > Preferences
	// menu as well as the (SE) Preferences contextual menu
	in_reg.RegisterMenu( siMenuMainApplicationPreferencesID, "MooMenu", true );
	in_reg.RegisterMenu( siMenuSEPreferenceContextID, "MooMenu", false );

その後、MooMenu_Init コールバックで、メニュー プラグイン項目を一度だけ定義(そのメニュー プラグイン項目に関連付けられたメニュー項目またはエントリを指定)すれば済みます。

ネスト構造: サブメニューを使用する

多くの場合、ユーザ メニューは既存メニューの終端部に表示されます。 エントリが 2、3 個しかない場合は、エントリを同じメニューに表示します。 同じメニューに表示しない場合、サブメニューを使用すれば、多数のエントリを容易に系統立てて編成することができます。

フラット エントリ(同一メニュー)	サブメニュー(ドロップダウン メニュー)

DisplayAsSubmenu パラメータ(PluginRegistrar.RegisterMenu メソッドの)でメニュー プラグイン アイテムに登録しているときに、メニュー プラグイン アイテムがアンカー メニュー内のフラットなリストとして表示するか、または次のドロップダウン メニューとして表示するかどうかを指定します。

// To register a flat menu (no submenu):
	in_reg.RegisterMenu( siMenuTbDeformID, "AnchorPoint", false );

	// To register a submenu:
	in_reg.RegisterMenu( siMenuTbDeformID, "AnchorPoint", true );
	// ... or the equivalent (true is the default):
	in_reg.RegisterMenu( siMenuTbDeformID, "AnchorPoint" );

もう 1 つ興味深い点は、サブメニューをいくつでもネストできることです。ただし、メニュー アンカー ポイントは 1 つしか必要ありません。他の従属サブメニューは、最上位レベル メニュー プラグインの Init コールバック内部で定義されます。この定義の際に使用される AddItem 呼び出しの Style パラメータには、値 siMenuItemSubmenu を指定します。

function NestedMenus_Init( in_context )
	{
		// Get the menu object from the Context input
		var oTopMnu = in_context.Source;

		// Add some regular menu items
		oTopMnu.AddItem( "Regular Item1", siMenuItem );
		oTopMnu.AddItem( "Regular Item2", siMenuItem );

		// Add the submenu item 
		var oSubLevel1 = oTopMnu.AddItem( "SubMenu Demo Level1", 
			siMenuItemSubmenu )
		oSubLevel1.AddItem( "SubLevel1 ItemA", siMenuItem );
		oSubLevel1.AddItem( "SubLevel1 ItemB", siMenuItem );

		// Nest another submenu item 
		var oSubLevel2 = oSubLevel1.AddItem( "SubMenu Demo Level2", 
			siMenuItemSubmenu )
		oSubLevel2.AddItem( "SubLevel2 ItemA", siMenuItem );
		oSubLevel2.AddItem( "SubLevel2 ItemB", siMenuItem );
		oSubLevel2.AddItem( "SubLevel2 ItemC", siMenuItem );
		oSubLevel2.AddItem( "SubLevel2 ItemD", siMenuItem );

		// ... and another ...
		var oSubLevel3 = oSubLevel2.AddItem( "SubMenu Demo Level3", 
			siMenuItemSubmenu )
		oSubLevel3.AddItem( "SubLevel3 ItemA", siMenuItem );
		oSubLevel3.AddItem( "SubLevel3 ItemB", siMenuItem );
		oSubLevel2.AddItem( "SubLevel2 ItemC", siMenuItem );

		// ... etc.

		// Finish with success notification
		return true;
	}

このサンプルでは、次のタイプのネストが生成されます。

メニュー オブジェクトに各サブメニューを追加することにより、AddItem(Menu)呼び出しから返されたメニュー オブジェクトが取得され、別のサブメニューがネストされます。 上に挙げたサンプルにおいて、oTopMnu オブジェクトを使用して各 SubLevel サブメニューを追加した場合は、代わりに 3 つのサブメニューが同一階層として作成されます。

名前付け: ラベルを使用する

フラット メニューの場合、メイン エントリ ポイントの名前は表示されませんが、トップ サブメニューの登録(RegisterMenu(PluginRegistrar))に使用した名前またはサブメニューの追加(AddItem(Menu))に使用した名前は、アンカー ポイントの名前として表示されます(サブメニューの作成の詳細については、「ネスト構造: サブメニューを使用する」を参照)。

メニュー項目(セパレータ以外)に Label パラメータを使用して項目名を定義します(AddItem(Menu)、AddCommandItem(Menu)またはAddItem(Menu))。

// Add an entry that appears as 'Daffy Duck' and calls a special 
	// function defined in the same plug-in file as 'QuackQuackQuack':
	oMnu.AddCallbackItem( "Daffy Duck", "QuackQuackQuack" );

	// Add an entry that appears as 'Launch Explorer' and invokes the
	// 'OpenXSIExplorer' command:
	oMnu.AddCommandItem( "Launch Explorer", "OpenXSIExplorer" );

	// Alternative ways to do the same things:
	var cbk = oMnu.AddItem( "Daffy Duck", siMenuItem );
	cbk.Callback = "QuackQuackQuack";

	var cmd = oMnu.AddItem( "Launch Explorer", siMenuItem );
	cmd.Command = "OpenXSIExplorer";

// Assign 'k' as the access key for the 'Daffy Duck' menu entry:
	oMnu.AddCallbackItem( "Daffy Duc&k", "QuackQuackQuack" );

	// Assign 'x' as the access key for the 'Launch Explorer' menu entry:
	oMnu.AddCommandItem( "Launch E&xplorer", "OpenXSIExplorer" );

系統的な編成: セパレータを使用する

特定のメニュー項目を他のメニュー項目と見分けがつくようにする場合があります。 AddSeparatorItem(Menu) メソッドが用意されています。この特別なメソッドでは水平線を挿入できます。 たとえば以下のようになります。

// Of five items, separate the third and fourth
		oSepMnu.AddItem( "Menu Item 1", siMenuItem );
		oSepMnu.AddItem( "Menu Item 2", siMenuItem );

		oSepMnu.AddSeparatorItem();

		oSepMnu.AddItem( "Menu Item 3", siMenuItem );
		oSepMnu.AddItem( "Menu Item 4", siMenuItem );

		oSepMnu.AddSeparatorItem();

		oSepMnu.AddItem( "Menu Item 5", siMenuItem );

順序付け: メニュー項目の並び順を指定する

最終的なメニュー内でのメニュー項目の並び順は、メニュー項目が定義された順序に応じて決定されます。 これは、すべてのメニュー項目(コマンド エントリ、コールバック エントリ、サブメニュー、およびセパレータ)に当てはまります。 前のセクションで挙げたサンプル(「系統的な編成: セパレータを使用する」)と次のサンプルを比較しましょう。

// Move the lines out of order
		oSepMnu.AddItem( "Menu Item 3", siMenuItem );
		oSepMnu.AddItem( "Menu Item 4", siMenuItem );

		oSepMnu.AddItem( "Menu Item 1", siMenuItem );
		oSepMnu.AddItem( "Menu Item 2", siMenuItem );

		oSepMnu.AddSeparatorItem();
		oSepMnu.AddSeparatorItem();

		oSepMnu.AddItem( "Menu Item 5", siMenuItem );

例: カスタム メニューでポリゴン メッシュ フィルタを使用する

このサンプルは、カスタム メニュー用フィルタの指定方法を例証したものです。 コードは Init コールバックで定義されます。 ヌルまたはサーフェイス メッシュ オブジェクトが選択された状態で、メニュー項目のどれかを起動しようとすると、メニューは無効になります。 ユーザがポリゴン メッシュ オブジェクトを選択するとすぐに、メニューはアクセス可能になります。

// Get the menu object from the Context input
	var oFMnu = in_context.Source;
	oFMnu.Filter = "polygonmesh";

	// Add three callback items but only enable them for
	// polygon meshes.
	oFMnu.AddCallbackItem( "Punch Out Hole", "PunchOutHole" );
	oFMnu.AddCallbackItem( "Remove Corner", "RemoveCorner" );
	oFMnu.AddCallbackItem( "Smooth Curves", "SmoothCurves" );