Autodesk Softimage 2014 SDK ドキュメント

目次Softimage SDK プログラミングガイド新機能と変更点Softimage 2014 Softimage 2013Softimage 2012 Subscription Advantage PackSoftimage 2012Softimage 2011はじめにSDK コンポーネントの紹介Softimage SDK アーキテクチャについてSoftimage API の構造についてSoftimage オブジェクトモデルと C++ API の違いについてSoftimage でのカスタマイズのタイプヘルプを使用する『コマンドおよびスクリプトリファレンスのガイド』の読み方SDK を使用して Softimage をカスタマイズする自己インストールプラグイン自己インストールプラグインの概要プラグインウィザードを使って作業するプラグインプロパティの設定プラグイン用ヘルプファイルの指定プラグイン項目の登録プラグイン項目の命名カスタムプロパティでのプリフィックスの使用コールバックの書き出し自己インストールプラグインを配布する自己インストールプラグインのコールバックプラグインタイプによるコールバックコールバックリストカスタムプリミティブカスタムプリミティブを作成するカスタムプリミティブウィザードカスタムコマンドカスタムコマンドとはカスタムコマンドウィザードコマンドの登録コマンドの機能の設定コマンドのユーザインターフェイステキストの提供引数の追加引数の操作値を返す C++ コールバックの書き出しスクリプトからの C++ カスタムコマンドの呼び出しメニューへのコマンドの追加カスタムコマンドを元に戻す/やり直すカスタムオペレータカスタムオペレータとはオペレータの登録カスタムオペレータウィザード接続の作成カスタムパラメータの追加スタティックオペレータとダイナミックオペレータSoftimage でのオペレータの適用制限事項ランタイムオペレータと自己インストールカスタムオペレータヒントとテクニックカスタムプロパティカスタムプロパティとはカスタムプロパティを作成するダイアログのビルドカスタムプロパティを定義する自己インストールプロパティの作成プロパティの自己インストール式への移行プロパティコールバックプロパティページコントロールラベル固定テキストビットマップウィジット編集可能テキストボックス単一行テキスト複数行テキストテキストエディタウィジェット Enum コントロールリストボックスコンボボックスとドロップダウンボックスラジオボタンアイコンボタンビットフィールドパスコントロールファイルブラウザウィジットフォルダウィジット数値コントロールスライダ付き数値編集ボックス RGB カラーコントロール RGBA カラーコントロール F カーブウィジット GridData ウィジットシノプティックウィジットチェックボックスコマンドボタンコントロール属性を設定するグループコントロールラッピングコントロール(行) 複数ページ(タブ)の使用コントロールウィンドウのサイズ変更カスタムプロパティを動的に変更する処理中のプロパティページの定義ヘルプファイルのを提供するカスタムプロパティページのサンプルカスタム ICENodeカスタム ICENode とは処理フェーズ実装の概要カスタム ICENode の登録ICENodeDefオブジェクト登録の例カスタム ICENode の処理ポートデータへのアクセスポートデータのインデックス処理ポートデータの繰り返し適用マルチポート接続ポートのポリモーフィズムを処理するユーザデータCustomVector3ToScalar の例カスタム ICENode のカテゴリ標準カスタム ICENodeシングルスレッドカスタム ICENodeマルチフェーズカスタム ICENodeエレメントジェネレータカスタム ICENodeシングルスレッド/エレメントジェネレータカスタム ICENodeマルチフェーズ/エレメントジェネレータカスタム ICENodeカスタムICENodeの適用カスタム ICENode ウィザードポートカスタムタイプオプションCodeカスタム ICENodes のアイコンをカスタマイズする制限事項カスタムシェーダSoftimage カスタムシェーダについてシェーダ定義のインスタンス化と ProgIDシェーダ定義プラグインを作成するシェーダ言語パーサ定義を作成するリアルタイム(ハードウェア)シェーダプラグインの作成Preset Manager の登録シェーダファミリシェーダファミリの検出ネイティブ Softimage シェーダファミリカスタムシェーダファミリの作成シェーダパラメータ定義パラメータデータタイプパラメータ定義の追加パラメータ定義の UI コントロールを調整するVBScript の例: レンダツリーでのポートのグループ化JScript の例: UI のないパラメータ定義ShaderDef 属性を設定するレンダラ情報の提供Softimage でのシェーダコードの編集シェーダ定義とパーサの例mental ray シェーダウィザードを使用するカスタム Fx オペレータカスタム Fx オペレータとはソースコードの例UFO の用語実装定義ラスターの入力と出力ユーザデータレンダリング画面描画と画面インタラクションメモリ割り当てFx オペレータのコンパイルUFO のインストールキャラクタ開発キットキャラクタ開発キットを使用する二足、ドッグレッグ、および四足からリグへのコマンドアクセスカスタマイズリグの作成例: カスタムリグスクリプトの分析デフォルトガイド内のガイドオブジェクトを識別する頭と首胸とスパイン腹部と腰尾腕、手、および指脚と足スキン戻り値を使って作業する例: タコリグの作成CDK オブジェクトリファレンス Biped Quadruped Head Arm Hand Belly Spine Torso Tail Leg DogLeg Foot Joint Shadow BicepRoll ForeArmRoll ControlSpline PointSlide ThighSlide UI カスタムフィルタカスタムフィルタとはフィルタタイプフィルタコールバックフィルタの作成3D オブジェクトフィルタの記述SubComponent フィルタの記述プロパティフィルタの記述オブジェクトフィルタの記述コード内でのカスタムフィルタの使用フィルタの登録カスタムイベントイベントとは対応イベントイベントの作成イベントハンドラの登録イベントコールバックコンテキスト属性イベントのミュートイベントハンドラをプログラムによってインストールするカスタムディスプレイホストCustom Display Host について開発環境のセットアップカスタムディスプレイホストのコンポーネントカスタムレンダラカスタムレンダラとはレンダリングエンジンの登録プロパティの追加ファイル形式の指定イメージのレンダリングアーカイブの書き出し単一フレーム/複数フレームのアーカイブシーンのサブセットのレンダリングデバイスドライバデバイスドライバとはデバイスドライバの作成Softimage でのデバイスドライバの登録デバイスドライバのパッケージングデバイスドライバの例標準メニューとコンテキストメニューメニューでカスタマイズできる内容ユーザ独自のメニューの作成方法Softimage でのカスタムメニューの登録カスタムメニューのパッケージングカスタムメニューのサンプルスプレッドシートクエリスプレッドシートクエリとはスプレッドシートクエリのスクリプティングスプレッドシートクエリをインストールするカスタマイズのビルドおよび配布個人用配備オプションSoftimage User Interface Toolkit(XSIUIToolkit)の使用ウォークスルー: プラグインマネージャプラグインマネージャを使った作業プラグインツリーを使った作業プラグインの競合を解決するワークグループを使用するワークグループの管理ウォークスルー: アドオンのビルドアドオンパッケージアドオンディレクトリアドオンを記録するアドオンをパッケージングするアドオンパッケージを編集するアドオンをインストールおよびアンインストールするアドオンパッケージの内容Install Shield を使った Softimage プラグインのインストールパッケージダイアログを使用するファイルのインストールなどにおけるコマンドラインの使用オブジェクトモデルでのアドオン操作制限事項クロスプラットフォームの配備1 つのライブラリファイル(.DLL/SO)に複数のハンドラをバンドルグラフィックシーケンサSoftimage でのハードウェアディスプレイの制御についてSoftimage グラフィックシーケンサ(XGS)プラグインの作成ビューポートコールバックのタイプSDK での作業選択選択範囲のアクセス現在選択されている内容の確認選択されているオブジェクトのリストへのアクセスオブジェクトモデルから選択されているコンポーネントのリストにアクセスするC++ API を介して選択されたコンポーネントのリストにアクセスするCRefArray として選択リストを操作する(C++ API の場合のみ)現在の選択フィルタの取得選択の操作単一のアイテムの選択(選択範囲への追加)項目のリストを選択する特定のアイテムの選択解除(選択範囲からの削除)すべての選択の解除(選択範囲のクリア)階層の操作モデリングジオメトリのデフォーム(コンポーネントの変更)トポロジの変更(コンポーネントの追加と削除)クラスタを取得するテクスチャUVへのアクセス頂点カラーへのアクセスポリゴンアイランドの列挙ローカルリファレンスフレームの取得モード値の操作アニメーションアニメーションレベルエクスプレッションエクスプレッションを作成するエクスプレッションのアクセスリンクパラメータF カーブF カーブの補間と外挿コンストレイントシェイプアニメーションエンベロープソースとクリップ DataSource 相対名Animation Mixer再生コントロールPlayControl プロパティセットにアクセスする現在のフレームを取得および変更するタイムライン上で移動する目的の方向への再生開始PlayControl オプションを変更するフレームレートおよびフォーマットを制御する再生中の各フレーム変更におけるコマンドを実行するICE ノードICE とはポートポリモーフィズムとデータの整合性配列ノードのデータへのアクセスICE グラフをデバッグするICE ノードパーティクルパーティクルクラウドの作成シミュレート ICE ツリーのコンポーネントのアクセス Softimage シーングラフを使った作業 3D オブジェクトの検索ツリー内の移動特別なナビゲーションツールフルパスによるエレメントの検索パラメータを使った作業パラメータとはパラメータ値へのアクセスコンパウンドパラメータプロキシパラメータシーンのロード完了後の値の設定(補助ファイル) 戻り値および出力引数を使って操作する戻り値の概要出力引数の概要各言語でサポートされている出力引数 ISIVTCollectionの概要関数がすでに値を戻している場合の処理について戻り値および出力引数の処理の例 VBScript の例: 出力引数と ISIVTCollection VBScript の例: メソッドから出力引数を取得する JScript の例: メソッド「2」の回避策の使用JScript の例: ISIVTCollection の使用 Python の例: コマンドから戻された ISIVTCollection を使用した作業Python の例: メソッドから出力引数にアクセスするためにタプルを使用する例: 出力引数と戻り値のカスタムコマンドによる回避策オペレータでの作業オペレータとはオペレータを適用するコネクションセットについてオペレータとその他へのアクセスファイルとパスを使った作業外部ファイルの情報の取得UNC パスカスタムデータ(ユーザデータ)の格納ユーザデータとはバイナリユーザデータのオブジェクトにアタッチするコンポーネント上のバイナリユーザデータにアクセスするコンポーネント上のユーザデータテンプレートにアクセスするシーン内のユーザデータの検索SOFTIMAGE|3D のユーザデータを読み込む実行した操作に対する情報の表示ユーザ設定を使った操作スクリプト開発Softimage スクリプト入門サポートされるスクリプト言語Softimage オブジェクトモデルの使い方(初心者向け)詳細情報の参照先Python スクリプトPython を取得して Softimage 定数(enum)を認識するメソッドからの出力引数の取得Python クラスをコマンドボタンにリンクするSoftimage でPython カスタムモジュールを使って操作するカスタムコマンドから Python タイプを返すPython のショートカットヒント例コマンド例オブジェクトモデルの例Script Editor の使用Script Editor についてスクリプトを編集するコーディングの簡素化スクリプト環境のカスタマイズコマンドヒストリの使用ヘルプの取得スクリプトファイルを管理するスクリプトを実行するシーンエレメントへのアクセス文字列式オブジェクト名コンポーネントエレメントタイプパラメータオブジェクトリストマークパラメータリストスクリプトコマンドで選択するデータ型と戻り値「型」について言語間でのデータタイプを比較する整数LongFloatDouble文字列ブールVariant配列KeyValue値を返す戻り値に関する必要な知識オブジェクトおよびコレクションに関する注意事項戻り値が有効であるかどうかを確認する戻り値の型をチェックするSoftimage で配列(およびその他のコレクション)を使った作業ネイティブ配列の使用GridData オブジェクトの使用カスタムプロパティセット内での GridData オブジェクトの使用GridData オブジェクトを一時的に使用するコレクションと配列コレクションを使用するコレクションを作成および追加するコレクションとコレクション項目の削除グループとコレクションおよび配列Softimage ネイティブコマンドによるグループへのアクセスオブジェクトモデルを使用してグループにアクセスする特殊なスクリプト関数およびオブジェクトActiveX オブジェクトの作成グローバル(ネイティブ)オブジェクト最適化されたコードの記述GetValue および SetValue の代わりにオブジェクトモデルを使用する現在のフレームを変更する代わりに EvaluateAt()を使用するオブジェクトモデルでグローバル変数を使用する文字列式とオブジェクトポインタの間の不要な変換を回避するスクリプトのデバッグMicrosoft Script Debugger の使用PyWin Debugger の使用エラーメッセージについてERROR<so>ERROR:2001-<function_name> - Argument <#> is invalid<so>2001function_name Argument <#> is invalidERROR : 2038 - Bad Variable TypeERROR : 2000 - Argument <#>(<parametername>)is invalidERROR : Cannot use parentheses when calling a SubERROR : Expected end of statementERROR : Invalid argument specifiedERROR : <enum_name> is not definedERROR : <tuple_name> is not definedERROR : ’tuple’ object has no attributeERROR : Object doesn't support this property or method:ERROR : Object not a collectionERROR : Object requiredERROR : (Python)dict can not be converted to a COM VARIANTERROR : Syntax errorERROR : Type mismatchERROR : Wrong number of arguments or invalid property assignmentバッチスクリプトの実行 Softimage の稼動モードを確認する方法(バッチモードまたはインタラクティブモード)バッチスクリプトに引数を渡す方法バッチモードでスクリプトを実行するリモートでのスクリプト実行コマンドウィンドウを自動的に閉じるリアルタイムメッセージログ他のアプリケーションとの相互運用性C++ API 開発C++ API についてC++ プラグインのビルドC++ プラグインの作成プラグインのコンパイルプラグインのデバッグプラグインのリビルドビルドに関する一般的な問題環境変数およびビルドフラグC++ API を使用したプログラミングSoftimage オブジェクトの参照: CRefCRef キャストオペレータについてSoftimage での操作 Variant および SafeArray の使用UV順序パラメータパフォーマンスの最適化 C++ からのコマンドの呼び出し戻り値へのアクセス出力引数を操作するレガシープラグインコールバックレガシープラグインの移行C++ API と Softimage オブジェクトモデルの混在C# 開発Softimage で C# を使用するC# プラグインのビルドC# プラグインを作成するプラグインのコンパイルプラグインのデバッグプラグインのリビルドビルドまたはロードに関する一般的な問題共有ネットワークからプラグインをロードできない Softimage で .NET プラグインをロードできないC#を使用したプログラミングSoftimage での操作C# のデータ型とキャスティングについて列挙型定数と文字列定数の使用オブジェクトモデルメンバの呼び出しC# からのコマンドの呼び出しC# による Softimage プラグインのビルドXSICollection オブジェクトの作成