Quaternion - stingray.Quaternion オブジェクト リファレンス - Stingray Lua API リファレンス

stingray.Quaternion オブジェクト リファレンス

説明

クォータニオン定式化(x, y, z, w)で回転を表します。

これらのオブジェクトを使用するにあたって、必ずしもクォータニオンについて理解している必要はなく、不透明な回転の表現として捉えておけば問題ありません。

注: Quaternion オブジェクトは一時的に作成されるオブジェクトです。このオブジェクトは、生成されたフレーム内でのみ使用することができます。複数のフレームにわたってクォータニオンを保持する必要がある場合は QuaternionBox を使用します。詳細については、「オブジェクトのライフタイムとユーザデータのバインド」を参照してください。

関数

パラメータ

quat :

stingray.Quaternion

回転角度を返すクォータニオンを指定します。

戻り値

number

現在向いている方向を中心としたクォータニオンのアップ ベクトルの回転角度を返します。ラジアンで表されます。

パラメータ

axis :

stingray.Vector3

クォータニオンの主軸。

angle :

number

ラジアンで表される主軸を中心とした角度。

戻り値

stingray.Quaternion

新しく作成されたクォータニオン。

stingray.Quaternion() と同じです。

パラメータ

quat :

stingray.Quaternion

共役を返すクォータニオンを指定します。

戻り値

stingray.Quaternion

quat で指定されたクォータニオンの共役を返します。

パラメータ

quat :

stingray.Quaternion

分解するクォータニオンを指定します。

戻り値

stingray.Vector3

クォータニオンの向いている方向を定義する X、Y、Z 値を指定します。

number

現在向いている方向を中心としたクォータニオンのアップ ベクトルの回転を返します。ラジアンで表されます。

パラメータ

quat_a :

stingray.Quaternion

1 つ目のクォータニオンを指定します。

quat_b :

stingray.Quaternion

2 つ目のクォータニオンを指定します。

戻り値

number

内積を返します。

パラメータ

quat_a :

stingray.Quaternion

1 つ目のクォータニオンを指定します。

quat_b :

stingray.Quaternion

2 つ目のクォータニオンを指定します。

戻り値

boolean

2 つのクォータニオンの要素がすべて同じであれば true、そうでなければ false を返します。

パラメータ

quat :

stingray.Quaternion

軸を取得するクォータニオンを指定します。

戻り値

stingray.Vector3

クォータニオンの回転の前方軸を返します。

パラメータ

x :

number

X 要素を指定します。

y :

number

Y 要素を指定します。

z :

number

Z 要素を指定します。

w :

number

W 要素を指定します。

戻り値

stingray.Quaternion

新しく作成されたクォータニオン。

パラメータ

x :

number

オイラー X 軸の回転の度数を指定します。

y :

number

オイラー Y 軸の回転の度数を指定します。

z :

number

オイラー Z 軸の回転の度数を指定します。

戻り値

stingray.Quaternion

新しく作成されたクォータニオン。

パラメータ

matrix :

stingray.Matrix4x4

抽出する回転を含む行列を指定します。

戻り値

stingray.Quaternion

新しく作成されたクォータニオン。

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

stingray.Quaternion

単位クォータニオンを返します。

パラメータ

quat :

stingray.Quaternion

反転させるクォータニオンを指定します。

戻り値

stingray.Quaternion

反転された回転を返します。

パラメータ

quat :

stingray.Quaternion

テストするクォータニオンを指定します。

戻り値

boolean

クォータニオンの要素がすべて有効な数値であれば true を返し、1 つでも #NaN#INF がある場合は false を返します。

パラメータ

quat_a :

stingray.Quaternion

1 つ目のクォータニオンを指定します。

quat_b :

stingray.Quaternion

2 つ目のクォータニオンを指定します。

t :

number

2 つのクォータニオン間の比率または補間ポイントを指定します。0 から 1 までの任意の値にすることができます。この値を 0 に近づけると quat_a に近い回転になり、1 に近づけると quat_b に近い回転になります。

戻り値

stingray.Quaternion

生成されたクォータニオンを返します。

この関数で実行される線形補間は正規化された線形補間、つまり nlerp であり、通常は最適な結果を返します。

パラメータ

dir :

stingray.Vector3

クォータニオンの前方向を指定します。

up :

stingray.Vector3?

(オプション) 新しいクォータニオンのアップ ベクトルを指定します。省略した場合は、Z 軸の正方向(0,0,1)が使用されます。

? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
戻り値

stingray.Quaternion

新しく作成されたクォータニオン。

パラメータ

quat :

stingray.Quaternion

変換するクォータニオンを指定します。

戻り値

stingray.Matrix4x4

クォータニオンと同じ回転を表す Matrix4x4 を返します。

パラメータ

quat_a :

stingray.Quaternion

1 つ目のクォータニオンを指定します。

quat_b :

stingray.Quaternion

2 つ目のクォータニオンを指定します。

戻り値

stingray.Quaternion

乗算の結果です。

この関数は、最初に quat_b を使用してオブジェクトを回転させ、次に quat_a を使用してオブジェクトを回転させることにより、乗算された回転を作成します。

パラメータ

quat :

stingray.Quaternion

長さを返すクォータニオンを指定します。

戻り値

number

クォータニオンの長さを返します。

パラメータ

quat :

stingray.Quaternion

正規化するクォータニオンを指定します。

戻り値

stingray.Quaternion

正規化された回転を返します。

パラメータ

quat :

stingray.Quaternion

軸を取得するクォータニオンを指定します。

戻り値

stingray.Vector3

クォータニオン回転の右軸を返します。

パラメータ

quat :

stingray.Quaternion

ベクトルの回転に使用するクォータニオンを指定します。

vector :

stingray.Vector3

回転させるベクトルを指定します。

戻り値

stingray.Vector3

回転後のベクトルを返します。

パラメータ

quat :

stingray.Quaternion

設定するクォータニオンを指定します。

x :

number

クォータニオンの主軸の新しい X コンポーネント値を指定します。

y :

number

クォータニオンの主軸の新しい Y コンポーネント値を指定します。

z :

number

クォータニオンの主軸の新しい Z コンポーネント値を指定します。

w :

number

クォータニオンの主軸を中心としたアップ ベクトルの回転を定義する新しい W コンポーネント値を指定します。

戻り値

stingray.Quaternion

生成されたクォータニオンを返します。

パラメータ

quat :

stingray.Quaternion

要素に分解するクォータニオンを指定します。

戻り値

number

クォータニオンの軸の X コンポーネント値を返します。

number

クォータニオンの軸の Y コンポーネント値を返します。

number

クォータニオンの軸の Z コンポーネント値を返します。

number

クォータニオンの軸を中心としたローカル アップ ベクトルの回転を定義する W コンポーネント値を返します。

パラメータ

quat :

stingray.Quaternion

変換するクォータニオンを指定します。

戻り値

number

オイラー X 軸の回転の度数を指定します。

number

オイラー Y 軸の回転の度数を指定します。

number

オイラー Z 軸の回転の度数を指定します。

パラメータ

quat :

stingray.Quaternion

文字列として返すクォータニオンを指定します。

戻り値

string

文字列表現です。

この関数は、デバッグ目的にのみ使用します。

パラメータ

quat :

stingray.Quaternion

軸を取得するクォータニオンを指定します。

戻り値

stingray.Vector3

クォータニオン回転のアップ軸を返します。