Softimage SDK プログラマー ガイド > SDK によるカスタマイズ > カスタム プロパティ > 

自己インストール プロパティの作成

 
 
 

ウィザードを使用して、カスタム プロパティを含む自己インストール プラグイン用のコードを生成できます。 ウィザードでは、プラグインおよびプロパティ用のスケルトン コードだけでなく、メニューにプロパティを追加するために必要なコードも生成できます。

メニューにプロパティを追加すると、選択リスト内の最初のオブジェクトにプロパティを追加するメニュー コマンドが表示されます。

自己インストール プロパティを作成するには

  1. [ファイル](File)[プラグイン](Plug-ins)をクリックして、[プラグインマネージャ]を開きます

    [ヒント ](Tip)[ツール開発環境]レイアウトの[プラグイン](Plug-ins)タブをクリックすると、[プラグインマネージャ]ビューに切り替えることができます。

  2. 次のいずれかの操作を実行します。

    • ユーザ ロケーションでプロパティを作成するには、[ファイル](File)[新規作成](New)[プロパティ](Property)をクリックします。

    • 別の場所(たとえば、Add-on ディレクトリ)でプロパティを作成するには、プラグイン ツリーで場所を展開し、[プラグイン](Plugins)フォルダを右クリックして、[新規作成](New)[プロパティ](Property)をクリックします。

    カスタム プロパティ ウィザードが表示されます。

  3. [プロパティ名](Property Name)ボックスに、プロパティの名前を入力します。

    プロパティ名の先頭文字には必ず英字を使用してください。 以降に続く文字には、英字、数字、アンダースコア(_)を使用できます。

  4. [スクリプト言語](Script Language)リストで、生成する言語をクリックして選択します。

  5. メニューにプロパティを追加したい場合、[メニューに追加](Add to Menu)リストで、メニュー アンカー ポイントをクリックします。

    すると、選択リスト内の最初のオブジェクトにプロパティを追加するメニュー コマンドが生成されます。 メニューに表示されるテキストが、プロパティ名です。

  6. プロパティにパラメータを追加します。 操作方法:

  7. プロパティ ページで、パラメータのレイアウトを定義します。 操作方法:

    (省略可能)この操作は、生成されたDefineLayoutコールバックを編集することにより、いつでも実行できます。

  8. [プロパティ生成](Generate Property)をクリックします。

    スクリプト言語を選択すると、プラグインがロードされて、シーン ルートにプロパティが追加された後、プロパティ ページが開きます。

    C++ を生成した場合は、ユーザが先にプラグインをビルドしておく必要があります。

パラメータを追加する

Define コールバックのボディは、[パラメータ](Parameters)タブで、一連のCustomProperty.AddParameter または CustomProperty::AddParameter 呼び出しを使って生成されます。

パラメータを追加するには

  1. [パラメータ タイプ](ParamType)リストで、追加したいパラメータのタイプをクリックします。

    パラメータ タイプ

    Variant 型

    デフォルト コントロール

    テキスト

    siString

    siControlString

    ブール

    siBool

    siControlCheck

    整数

    siInt4

    siControlNumber

    短整数

    siUByte

    浮動小数点数

    siFloat

    倍精度数

    siDouble

    アルファによるカラー

    カラー または カラー

    siControlRGBA

    グリッド コントロール

    グリッド または グリッド

    siControlGrid

    F カーブ

    FCurve または FCurve

    siControlFCurve

    ボタン

    ボタン

    siControlButton

    上記以外のタイプのコントロール(たとえば、リスト ボックス、コンボ ボックス、シノプティック ウィジット)が必要な場合は、必要なタイプのパラメータを追加します。プロパティを生成した後は、パラメータに別のコントロールを使用するための DefineLayout コールバックを編集することができます。

  2. [名前/ラベル](Name/Label)ボックスに、パラメータの名前を入力します。

    このパラメータ名は、レイアウトにパラメータが追加された場合に、パラメータに関連付けられているコントロール用の既定のラベルとして使用されます。 別のラベルを指定するには、PPGLayout.AddItem または PPGLayout::AddItem への呼び出しを編集します(生成された DefineLayout コールバック関数で)。

    パラメータ名の先頭文字には必ず英字を使用してください。 以降に続く文字には、英字、数字、アンダースコア(_)を使用できます。

    パラメータ名を使用してコールバック関数を命名するので(MyProperty_MyParameter_OnChanged など)、選択したプログラミング言語で該当するパラメータ名が有効な識別子である必要があります。

    名前にスペースが含まれる場合、そのスペースはウィザードで自動的にアンダースコアに置き換えられます。

  3. プロパティ属性を設定します。

    • [読み取り専用](Read Only): このチェック ボックスをオンにすると、パラメータが読み取り専用になります。 そのパラメータがレイアウトに追加されると、コントロールが無効になります。

    • [アニメート可能](Animatable): このチェック ボックスをオンにすると、ユーザによるコントロールのアニメートが許可されます。 このパラメータは、プロパティ ページ上にアニメーション アイコンがあります。

    • [Callback]: デフォルトでは、ウィザードで自動的にパラメータ用コールバック(ボタン用OnClickedと、それ以外のパラメータ用 OnChanged)が生成されます。 パラメータ用コールバックを必要としない場合は、[コールバック](Callback)チェック ボックスをオフにしてください。

    • [デフォルト](Default): パラメータ用の既定値(適用可能な場合)。

    • [値の範囲](Value Range): 数値パラメータ用の最小値および最大値。

    • [UI での値の範囲](UI Value Range): スライダを使って設定できる(数値パラメータ用の)最小値および最大値。 既定では、[UI での値の範囲]は[値の範囲]と同じになります。 [UI での値の範囲]を変更するには、[値の範囲]チェック ボックスをオンにします。

  4. [項目の追加](Add Item)をクリックして、[パラメータ](Parameters)グリッドにパラメータを追加します。

    • グリッドでは、名前およびタイプ以外のパラメータ属性を編集することができます。 セルをクリックして、新しい属性値を入力します。

    • パラメータを削除するには、列(明るい緑色でハイライト表示される列)の始まりにある影付きのセルをクリックし、[選択の削除](Delete Selected)をクリックします。

レイアウトを定義する

[レイアウト](Layout)タブでは、プロパティ ページにコントロールを追加し、列、グループ、およびタブを使用してコントロールを整列できます。 レイアウトに追加された各パラメータ用のデフォルトのコントロール タイプは、生成されたDefineLayoutコールバックによって追加されます。

パラメータ タイプ

既定のコントロール タイプ

テキスト

siControlString

ブール

siControlCheck

整数

siControlNumber

短整数

浮動小数点数

倍精度数

アルファによるカラー

siControlRGBA

グリッド コントロール

siControlGrid

F カーブ

siControlFCurve

ボタン

siControlButton

数種類のコントロール(コンボボックスや一連のラジオボタン)を追加するには、生成されたDefineLayoutコールバックを編集する必要があります。 たとえば、コンボ ボックスが必要な場合は、文字列パラメータまたは数値パラメータをレイアウトに追加して、コードを生成します。 その後、生成された DefineLayout コールバックで、生成された呼び出しを PPGLayout.AddItem または PPGLayout::AddItemに置換します。 

oLayout.AddItem("Param3");

コンボ ボックス用のコードを使用する場合 

var aSnippets = [ "enumerator", 0, "for-in", 1, "switch", 2 ];
oLayout.AddEnumControl( "Param3", aSnippets, "Snippets", siControlCombo );

既定では、コントロール用ラベルとしてパラメータ名が使用されます。 ラベルにスペースを含める場合、生成された PPGLayout.AddItem または PPGLayout::AddItem 呼び出しを次のように編集する必要があります。 

oLayout.AddItem("Property_Name", "Property Name");

PPGLayout.AddItem または PPGLayout::AddItem の 1 番目の引数はパラメータ名で、2 番目はラベルです。

LabelMinPixels や LabelPercentages の設定などの操作が必要な場合は、生成コードも編集する必要があります。

プロパティ ページにコントロールを追加するには

  • [パラメータ](Parameters)リストで、パラメータをクリックし、[追加](Add)をクリックします。

    デフォルトでは、パラメータはユーザが追加した順序どおりにレイアウトに追加されます。 ただし、[レイアウト]リストでパラメータを選択した場合、次回パラメータを追加する際には、選択されたパラメータの真上に追加パラメータが挿入されます。

    [レイアウト]リストの順序は、[上へ]ボタンおよび[下へ]ボタンを使用して並べ替えることができます。

行を追加するには

  1. [列の追加](Add Row)をクリックします。

    空の行が[レイアウト](Layout)リストに追加されます。 [レイアウト](Layout)リストでパラメータを選択した場合、選択されたパラメータの真上に行が追加されます。

  2. [レイアウト](Layout)リストで、行内に配置したいパラメータの 1 つをクリックし、行内にパラメータが表示されるまで[上へ](Up)(または[下へ](Down))をクリックします。

    行内に配置する他のパラメータに対しても同じ操作を実行します。

グループを追加するには

  1. [グループ化](Groupings)の[名前](Name)ボックスに、グループの名前を入力します。

  2. [グループの追加](Add Group)をクリックします。

    空のグループが[レイアウト](Layout)リストに追加されます。 [レイアウト](Layout)リストでパラメータを選択した場合、選択されたパラメータの真上にグループが追加されます。

  3. グループの内部にパラメータを移動するには、そのパラメータをクリックし、[上へ](Up) (パラメータが[レイアウト](Layout)リスト内のグループよりも下にある場合)または[下へ](Down)(パラメータが[レイアウト](Layout)リスト内のグループよりも上にある場合)のどちらかをクリックします。

    同様に、グループの外部にパラメータを移動するには、そのパラメータをクリックし、グループの外部にパラメータが移動するまで[上へ](Up)または[下へ](Down)をクリックします。

タブを追加するには

  1. [グループ化](Groupings)の[名前](Name)ボックスに、タブの名前を入力します。

    あるグループに名前(ラベル)を付けない場合、、生成された PPGLayout.AddGroup または PPGLayout::AddGroup への呼び出しを編集する必要があります(DefineLayout コールバックで)。

  2. [タブの追加](Add Tab)をクリックします。

    タブを最初に追加したときに、[レイアウト](Layout)リスト内に既に存在するすべてのパラメータが、そのタブ上に配置されます。

  3. 別のタブを追加するには、[名前](Name)ボックスにタブの名前を入力し、([タブの追加](Add Tab)をクリックする前に)次のいずれかの操作を実行します。

    • レイアウトにさらに他のパラメータを追加し、[レイアウト](Layout)リストで、追加されたパラメータの 1 つをクリックします。

    • [上へ](Up)および[下へ](Down)ボタンを使用して、一部のパラメータをタブの外部に移動します。

    • [レイアウト]リストで、タブ([Tab "name" ]{ 行)をクリックします。 これによって、空のタブが追加されます。

このトピックについてのコメントをお送りください