HumanIK - stingray.HumanIK ネームスペースリファレンス - Stingray Lua API リファレンス

stingray.HumanIK ネームスペースリファレンス

説明

このオブジェクトは、HumanIK インタフェースへのアクセスを提供します。

関数

パラメータ

context_index :

number

設定するキャラクタの評価コンテキストのインデックスです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

position :

stingray.Vector3

目的のターゲット位置です。

戻り値
この関数は値を返しません。

特定のエイム コンストレイントのターゲットの位置を、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

クエリーするキャラクタの評価コンテキストに関連付けられたユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

target_unit :

stingray.Unit

エイム対象のキャラクタライズされたユニットです(エイムする raw 位置に切り替えるために nil にすることができます)。

target_effector :

number

エイム対象のエフェクタの EffectorID です。

戻り値
この関数は値を返しません。

特定のエイム コンストレイントのターゲットのユニット(およびエフェクタ)を、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

コンテキストに関連するユニットです。

resource_name :

string

ユニットに関連付けられた .character リソースの名前です。

戻り値
この関数は値を返しません。

ほとんどのケースで明示的にキャラクタのコンテキストを宣言する必要はありません。キャラクタのコンテキストは、関連するユニットで更新イベントが発生するときに、自動的に宣言され作成されます。キャラクタで最初の更新処理が発生する前に、IK をセットアップまたはキャラクタをリターゲットするとき、特にフローを使用するときは、キャラクタのコンテキストを宣言するだけで済みます(コンテキストを宣言しない場合は、プラグインはクエリーを破棄します)。

パラメータ

unit :

stingray.Unit

コンテキストを削除するユニットです。

戻り値
この関数は値を返しません。

属しているワールドが破壊されると、キャラクタのコンテキストは自動的に削除されます。ただし、特定のイベント(Unit Unspawn イベントなど)のキャラクタのコンテキストを、明示的に削除する必要があります。パフォーマンス上の理由から、再度、HumanIK で動作しないキャラクタ上でコンテキストを削除することをお勧めします。たとえば、無効なキャラクタは削除する必要があります。

パラメータ
この関数はパラメータを受け入れません。
戻り値
この関数は値を返しません。

理解しデバッグするのに役立ちます。すべてのキャラクタの評価コンテキストの場合、すべての現在のコンストレイントとメインの設定が一覧表示されます。キャラクタが適切に反応しない理由がわからない場合は、常にこの関数を呼び出します。

パラメータ

unit :

stingray.Unit

HumanIK エフェクタ情報をログにダンプするユニットです。

戻り値
この関数は値を返しません。

理解しデバッグするのに役立ちます。

パラメータ

unit :

stingray.Unit

HumanIK 情報をファイルにダンプするユニットです。

戻り値
この関数は値を返しません。

ファイルは次のとおりです。hik_dump.hik: キャラクタライズ hik_dump.hiks: キャラクタの状態 hik_dump.hikes: エフェクタの状態 hik_dump.hikps: プロパティの状態)

パラメータ

unit :

stingray.Unit

指コントロール コンストレイントの "factor" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

factor_id :

number

設定するコンストレイントの ID(0: すべて、1 ~ 5: 指、6: 横への広がり) です。

戻り値

number

伸張係数(0.0: 伸張なし、1.0: 完全伸張)。

パラメータ

unit :

stingray.Unit

指コントロール コンストレイントの "all" 値を取得するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

boolean

すべての指のコンストレイントを、同時に操作する場合に、true になります。

パラメータ

unit :

stingray.Unit

指コントロール コンストレイントの "left" 値を取得するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

boolean

左手のコンストレイントを操作する場合に、true になります。

パラメータ

unit :

stingray.Unit

指コントロール コンストレイントの "all" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

all :

number

指コントロールを、すべての指で同時に操作する場合に、1 に設定します。

戻り値
この関数は値を返しません。

指コントロールを、すべての指で同時に操作するかどうかを選択することができます。

パラメータ

unit :

stingray.Unit

指コントロール コンストレイントの "factor" 値を設定するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

factor_id :

number

設定するコンストレイントの ID(0: すべて、1 ~ 5: 指、6: 横への広がり) です。

factor :

number

伸張係数(0.0: 伸張なし、1.0: 完全伸張)。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

指コントロール コンストレイントの "left" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

left :

number

指コントロールを、左手で操作する場合に、1 に設定します。

戻り値
この関数は値を返しません。

左手が影響を受けるかどうか(または右手)を選択することができます。

パラメータ

unit :

stingray.Unit

フロア コンタクト コンストレイントの "feet enabled" 値を取得するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

boolean

HumanIK 足ソルビングが有効になってい場合に、true になります。

パラメータ

unit :

stingray.Unit

フロア コンタクト コンストレイントの "hands enabled" 値を取得するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

boolean

HumanIK 手ソルビングが有効になってい場合に、true になります。

パラメータ

unit :

stingray.Unit

フロア コンタクト コンストレイントの "nb rays" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

地表のトポロジをスキャンするために投影されるレイの数です。

パラメータ

unit :

stingray.Unit

フロア コンタクト コンストレイントの "ray down length" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

レイキャスト レイの終了位置のための(足首/手首エフェクタからの)下向きの垂直距離です。

パラメータ

unit :

stingray.Unit

フロア コンタクト コンストレイントの "ray up length" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

レイキャスト レイの開始位置のための(足首/手首エフェクタからの)上向きの垂直距離です。

パラメータ

unit :

stingray.Unit

フロア コンタクト コンストレイントの "hands enabled" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

コンストレイントのスムージング強度

パラメータ

unit :

stingray.Unit

フロア コンタクト コンストレイントの "feet enabled" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

enable_feet :

boolean

足のフロア コンタクトを有効にするには、true に設定します。

戻り値
この関数は値を返しません。

足のフロア コンタクトを特定のフロア コンタクトで有効にするかどうかを設定することができます。コンストレイントされるかどうかは、コンテキストに依存します。

パラメータ

unit :

stingray.Unit

フロア コンタクト コンストレイントの "feet enabled" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

enable_hands :

boolean

手のフロア コンタクトを有効にするには、true に設定します。

戻り値
この関数は値を返しません。

手のフロア コンタクトを特定のフロア コンタクトで有効にするかどうかを設定することができます。コンストレイントされるかどうかは、コンテキストに依存します。

パラメータ

unit :

stingray.Unit

フロア コンタクト コンストレイントの "nb rays" 値を設定するユニットです。

constraint_index :

number

調整するコンストレイントのインデックスです。

nb_rays :

number

地表のトポロジをスキャンするために投影されるレイの数(1 が最小、9 が汎用性値)です。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

フロア コンタクト コンストレイントの "ray down length" 値を設定するユニットです。

constraint_index :

number

調整するコンストレイントのインデックスです。

ray_down_length :

number

レイキャストのレイ開始位置の(足首/手首エフェクタからの)下方向の距離。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

フロア コンタクト コンストレイントの "ray up length" 値を設定するユニットです。

constraint_index :

number

調整するコンストレイントのインデックスです。

ray_up_length :

number

レイキャスト レイの開始位置のための(足首/手首エフェクタからの)上向きの垂直距離です。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

フロア コンタクト コンストレイントの "smoothing" 値を設定するユニットです。

constraint_index :

number

調整するコンストレイントのインデックスです。

smoothing :

number

調整スムージング強度です(0.0 の場合はまったくスムージングされません)。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

インデックスを取得する必要がある評価コンストレイントに関連付けられたユニットです。

constraint_id :

number

確認後のコンストレイント ID です。

戻り値

number

キャラクタの評価コンテキストの IK コンストレイント スタック内のコンストレイントのインデックスです(見つからない場合は -1)。

パラメータ

context_index :

number

照会するキャラクタの評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

コンストレイント タイプです(メインの "HumanIK.lua" ファイルを参照してください)。

パラメータ

context_index :

number

照会するキャラクタの評価コンテキストのインデックスです。

戻り値

string

コンテキスト用のデバッグ名です。

パラメータ

unit :

stingray.Unit

情報の取得元となるユニットです。

戻り値

boolean

FK リグをエディタ ビューポートで描画する必要がある場合は、true になります。

boolean

IK リグをエディタ ビューポートで描画する必要がある場合は、true になります。

boolean

ユニットが選択されていない場合でも、リグを常に描画する必要がある場合は、true になります。

パラメータ

unit :

stingray.Unit

エフェクタのトランスフォームをクエリーするユニットです。

effector_id :

number

トランスフォームを読み込むエフェクタのエフェクタ ID です。

戻り値

stingray.Vector3

エフェクタの位置です。

stingray.Quaternion

エフェクタの方向です。

パラメータ

unit :

stingray.Unit

クエリーするユニットです。

line_index :

number

照会する線分のインデックスです。

戻り値

stingray.Vector3

線分の終点 1 の(ワールド座標内の)位置です。

stingray.Vector3

線分の終点 2 の(ワールド座標内の)位置です。

パラメータ

unit :

stingray.Unit

クエリーするユニットです。

marker_index :

number

照会するマーカーのインデックスです。

戻り値

stingray.Vector3

マーカーの(ワールド座標内の)位置です。

パラメータ

unit :

stingray.Unit

クエリーするユニットです。

node_id :

number

照会するノード ID/ジョイント ID です。

戻り値

number

指定されたノード/ジョイントの子ノード/子ジョイントの数です。

パラメータ

unit :

stingray.Unit

クエリーするユニットです。

node_id :

number

照会するノード ID/ジョイント ID です。

child_index :

number

照会する子ノード/子ジョイントのインデックスです。

戻り値

number

子ノードのインデックスです。

パラメータ

context_index :

number

照会するキャラクタの評価コンテキストのインデックスです。

node_id :

number

照会するノード ID/ジョイント ID です。

戻り値

number

親ノードの ID です。

パラメータ

context_index :

number

照会するキャラクタの評価コンテキストのインデックスです。

node_id :

number

位置を読み込むノードのノード ID です。

fk :

boolean

true のときは FK 位置、false のときは IK 位置です。

戻り値

stingray.Vector3

ノードの位置を返します。

パラメータ

unit :

stingray.Unit

クエリーするユニットです。

node_id :

number

トランスフォームを読み込むノード/ボーンの ID です。

fk :

number

IK 位置を照会するには 0 に設定し、FK 位置を照会するには 1 に設定します。

戻り値

stingray.Vector3

ノード/ボーンの位置です。

stingray.Quaternion

ノード/ボーンの方向です。

FK1 に設定されている場合は、FK 位置を返します。FK0 に設定されている場合は、IK 位置を返します。

パラメータ

unit :

stingray.Unit

情報の取得元となるユニットです。

戻り値

boolean

IK ソルバが、このコンテキストで無効になっている場合は、true になります。

boolean

FK 更新が、このコンテキストで無効になっている場合は、true になります。

パラメータ

unit :

stingray.Unit

リターゲット ソースを取得するユニットです。

戻り値

number

リターゲットのためのソースとして使用されるキャラクタの評価コンテキストのインデックスです(指定しない場合は-1)。

パラメータ

unit :

stingray.Unit

ルック アット コンストレイントの "chest contribution" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定されたルック アット 動作の胸の寄与係数(0.0 ~ 1.0 の間)です。

パラメータ

unit :

stingray.Unit

ルック アット コンストレイントの "xy only" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

boolean

水平方向(XY)の平面でルック アット コンストレイントだけを操作する場合は、true になります。

パラメータ

unit :

stingray.Unit

ルック アット コンストレイントの "chest contribution" 値を設定するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

chest_contribution :

number

胸がどの程度ターゲットのトラッキングに寄与できるかを定義します(0.0: 寄与なし、1.0: 完全に寄与)。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

ルック アット コンストレイントの "target position" 値を設定するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

target_position :

stingray.Vector3

ルック アットする実際のグローバル位置です。

戻り値
この関数は値を返しません。

特定のルック アット コンストレイントのターゲット位置を、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

ルック アット コンストレイントの "target unit" 値を設定するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

target_unit :

stingray.Unit

ルック アットするキャラクタライズされたユニットです(ルック アットの raw 位置に切り替えるために nil にすることができます)。

target_effector :

number

ルック アットするエフェクタの EffectorID です。

戻り値
この関数は値を返しません。

特定のルック アット コンストレイントのターゲットのユニット(およびエフェクタ)を、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

ルック アット コンストレイントの "xy only" 値を設定するユニットです。

constraint_index :

number

設定するコンストレイントのインデックスです。

restrain_to_xy_plan :

boolean

頭(および胸)は XY 平面にモーションを制約します。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

クエリーするユニットです。

node_id :

number

照会するノードのノード ID です。

戻り値

stingray.Vector3

ノードのオイラー/ラジアン単位の最小制限(X、Y、Z)です。

stingray.Vector3

ノードのオイラー/ラジアン単位の最大制限(X、Y、Z)です。

stingray.Quaternion

ノードの事前回転です。

パラメータ

unit :

stingray.Unit

クエリーするユニットです。

node_id :

number

照会するノードのノード ID です。

戻り値

number

制限を書き出す線分の数です。

パラメータ

unit :

stingray.Unit

クエリーするユニットです。

element_index :

number

取得する要素のインデックスです。

戻り値

stingray.Vector3

最初の終点位置(絶対位置)です。

stingray.Vector3

2 番目の終点位置(絶対位置)です。

number

要素の赤コンポーネント

number

要素の緑コンポーネント

number

要素の青コンポーネント

パラメータ

unit :

stingray.Unit

クエリーするユニットです。

node_id :

number

照会するノードのノード ID です。

戻り値

boolean

ノードが制限付きの場合は、true になります。

パラメータ

unit :

stingray.Unit

クエリーするユニットです。

戻り値

number

コンテキストのスタック内の現在のコンストレイントの数です。

パラメータ

unit :

stingray.Unit

クエリーするユニットです。

戻り値

number

コンテキストに関連付けられている線分の数です。

線分は主として、IK の計算中のキーの位置を表示するデバッグのために使用されます。たとえば、あるキャラクタの頭部から別のキャラクタの頭部を指している線分は、ルック アット コンストレイントによって生成される可能性があります。

パラメータ

unit :

stingray.Unit

クエリーするユニットです。

戻り値

number

コンテキストに関連付けられているマーカーの数です。

マーカーは主として、IK の計算中のキーの位置を表示するデバッグのために使用されます。たとえば、フロア コンタクトの計算時に計算されたレイ キャストの衝突ポイントが、マーカーを生成する可能性があります。

パラメータ

unit :

stingray.Unit

オフセット位置コンストレイントの "effector" 値を取得するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

number

オフセット回転コンストレイントのエフェクタ ID です。

パラメータ

unit :

stingray.Unit

オフセット位置コンストレイントの "vector" 値を設定するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

stingray.Vector3

オフセット回転コンストレイントのデルタ ベクトル(ディスプレイスメント)です。

パラメータ

unit :

stingray.Unit

オフセット位置コンストレイントの "world space" 値を取得するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

boolean

ワールド空間でコンストレイントの作業している場合は、true になります。

パラメータ

unit :

stingray.Unit

設定するオフセット位置コンストレイント「エフェクタ」値を持つユニット

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

effector_id :

number

コンストレイントに適用するエフェクタ(Hips、LeftWrist、...)のエフェクタ ID です。

戻り値
この関数は値を返しません。

特定のオフセット位置コンストレイントエフェクタを、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

オフセット位置コンストレイントの "vector" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

delta :

stingray.Vector3

適用する位置オフセットのデルタ ベクトル(ディスプレイスメント)です。

戻り値
この関数は値を返しません。

特定のオフセット位置コンストレイントのデルタ ベクトルを、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

オフセット位置コンストレイントの "world space" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

world_space :

number

ワールド空間で作業するには 1 に設定し、それ以外の場合は、リファレンス ポーズは(ローカル座標の)最新評価ポーズになります。

戻り値
この関数は値を返しません。

特定のオフセット位置コンストレイントのコンストレイントの空間(ワールド空間/ローカル空間(最新評価ポーズ))は、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

オフセット回転コンストレイントの "angle" 値を取得するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

number

オフセット回転コンストレイントの角度(度数)です。

パラメータ

unit :

stingray.Unit

オフセット回転コンストレイントの "axis" 値を取得するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

stingray.Vector3

オフセット回転コンストレイントの軸です。

パラメータ

unit :

stingray.Unit

オフセット回転コンストレイントの "effector" の値を取得するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

number

オフセット回転コンストレイントのエフェクタ ID です。

パラメータ

unit :

stingray.Unit

オフセット回転コンストレイントの "is world space" 値を取得するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

boolean

ワールド空間でコンストレイントの作業している場合は、true になります。

パラメータ

unit :

stingray.Unit

オフセット回転コンストレイントの "angle" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

angle :

number

適用するオフセット回転の角度(度数)です。

戻り値
この関数は値を返しません。

特定のオフセット回転コンストレイントの角度を、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

オフセット回転コンストレイントの "axis" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

axis :

stingray.Vector3

適用する回転オフセットの軸です。

戻り値
この関数は値を返しません。

特定のオフセット回転コンストレイントの回転の軸を、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

オフセット回転コンストレイントの "effector" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

effector :

number

コンストレイントに適用するエフェクタ(Hips、LeftWrist、...)のエフェクタ ID です。

戻り値
この関数は値を返しません。

特定のオフセット回転コンストレイントのエフェクタを、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

オフセット回転コンストレイントの "world space" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

world_space :

number

ワールド空間で作業するには 1 に設定し、それ以外の場合は、リファレンス ポーズは(ローカル座標の)最新評価ポーズになります。

戻り値
この関数は値を返しません。

特定のオフセット回転コンストレイントのコンストレイントの空間(ワールド空間/ローカル空間(最新評価ポーズ))は、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

ピン コンストレイントの "effector" 値を取得するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

number

ピン コンストレイントのエフェクタ ID です。

パラメータ

unit :

stingray.Unit

ピン コンストレイントの "world space" 値を取得するユニットです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

boolean

ワールド空間でコンストレイントの作業している場合は、true になります。

パラメータ

unit :

stingray.Unit

設定するピン コンストレイント「エフェクタ」値を持つユニット

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

effector_id :

number

コンストレイントに適用するエフェクタ(Hips、LeftWrist、...)のエフェクタ ID です。

戻り値
この関数は値を返しません。

特定のピン コンストレイントのエフェクタを、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

ピン コンストレイントの "world space" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

world_space :

number

ワールド空間で作業するには 1 に設定し、それ以外の場合は、リファレンス ポーズは(ローカル座標の)最新評価ポーズになります。

戻り値
この関数は値を返しません。

特定のピン コンストレイントのコンストレイントの空間(ワールド空間/ローカル空間(最新評価ポーズ))は、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

Plant コンストレイントの "depth" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

コンストレイントの埋め込みの深さです。

パラメータ

unit :

stingray.Unit

Plant コンストレイントの "feet enabled" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

boolean

足の接地が有効になっている場合は、true になります。

パラメータ

unit :

stingray.Unit

Plant コンストレイントの "feet enabled" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

boolean

手の接地が有効になっている場合は、true になります。

パラメータ

unit :

stingray.Unit

Plant コンストレイントの "nb rays" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

地表のトポロジをスキャンするために投影されるレイの数です。

パラメータ

unit :

stingray.Unit

Plant コンストレイントの "ray down length" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

レイキャスト レイの終了位置のための(足首/手首エフェクタからの)下向きの垂直距離です。

パラメータ

unit :

stingray.Unit

Plant コンストレイントの "ray up length" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

レイキャスト レイの開始位置のための(足首/手首エフェクタからの)上向きの垂直距離です。

パラメータ

unit :

stingray.Unit

Plant コンストレイントの "smoothing" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

コンストレイントのスムージング強度

パラメータ

unit :

stingray.Unit

Plant コンストレイントの "is relative" 値を取得するユニットです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

boolean

埋め込みが相対モードで動作している場合は、true になります。

パラメータ

unit :

stingray.Unit

Plant コンストレイントの "depth" 値を設定するユニットです。

constraint_index :

number

調整するコンストレイントのインデックスです。

depth :

number

埋め込み深度(0.0 は、正確にフロア サーフェス上を意味し、0.03 が通常の適切な値です)。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

Plant コンストレイントの "feet enabled" 値を設定するユニットです。

constraint_index :

number

調整するコンストレイントのインデックスです。

feet :

boolean

足の接地を有効にするには、true に設定します。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

Plant コンストレイントの "hands enabled" 値を設定するユニットです。

constraint_index :

number

調整するコンストレイントのインデックスです。

hands :

boolean

手の接地(主に四肢)を有効にするには、true に設定します。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

Plant コンストレイントの "nb rays" 値を設定するユニットです。

constraint_index :

number

調整するコンストレイントのインデックスです。

nb_rays :

number

地表のトポロジをスキャンするために投影されるレイの数(1 が最小、9 が汎用性値)です。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

Plant コンストレイントの "ray down length" 値を設定するユニットです。

constraint_index :

number

調整するコンストレイントのインデックスです。

ray_down_length :

number

レイキャスト レイの終了位置のための(足首/手首エフェクタからの)下向きの垂直距離です。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

Plant コンストレイントの "ray up length" 値を設定するユニットです。

constraint_index :

number

調整するコンストレイントのインデックスです。

ray_up_length :

number

レイキャスト レイの開始位置のための(足首/手首エフェクタからの)上向きの垂直距離です。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

Plant コンストレイントの "relative" 値を設定するユニットです。

constraint_index :

number

調整するコンストレイントのインデックスです。

hands :

boolean

相対モード(FK 高度を保持)を有効にするには、true に設定します。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

Plant コンストレイントの "smoothing" 値を設定するユニットです。

constraint_index :

number

調整するコンストレイントのインデックスです。

smoothing :

number

調整スムージング強度です(0.0 の場合はまったくスムージングされません)。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

1 つのコンストレイントごとにキャラクタの評価コンテキストをポップするユニットです。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

キャラクタの評価コンテキストをクリアするユニットです。

戻り値
この関数は値を返しません。

この関数を呼び出した後、そのキャラクタの IK コンストレイント スタックは空になります。

パラメータ

unit :

stingray.Unit

エイム コンストレイントをプッシュするユニットです。

attachment_effectorID :

number

武器がアタッチされているエフェクタ ID です。

hips_contribution :

number

エイムする労力に対するヒップの寄与係数(0.0 ~ 1.0 の間)です。

chest_contribution :

number

エイムする労力に対する胸の寄与係数(0.0 ~ 1.0 の間)です。

shoulder_contribution :

number

エイムする労力に対する肩の寄与係数(0.0 ~ 1.0 の間)です。

elbow_contribution :

number

エイムする労力に対する肘の寄与係数(0.0 ~ 1.0 の間)です。

reference_target_bone :

number

ユニットのリファレンス ターゲット ボーン オブジェクト ノード インデックスです。

pin_other_hand :

boolean

別の手(武器がペアレント化されていない手)を、(ピボットが胸または腰でないときは、両手の武器の)銃に対して相対的な位置に固定します。

target_unit :

number

エイムするキャラクタライズされたユニットです(エイムするターゲット位置に対して nil を設定します)。

target_effector :

number

エイム対象のターゲット ユニットの EffectorID です(ターゲット位置にエイムする場合は、-1 になります)。

target_position :

stingray.Vector3

実際のターゲット位置(aim_at_position が true の場合)

aim_at_position :

boolean

エイム対象のターゲット位置を true に設定し、エイムするターゲット ユニットを false に設定します。

max_angular_speed :

number

トラッキング ベクトルの最大角速度です(1 秒あたりの角度)。

contact :

boolean

接触する武器(または打ち抜かない武器)を扱う場合に、true に設定します。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

エイム コンストレイントは、キャラクタのパーツ(通常は肘、肩、胸またはヒップ)をエイムするターゲットの方向に再設定します。複数のエイムするコンストレイントをキャラクタ上で同時にアクティブにし、エイムする労力を複数の(異なるアルファ値の)ボディー パーツに分散できます。

パラメータ

unit :

stingray.Unit

指コントロール コンストレイントをプッシュするユニットです。

all :

number

指コントロールを、すべての指で同時に操作する場合に、1 に設定します。

left :

number

指コントロールを、左手で操作する場合に、1 に設定します。

hand_factor :

number

全ての手の伸張係数(0.0: 伸張なし、1.0: 完全伸張)です。

factor_1 :

number

指 1 の伸張係数(0.0: 伸張なし、1.0: 完全伸張)です。

factor_2 :

number

指 2 の伸張係数(0.0: 伸張なし、1.0: 完全伸張)です。

factor_3 :

number

指 3 の伸張係数(0.0: 伸張なし、1.0: 完全伸張)です。

factor_4 :

number

指 4 の伸張係数(0.0: 伸張なし、1.0: 完全伸張)です。

factor_5 :

number

指 5 の伸張係数(0.0: 伸張なし、1.0: 完全伸張)です。

spread :

number

横方向の拡散係数(0.0: 拡散なし、1.0: 完全拡散)です。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

フロア コンストレイントをプッシュするユニットです。

enable_feet :

boolean

足のフロア コンタクトを有効にするには、true に設定します。

enable_hands :

boolean

手のフロア コンタクトを有効にするには、true に設定します。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

smoothing :

number

シャープな調整を回避するスムーズ強度です(0.0 は無効を意味します)。

nb_rays :

number

地表の位置と法線をスキャンするためにキャストするレイの数です(1 が最小で、9 の値では多数になります)。

ray_up_length :

number

レイキャスト レイの開始位置のための(足首/手首エフェクタからの)上向きの垂直距離です。

ray_down_length :

number

レイキャスト レイの終了位置のための(足首/手首エフェクタからの)下向きの垂直距離です。

戻り値
この関数は値を返しません。

フロア コンタクトコンストレイントは、脚と腕にだけ影響し、ヒップや胸には影響しません。このコンストレイントの目的は、地形ジオメトリ内に足と手が貫通するのを避けることです。また、ヒップや胸を更新する場合は、Plant コンストレイントを最初に呼び出すことができます。

パラメータ

unit :

stingray.Unit

反転コンストレイントをプッシュするユニットです。

limb_name :

string

反転する四肢の名前です(使用可能な値は、「左脚」、「右脚」。「左腕」、「右腕」です)。

戻り値
この関数は値を返しません。

「反転」コンストレイントは、(前方に曲がる膝のように)予想とは逆の方向に曲がるようにキャラクタの四肢を有効にします。これは、この動作が想定されるニワトリなどの特定の二足歩行動物を扱う場合に便利です。

パラメータ

unit :

stingray.Unit

LOD コンストレイントをプッシュするユニットです。

low_definition_retarget :

boolean

低解像度のリターゲット(true)または完全な精度のリターゲット(false)を使用します。

low_definition_solve :

boolean

低解像度のソルバ(true)または完全な精度のソルバ(false)を使用します。

戻り値
この関数は値を返しません。

LOD ソルバ(低解像度ソルバ)は、完全な精度のソルバより 10 倍の速さで動作します。多くの場合、その結果は、カメラから遠く離れて立っているキャラクタには十分なものです。マルチ パスのソルバ中に、低解像度と高解像度のソルバの両方を使用することは非常に合理的です。

パラメータ

unit :

stingray.Unit

ルック アット コンストレイントをプッシュするユニットです。

target_unit :

number

エイム対象のキャラクタライズされたユニットです(look_at_position が True に設定されている場合は、nil にすることができます)。

target_effector :

number

ルック アットするターゲット エフェクタのエフェクタ ID です(look_at_position が false に設定されている場合は、-1 にすることができます)。

target_position :

stingray.Vector3

実際のターゲット位置(look_at_position が true の場合)です。

look_at_position :

boolean

ルック アットのターゲット位置を true に設定し、ルック アットのターゲット ユニットを false に設定します。

restrain_to_xy_plan :

boolean

頭(および胸)は XY 平面にモーションを制約します。

chest_contribution :

number

胸がどの程度ターゲットのトラッキングに寄与できるかを定義します(0.0: 寄与なし、1.0: 完全に寄与)。

max_angular_speed :

number

トラッキング ベクトルの最大角速度です(1 秒あたりの角度)。

enable_limits :

boolean

FOV 制限を有効にするには、true に設定します。

max_horizontal_angle :

number

最大水平角です(60 の場合、頭部を最大で左 60 度、右 60 度まで動かすことができます)。

max_vertical_angle :

number

最大垂直角です(30 の場合、頭部を最大で上 30 度、下 30 度まで動かすことができます)。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

「ルック アット」コンストレイントを使用すると、1 つのキャラクタが別のキャラクタをルック アットできます。

パラメータ

unit :

stingray.Unit

オフセット位置コンストレイントをプッシュするユニットです。

effector_id :

number

コンストレイントに適用するエフェクタ(Hips、LeftWrist、...)のエフェクタ ID です。

delta :

stingray.Vector3

適用する位置オフセットのデルタ ベクトル(ディスプレイスメント)です。

world_space :

number

ワールド空間で作業するには 1 に設定し、それ以外の場合は、リファレンス ポーズは(ローカル座標の)最新評価ポーズになります。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

「オフセット位置」コンストレイントを使用すると、適用する特定のエフェクタの位置オフセットを設定することができます。位置オフセットは、world_space 値によって、ワールド空間またはローカル空間(最新ポーズ評価)のいずれかで表すことができます。

パラメータ

unit :

stingray.Unit

オフセット回転コンストレイントをプッシュするユニットです。

effector_id :

number

コンストレイントに適用するエフェクタ(Hips、LeftWrist、...)のエフェクタ ID です。

axis :

stingray.Vector3

適用する回転オフセットの軸です。

angle :

number

適用するオフセット回転の角度(度数)です。

world_space :

number

ワールド空間で作業するには 1 に設定し、それ以外の場合は、リファレンス ポーズは(ローカル座標の)最新評価ポーズになります。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

「オフセット回転」コンストレイントを使用すると、適用する特定のエフェクタの回転オフセットを設定することができます。回転オフセットは、world_space 値によって、ワールド空間またはローカル空間(最新ポーズ評価)のいずれかで表すことができます。

パラメータ

unit :

stingray.Unit

LOD コンストレイントをプッシュするユニットです。

solve_left_arm :

boolean

左腕を解決するか、左腕の解決を実行しません。

solve_right_arm :

boolean

右腕を解決するか、右腕の解決を実行しません。

solve_left_leg :

boolean

左脚を解決するか、左脚の解決を実行しません。

solve_right_leg :

boolean

右脚を解決するか、右脚の解決を実行しません。

solve_left_shoulder :

boolean

左肩を解決するか、左肩の解決を実行しません。

solve_right_shoulder :

boolean

右肩を解決するか、右肩の解決を実行しません。

solve_left_hand :

boolean

左手を解決するか、左手の解決を実行しません。

solve_right_hand :

boolean

右手を解決するか、右手の解決を実行しません。

solve_left_foot :

boolean

左足を解決するか、左足の解決を実行しません。

solve_right_foot :

boolean

右足を解決するか、右足の解決を実行しません。

solve_head :

boolean

頭部を解決するか、頭部の解決を実行しません。

solve_spine :

boolean

脊椎を解決するか、脊椎の解決を実行しません。

戻り値
この関数は値を返しません。

既定では、すべてのボディパーツがキャラクタ上で解決されます。特定のボディパーツに対してソルビングを制限するには、IK コンストレイント スタック内にこのコンストレイントを挿入します。マルチ パスのソルバ実行時に、IK コンストレイント スタック内のいくつかの Partial Solving Settings コンストレイントを挿入して修正します。(解決済みパーツは、ソルブ コンストレイントをそれぞれ呼び出した後に、自動的に「all」にリセットされることに注意してください)。

パラメータ

unit :

stingray.Unit

ピン コンストレイントをプッシュするユニットです。

effector_id :

number

コンストレイントに適用するエフェクタ(Hips、LeftWrist、...)のエフェクタ ID です。

world_space :

number

ワールド空間で動作させるには 1 に設定し、キャラクタ空間で動作させるには 0 に設定します。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

「ピン」コンストレイントは、その初期位置(ワールド空間またはキャラクタ空間のいずれか)にエフェクタをロックする簡単な方法です。

パラメータ

unit :

stingray.Unit

Plant コンストレイントをプッシュするユニットです。

enable_feet :

boolean

足のフロア プラントを有効にするには、true に設定します。

enable_hands :

boolean

手のフロア プラントを有効にするには、true に設定します。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

nb_rays :

number

地表の位置と法線をスキャンするためにキャストするレイの数です(1 が最小で、9 の値では多数になります)。

ray_up_length :

number

レイキャスト レイの開始位置のための(足首/手首エフェクタからの)上向きの垂直距離です。

ray_down_length :

number

レイキャスト レイの終了位置のための(足首/手首エフェクタからの)下向きの垂直距離です。

relative :

boolean

相対的なフロア プラント(足首とヒップの FK 高度を保持)を有効にするには、true に設定します。

smoothing :

number

スムージング強度(0.0 はスムージングなしを意味し、1.5 が通常の適切な値です)。

depth :

number

埋め込み深度(0.0 は、正確にフロア サーフェス上を意味し、0.03 が通常の適切な値です)。

affect_chest_rotation :

number

胸の回転が、このノード(0.05 が通常の適切な値)により影響を受ける可能性の度合(0.0 ~ 1.0 の間)です。

affect_hips_rotation :

number

ヒップの回転が、このノード(0.2 が通常の適切な値)により影響を受ける可能性の度合(0.0 ~ 1.0 の間)です。

戻り値
この関数は値を返しません。

このコンストレイントの目的は、地形ジオメトリ内に足と手を埋め込むことです。このため、コンストレイントは、キャラクタのヒップをほぼ垂直に移動することができます。通常、フロア コンタクト コンストレイントは、Plant コンストレイントの直後にスタック上でプッシュされます。

パラメータ

unit :

stingray.Unit

プロパティ値コンストレイントをプッシュするユニットです。

property_id :

number

値を変更するプロパティの ID です。

value :

number

プロパティの新しい値です。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

指コントロール コンストレイントをプッシュするユニットです。

effector_id :

number

コンストレイントに適用するエフェクタ(Hips、LeftWrist、...)のエフェクタ ID です。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

「Pull」コンストレイントにより、次の実際のフル ボディ IK を有効にします。そのコンストレイントを満たすためにボディ全体をドラッグするエフェクタを可能にします。

パラメータ

unit :

stingray.Unit

到達方向コンストレイントをプッシュするユニットです。

effector_id :

number

コンストレイントに適用するエフェクタ(Hips、LeftWrist、...)のエフェクタ ID です。

euler_orientation :

stingray.Vector3

到達するターゲット方向(オイラー角度単位)です。

world_space :

number

ワールド空間で作業するには 1 に設定し、それ以外の場合は、リファレンス ポーズは(ローカル座標の)最新評価ポーズになります。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

「Reach Orientation」コンストレイントにより、到達する特定のエフェクタのターゲット方向を設定することができます。ターゲット方向は、world_space 値によって、ワールド空間またはローカル空間(最新ポーズ評価)のいずれかで表すことができます。

パラメータ

unit :

stingray.Unit

到達位置コンストレイントをプッシュするユニットです。

effector_id :

number

コンストレイントに適用するエフェクタ(Hips、LeftWrist、...)のエフェクタ ID です。

position :

stingray.Vector3

目的のターゲット位置です。

world_space :

number

ワールド空間で作業するには 1 に設定し、それ以外の場合は、リファレンス ポーズは(ローカル座標の)最新評価ポーズになります。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

「Reach Position」コンストレイントにより、到達する特定のエフェクタのターゲット位置を設定することができます。ターゲット位置は、world_space 値によって、ワールド空間またはローカル空間(最新ポーズ評価)のいずれかで表すことができます。

パラメータ

unit :

stingray.Unit

相対的なピン コンストレイントをプッシュするユニットです。

effector_id :

number

コンストレイントに適用するエフェクタ(Hips、LeftWrist、...)のエフェクタ ID です。

pin_to_unit :

stingray.Unit

相対的な固定に使用するユニットです。

pin_to_unit_object :

number

ユニット オブジェクト ノード インデックスです。

translation :

number

変換係数(0.0 ~ 1.0 の間)(既定は 1.0 に設定)です。

rotation :

number

回転係数(0.0 ~ 1.0 の間)(既定は 1.0 に設定)です。

pull :

number

プル係数(0.0 ~ 1.0 の間)です。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

相対的なピン コンストレイントは、エフェクタを外部ユニットに固定します(これにより、この外部ユニットを移動または回転させ、エフェクタがその動きを追跡します)。

パラメータ

unit :

stingray.Unit

Resist コンストレイントをプッシュするユニットです。

effector_id :

number

コンストレイントに適用するエフェクタ(Hips、LeftWrist、...)のエフェクタ ID です。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

「Resist」コンストレイントは、フルボディ IK でのみ有効であり、元の FK 方向を保持する必要がある度合いを示します。

パラメータ

unit :

stingray.Unit

ソルブ コンストレイントをプッシュするユニットです。

戻り値
この関数は値を返しません。

しかし一部のケースでは、同じフレームの間に、キャラクタを複数回解決する際に便利な場合があります。この解決要求により、マルチパス ソルビングが有効になり、IK コンストレイントスタック内の任意の場所に挿入できます。

パラメータ

unit :

stingray.Unit

テスト Biped コンストレイントを適用するユニットです。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

「テスト Biped」コンストレイントは、Biped スケルトンのユニットが適切に HumanIK によって操作できることを確認する簡単な方法です。Biped ユニットでこのコンストレイントをプッシュすると、テストのモーションに追従するために、ヒップ、胸、手首の移動が開始されたことが確認できます。

パラメータ

unit :

stingray.Unit

テスト Quadruped コンストレイントを適用するユニットです。

戻り値
この関数は値を返しません。

「テスト Quadruped」コンストレイントは、Quadruped スケルトンのユニットが適切に HumanIK によって操作できることを確認する簡単な方法です。Quadruped ユニットでこのコンストレイントをプッシュすると、足が地面に接地したままで、ヒップ、胸、手首の移動が開始されたことが確認できます。

パラメータ

unit :

stingray.Unit

到達方向コンストレイントの "orientation" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

euler_orientation :

stingray.Vector3

到達するターゲット方向(オイラー角度単位)です。

戻り値
この関数は値を返しません。

特定の到達方向コンストレイントのターゲット方向を、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

到達位置コンストレイントの "position" 値を設定するユニットです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

position :

stingray.Vector3

目的のターゲット位置です。

戻り値
この関数は値を返しません。

特定の到達位置コンストレイントのターゲット位置を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定するキャラクタの評価コンテキストのインデックスです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値
この関数は値を返しません。

リフレッシュ時に、コンストレイントにより(FK 状態の)エフェクタと外部ユニットの間の相対トランスフォームが計算され、保存されます。コンストレイントはこの相対トランスフォームを次のフレーム中保持します。

パラメータ

unit :

stingray.Unit

修正する評価コンテキストに関連付けられているユニットです。

constraint_index :

number

アルファに設定するコンストレイントのインデックスです。

alpha :

number

このコンストレイントのアルファ値(強度)(0.01.0 の間)です。

戻り値
この関数は値を返しません。

アルファ値は、コンストレイントの強さ/強度を示します。アルファ0.0 設定した場合、コンストレイントの効果は現れません。アルファ1.0 設定した場合、コンストレイントは完全にアクティブになります。

パラメータ

unit :

stingray.Unit

対象となるユニットです。

draw_fk :

boolean

エディタ ビューポートで FK リグを描画するには、true に設定します。

draw_ik :

boolean

エディタ ビューポートで IK リグを描画するには、true に設定します。

draw_always :

boolean

ユニットが選択されていない場合でも、常にエディタ ビューポートでリグを描画するには、true に設定します。

戻り値
この関数は値を返しません。
パラメータ

unit :

stingray.Unit

対象となるユニットです。

disable_ik :

boolean

IK ソルバを無効にするには、true に設定します。

disable_fk :

boolean

FK 更新を無効にするには、true に設定します。

戻り値
この関数は値を返しません。
パラメータ

target_unit :

stingray.Unit

リターゲット先の評価コンテキストに関連付けられているユニットです。

source_unit :

stingray.Unit

リターゲット元の評価コンテキストに関連付けられているユニットです。

戻り値
この関数は値を返しません。

リターゲットを無効にするには、source_context_index の値に -1 を設定します。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

chain_index :

number

名前を照会するチェーンのインデックスです。

戻り値

string

コンテキスト用のデバッグ名です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定されたチェーンのモーション コンストレイントのモーションの振幅です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定されたチェーンのモーション コンストレイントのチェーンのインデックスです。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定されたチェーンのモーション コンストレイントのモーションの周波数(Hz 単位)です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定されたチェーンのモーション コンストレイントのモーションの位相(秒単位)です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定されたチェーンのモーション コンストレイントのモーションの引張強度(0.0 ~ 1.0 の間)です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定されたチェーンのモーション コンストレイントのモーションの方向達成度ブレンド係数(0.0 ~ 1.0 の間)です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定されたチェーンのモーション コンストレイントのモーションの移動達成度ブレンド係数(0.0 ~ 1.0 の間)です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定されたチェーンのモーション コンストレイントのモーションのタイプです。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

amplitude :

number

適用されるモーションの振幅です。

戻り値
この関数は値を返しません。

特定のチェーンのモーション コンストレイントのモーションの振幅を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

chain_index :

number

コンストレイントを適用するチェーンのインデックスです。

戻り値
この関数は値を返しません。

特定のチェーンのモーション コンストレイントのチェーンのインデックスを、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

frequency :

number

適用されるモーションの周波数です。

戻り値
この関数は値を返しません。

特定のチェーンのモーション コンストレイントのモーションの周波数を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

phase :

number

適用されるモーションの位相です。

戻り値
この関数は値を返しません。

特定のチェーンのモーション コンストレイントのモーションの位相を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

pull :

number

モーションの引張強度です。

戻り値
この関数は値を返しません。

特定のチェーンのモーション コンストレイントのモーションの引張強度を、状況に応じて更新することができます。注: 「reach_t > 0.0」である場合のみ、Pull をアクティブにすることができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

reach_r :

number

モーションの回転達成度ブレンド係数です。

戻り値
この関数は値を返しません。

特定のチェーンのモーション コンストレイントのモーションの回転達成度ブレンド係数を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

reach_t :

number

モーションの位置達成度ブレンド係数です。

戻り値
この関数は値を返しません。

特定のチェーンのモーション コンストレイントのモーションの位置達成度ブレンド係数を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

motion_type :

number

適用されるモーションのタイプ: // 0: モーションなし // 1: 水平平面軸の円上でエフェクタの位置を移動する // 2: 上軸上でエフェクタの位置を移動する、余弦移動 // 3: 右軸上でエフェクタの位置を移動する、余弦移動 // 4: 前軸上でエフェクタの位置を移動する、余弦移動 // 5: 軸周りでエフェクタの位置を移動する // 6: 回転軸上でエフェクタを回転する // 7: ピッチ軸上でエフェクタを回転する // 8: ヨー軸上でエフェクタを回転する

戻り値
この関数は値を返しません。

特定のチェーンのモーション コンストレイントのモーション タイプを、状況に応じて更新することができます。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

chain_index :

number

照会するチェーンのインデックスです。

戻り値

number

この生物のこのチェーンに含まれるノードの数です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

chain_index :

number

照会するチェーンのインデックスです。

戻り値

number

この生物のこのチェーンの親の断面のインデックスです。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定されたチェーンのピン コンストレイントのチェーンのインデックスです。

パラメータ

context_index :

number

照会するキャラクタの評価コンテキストのインデックスです。

constraint_index :

number

照会するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

戻り値

boolean

ワールド空間でコンストレイントの作業している場合は、true になります。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

chain_index :

number

コンストレイントを適用するチェーンのインデックスです。

戻り値
この関数は値を返しません。

特定のチェーン ピン コンストレイントのエフェクタを、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定するキャラクタの評価コンテキスト スタック内のコンストレイントのインデックスです。

world_space :

number

ワールド空間で作業するには 1 に設定し、それ以外の場合は、リファレンス ポーズは(ローカル座標の)最新評価ポーズになります。

戻り値
この関数は値を返しません。

特定のチェーン ピン コンストレイントのコンストレイントの空間(ワールド空間/ローカル空間(最新評価ポーズ))は、状況に応じて更新することができます。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定されたチェーン プロパティ コンストレイントのチェーンのインデックスです。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

チェーンの圧縮抵抗係数(0.0 ~ 1.0 の間)です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

チェーンの剛性係数(0.0 ~ 1.0 の間)です。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

chain_index :

number

コンストレイントを適用するチェーンのインデックスです。

戻り値
この関数は値を返しません。

特定のチェーン プロパティ コンストレイントのチェーンのインデックスを、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

compression_resistance :

number

チェーンの剛性係数(0.0 ~ 1.0 の間)です。

戻り値
この関数は値を返しません。

特定のチェーン プロパティ コンストレイントの圧縮の抵抗を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

stiffness :

number

チェーンの剛性係数(0.0 ~ 1.0 の間)です。

戻り値
この関数は値を返しません。

特定のチェーン プロパティ コンストレイントの剛性を、状況に応じて更新することができます。

パラメータ

unit :

stingray.Unit

コンテキストに関連するユニットです。

resource_name :

string

ユニットに関連付けられた .creature リソースの名前です。

戻り値
この関数は値を返しません。

ほとんどのケースで明示的に生物のコンテキストを宣言する必要はありません。生物のコンテキストは、関連するユニットで更新イベントが発生するときに、自動的に宣言され作成されます。生物で最初の更新処理が発生するに、IK をセットアップまたは生物をリターゲットするとき、特にフローを使用するときは、生物のコンテキストを宣言するだけで済みます(コンテキストを宣言しない場合は、プラグインはクエリーを破棄します)。

パラメータ

unit :

stingray.Unit

コンテキストを削除するユニットです。

戻り値
この関数は値を返しません。

属しているワールドが破壊されると、生物のコンテキストは自動的に削除されます。ただし、特定のイベント(Unit Unspawn イベントなど)の生物のコンテキストを、明示的に削除する必要があります。パフォーマンス上の理由から、再度、HumanIK で動作しない生物上でコンテキストを削除することをお勧めします。たとえば、無効な生物は削除する必要があります。

パラメータ
この関数はパラメータを受け入れません。
戻り値
この関数は値を返しません。

理解しデバッグするのに役立ちます。すべての生物の評価コンテキストの場合、これにより、すべての現在のコンストレイントとその設定がリストされます。生物が適切に反応しない理由を理解されていない場合は、常にこの関数を呼び出します。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

chain_index :

number

照会するチェーンのインデックスです。

戻り値

stingray.Vector3

チェーン エフェクタの位置です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

chain_index :

number

照会するチェーンのインデックスです。

戻り値

stingray.Vector3

チェーン エフェクタの位置です。

stingray.Quaternion

チェーン エフェクタの方向です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

chain_index :

number

照会するチェーンのインデックスです。

node_index :

number

照会するノードのインデックスです。

fk :

number

IK 位置を照会するには 0 に設定し、FK 位置を照会するには 1 に設定します。

戻り値

stingray.Vector3

チェーン ノードの位置です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

コンストレイント タイプです(メインの "HumanIK.lua" ファイルを参照してください)。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

戻り値

string

コンテキスト用のデバッグ名です。

パラメータ

context_index :

number

影響する生物の評価コンテキストのインデックスです。

戻り値

boolean

FK リグをエディタ ビューポートで描画する必要がある場合は、true になります。

boolean

IK リグをエディタ ビューポートで描画する必要がある場合は、true になります。

boolean

ユニットが選択されていない場合でも、リグを常に描画する必要がある場合は、true になります。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

line_index :

number

照会する線分のインデックスです。

戻り値

stingray.Quaternion

線分の色はクォータニオンで表示されます。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

line_index :

number

照会する線分のインデックスです。

戻り値

stingray.Vector3

線分の終点 1 の(ワールド座標内の)位置です。

stingray.Vector3

線分の終点 2 の(ワールド座標内の)位置です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

marker_index :

number

照会するマーカーのインデックスです。

戻り値

stingray.Quaternion

マーカーの色はクォータニオンで表示されます。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

marker_index :

number

照会するマーカーのインデックスです。

戻り値

stingray.Vector3

マーカーの(ワールド座標内の)位置です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

section_index :

number

照会する断面のインデックスです。

戻り値

stingray.Vector3

断面のエフェクタの位置です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

section_index :

number

照会する断面のインデックスです。

戻り値

stingray.Vector3

断面のエフェクタの位置です。

stingray.Quaternion

断面のエフェクタの方向です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

戻り値

number

この生物で実装されたチェーンの数です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

戻り値

number

コンテキストのスタック内の現在のコンストレイントの数です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

戻り値

number

コンテキストに関連付けられている線分の数です。

線分は主として、IK の計算中のキーの位置を表示するデバッグのために使用されます。たとえば、ある生物の頭部から別のキャラクタの頭部を指している線分は、ルック アット コンストレイントによって生成される可能性があります。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

戻り値

number

コンテキストに関連付けられているマーカーの数です。

マーカーは主として、IK の計算中のキーの位置を表示するデバッグのために使用されます。たとえば、フロア コンタクトの計算時に計算されたレイ キャストの衝突ポイントが、マーカーを生成する可能性があります。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

戻り値

number

この生物で実装された断面の数です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された Plant コンストレイントの後方左の脚を表すチェーンのインデックスです。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された Plant コンストレイントの後方右の脚を表すチェーンのインデックスです。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

保持する胸の回転の量です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された Plant コンストレイントの胸を表す断面のインデックスです。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された Plant コンストレイントの前方左の脚を表すチェーンのインデックスです。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された Plant コンストレイントの前方右の脚を表すチェーンのインデックスです。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された Plant コンストレイントのヒップを表す断面のインデックスです。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

地表のトポロジをスキャンするために投影されるレイの数です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

レイキャスト レイの終了位置のための(足首/手首エフェクタからの)下向きの垂直距離です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

レイキャスト レイの開始位置のための(足首/手首エフェクタからの)上向きの垂直距離です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

コンストレイントのスムージング強度

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

back_left_leg_chain_index :

number

後方左の脚を表すチェーンのインデックスです。

戻り値
この関数は値を返しません。

特定の Plant コンストレイントの後方左の脚を表すチェーン インデックスを、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

back_right_leg_chain_index :

number

後方右の脚を表すチェーンのインデックスです。

戻り値
この関数は値を返しません。

特定の Plant コンストレイントの後方右の脚を表すチェーン インデックスを、状況に応じて更新することができます。

パラメータ

context_index :

number

調整する生物の評価コンテキストのインデックスです。

constraint_index :

number

調整するコンストレイントのインデックスです。

chest_rotation_preserve :

number

保持する元の回転の量(0.0 ~ 1.0 の間)です。

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

chest_section_index :

number

胸を表す断面のインデックスです。

戻り値
この関数は値を返しません。

特定の Plant コンストレイントの胸を表す断面のインデックスを、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

front_left_leg_chain_index :

number

前方左の脚を表すチェーンのインデックスです。

戻り値
この関数は値を返しません。

特定の Plant コンストレイントの前方左の脚を表すチェーン インデックスを、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

front_right_leg_chain_index :

number

前方右の脚を表すチェーンのインデックスです。

戻り値
この関数は値を返しません。

特定の Plant コンストレイントの前方右の脚を表すチェーン インデックスを、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

hips_section_index :

number

ヒップを表す断面のインデックスです。

戻り値
この関数は値を返しません。

特定の Plant コンストレイントのヒップを表す断面のインデックスを、状況に応じて更新することができます。

パラメータ

context_index :

number

調整する生物の評価コンテキストのインデックスです。

constraint_index :

number

調整するコンストレイントのインデックスです。

nb_rays :

number

地表のトポロジをスキャンするために投影されるレイの数(1 が最小、9 が汎用性値)です。

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

調整する生物の評価コンテキストのインデックスです。

constraint_index :

number

調整するコンストレイントのインデックスです。

ray_down_length :

number

レイキャスト レイの終了位置のための(足首/手首エフェクタからの)下向きの垂直距離です。

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

調整する生物の評価コンテキストのインデックスです。

constraint_index :

number

調整するコンストレイントのインデックスです。

ray_up_length :

number

レイキャスト レイの開始位置のための(足首/手首エフェクタからの)上向きの垂直距離です。

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

調整する生物の評価コンテキストのインデックスです。

constraint_index :

number

調整するコンストレイントのインデックスです。

smoothing :

number

調整スムージング強度です(0.0 の場合はまったくスムージングされません)。

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

修正する生物の評価コンテキストのインデックスです。

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

修正する生物の評価コンテキストのインデックスです。

戻り値
この関数は値を返しません。

この関数を呼び出した後、その生物の IK コンストレイント スタックは空になります。

パラメータ

context_index :

number

コンストレイントにプッシュする生物の評価コンテキストのインデックスです。

chain :

number

モーションを適用する生物のチェーンのインデックスです。

motion_type :

number

適用されるモーションのタイプ: * 0: モーションなし * 1: 水平平面軸の円上でエフェクタの位置を移動する * 2: 上軸上でエフェクタの位置を移動する、余弦移動 * 3: 右軸上でエフェクタの位置を移動する、余弦移動 * 4: 前軸上でエフェクタの位置を移動する、余弦移動 * 5: 軸周りでエフェクタの位置を移動する * 6: 回転軸上でエフェクタを回転する * 7: ピッチ軸上でエフェクタを回転する * 8: ヨー軸上でエフェクタを回転する

amplitude :

number

モーションの振幅です。

frequency :

number

モーションの周波数です。

phase :

number

チェーンのモーションの位相(秒単位)です。

pull :

number

モーションの引張強度です。

reach_t :

number

位置到達度ブレンド係数です。

reach_r :

number

方向到達度ブレンド係数です。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

「モーション」コンストレイントは、エフェクタに手続き型モーションを適用する非常に基本的な方法です。ハードコード モーションは、エフェクタを上下に移動させる、振動させる、などに使用できます。

パラメータ

context_index :

number

解決する生物の評価コンテキストのインデックスです。

chain :

number

固定するために表示されるチェーン ノードのインデックスです。

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

影響する生物の評価コンテキストのインデックスです。

chain :

number

プロパティを設定するチェーンのインデックスです。

stiffness :

number

チェーンの剛性係数(0.0 ~ 1.0 の間)です。

compression_resistance :

number

チェーンの圧縮抵抗係数(0.0 ~ 1.0 の間)です。

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

解決する生物の評価コンテキストのインデックスです。

chain :

number

到達するために表示されるチェーン ノードのインデックスです。

pull :

number

Pull 値

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

解決する生物の評価コンテキストのインデックスです。

chain :

number

到達するために表示されるチェーン ノードのインデックスです。

position :

stingray.Vector3

到達するターゲット位置です。

world_space :

number

ワールド空間で動作させるには 1 に設定し、キャラクタ空間で動作させるには 0 に設定します。

戻り値
この関数は値を返しません。

ターゲット位置は、space 値によって、ワールド空間またはローカル空間のいずれかで表すことができます。

パラメータ

context_index :

number

解決する生物の評価コンテキストのインデックスです。

chain :

number

フロア コンタクトに適用する四肢とみなされるチェーンです。

distance_up :

number

フロア衝突レイ キャスト元を開始する現在のエフェクタ位置からの高度です。

distance_down :

number

フロア衝突レイ キャストを終了する現在のエフェクタ位置からの高度です。

pull :

number

衝突が発見されたときに適用する Pull 値です。

height :

number

チェーン Plant/蹄の垂直厚さ

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

解決する生物の評価コンテキストのインデックスです。

hips_section_index :

number

四足歩行のヒップとみなされる断面のノードのインデックスです。

chest_section_index :

number

四足歩行の胸とみなされる断面のノードのインデックスです。

front_left_leg_chain_index :

number

四足歩行の左前方の脚とみなされるチェーンのインデックスです。

front_right_leg_chain_index :

number

四足歩行の右前方の脚とみなされるチェーンのインデックスです。

back_left_leg_chain_index :

number

四足歩行の左後方の脚とみなされるチェーンのインデックスです。

back_right_leg_chain_index :

number

四足歩行の右後方の脚とみなされるチェーンのインデックスです。

nb_rays :

number

地表の位置と法線をスキャンするためにキャストするレイの数です(1 が最小で、9 の値では多数になります)。

ray_up_length :

number

レイキャスト レイの開始位置のための(足首/手首エフェクタからの)上向きの垂直距離です。

ray_down_length :

number

レイキャスト レイの終了位置のための(足首/手首エフェクタからの)下向きの垂直距離です。

smoothing :

number

スムージング強度(0.0 はスムージングなしを意味し、1.5 が通常の適切な値です)。

chest_rotation_preserve :

number

保持する元の胸の方向の量です。

戻り値
この関数は値を返しません。

これは、腰と胸の変形に影響します。

パラメータ

context_index :

number

コンストレイントにプッシュする生物の評価コンテキストのインデックスです。

section :

number

モーションを適用する生物の断面のインデックスです。

motion_type :

number

適用されるモーションのタイプ: * 0: モーションなし * 1: 水平平面軸の円上でエフェクタの位置を移動する * 2: 上軸上でエフェクタの位置を移動する、余弦移動 * 3: 右軸上でエフェクタの位置を移動する、余弦移動 * 4: 前軸上でエフェクタの位置を移動する、余弦移動 * 5: 軸周りでエフェクタの位置を移動する * 6: 回転軸上でエフェクタを回転する * 7: ピッチ軸上でエフェクタを回転する * 8: ヨー軸上でエフェクタを回転する

amplitude :

number

モーションの振幅です。

frequency :

number

モーションの周波数です。

phase :

number

断面のモーションの位相(秒単位)です。

pull :

number

モーションの引張強度です。

reach_t :

number

位置到達度ブレンド係数です。

reach_r :

number

方向到達度ブレンド係数です。

alpha :

number

コンストレイントのアルファ値(強さ/強度)(0.0 ~ 1.0 の間)です。

blend_in_time :

number

コンストレイントが完全にアクティブになる(アルファ値に達する)までの時間(秒単位)です。

constraint_id :

number

後でコンストレイントを取得し、調整するためのコンストレイント ID です(トラッキングが必要な場合は、-1 になります)。

戻り値
この関数は値を返しません。

「モーション」コンストレイントは、エフェクタに手続き型モーションを適用する非常に基本的な方法です。ハードコード モーションは、エフェクタを上下に移動させる、振動させる、などに使用できます。

パラメータ

context_index :

number

影響する生物の評価コンテキストのインデックスです。

chain :

number

プロパティを設定するチェーンのインデックスです。

extra_pull :

number

断面のチェーンによって生成される追加の Pull の係数です。

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

解決する生物の評価コンテキストのインデックスです。

chain :

number

到達するために表示されるチェーン ノードのインデックスです。

reach_t :

number

到達度 T 値です。

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

解決する生物の評価コンテキストのインデックスです。

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

section_index :

number

名前を照会する断面のインデックスです。

戻り値

string

コンテキスト用のデバッグ名です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された断面モーション コンストレイントのモーションの振幅です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された断面モーション コンストレイントのモーションの周波数(Hz 単位)です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された断面モーション コンストレイントのモーションの位相(秒単位)です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された断面モーション コンストレイントのモーションの Pull 強度(0.0 ~ 1.0 の間)です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された断面モーション コンストレイントの方向達成度ブレンド係数(0.0 ~ 1.0 の間)です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された断面モーション コンストレイントのモーションの移動達成度ブレンド係数(0.0 ~ 1.0 の間)です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された断面モーション コンストレイントの断面のインデックスです。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された断面モーション コンストレイントのモーションのタイプです。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

amplitude :

number

適用されるモーションの振幅です。

戻り値
この関数は値を返しません。

特定の断面のモーション コンストレイントのモーションの振幅を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

frequency :

number

適用されるモーションの周波数です。

戻り値
この関数は値を返しません。

特定の断面のモーション コンストレイントのモーションの周波数を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

phase :

number

適用されるモーションの位相です。

戻り値
この関数は値を返しません。

特定の断面モーション コンストレイントのモーション位相を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

pull :

number

モーションの引張強度です。

戻り値
この関数は値を返しません。

特定の断面モーション コンストレイントのモーションの Pull 強度を、状況に応じて更新することができます。注: 「reach_t > 0.0」である場合のみ、Pull をアクティブにすることができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

reach_r :

number

モーションの回転達成度ブレンド係数です。

戻り値
この関数は値を返しません。

特定の断面モーション コンストレイントのモーションの回転達成度ブレンド係数を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

reach_t :

number

モーションの位置達成度ブレンド係数です。

戻り値
この関数は値を返しません。

特定の断面モーション コンストレイントのモーションの位置達成度ブレンド係数を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

section_index :

number

コンストレイントを適用する断面のインデックスです。

戻り値
この関数は値を返しません。

特定の断面のピン コンストレイントの断面のインデックスを、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

motion_type :

number

適用されるモーションのタイプ: // 0: モーションなし // 1: 水平平面の円上でエフェクタの位置を移動する // 2: 上軸上でエフェクタの位置を移動する、余弦移動 // 3: 右軸上でエフェクタの位置を移動する、余弦移動 // 4: 前軸上でエフェクタの位置を移動する、余弦移動 // 5: 球上でエフェクタの位置を移動する // 6: 回転軸上でエフェクタを回転する // 7: ピッチ軸上でエフェクタを回転する // 8: ヨー軸上でエフェクタを回転する

戻り値
この関数は値を返しません。

特定の断面のモーション コンストレイントのモーション タイプを、状況に応じて更新することができます。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

断面のチェーンによって生成される追加の Pull の係数です。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

constraint_index :

number

照会するコンストレイントのインデックスです。

戻り値

number

指定された断面プロパティ コンストレイントの断面のインデックスです。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

extra_pull :

number

断面のチェーンによって生成される追加の Pull の係数です。

戻り値
この関数は値を返しません。

特定の断面のプロパティ コンストレイントの追加の Pull 係数を、状況に応じて更新することができます。

パラメータ

context_index :

number

設定する生物の評価コンテキストのインデックスです。

constraint_index :

number

設定する生物の評価コンテキスト スタック内のコンストレイントのインデックスです。

section_index :

number

コンストレイントを適用する断面のインデックスです。

戻り値
この関数は値を返しません。

特定の断面のプロパティ コンストレイントの断面のインデックスを、状況に応じて更新することができます。

パラメータ

context_index :

number

影響する生物の評価コンテキストのインデックスです。

draw_fk :

boolean

エディタ ビューポートで FK リグを描画するには、true に設定します。

draw_ik :

boolean

エディタ ビューポートで IK リグを描画するには、true に設定します。

draw_always :

boolean

ユニットが選択されていない場合でも、常にエディタ ビューポートでリグを描画するには、true に設定します。

戻り値
この関数は値を返しません。
パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

chain_index :

number

名前を照会するチェーンのインデックスです。

iteration :

number

照会する反復ソルバです。

戻り値

stingray.Vector3

チェーンの最後の回転エラー軸です。

number

このチェーンの最後の回転エラー角度(度単位)です。

生物のチェーンの最後の回転エラーを取得します。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

chain_index :

number

名前を照会するチェーンのインデックスです。

iteration :

number

照会する反復ソルバです。

戻り値

number

このチェーンの最後のエラー重みです。

生物のチェーンの最後のエラー重みを取得します。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

chain_index :

number

名前を照会するチェーンのインデックスです。

iteration :

number

照会する反復ソルバです。

戻り値

stingray.Vector3

このチェーンの最後のエラー ベクトルです。

生物のチェーンの最後のエラー ベクトルを取得します。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

chain_index :

number

名前を照会するチェーンのインデックスです。

戻り値

number

このチェーンの最後のトランスレーションの重みです。

生物のチェーンの最後のトランスレーションの重みを取得します。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

section_index :

number

名前を照会する断面のインデックスです。

iteration :

number

照会する反復ソルバです。

戻り値

stingray.Vector3

この断面の最後の回転エラー軸です。

number

この断面の最後の回転エラー角度(度単位)です。

生物の断面の最終の回転エラーを取得します。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

section_index :

number

名前を照会する断面のインデックスです。

iteration :

number

照会する反復ソルバです。

戻り値

stingray.Vector3

この断面の最後の回転エラー軸です。

number

この断面の最後の回転エラー角度(度単位)です。

生物の断面の最終の回転エラーを取得します。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

section_index :

number

名前を照会する断面のインデックスです。

iteration :

number

照会する反復ソルバです。

戻り値

number

この断面の最後のエラー重みです。

生物の断面の最後のエラー重みを取得します。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

section_index :

number

名前を照会する断面のインデックスです。

iteration :

number

照会する反復ソルバです。

戻り値

number

この断面の最後の断面の重みです。

生物の断面の最後の断面の重みを取得します。

パラメータ

context_index :

number

照会する生物の評価コンテキストのインデックスです。

section_index :

number

名前を照会する断面のインデックスです。

iteration :

number

照会する反復ソルバです。

戻り値

stingray.Vector3

この断面の最後のエラー ベクトルです。

生物の断面の最後のエラー ベクトルを取得します。

パラメータ

do_enable :

boolean

HumanIK を有効にするには、true に設定、HumanIK を無効にするには、false に設定します。

戻り値
この関数は値を返しません。

HumanIK を使用しない場合は、CPU 時間を短縮するために無効にしておくことをお勧めします。

パラメータ

do_enable :

boolean

コリジョン デバッグ モードを有効にするには、true に設定し、コリジョン デバッグ モードを無効にするには false に設定します。

戻り値
この関数は値を返しません。

これは、フロア コンタクトの問題の視覚化、理解、およびデバッグに役立ちます。

パラメータ

do_enable :

boolean

X 線モードを有効にするには、true に設定し、X 線モードを無効にするには false に設定します。

戻り値
この関数は値を返しません。

X 線モードは、ゲームのビューポートで便利なデバッグ情報量(リグ、ターゲット、マーカー、...)が表示されます。

パラメータ
この関数はパラメータを受け入れません。
戻り値

boolean

HumanIK が有効になっている場合は、true になります。

パラメータ

do_reveal :

boolean

すべての HumanIK リグとマーカーを表示するには true に設定し、それらを非表示にするには false に設定します。

戻り値
この関数は値を返しません。