Softimage 2014

カスタムプリミティブ

カスタムプリミティブオブジェクトはインプリシットプリミティブであり、完全にその表現を定義することができます。円錐、球などの Softimage のその他のプリミティブのようにカスタムプリミティブオブジェクトを使用することができます。

XSILoadPlugin コールバック内の PluginRegistrar.RegisterPrimitive を使用して、カスタムプリミティブオブジェクトを最初に登録する必要があります。カスタムプリミティブオブジェクトを登録した後、GetPrim および X3DObject::AddPrimitive のようなプリミティブの作成コマンドを使用して作成することができます。カスタムプリミティブオブジェクトのパラメータを定義して、DefineLayout コールバックを使用してプロパティページに表示される箇所を調整することができます。 PPGEvent コールバックは、siParameterChange イベント ID を使用して、パラメータの変更を追跡するのに使用できます。 Draw コールバックは、カスタムプリミティブオブジェクトを描画します。カスタムプリミティブオブジェクトは、OpenGL コールを使用してシーンで直接描画されます。他のインプリシットジオメトリと同じように、カスタムプリミティブオブジェクトは、SIConvert コマンドまたは CreatePrim コマンドのいずれかを使用して変換することができます。カスタムプリミティブオブジェクトは、ポリゴンメッシュにのみ変換することができます。

BoundingBox コールバックは、カスタムプリミティブのバウンディングボックスを返します。バウンディングボックスは、カスタムプリミティブオブジェクトの簡易バージョンを表しており、特定の操作中のパフォーマンスを向上させるために使用されます。 Draw コールバックと異なり、バウンディングボックスの値は内部的にキャッシュされ、パラメータ値に対する変更などの更新がある場合にのみ呼び出されます。

カスタムプリミティブウィザードを使用して、カスタムプリミティブオブジェクトを含む自己インストールプラグインのコードを作成することができます。カスタムプリミティブウィザードにアクセスするには、[プラグインマネージャ] [ファイル] [新規] [プリミティブ] を選択します。

カスタムプリミティブオブジェクトの定義方法については、SDK ワークグループのカスタムプリミティブの例を参照してください(<your_installation_folder>¥Softimage 2014¥XSISDK¥examples¥workgroup¥Addons¥CustomPrimitive)。

GridData オブジェクトの機能強化

新しいメソッド、属性、およびイベントは、GridData オブジェクトを向上させるために追加されます。新しいメソッドを使用すると、GridData オブジェクトに新しい列タイプの設定、行や列の挿入と削除などの便利な機能を実行できます。

新しい属性には、行の高さを固定する siUIGridLockRowHeight、列の幅を固定する siUIGridLockColumnWidth、およびサムネイルのサイズ指定がない場合の既定サイズを設定する siUIGridThumbnailSize があります。新しく追加されたイベントには、パラメータの変更前に呼び出される OnBeginValueChange、パラメータの変更後に呼び出される OnEndValueChange、グリッドウィジェットに選択変更を適用する前に呼び出される OnBeginSelectionChange、グリッドウィジェットに選択変更を適用した後に呼び出される OnEndSelectionChange、グリッドウィジェットでボタンがクリックされたときに呼び出される OnButtonClicked、グリッドウィジェットでヘッダーがダブルクリックされたときに呼び出される OnHeaderDoubleClick、グリッドウィジェット上でマウスが右クリックされたときに呼び出される OnContextMenuInit、グリッドウィジェット上でコンテキストメニューの項目が選択されたときに呼び出される OnContextMenuSelected があります。

詳細については、SDK ワークグループの GridData のサンプルを参照してください。

アップグレードされた Python と新しい環境変数

Windows と Linux では、Softimage とともにインストールされているバージョンは Python v2.7.3 です。Windows と Linux 両方の pywin32 拡張のバージョンは v217 です。さらに、新しい環境変数 WARNPYTHON3K を 1 に設定すると、Python 3.x で機能が動作をしないか異常な動作をしたときにスクリプトログに警告メッセージが生成されるようにすることができます。

新しいクラス(C++)

CustomPrimitive – カスタムプリミティブオブジェクトを表します。
CustomPrimitiveContext – カスタムプリミティブの ConvertToGeom() コールバックによって返されるコンテキストオブジェクトです。

新しいコールバック(C++)

次のコールバックは、カスタムプリミティブオブジェクトに追加されます。

Define – カスタムプリミティブオブジェクトが作成されるたびに呼び出されます。このコールバックを使用して、カスタムプリミティブに対するパラメータを追加することができます。
DefineLayout – Define コールバックがセッションで初めて呼び出された直後に呼び出されます。 PPG.Refresh メソッドを使用するときに、このコールバックを呼び出すこともできます。このコールバックを使用して、プロパティページのユーザインタフェース(UI)コントロールのレイアウトを定義することができます。
Draw – カスタムプリミティブオブジェクトを描画する要求があるときに呼び出されます。座標はカスタムプリミティブオブジェクトのローカル空間に設定されます。
BoundingBox – カスタムプリミティブのバウンディングボックスの要求があるときに呼び出されます。
ConvertToGeom – ジオメトリ変換時にカスタムプリミティブオブジェクトを SIConvert または CreatePrim コマンドに渡すときに、呼び出されます。
PPGEvent は、プロパティページイベントすべてに対するコールバックです。

新しいメソッド（C++）

Framebuffer::GetResolvedPath(const CTime &in_rTime, const CRef& in_rCtx) – フレームバッファで指定された出力ファイル名パステンプレートを受け取り、指定された時間で実際のパス名に変化させて、それを CString として返します。 in_rTime パラメータは、[Frame] および [Field] トークンの結果をコントロールします。
Framebuffer::GetResolvedPath(const CRef & in_rCtx) – フレームバッファで指定された出力ファイル名パスのテンプレートを受け取り、時間に依存しないパスに変化させます。このとき、[Frame]のすべてのインスタンスが一連の '#' 記号に置き換えられます。この記号で現在のフレーム番号とパディング幅を表します。
CICEAttributeDataArray::SetData() – データ配列に書き込むためのカプセル化配列へのアクセッサです。
CICEAttributeDataArray::SetArray() および CICEAttributeDataArray<bool>::SetArray() – 配列内の値を設定します。
CICEAttributeDataArrayCustomType::SetArray(const TData** in_ppData, ULONG in_count, ULONG in_fixedElemSize) および CICEAttributeDataArrayCustomType::SetArray(const TData** in_ppData, ULONG in_count, ULONG* in_pElementSizes) – カスタムタイプのデータ配列内の値を設定します。
CICEAttributeDataArrayString::SetArray() – 文字列 ICE 属性内の値すべてを設定します。
CICEAttributeDataArray2D::SetSubArray() および CICEAttributeDataArray2DString::SetSubArray() – 指定されたインデックスでサブ配列を設定します。これは、書き込み可能な属性でのみサポートされ、組み込みの属性では使用できません。
CICEAttributeDataArray2D::SetArray2D() – 2D ICE 属性内の値すべてを設定します。
CICEAttributeDataArray2DCustomType::SetSubArray(ULONG in_index, const unsigned char** in_ppData, ULONG in_count, ULONG* in_pElemSizes) および CICEAttributeDataArray2DCustomType::SetSubArray (ULONG in_index, const unsigned char** in_ppData, ULONG in_count, ULONG in_fixedElemSize) – 指定されたインデックスでサブ配列を設定します。これは、書き込み可能な属性でのみサポートされ、組み込みの属性では使用できません。
CShape::SetAsInstance() – シェイプのインスタンスとして設定します。
CShape::SetAsReference() – シェイプの参照として設定します。
CShape::SetAsTrivial() – 小さなシェイプのタイプとして設定します。
CValue::CValue(const CStringArray& valSrc) - コンストラクタです。
CValue::CValue& operator=(const CStringArray& valSrc ) – 割り当てです。
CValue::operator CStringArray&() – CStringArray のエクストラクタです。
CValue::operator == (const CStringArray&) const [inline] – CStringArray の等価演算子です。
CustomPrimitive::AddParameter() – 新しいパラメータをかカスタムプリミティブオブジェクトに追加します。
CustomPrimitive::RemoveParameter() – カスタムプリミティブオブジェクトから指定されたパラメータを削除します。
PluginRegistrar::RegisterPrimitive() – カスタムプリミティブタイプを登録します。
GridData::SetIntColumnDef() – 列のタイプを siColumnInt に変更します。
GridData::GetIntColumnDef() – siColumnInt 定義を列に読み込みます。
GridData::SetFloatColumnDef() - 列のタイプを siColumnFloat に変更します。
GridData::GetFloatColumnDef() – 列に siColumnFloat 定義を読み込みます。
GridData::SetVectorColumnDef() – 列のタイプを siColumnVector に変更します。
GridData::GetVectorColumnDef() – 列に siColumnVector 定義を読み込みます。
GridData::SetFileColumnDef() – 列のタイプを siColumnFile に変更します。
GridData::GetFileColumnDef() – 列に siColumnFile 定義を取り込みます。
GridData::SetShaderBallColumnDef() – 列のタイプを siColumnShaderBall に変更します。
GridData::GetShaderBallColumnDef() – 列に siColumnShaderBall 定義を読み込みます。
GridData::SetImageClipColumnDef() – 列のタイプを siColumnImageClip に変更します。
GridData::GetImageClipColumnDef() – 列に siColumnImageClip 定義を読み込みます。
GridData::InsertRow() – 新しい行を挿入します。
GridData::RemoveRow() – 行を削除します。
GridData::InsertColumn() – 新しい列を挿入します。
GridData::RemoveColumn() – 列を削除します。
GridData::SetCellBackgroundColor() – セルの背景カラーを変更します。
GridData::GetCellBackgroundColor() – セルの背景カラーを読み込みます。
GridData::SetColumnsVisibility() – 列の表示/非表示を変更します。
GridData::SetRowsVisibility() – 行の表示/非表示を変更します。
GridData::SetCellReadOnlyFlags() - セルの読み取り専用のフラグを設定します。
GridData::GetCellReadOnlyFlags() – セルの読み取り専用フラグを読み込みます。
GridData::PutMultiSelectionMode() – 複数選択モードを設定します。
GridData::GetMultiSelectionMode() – 複数選択モードを読み込みます。
GridData::PutReadOnly() – グリッドデータ全体の読み取り専用モードを設定します。
GridData::GetReadOnly() – グリッドデータ全体の現在の読み取り専用モードを読み込みます。
CParameterRefArray::PlotAnimation(double in_startFrame, double in_stopFrame, double in_stepFrame, bool in_bProcessRotation, bool in_bDisplayProgressBar, CLongArray &out_startParamValuesIndicesArray, CDoubleArray &out_plottedFramesArray, CDoubleArray &out_plottedValuesArray) – アニメーションの連続したフレームからパラメータ値をプロットすることにより取得したプロット済みの値の配列を返します。
CParameterRefArray::PlotAnimation(double in_startFrame, double in_stepFrame, const CDoubleArray &in_frameset, double in_frameRate, siFCurveType in_fcurveTypeToPlot, siFCurveInterpolation in_interpolation, bool in_bFitValues, double in_fitTolerance, bool in_bProcessRotation, bool in_bDisplayProgressBar) – アニメーションの連続したフレームからパラメータ値をプロットすることにより FCurve オブジェクトの配列を作成して返します。結果の FCurve オブジェクトは、一時的なもので、任意のコンポーネントに接続されません。結果の FCurve オブジェクトのすべては、Application オブジェクトの親となります。
Scene::GetRenderableCameras() – レンダリングできるシーンと追加のカメラ内のカメラすべての配列を返します。
Scene::GetAllCacheClipsAndObjects() – シーン内のすべてのファイルキャッシュクリップの配列およびそれらが適用されるオブジェクト名のリストを返します。

新しいメソッド（オブジェクトモデル）

GridData.SetColumnDef – 列定義を設定します。
GridData.GetColumnDef – 列定義を取得します。
GridData.InsertColumn – 指定されたインデックスで新しい列を挿入します。新しい列タイプは siColumnStandard です。 SetColumnType または SetColumnDef メソッドを呼び出すことにより、後で変更することができます。既存の列は、新しい列に合わせて右にシフトされます。
GridData.InsertRow – 指定されたインデックスで、行を挿入します。既存の行は、新しい行に合わせて下にシフトされます。
GridData.RemoveColumn – 指定されたインデックスの列を削除します。削除された列の右側の列は、1 インデックスずつ左方向に移動します。
GridData.RemoveRow – 指定されたインデックスの行を削除します。削除された行の下の行は、1 インデックスずつ上に移動します。
GridData.SetColumnsVisibility – 列のセットを非表示または表示にします。
GridData.SetRowsVisibility – 行のセットを非表示または表示にします。
GridData.SetCellReadOnlyFlags – 指定したセルの読み取り専用フラグを変更します。
GridData.GetCellReadOnlyFlags – 指定したセルの読み取り専用フラグを取得します。
GridData.SetCellBackgroundColor – セルの背景カラーを設定します。
GridData.GetCellBackgroundColor – 指定したセルの背景カラーを取得します。
GridWidget.GetSelection – 現在の選択を取得します。

新しいストラクチャ(C++)

CShape::ParameterInstance – シェイプインスタンスのパラメータを保持するための構造体です。
CShape::ParameterReference – シェイプリファレンスのパラメータを保持するための構造体です。

新しいコマンド

AddShotClip – 新しいクリップを作成して、トラックに追加します。クリップは、特定のカメラがアクティブになる時間を表します。
GetShotClip – フレームのシーケンス時間が指定されたクリップを検索します。
DeleteUnusedCameraSequencerTracks — 現在使用されていない(クリップがない)カメラシーケンサ内のすべてのトラックを削除します。
FreezeLipSync – 既存のリップシンクオペレータを削除し、シェイプトラックの F カーブを生成します。
GenerateLipSync – Evolver キャラクタのリップシンクアニメーションを生成します。
RemoveICESimInitState – シミュレーションの初期状態を削除します。
PlotFrameSetToActions – フレーム番号で構成されるフレームセットからの値をプロットすることにより、新しいアクションを作成して戻します。
DeleteUnusedCameraSequencerTracks – 現在使用されていないカメラシーケンサ内のすべてのトラックを削除します。
CreateShotCameraAndSwitch – ソースビューポートに基づいてショットカメラを作成し、別のビューポートのカメラとしてショットカメラを設定します。
CreateShotCamera – ソースカメラに基づいて、ショットカメラを作成します。
GetPrimCameraWithoutInterest – 注視点のないカメラプリミティブオブジェクトを作成します。
PlotCamSeqToActions: 連続する Camera Sequencer フレームからの値をプロットすることにより、新しいアクションを作成して戻します。
PlotCamSeqShape – カメラシーケンサでシェイプアニメーションを使用してオブジェクトをプロットします。シェイプソース(キー)はシェイプアニメーションのプロットされたフレームごとに作成されます。
PlotCamSeqForCachedObjects: Camera Sequencer 時間で新しいキャッシュファイルにオブジェクトがキャッシュされたファイルをプロットします。
ApplyCamSeqFileCacheSources: 供給されたクリップを削除し、キャッシュクリップとして入力オブジェクトに各ファイルキャッシュの位置を順次適用します。
GetSceneFrameSetFromCamSeq: Camera Sequencer のフレーム範囲からシーン時間のフレーム数をリマップした時間を取得します。
PlotSequencerCamera – カメラシーケンサのショットクリップすべてに単一カメラを作成します。また、カメラアニメーションの連続するシーケンスフレームからの値をプロットすることより、新しいアクションを作成します。

新しいプロパティ(オブジェクトモデル)

GridData.MultiSelectionMode – グリッドデータの選択モードを設定します。
GridData.ReadOnly – グリッドデータ全体の読み取り専用モードを設定します。
Scene.RenderableCameras – mental ray とその他のレンダラーで使用できるすべてのカメラオブジェクトを含む SIObjectCollection を返します。

新しい列挙型

siICERBDType_Bbox、siICERBDType_ConvexHull、および siICERBDType_ExactShape – リジッドボディダイナミクスで使用されるタイプを定義する定数です。
siRenderNoAttributes – 頂点、エッジなどのメッシュ属性を表示しません。
siOverrideSource: ソースを変更します。
siClipShotType – ショットクリップを表す定数文字列です。
siTrackShotType – ショットトラックを表す定数文字列です。

siGridDataMultiselectionMode

コンスタント	説明
siCellSelection	一度に 1 つのセルが選択されます。
siColumnSelection	選択は 1 つの列に制限されます。
siGlobalSelection	複数選択の制限はありません(既定)。

siGridWidgetColumnType

コンスタント	説明
siColumnInt	セルの値は整数です。
siColumnFloat	セルの値は浮動小数値です。
siColumnImageClip	セルの値はサムネイルで表されるイメージクリップです。
siColumnColor	セルの値はカラーです。
siColumnVector	セルの値は、列の定義に応じて 2、3、または 4 次元の倍精度数値の配列です。
siColumnButton	セルの値はボタンで表されるボタンラベルです。
siColumnFile	セルの値はファイル名またはフォルダ名です。
siColumnshaderBall	セルの値は、シェーダボールで表されるマテリアルです。
siColumnMultiLine	複数行にテキストを入力できる列です。

siPPGEventID

コンスタント	説明
siGridDataEvent	GridData イベントです。イベントによって、次のコールバックが呼び出されます。 _OnBeginValueChange および _OnEndValueChange _OnBeginSelectionChange および _OnEndSelectionChange _OnButtonClicked _OnHeaderDoubleClick _OnContextMenuInit および _OnContextMenuSelected

siDragAndDropAction2 – siOnDragAndDrop2 イベントに指定できるアクションは次のとおりです。

コンスタント	説明
siDragOverAction	上にドラッグします。ソースオブジェクトがシーンエクスプローラまたはビューポートなどのサポートされているターゲットビュー上にドラッグされます。
siDropAction	ドロップします。ソースオブジェクトがシーンエクスプローラまたはビューポートなどのサポートされているターゲットビューにドロップされます。
siDragEnterAction	ドラッグして中に入れます。ソースオブジェクトがシーンエクスプローラまたはビューポートなどのサポートされているターゲットビューに入ります。
siDragLeaveAction	ドラッグして外に出します。ソースオブジェクトがシーンエクスプローラまたはビューポートなどのサポートされているターゲットビューから出ます。

siDragAndDropModifiers – siOnDragAndDrop2 イベントに指定できるマウスおよびキーボードモディファイアは次のとおりです。

コンスタント	説明
siDragModifierLButton	マウスの左ボタンが押されます。
siDragModifierRButton	マウスの右ボタンが押されます。
siDragModifierShift	[Shift]キーが押されます。
siDragModifierCtrl	[Ctrl]キーが押されます。
siDragModifierMButton	マウスの中ボタンが押されます。
siDragModifierAlt	[Alt]キーが押されます。

siDropEffect – ドラッグ操作が siOnDragAndDrop2 イベントによって受け入れられたときに表示されるマウスアイコンは次のとおりです。

コンスタント	説明
siDropEffectCopy	コピー。マウスアイコンの標準アイコンの下に矩形とプラス記号(+)が表示されます。
siDropEffectMove	移動。マウスアイコンの標準アイコンの下に矩形が表示されます。
siDropEffectLink	リンク。マウスアイコンの標準アイコンの下に矩形とリンクの記号(矢印)が表示されます。

siRenderQueryType::siRenderQueryHasPreMulAlphaOutput – レンダラーから返されたフラグメントがアルファで乗算済みかどうかを示すブール値を戻します。これは、プレビューウィンドウで色補正に使用されます。
siPPGItemAttribute::siUITabSize – siControlTextEditor に適用する数値属性です。テキストエディタコントロールのタブのサイズを指定します。
siPPGItemAttribute::siUIUseSpacesForTab – siControlTextEditor に適用するブール属性です。 true のとき、[Tab] キーを押すとタブ文字の代わりにスペース文字を挿入します。
siPPGItemAttribute::siUIShowIndentationGuides – siControlTextEditor に適用するブール属性です。各タブサイズ列で、インデントの空白の中に縦の点線として表示されるインデントガイドが表示されます。
siPPGItemAttribute::siUIShowWhitespace – siControlTextEditor に適用するブール属性です。テキストエディタコントロール内の空白文字(スペースやタブ)が表示されます。空白文字は小さな点として表示され、タブ文字は右矢印として表示されます。

新しい PPGEvent タイプ(C++)

siGridDataOnBeginValueChange
siGridDataOnEndValueChange
siGridDataOnBeginSelectionChange
siGridDataOnEndSelectionChange
siGridDataOnButtonClicked
siGridDataOnHeaderDoubleClick
siGridDataOnContextMenuInit
siGridDataOnContextMenuSelected

新しいイベント

siOnBeginRenderPass – パスがレンダリングされる前に発生します。このコールバックは、レンダリングの開始前にシーンを修正するために使用することができます。
siOnEndRenderPass – パスがレンダリングされた後に発生します。

siOnDragAndDrop2 – ソースがシーンエクスプローラやビューポートなどのサポートされているビューに入ったり、そこから出たり、上にドラッグされたり、中にドロップされたりしたときに発生します。コンテキスト属性は次のとおりです。

Attribute	詳細
DragAndDropAction	コールバックで処理する必要があるアクションのタイプを指定するための siDragAndDropAction2 値。指定できるアクションは次のとおりです。 siDragOverAction siDropAction siDragEnterAction siDragLeaveAction
DragSourceObjects	ドラッグされているソースオブジェクトの配列。 Softimage SDK オブジェクトまたは文字列の配列にすることができます。
DragTargetObjects	ソースがドラッグされているターゲットの配列。
DragTargetView	ドラッグ & ドロップの操作が発生するビュー。
DragMouseCoordinates	ビューのクライアント領域内でマウスの座標(X, Y)を表す配列(2 要素)。
Drag3DCoordinates	マウスの位置に対して 3D 座標(X, Y,Z)を示す配列(3 要素)。DragTargetView 属性がビューポートの場合にのみ有効です。
DragModifiers	現在適用されているモディファイヤの組み合わせを指定するための siDragModifiers フラグ。指定できるモディファイヤは次のとおりです。 siDragModifierLButton siDragModifierRButton siDragModifierShift siDragModifierCtrl siDragModifierMButton siDragModifierAlt
DragSourceSupported	出力引数。 DragAndDropAction 属性が siDragOverAction に等しい場合、ソースがサポートされていれば、コールバックはこの出力属性を true に設定します。この属性のデフォルト値は false です。 true が返された場合、(DragAndDropAction と siDropAction が等しい状態で)ソースがドロップされたときに、Softimage は siOnDragAndDrop2 イベントを起動します。 false が返された場合、Softimage は siDropAction を呼び出すかどうかを決定します。 false が返されると、siDragAndDrop2 イベントが接続されていない場合と同じ効果があります。この属性を持つ新しいソースとターゲットの組み合わせに対してのみサポートを追加することができます。イベントコールバックのコードは、この属性に対して一貫した値を返す必要があります。ソースとターゲットのペアが siOnDragOverAction の呼び出しに対して true の DragSourceSupported 属性をもたらす場合、siDropAction の呼び出しに対しても true を返す必要があります。
DragDropEffect	出力引数。 DragSourceSupported 属性が true の場合、siDropEffect 属性はマウスポインタに使用されるアイコンを制御します。指定できる値は次のとおりです。 siDropEffectCopy siDropEffectMove siDropEffectLink

詳細については、<yourinstallationdirectory>Addons¥DragAndDrop¥Application¥Plugins¥DnDEventExample.py で、Python のサンプルを参照してください。

新しいビュー属性

Text Based Editor (Scintilla)属性:

属性名	詳細
showindentationguides	インデントガイドをエディタ内で表示するかどうかを制御します。インデントガイドは、各タブサイズ列にあるインデントの空白の中に縦の点線として表示されます。
smarthighlighting	エディタが現在選択されている単語のすべてのインスタンスをハイライトするかどうかを制御します。

Fx Tree 属性:

属性名	詳細
Targetcontent	ビューに表示されている Fx Tree を戻したり、設定したりします。複数のアイテムを指定した場合は、最初の有効な Fx ツリーだけが表示されます。
Selectednodes	Fx Tree ノードのフルネームを含むコンマ区切り文字列として選択された Fx Tree ノードを戻したり、設定したりします。何も選択されていない場合は、空の文字列を戻します。

その他

SDK ヘルプの「コマンドおよびスクリプトリファレンス」セクションから、FX オペレータプリセット、ジェネレータオペレータプリセット、およびその他を含む、オペレータプリセット情報が、削除されました。オペレータパラメータの詳細については、『Softimage ユーザガイド』の「プロパティリファレンス」のセクションを参照してください。