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

説明

3 次元ベクトルを表します。

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

演算子

次に示すように、+ や - などのいくつかの演算子を使用して、Vector4 オブジェクトの変更やトランスフォームができます。

加算: +

+ 演算子を使用すると、2 つのベクトルを加算できます。たとえば、次のようになります。

newVector = vector1 + vector2

これは add() 関数と同等です。

減算: -

- 演算子を使用すると、ベクトルを別のベクトルで減算できます。たとえば、次のようになります。

newVector = vector1 - vector2

これは subtract() 関数と同等です。

否定: -

- 演算子をベクトル変数のプリフィックスとして使用して、ベクトルを否定できます。たとえば、次のようになります。

negativeVector = -vector1

乗算: *

* 演算子を使用すると、スカラー値でベクトルを乗算できます。たとえば、次のようになります。

newVector = vector * scalarFactor

これは multiply() 関数と同等です。要素ごとに 2 つのベクトルを乗算できる、multiply_elements() も参照してください。

除算: /

/ 演算子を使用すると、スカラー値でベクトルを除算できます。たとえば、次のようになります。

newVector = vector / scalarFactor

これは divide() 関数と同等です。要素ごとにベクトルで別のベクトルを除算できる、divide_elements() も参照してください。

コンポーネントへのアクセス: []

[] 演算子を使用すると、コンポーネント値を設定および取得できます。X コンポーネントにはインデックス 1 または "x" を、Y コンポーネントには 2 または "y" を、Z コンポーネントには 3 または "z" を、W コンポーネントには 4 または "w" を使用します。たとえば、次のようになります。

yComponentValue = vector[2]
zComponentValue = vector["z"]

コンストラクタとアクセサ

stingray.Vector4() stingray.Vector4.add() stingray.Vector4.divide() stingray.Vector4.divide_elements() stingray.Vector4.lerp() stingray.Vector4.max() stingray.Vector4.min() stingray.Vector4.multiply() stingray.Vector4.multiply_elements() stingray.Vector4.normalize() stingray.Vector4.subtract() stingray.Vector4.zero() stingray.Vector4Box.unbox()

その他の関連リファレンス項目

	stingray.Vector4Box
	color
	stingray.LineObject.add_box() stingray.LineObject.add_capsule() stingray.LineObject.add_circle() stingray.LineObject.add_cone() stingray.LineObject.add_half_sphere() stingray.LineObject.add_line() stingray.LineObject.add_sphere() stingray.Replay.record_debug_line() stingray.Replay.record_screen_debug_text() stingray.Replay.record_world_debug_text() stingray.Vector4Box() stingray.Vector4Box.store()
	Math

この参照ページは、次の概要トピックと関連付けられています

「リリース ノート > Stingray 1.1 リリース ノート」

データ メンバー

w : number W コンポーネント。

x : number X コンポーネント。

y : number Y コンポーネント。

z : number Z コンポーネント。

関数

add ( vector_a, vector_b ) : stingray.Vector4 指定された 2 つのベクトルを加算し、結果のベクトルを返します。

パラメータ

vector_a :	stingray.Vector4	追加する最初のベクトルです。
vector_b :	stingray.Vector4	追加する 2 番目のベクトルです。

戻り値

stingray.Vector4

2 つの入力ベクトルの合計です。

distance ( vector_a, vector_b ) : number 指定された 2 点間の距離を返します。

パラメータ

vector_a :	stingray.Vector4	最初の点です。
vector_b :	stingray.Vector4	2 番目の点です。

戻り値

number

vector_a と vector_b の間のスカラー距離です。

distance_squared ( vector_a, vector_b ) : number 指定された 2 点間の距離の 2 乗を返します。

パラメータ

vector_a :	stingray.Vector4	最初のベクトルです。
vector_b :	stingray.Vector4	2 番目のベクトルです。

戻り値

number

vector_a と vector_bの間の距離の 2 乗です。

divide ( vector, factor ) : stingray.Vector4 指定されたベクトルをスカラー値で除算し、結果のベクトルを返します。

パラメータ

vector :	stingray.Vector4	除算するベクトルです。
factor :	number	ベクトルを除算するスカラー値です。

戻り値

stingray.Vector4

入力ベクトルとスカラー値の商です。

divide_elements ( vector_a, vector_b ) : stingray.Vector4 vector_a の各要素を、対応する vector_b の要素で除算し、結果のベクトルを返します。

パラメータ

vector_a :	stingray.Vector4	除算されるベクトルです。
vector_b :	stingray.Vector4	除算して vector_a にするベクトルです。

戻り値

stingray.Vector4

2 つの入力ベクトルの商です。

dot ( vector_a, vector_b ) : number 指定された 2 つのベクトルのドット積を返します。

パラメータ

vector_a :	stingray.Vector4	最初のベクトルです。
vector_b :	stingray.Vector4	2 番目のベクトルです。

戻り値

number

内積を返します。

element ( vector, index ) : number ベクトル内の指定されたインデックスに格納された値を返します。

パラメータ

vector :	stingray.Vector4	コンポーネントが返されるベクトル。
index :	integer	返されるコンポーネントのインデックスです。X コンポーネントには 1 を、Y コンポーネントには 2 を、Z コンポーネントには 3 を、W コンポーネントには 4 を使用します。

戻り値

number

指定されたインデックスでの要素の値です。

equal ( vector_a, vector_b ) : boolean 2 つのベクトルが同一かどうかを示します。

パラメータ

vector_a :	stingray.Vector4	比較する最初のベクトルです。
vector_b :	stingray.Vector4	比較する 2 番目のベクトルです。

戻り値

boolean

2 つのベクトルが同一の場合は true を返し、そうでない場合は false を返します。

is_valid ( vector ) : boolean ベクトルが有効な値のみで構成されているかどうかを示します。

パラメータ

vector :

stingray.Vector4

検証されるベクトルです。

戻り値

boolean

ベクトルのすべてのコンポーネントが有効な数字である場合は true を、いずれかのコンポーネントが #NaN または #INF である場合は false を返します。

length ( vector ) : number 指定されたベクトルのスカラー長を返します。

パラメータ

vector :

stingray.Vector4

長さが返されるベクトルです。

戻り値

number

ベクトルの長さです。

lerp ( vector_a, vector_b, ratio ) : stingray.Vector4 指定の比率で、指定された 2 つのベクトル間を線形に補間することで、新しいベクトルを生成します。

パラメータ

vector_a :	stingray.Vector4	最初のベクトルです。
vector_b :	stingray.Vector4	2 番目のベクトルです。
ratio :	number	補間の比率、または重みです。0 から 1 までの任意の値にすることができます。0 に近い値であれば vector_a に近いベクトルが生成され、1 に近い値であれば vector_b に近いベクトルが生成されます。

戻り値

stingray.Vector4

生成結果のベクトルです。

max ( vector_a, vector_b ) : stingray.Vector4 指定された 2 つのベクトルの各コンポーネントの最大値が含まれるベクトルを返します。

パラメータ

vector_a :	stingray.Vector4	最初のベクトルです。
vector_b :	stingray.Vector4	2 番目のベクトルです。

戻り値

stingray.Vector4

生成結果のベクトルです。

min ( vector_a, vector_b ) : stingray.Vector4 指定された 2 つのベクトルの各コンポーネントの最小値が含まれるベクトルを返します。

パラメータ

vector_a :	stingray.Vector4	最初のベクトルです。
vector_b :	stingray.Vector4	2 番目のベクトルです。

戻り値

stingray.Vector4

生成結果のベクトルです。

multiply ( vector, factor ) : stingray.Vector4 指定されたベクトルをスカラー値で乗算し、結果のベクトルを返します。

パラメータ

vector :	stingray.Vector4	乗算するベクトルです。
factor :	number	ベクトルを乗算するスカラー値です。

戻り値

stingray.Vector4

入力ベクトルとスカラー値の積です。

multiply_elements ( vector_a, vector_b ) : stingray.Vector4 vector_a の各要素を、対応する vector_b の要素で乗算し、結果のベクトルを返します。

パラメータ

vector_a :	stingray.Vector4	乗算する最初のベクトルです。
vector_b :	stingray.Vector4	乗算する 2 番目のベクトルです。

戻り値

stingray.Vector4

2 つの入力ベクトルの積です。

normalize ( vector ) : stingray.Vector4 指定されたベクトルを正規化し (つまりそのスカラー長を 1 に変換し)、結果を返します。

パラメータ

vector :

stingray.Vector4

正規化されるベクトルです。

戻り値

stingray.Vector4

正規化されたベクトルです。

set_element ( vector, index, value ) ベクトル内の指定されたインデックスを、指定の値に設定します。

パラメータ

vector :	stingray.Vector4	コンポーネントが設定されるベクトルです。
index :	integer	設定されるコンポーネントのインデックスです。X コンポーネントには 1 を、Y コンポーネントには 2 を、Z コンポーネントには 3 を、W コンポーネントには 4 を使用します。
value :	number	指定されたインデックスで設定された値。

戻り値

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

set_w ( vector, value ) ベクトルの W コンポーネントの値を設定します。

パラメータ

vector :	stingray.Vector4	コンポーネントが設定されるベクトルです。
value :	number	W コンポーネントの新しい値です。

戻り値

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

set_x ( vector, value ) ベクトルの X コンポーネントの値を設定します。

パラメータ

vector :	stingray.Vector4	コンポーネントが設定されるベクトルです。
value :	number	X コンポーネントの新しい値。

戻り値

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

set_xyzw ( vector, x, y, z, w ) ベクトルの X、Y、Z、および W の各コンポーネントの値を設定します。

パラメータ

vector :	stingray.Vector4	コンポーネントが設定されるベクトル。
x :	number	X コンポーネントの新しい値。
y :	number	Y コンポーネントの新しい値です。
z :	number	Z コンポーネントの新しい値。
w :	number	W コンポーネントの新しい値です。

戻り値

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

set_y ( vector, value ) ベクトルの Y コンポーネントの値を設定します。

パラメータ

vector :	stingray.Vector4	コンポーネントが設定されるベクトルです。
value :	number	Y コンポーネントの新しい値です。

戻り値

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

set_z ( vector, value ) ベクトルの Z コンポーネントの値を設定します。

パラメータ

vector :	stingray.Vector4	コンポーネントが設定されるベクトルです。
value :	number	Z コンポーネントの新しい値。

戻り値

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

subtract ( vector_a, vector_b ) : stingray.Vector4 vector_a から vector_b を減算し、結果のベクトルを返します。

パラメータ

vector_a :	stingray.Vector4	開始ベクトルです。
vector_b :	stingray.Vector4	減算されるベクトルです。

戻り値

stingray.Vector4

減算の結果です。

to_elements ( vector ) : number, number, number, number 指定されたベクトルをそのコンポーネント値に分解します。

パラメータ

vector :

stingray.Vector4

コンポーネントに分解されるベクトルです。

戻り値

number	ベクトルの X コンポーネントです。
number	ベクトルの Y コンポーネントです。
number	ベクトルの Z コンポーネントです。
number	ベクトルの W コンポーネントです。

その他の関連リファレンス項目

color

to_string ( vector ) : string 指定されたベクトルの文字列表現を返します。

パラメータ

vector :

stingray.Vector4

文字列として返すベクトルです。

戻り値

string

文字列表現です。

この関数は、デバッグ目的でのみ使用してください。文字列を保存して、新しいベクトルに読み込むことはしないでください。複数のフレームで使用するベクトルを保存するには、Vector4Box を使用します。

w ( vector ) : number ベクトルの W コンポーネントの値を返します。

パラメータ

vector :

stingray.Vector4

コンポーネントが返されるベクトル。

戻り値

number

W コンポーネントの値です。

x ( vector ) : number ベクトルの X コンポーネントの値を返します。

パラメータ

vector :

stingray.Vector4

コンポーネントが返されるベクトル。

戻り値

number

X コンポーネントの値です。

y ( vector ) : number ベクトルの Y コンポーネントの値を返します。

パラメータ

vector :

stingray.Vector4

コンポーネントが返されるベクトル。

戻り値

number

Y コンポーネントの値です。

z ( vector ) : number ベクトルの Z コンポーネントの値を返します。

パラメータ

vector :

stingray.Vector4

コンポーネントが返されるベクトル。

戻り値

number

Z コンポーネントの値。

zero ( ) : stingray.Vector4 すべての値を初期化してゼロにした新しいベクトルを返します。

パラメータ

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

戻り値

stingray.Vector4

ゼロのベクトル。