インタフェース: ParamCollectorOps

このコアインタフェースは、[パラメータコレクター](Parameter Collector)ダイアログボックスへのアクセスを提供します。

Interface: ParamCollectorOps

プロパティ:

ParamCollectorOps.visible : bool : Read|Write

true に設定した場合、パラメータコレクターフロータが表示されます。false に設定した場合、非表示になります。

ParamCollectorOps.multiEdits : bool : Read|Write

[複数の編集](Multiple Edits)アイコンの状態を取得/設定します。true に設定した場合、複数のパラメータを同時にコントロールできます。

ParamCollectorOps.isAbsolute : bool : Read|Write

[絶対/相対](Absolute/Relative)アイコンの状態を取得/設定します。true に設定した(アイコンのチェックマークを消した)場合、編集ボックスには絶対値が表示されます。false に設定した(アイコンのチェックマークを付けた)場合、編集ボックスには相対変化が表示されます。

次のプロパティは、カスタムトラックバーキーフィルタ「パラメータコレクターキー」をコントロールします。

ParamCollectorOps.showTrackBarKeys : bool : Read|Write

パラメータコレクターによって表示されるパラメータのアニメーションキーを、トラックバーに表示するかどうかをコントロールします。既定値は false です。

ParamCollectorOps.showTrackBarSelectedKeys : bool : Read|Write

選択したキーをトラックバーに表示するかどうかをコントロールします。既定値は false です。

ParamCollectorOps.hideOtherKeys : bool : Read|Write

パラメータコレクターに表示されないパラメータのキーを、トラックバーに表示するかどうかをコントロールします。既定値は false です。

メソッド:

<void>ParamCollectorOps.newCollection()

新しいパラメータコレクションを作成します。

<void>ParamCollectorOps.duplicateCollection()

現在のパラメータコレクションのクローンを作成します。

<void>ParamCollectorOps.deleteCollection()

現在のパラメータコレクションを削除します。

<integer>ParamCollectorOps.numCollections()

パラメータコレクションの数を返します。

<index>ParamCollectorOps.getActiveCollection()

現在のパラメータコレクションのインデックスを返します。

<void>ParamCollectorOps.setCollectionName <index>collectionIndex <string>name

インデックスで指定されたパラメータコレクションの名前を、指定した文字列に設定します。

<string>ParamCollectorOps.getCollectionName <index>collectionIndex

インデックスで指定されたパラメータコレクションの名前を、文字列で返します。

<void>ParamCollectorOps.doLinkToObjectDialog()

[オブジェクトにリンク](Links to Object)ダイアログボックスを開きます。

オブジェクトを選択すると、シーンのオブジェクトの一部としてライブリンクを使用して現在のコレクションが保存されます。コレクションを変更すると、オブジェクトに保存されているコレクションのバージョンがすぐに更新されます。

[オブジェクトにリンク](Link to Object)の機能は基本的に[オブジェクトに配置](Put To Object)と同じですが、[オブジェクトにリンク](Link to Object)では、特に共通のプロダクションワークフローである別のシーンにオブジェクトをマージする場合は、コレクションの最新保存バージョンが保証されます。

注:「リンクした」オブジェクトはシーンで 1 つしかアクティブにできませんが、[オブジェクトに配置](Put To Object)は任意の数のオブジェクトに同時に使用できます。

<void>ParamCollectorOps.linkToObject <node>node

指定されたノードに現在のコレクションをリンクします。シーンオブジェクトへのコレクションのリンクについては、上記の説明を参照してください。

<void>ParamCollectorOps.removeLinkToObject()

リンクされていたオブジェクトからコレクションをリンク解除します。

<void>ParamCollectorOps.doPutToObjectDialog()

[オブジェクトに配置](Put To Object)ダイアログボックスを開きます。

オブジェクトに配置すると、シーンのオブジェクトの一部として現在のコレクションが保存されます。

パラメータコレクションは作成元のシーンとともに保存されますが、この機能を使用してコレクションを別のシーンに転送できます。コレクションをオブジェクトに配置したら、シーンを保存します。別のシーンを開くか作成し、保存したシーンから新しいシーンにオブジェクトを合成してから[オブジェクトから取得](Get from Object)を使用します。

シーン内のさまざまなオブジェクトでさまざまなコレクションの配置と取得を行い、パラメータコレクションのバックアップ、編成、合理化を行うこともできます。オブジェクトに配置したコレクションのパラメータやロールアウトの追加、順序変更、削除を行った場合は、オブジェクトに再び配置して、変更内容をコレクションに保存する必要があることに注意してください。「ライブ」更新の場合は、上のオブジェクトへのリンクの説明を参照してください。

<void>ParamCollectorOps.doGetFromObjectDialog()

[オブジェクトから取得](Get from Object)ダイアログボックスを開き、[オブジェクトに配置](Put To Object)または[オブジェクトにリンク](Link To Object)のいずれかを使用してオブジェクトに保存されたコレクションを取得します。

<void>ParamCollectorOps.putToObject <node>node

指定されたノードにコレクションを配置します。シーンオブジェクトへのコレクションの配置については、上記の説明を参照してください。

<void>ParamCollectorOps.getFromObject <node>node

指定されたノードから、配置かリンクが行われたコレクションを取得します。詳細については、上記の説明を参照してください。

<void>ParamCollectorOps.doAddToSelectedDialog()

[選択を追加](Add To Selected)アイコンをクリックすることに対応し、[トラックビュー選択](Track View Pick)ダイアログボックスを開いて、選択されているロールアウトにトラックを追加します。

<void>ParamCollectorOps.doAddDialog()

[新規ロールアウトに追加](Add to New Rollout)アイコンをクリックすることに対応し、[トラックビュー選択](Track View Pick)ダイアログボックスを開いて、新しいロールアウトにトラックを追加します。

<void>ParamCollectorOps.deleteSelectedParameters()

選択したパラメータを削除します。[選択を削除](Delete Selected)アイコンを押した場合に相当します。

<void>ParamCollectorOps.deleteAllParameters()

すべてのパラメータを削除します。[すべて削除](Delete All)アイコンを押した場合に相当します。

<void>ParamCollectorOps.addNewRollout <string>name <bool>addSelectedParameters

指定された名前を使って新しいロールアウトを追加します。

.addSelectedParameters を true にした場合、既存ロールアウトから選択されているパラメータも、新しいロールアウトに追加されます。false にした場合、新しいロールアウトにパラメータは追加されません。

<void>ParamCollectorOps.deleteRollout <index>index

インデックスで指定されたロールアウトを削除します。

<void>ParamCollectorOps.deleteRolloutMoveUp <index>index

インデックスで指定されたロールアウトを削除し、削除したロールアウトから前のロールアウトへすべてのパラメータを移します。

<void>ParamCollectorOps.deleteRolloutMoveDown <index>index

インデックスで指定されたロールアウトを削除し、削除したロールアウトから次のロールアウトへすべてのパラメータを移します。

<void>ParamCollectorOps.DoRenameRolloutDialog()

選択したロールアウトの[ロールアウトの名前を変更](Rename Rollout)ダイアログボックスを開きます。

<void>ParamCollectorOps.RenameRollout <index>index <string>name

インデックスで指定されたロールアウトの名前を、指定の名前に変更します。

<bool>ParamCollectorOps.isRolloutSelected()

選択したロールアウトが存在する場合、true を返します。

<index>ParamCollectorOps.getSelectedRollout()

選択したロールアウトのインデックスを返します。

<integer>ParamCollectorOps.numRollouts <index>collectionIndex

インデックスで指定されたコレクション内のロールアウトの数を返します。

<void>ParamCollectorOps.setRolloutName <index>collectionIndex <index>rolloutIndex <string>name

インデックスで指定されたコレクション内の、インデックスで指定されたロールアウトのロールアウト名を、指定の文字列に設定します。

<string>ParamCollectorOps.getRolloutName <index>collectionIndex <index>rolloutIndex

インデックスで指定されたコレクション内の、インデックスで指定されたロールアウトのロールアウト名を、文字列値で返します。

<integer>ParamCollectorOps.getNumParameters <index>collectionIndex <index>rolloutIndex

インデックスで指定されたコレクションの、インデックスで指定されたロールアウト内のパラメータの数を、整数値で返します。

<bool>ParamCollectorOps.anyParameters()

パラメータが存在する場合は true を、存在しない場合は false を返します。

<bool>ParamCollectorOps.anySelected()

選択したパラメータが存在する場合は true を、存在しない場合は false を返します。

<integer>ParamCollectorOps.numSelected()

選択したパラメータの数を整数値で返します。

<void>ParamCollectorOps.selectAll()

すべてのパラメータを選択します。

<void>ParamCollectorOps.selectAllRollout()

選択したロールアウト内のすべてのパラメータを選択します。

<void>ParamCollectorOps.selectNone()

すべてのパラメータを選択解除します。

<void>ParamCollectorOps.selectInvert()

パラメータ選択を反転します。

<bool>ParamCollectorOps.addParameterBySubNum <fpvalue>animOwner <index>subNum <index>collectionIndex <index>rolloutIndex <string>name

指定した animOwner の、インデックスで指定された subAnim を、インデックスで指定されたコレクションの、インデックスで指定されたロールアウトに、所定の名前を使用して追加します。

<void>ParamCollectorOps.moveSelectedParameters <enum>type 

type enums: {#moveUp|#moveDown|#moveUpRollout|#moveDownRollout}

選択したパラメータを指定した方向に移動します。

<void>ParamCollectorOps.keyParameters <bool>selectedOnly

すべてのパラメータのキーを設定します。selectedOnly が true の場合、選択したパラメータだけにキーが設定されます。

<void>ParamCollectorOps.resetParameters <bool>selectedOnly

すべてのパラメータをリセットします。selectedOnly が true の場合、選択したパラメータだけがリセットされます。

<bool>ParamCollectorOps.addParameter <fpvalue>anim <index>collectionIndex <index>rolloutIndex

指定した anim パラメータを、インデックスで指定されたコレクションの、インデックスで指定されたロールアウトに追加します。

<integer>ParamCollectorOps.getParameterIndex <index>collectionIndex <index>rolloutIndex <index>paramIndexInRollout

インデックスで指定されたコレクションの、インデックスで指定されたロールアウトから、インデックスで指定されたパラメータのインデックスを返します。

<maxObject>ParamCollectorOps.getParameterParentAnim <index>paramIndex

インデックスで指定されたパラメータの親トラックを返します。

<integer>ParamCollectorOps.getParameterSubAnimNum <index>paramIndex

親トラック内でインデックス指定されたパラメータの subAnim のインデックスを返します。

例:

--Create a Box, collect its Length, Width and Height parameters.
--Get the index of the first parameter in the first rollout
--of the first collection(in the above case this is the Length param):
theIndex = ParamCollectorOps.getParameterIndex 1 1 1
--> 1
--Get the parent track of the parameter:
theParent = ParamCollectorOps.getParameterParentAnim theIndex
--> ReferenceTarget:ParamBlock
--Get the subAnim index of the parameter inside the parent:
theSubNum = ParamCollectorOps.getParameterSubAnimNum theIndex
--> 1
--Get the parameter's subAnim
theSubnim = theParent[theSubNum]
--> SubAnim:Length
--Get the value of the parameter
theValue = theSubnim.value
--> 25.0
--Set the value of the parameterto 10
theSubnim.value = 10
--> 10

<maxObject>ParamCollectorOps.getParameterAnim <index>paramIndex

インデックスで指定されたパラメータのアニメーションコントローラオブジェクトを返します。

注:パラメータがアニメートされておらず、コントローラが割り当てられていない場合、このメソッドは undefined を返します。

例:

--Using the same Box and Collection from the above example,
--if you try to access the Length parameter's animation controller,
--you will get undefined by default:
theIndex = ParamCollectorOps.getParameterIndex 1 1 1
--> 1
ParamCollectorOps.getParameterAnim theIndex
--> undefined
--Animate the Length of the Box over time and try again:
with animate on at time 100 $Box01.length = 100
--> 100
ParamCollectorOps.getParameterAnim theIndex
--> Controller:Bezier_Float

<void>ParamCollectorOps.setParameterNotesTitle <index>paramIndex <string>text

インデックスで指定されたパラメータのノートのタイトルを、指定した文字列に設定します。

<string>ParamCollectorOps.getParameterNotesTitle <index>paramIndex

インデックスで指定されたパラメータのノートのタイトルを、文字列で返します。

<void>ParamCollectorOps.setParameterNotesNotes <index>paramIndex <string>text

インデックスで指定されたパラメータのノートテキストを、指定した文字列に設定します。

<string>ParamCollectorOps.getParameterNotesNotes <index>paramIndex

インデックスで指定されたパラメータのノートテキストを、文字列で返します。

<void>ParamCollectorOps.setParameterNotesURL <index>paramIndex <string>text

インデックスで指定されたパラメータのノート URL を、指定した文字列に設定します。

<string>ParamCollectorOps.getParameterNotesURL <index>paramIndex

インデックスで指定されたパラメータのノート URL を、文字列で返します。

<void>ParamCollectorOps.doEditNotesDialog()

[ノートを編集](Edit Notes)ダイアログボックスを開きます。

<void>ParamCollectorOps.refresh()

パラメータコレクターをリフレッシュします。

<integer>ParamCollectorOps.getNumParametersInCollection <index>collectionIndex

インデックスで指定されたコレクション内のパラメータの数を返します。

<int by value array>ParamCollectorOps.getSelectedParameters <index>collectionIndex

インデックスで指定されたコレクション内の選択されたパラメータの配列を返します。

<void>ParamCollectorOps.doRemoveFromObjectDialog()

[オブジェクトから除去](Remove From Object)ダイアログボックスを開きます。上で説明したようにオブジェクトに配置かリンクされたコレクションを削除するために使用します。

<void>ParamCollectorOps.removeFromObject <node>node

指定されたノードからコレクションを削除します。上で説明したようにオブジェクトに配置かリンクされたコレクションを削除するために使用します。

<integer>ParamCollectorOps.getNumSelectedParameters <index>collectionIndex <index>rolloutIndex

インデックスで指定されたコレクションの、インデックスで指定されたロールアウト内の、選択したパラメータの数を返します。

<bool>ParamCollectorOps.anyRollouts()

現在のコレクション内にロールアウトが存在する場合は true を返し、存在しない場合は false を返します。

<bool>ParamCollectorOps.addParameterTraverse <fpvalue>anim <bool>addChildren <index>collectionIndex <index>rolloutIndex <string>name

指定したアニメーションオブジェクトの subAnim 階層をトラバースして、インデックスで指定されたコレクションの、インデックスで指定されたロールアウトに、複数のパラメータを追加します。

<void>ParamCollectorOps.setParameterSelected <index>paramIndex <bool>selected

インデックスで指定されたパラメータの選択された状態を、指定したブール値に設定します。

<bool>ParamCollectorOps.getParameterSelected <index>paramIndex

インデックスで指定されたパラメータの選択された状態を、ブール値で返します。

<node by value array>ParamCollectorOps.getParameterNodes <index>paramIndex

インデックスで指定されたパラメータの影響を受けるノードの配列を返します。

インタフェース: ParamCollectorOps

関連事項