vector2 - stingray.Vector2 オブジェクト リファレンス - Stingray Lua API リファレンス
説明
3 次元ベクトルを表します。
注: Vector2 オブジェクトは一時的なものです。 このオブジェクトは、生成されたフレーム内でのみ使用することができます。複数のフレームで使用するために Vector2 を保存する必要がある場合は、代わりに Vector2Box を使用します。詳細については、「オブジェクトのライフタイムとユーザデータのバインド」を参照してください。
演算子
次に示すように、+ や - などのいくつかの演算子を使用して、Vector2 オブジェクトの変更やトランスフォームができます。
加算: +
+ 演算子を使用すると、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" を使用します。たとえば、次のようになります。
yComponentValue = vector[2]
xComponentValue = vector["x"]
コンストラクタとアクセサ 
関連サンプル コード
その他の関連リファレンス項目
この参照ページは、次の概要トピックと関連付けられています
データ メンバー
 |
x : number X 軸に沿ったベクトルの範囲。
|
| |
y : numberY 軸に沿ったベクトルの範囲。
|
関数
 |
add ( vector_a, vector_b ) : stingray.Vector2 指定された 2 つのベクトルを加算し、結果のベクトルを返します。
|
vector_a : | 追加する最初のベクトルです。 | |
vector_b : | 追加する 2 番目のベクトルです。 |
|
2 つの入力ベクトルの合計です。 |
| |
distance ( vector_a, vector_b ) : number指定された 2 点間の距離を返します。
|
vector_a : | 最初の点です。 | |
vector_b : | 2 番目の点です。 |
number |
vector_a と vector_b の間のスカラー距離です。 |
| |
distance_squared ( vector_a, vector_b ) : number指定された 2 点間の距離の 2 乗を返します。
|
vector_a : | 最初のベクトルです。 | |
vector_b : | 2 番目のベクトルです。 |
number |
vector_a と vector_bの間の距離の 2 乗です。 |
| |
divide ( vector, factor ) : stingray.Vector2指定されたベクトルをスカラー値で除算し、結果のベクトルを返します。
|
vector : | 除算するベクトルです。 | |
factor : | number | ベクトルを除算するスカラー値です。 |
|
入力ベクトルとスカラー値の商です。 |
| |
divide_elements ( vector_a, vector_b ) : stingray.Vector2vector_a の各要素を、対応する vector_b の要素で除算し、結果のベクトルを返します。
|
vector_a : | 除算されるベクトルです。 | |
vector_b : | 除算して vector_a にするベクトルです。 |
|
2 つの入力ベクトルの商です。 |
| |
dot ( vector_a, vector_b ) : number指定された 2 つのベクトルのドット積を返します。
|
| |
element ( vector, index ) : numberベクトル内の指定されたインデックスに格納された値を返します。
|
vector : | コンポーネントが返されるベクトル。 | |
index : | integer | 返されるコンポーネントのインデックスです。X コンポーネントには 1、Y コンポーネントには 2 を使用します。 |
number |
指定されたインデックスでの要素の値です。 |
| |
equal ( vector_a, vector_b ) : boolean2 つのベクトルが同一かどうかを示します。
|
vector_a : | 比較する最初のベクトルです。 | |
vector_b : | 比較する 2 番目のベクトルです。 |
boolean |
2 つのベクトルが同一の場合は true を返し、そうでない場合は false を返します。 |
| |
is_valid ( vector ) : booleanベクトルが有効な値のみで構成されているかどうかを示します。
|
vector : | 検証されるベクトルです。 |
boolean |
ベクトルのすべてのコンポーネントが有効な数字である場合は true を、いずれかのコンポーネントが #NaN または #INF である場合は false を返します。 |
| |
length ( vector ) : number指定されたベクトルのスカラー長を返します。
|
| |
lerp ( vector_a, vector_b, ratio ) : stingray.Vector2指定の比率で、指定された 2 つのベクトル間を線形に補間することで、新しいベクトルを生成します。
|
vector_a : | 最初のベクトルです。 | |
vector_b : | 2 番目のベクトルです。 | |
ratio : | number | 補間の比率、または重みです。0 から 1 までの任意の値にすることができます。0 に近い値であれば vector_a に近いベクトルが生成され、1 に近い値であれば vector_b に近いベクトルが生成されます。 |
|
生成結果のベクトルです。 |
| |
max ( vector_a, vector_b ) : stingray.Vector2指定された 2 つのベクトルの各コンポーネントの最大値が含まれるベクトルを返します。
|
vector_a : | 最初のベクトルです。 | |
vector_b : | 2 番目のベクトルです。 |
|
生成結果のベクトルです。 |
| |
min ( vector_a, vector_b ) : stingray.Vector2指定された 2 つのベクトルの各コンポーネントの最小値が含まれるベクトルを返します。
|
vector_a : | 最初のベクトルです。 | |
vector_b : | 2 番目のベクトルです。 |
|
生成結果のベクトルです。 |
| |
multiply ( vector, factor ) : stingray.Vector2指定されたベクトルをスカラー値で乗算し、結果のベクトルを返します。
|
vector : | 乗算するベクトルです。 | |
factor : | number | ベクトルを乗算するスカラー値です。 |
|
入力ベクトルとスカラー値の積です。 |
| |
multiply_elements ( vector_a, vector_b ) : stingray.Vector2vector_a の各要素を、対応する vector_b の要素で乗算し、結果のベクトルを返します。
|
vector_a : | 乗算する最初のベクトルです。 | |
vector_b : | 乗算する 2 番目のベクトルです。 |
|
2 つの入力ベクトルの積です。 |
| |
normalize ( vector ) : stingray.Vector2指定されたベクトルを正規化し (つまりそのスカラー長を 1 に変換し)、結果を返します。
|
| |
set_element ( vector, index, value )ベクトル内の指定されたインデックスを、指定の値に設定します。
|
vector : | コンポーネントが設定されるベクトルです。 | |
index : | integer | 設定されるコンポーネントのインデックスです。X コンポーネントには 1、Y コンポーネントには 2 を使用します。 |
value : | number | 指定されたインデックスで設定された値。 |
| この関数は値を返しません。 |
| |
set_x ( vector, value )ベクトルの X コンポーネントの値を設定します。
|
| |
set_xy ( vector, x, y )ベクトルの X および Y コンポーネントの値を設定します。
|
vector : | コンポーネントが設定されるベクトル。 | |
x : | number | X コンポーネントの新しい値。 |
y : | number | Y コンポーネントの新しい値です。 |
| この関数は値を返しません。 |
| |
set_y ( vector, value )ベクトルの Y コンポーネントの値を設定します。
|
| |
subtract ( vector_a, vector_b ) : stingray.Vector2vector_a から vector_b を減算し、結果のベクトルを返します。
|
vector_a : | 開始ベクトルです。 | |
vector_b : | 減算されるベクトルです。 |
|
減算の結果です。 |
| |
to_elements ( vector ) : number, number指定されたベクトルをそのコンポーネント値に分解します。
|
vector : | コンポーネントに分解されるベクトルです。 |
number |
ベクトルの X コンポーネントです。 |
number |
ベクトルの Y コンポーネントです。 |
| |
to_string ( vector ) : string指定されたベクトルの文字列表現を返します。
|
vector : | 文字列として返すベクトルです。 |
string |
文字列表現です。 |
この関数は、デバッグ目的でのみ使用してください。文字列を保存して、新しいベクトルに読み込むことはしないでください。複数のフレームで使用するベクトルを保存するには、Vector2Box を使用します。
| |
x ( vector ) : numberベクトルの X コンポーネントの値を返します。
|
| |
y ( vector ) : numberベクトルの Y コンポーネントの値を返します。
|
| |
zero ( ) : stingray.Vector2すべての値を初期化してゼロにした新しいベクトルを返します。
|