カメラ - stingray.Camera オブジェクト リファレンス - Stingray Lua API リファレンス

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

説明

ゲーム カメラを表します。

関数

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
戻り値

number

遠距離の値です。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

indices :

any(integer, string)+

整数または文字列のデータの 1 つまたは複数のインデックスです。

+ 表記は、指定されたタイプのインスタンスが 1 つまたは複数存在することを示しています。
any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
戻り値

any

指定されたインデックスのシーケンスで以前に保存したデータです。

Unit.get_data() に似ています。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

indices :

any(integer, string)+

整数または文字列のデータの 1 つまたは複数のインデックスです。

+ 表記は、指定されたタイプのインスタンスが 1 つまたは複数存在することを示しています。
any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。
戻り値

boolean

データ値が指定されたインデックスのシーケンスで格納されている場合は true を返し、それ以外の場合は false を返します。

Unit.has_data() に似ています。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

w :

stingray.Vector3

テストされるポイントです。

戻り値

number

正の値は、ポイントがフラスタムの内側にあることを示し、フラスタムの内側の何メートルの位置にポイントを配置するかを指定します。負の値は、ポイントがフラスタムの外側にあることを示し、ポイントがフラスタムの外側からどのくらい離れているかを指定します。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
戻り値

integer

定義されたモード タイプのいずれかの値です。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
戻り値

number

近距離の値です。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

aspect_ratio :

number

ターゲット アスペクト比

戻り値

stingray.Matrix4x4

複合投影マトリックス

カメラのモードに基づいて、有効な投影マトリックスを生成します。アスペクト比は[0.0, 1.0]の範囲内の数値です。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
戻り値

integer

定義された投影タイプのいずれかの値です。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

p :

stingray.Vector3

画面座標のポイント(x、y、0)

d :

number

ポイントの深さ

window :

stingray.Window?

テストするウィンドウです。(オプション) 指定しない場合は、最も大きいアプリケーション ウィンドウが使用されます。

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

viewport_size :

stingray.Vector2?

ビューポートのサイズです。(オプション)指定しない場合は、ウィンドウ バック バッファ サイズが使用されます。

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

stingray.Vector3

ワールド座標の変換されたポイントです。

画面座標では、(X、Y)の値は画面上のポイントのピクセル位置で、Z 値は使用されません。深度値は、ポイントがある画面内の深さ(カメラ プレーンからの距離)をメートル単位で示します。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

indices :

any(integer, string)

整数または文字列のデータの 1 つまたは複数のインデックスです。

any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。

value :

any

格納する値です。

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

get_data()の呼び出しで同じインデックスを渡すことにより、後でそのデータを取得できます。Unit.set_data() に似ています。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

range :

number

遠距離の値セットです。

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

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

left :

number

ビュー ボリュームの左の値です。

right :

number

ビュー ボリュームの右の値です。

down :

number

ビュー ボリュームの下の値です。

up :

number

ビュー ボリュームの上の値です。

index :

number?

オプション?サブ カメラのインデックスです。指定されていない場合は、既定で 1 になります。

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

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

left_tan :

number

ビュー ボリュームの左の値です。

right_tan :

number

ビュー ボリュームの右の値です。

down_tan :

number

ビュー ボリュームの下の値です。

up_tan :

number

ビュー ボリュームの上の値です。

index :

number?

オプション?サブ カメラのインデックスです。指定されていない場合は、既定で 1 になります。

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

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

m :

stingray.Matrix4x4

カメラのワールドに適用するローカル トランスフォームです。

index :

number?

オプション?サブ カメラのインデックスです。指定されていない場合は、既定で 1 になります。

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

つまり、左右の目のポーズを計算するために、立体視レンダリング中に使用されます。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

mode :

integer

カメラ モードです。定義されたモード タイプのいずれかの値を指定できます。

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

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

range :

number

近距離の値セットです。

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

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

min_x :

number

ビュー ボリュームの最小 x 値です。

max_x :

number

ビュー ボリュームの最大 x 値です。

min_z :

number

ビュー ボリュームの最小 z 値です。

max_z :

number

ビュー ボリュームの最大 z 値です。

index :

number?

オプション?サブ カメラのインデックスです。指定されていない場合は、既定で 1 になります。

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

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

projection_type :

integer

投影タイプです。定義された投影タイプのいずれかの値にすることができます。

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

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

fov :

number

視野角

index :

number?

オプション?サブ カメラのインデックスです。指定されていない場合は、既定で 1 になります。

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

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

index :

number?

オプション?サブ カメラのインデックスです。指定されていない場合は、既定で 1 になります。

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

number

視野角

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

w :

stingray.Vector3

ワールド座標のポイントです。

window :

stingray.Window?

テストするウィンドウです。(オプション) 指定しない場合は、最も大きいアプリケーション ウィンドウが使用されます。

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

viewport_size :

stingray.Vector2?

ビューポートのサイズです。(オプション)指定しない場合は、ウィンドウ バック バッファ サイズが使用されます。

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

stingray.Vector3

スクリーン座標の変換されたポイントです。

number

変換されたポイントの深度値

画面座標では、(X、Y)の値は画面上のポイントのピクセル位置で、Z 値は使用されません。深度値は、ポイントがある画面内の深さ(カメラ プレーンからの距離)をメートル単位で示します。

シーンの配置

このグループ内の関数は、このタイプのオブジェクトのシーン内での配置を制御します。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
戻り値

stingray.Matrix4x4

ローカル空間内のオブジェクトの位置と方向です。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
戻り値

stingray.Vector3

ローカル空間内のオブジェクトの位置です。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
戻り値

stingray.Quaternion

ローカル空間内のオブジェクトの回転です。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
戻り値

integer

シーン グラフ内の指定されたオブジェクトの ID です。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

parent :

stingray.Unit

このオブジェクトを所有している親ユニットです。

pose :

stingray.Matrix4x4

ローカル空間内のオブジェクトの新しい位置と方向です。

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

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

parent :

stingray.Unit

このオブジェクトを所有している親ユニットです。

position :

stingray.Vector3

ローカル空間内のオブジェクトの新しい位置です。

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

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。

parent :

stingray.Unit

このオブジェクトを所有している親ユニットです。

rotation :

stingray.Quaternion

ローカル空間内のオブジェクトの新しい回転です。

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

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
戻り値

stingray.Matrix4x4

ワールド空間内のオブジェクトの位置と方向です。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
戻り値

stingray.Vector3

ワールド空間内のオブジェクトの位置です。

パラメータ

self :

stingray.Camera

この関数を機能させるオブジェクト インスタンスを指定します。

この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
戻り値

stingray.Quaternion

ワールド空間内のオブジェクトの回転です。

モード タイプ

カメラで使用できる別のモードを定義します。

set_mode() を呼び出して、カメラを特定のモードに設定することができます。

MONO : integer

モノスコープ カメラを指定します。

STEREO : integer

立体視カメラを指定します。

投影タイプ

カメラで使用できるさまざまな投影タイプを定義します。

set_projection_type() を呼び出して、これらの投影モードのいずれかを使用するようにカメラを設定することができます。

ORTHOGRAPHIC : integer

正投影カメラを指定します。

PERSPECTIVE : integer

パース ビュー カメラを指定します。