Gui - stingray.Gui オブジェクト リファレンス - Stingray Lua API リファレンス
説明
Gui はプリミティブ 2D シェイプ(長方形、三角形、およびテキストなど)を管理するオブジェクトで、これらのシェイプをエンジン ビューポートで描画します。
GUI のタイプ
各 GUI には、原点と内部座標系があります。GUI オブジェクトを作成するときは、次のものを設定します。
World.create_screen_gui() は、ビューポートの左下コーナーに原典を固定した GUI の作成に使用します。このタイプの GUI は常に、スクリーン スペースのピクセル数で座標を示します。スクリーン GUI に描画するシェイプは、必ずシーン内のオブジェクトの上に重ねられ、シーン内のオブジェクトによりオクルージョンされることはありません。
このタイプの GUI は一般的に、常時表示しておく必要がある UI 要素に使用されます。たいていの場合、これらの要素は、ビューポートの表示域の位置関係で固定されます。たとえば、HUD、メニュー、または照準十字などがこれに該当します。
World.create_world_gui () は、3D ワールド内の指定されたトランスフォーム行列に原点を配置した GUI の作成に使用します。その座標は通常、ワールド単位(メートル)で示されます。ワールド空間に描画される GUI はシーン内に配置されるので、カメラとシェイプの間に挿入される他のサーフェスによってオクルージョンされます。
このタイプの GUI は一般に、シーン内の他の要素との位置関係で配置する必要がある UI 要素に使用されます。この要素には、特定のオブジェクトまたはキャラクタに関する情報、マップの目標地点を指すマーカー、または 3D ワールドでの位置とボリュームのデバッグ レンダリングなどがあります。
シェイプと描画プレーン
GUI に追加されるほとんどのシェイプは、2D プレーンで描画される 2D シェイプです。既定では、このプレーンは、GUI の原点における(x,z)プレーンに相当します。
シェイプは、左下コーナーの位置を基準として、描画プレーン内に配置されます。シェイプを作成する場合、シェイプの左下コーナーのローカル位置オフセットを指定することもできます。このオフセットで、シェイプは描画プレーン上に位置したまま原点から移動します。
この位置オフセットの X 座標では、シェイプは描画プレーン上を右方向に移動します。スクリーン スペース GUI を使用している場合、この X 座標値を大きくすると、効果としてシェイプは画面の右側に移動します。ワールド空間 GUI を使用している場合、その効果としてシェイプは GUI のローカル X 軸に沿って移動します。
この位置オフセットの Y 座標では、シェイプは描画プレーン上を上方向に移動します。スクリーン スペース GUI を使用している場合、この Y 座標値を大きくすると、効果としてシェイプは画面の上方向に移動します。ワールド空間 GUI を使用している場合、その効果としてシェイプは GUI のローカル Z 軸に沿って移動します。
この位置の Z 座標の解釈は、シェイプの作成に 2D または _3d のどちらの関数を使用しているかにより異なります。この後の各セクションを参照してください。
2D 関数
bitmap()、rect()、text()、または video() などの関数を使用してシェイプを GUI に追加する場合、シェイプの描画プレーンは必ず GUI の原点に配置されます。
シェイプの位置オフセットをこのプレーン上で指定すると、オフセットの Z 座標によりシェイプの描画レイヤが設定されます(後述の「描画レイヤ」を参照してください)。
既定の描画レイヤ 0 を使用する場合には、オフセットを Z 軸座標なしで Vector2 と指定できます。
_3d 関数
bitmap_3d()、rect_3d()、text_3d()、または video_3d() などの関数を使用してシェイプを GUI に追加する場合は、GUI の 3D 座標系内で、シェイプに独自のトランスフォーム行列を割り当てることができます。この行列により、シェイプの描画プレーンの原点が配置されます。
この行列を設定すると、位置オフセットに使用する(x,y)座標ではなく、GUI の 3D 空間内の 3D 座標を使用することに注意してください。つまり、この行列の Z 軸は上方向です。
シェイプの描画プレーンは、このトランスフォーム行列の(x,z)平面に沿って表示されます。シェイプに指定する位置オフセットにより、シェイプの X と Y のオフセットが描画プレーン上に設定されます。これはプレーン 2D シェイプの場合と同じです。位置オフセットの Z 座標は、その描画プレーンとの位置関係での 2D シェイプの深さを設定します。Z 座標の値を大きくすると、シェイプは描画プレーンより奥に後退し、0 より小さくするとシェイプは描画プレーンより前に浮き出ます。
これらの _3d 関数をスクリーンスペースの GUI で使用する場合、効果はシェイプの回転またはスキュー(あるいはその両方)になります。GUI の原点はビューポートに固定されているため、シェイプは GUI の描画プレーンに対して垂直の 1 方向からしか見ることができません。そのため GUI の 3D スペース内でシェイプをトランスフォームすると、トランスフォームの効果は事実上平らになるか、または 2D スクリーン スペースに投影されます。
ワールド空間 GUI でこれらの関数を使用すると、2D シェイプを 3D ワールド内の任意の場所に表示できます。これを設定する一般的な方法は、最初に Matrix4x4.identity 行列を使用してワールド空間 GUI を作成し、ワールド空間単位に対する幅と高さの比率を 1 に指定します。3D ワールド内にシェイプを描画する場合、シェイプの左下コーナーにあるトランスフォーム行列でシェイプを作成し、ワールド空間内に希望の位置と向きで配置します。このシナリオでは、(0,0,0)の位置オフセットはそのままにしておくことができます。
triangle 関数
triangle() 関数は上記の 2D と 3D の使用規則の例外として扱われます。上記の _3d 関数とは異なり、三角形に指定する位置では、2D シェイプの描画プレーンは配置されません。そうするのではなく、GUI の 3D 座標系内の三角形の頂点に 3D の位置を指定します。この関数を使用するときは、Z 軸は上方向であることに注意してください。
描画レイヤ
GUI で描画するすべてのシェイプには、同じ GUI 内での他のシェイプとのオーバーラップを制御する「描画レイヤ」があります。描画レイヤの値が高いシェイプは、GUI の座標系内でのシェイプの配置に関係なく、値が低いシェイプより手前にレンダリングされます。
プレーンの 2D シェイプ関数を使用すると、GUI の描画プレーン内でシェイプの位置に渡すベクトルの Z 軸座標に描画レイヤを設定できます。
_3d シェイプ関数を使用する場合は、描画レイヤを別のパラメータで設定します。(_3d シェイプの位置の Z コンポーネントは、実際にはそのシェイプを描画プレーンの中または上に移動させます。前述の説明を参照してください。)
イミディエイト モードと保持モード
GUI は、イミディエイト モードまたは保持モードで作成できます。
イミディエイト モードでは、GUI は最後のフレームからすべてのシェイプをクリアして各フレームを開始します。各フレームで、そのフレームで表示するすべてのシェイプを再描画する必要があります。
保持モードでは、GUI は提供された各シェイプを記憶し、停止を指示するまですべてのフレームでそのシェイプの描画を続行します。シェイプを作成すると、GUI はそのシェイプを一意に識別する整数を返します。シェイプのアトリビュートを変更する必要がある場合、この ID をいずれかの GUI update 関数に、変更するアトリビュートとともに渡すことができます。GUI でそのシェイプを今後表示する必要がなくなった場合は、その ID をいずれかの GUI destroy 関数に渡します。
サンプル
GUI インタフェースは非常に柔軟性がありますが、それを理解し、正しく設定するのは難しい場合があります。いくつかの実例については、core/editor_slave/stingray_editor の下の Lua ファイルを調べてください。ビューポートの Stingray エディタで描画されたほとんどのギズモと他のデバッグ レンダリングは、ワールド空間内の GUI オブジェクトを使用して作成され、ビューポート レンダリング オプションを制御するために使用するメニューは、スクリーン スペース GUI を使用して作成されています。
コンストラクタとアクセサ 
関連サンプル コード
その他の関連リファレンス項目
この参照ページは、次の概要トピックと関連付けられています
関数
 |
bitmap ( self, material, pos, size, color ) : integer 指定したマテリアルを使ってビットマップを作成(または描画)します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
material : | any(string, stingray.Material*) | 使用する .material リソース ファイルまたはマテリアル ポインタの名前を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
pos : | ビットマップの位置を指定します。Vector3 を渡す場合、z コンポーネントは描画レイヤを指定する整数です。描画レイヤの値が大きいオブジェクトは、他のオブジェクトの前面に表示されます。Vector2 を渡す場合、描画レイヤは 0 に設定されています。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
size : | ビットマップの寸法を指定します。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
ID を返します。 |
その他の関連リファレンス項目
| |
bitmap_3d ( self, material, tm, pos, layer, size, color ) : integerこの関数は、Gui.bitmap() に似ていますが、トランスフォーム行列(tm)を使用してオブジェクトを 3D に配置するため、3D ワールドでオブジェクトを自由に回転できます。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
material : | any(string, stingray.Material*) | 使用する .material リソース ファイルまたはマテリアル ポインタの名前を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
tm : | トランスフォーム行列です。オブジェクトを 3D で配置します。 | |
pos : | 位置を指定します。 | |
layer : | integer | レイヤを指定します。 |
size : | 寸法を指定します。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
ID を返します。 |
この関数を使用すると、1 つのワールド gui を使用してワールド内のさまざまな位置にオブジェクトを描画することができます。
注: この関数では、レイヤは位置とは別に指定されるため、位置の Z 座標を使用してオブジェクトの深さをオフセットすることができます。
| |
bitmap_3d_uv ( self, material, uv_00, uv_11, tm, pos, layer, size, color ) : integerこの関数は、Gui.bitmap_uv() に似ていますが、トランスフォーム行列(tm)を使用してオブジェクトを 3D に配置するため、3D ワールドでオブジェクトを自由に回転できます。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
material : | any(string, stingray.Material*) | 使用する .material リソース ファイルまたはマテリアル ポインタの名前を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
uv_00 : | UV 座標を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
uv_11 : | UV 座標を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
tm : | トランスフォーム行列です。オブジェクトを 3D で配置します。 | |
pos : | 位置を指定します。 | |
layer : | integer | レイヤを指定します。 |
size : | 寸法を指定します。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
ID を返します。 |
この関数を使用すると、1 つのワールド gui を使用してワールド内のさまざまな位置にオブジェクトを描画することができます。
注: この関数では、レイヤは位置とは別に指定されるため、位置の Z 座標を使用してオブジェクトの深さをオフセットすることができます。
| |
bitmap_uv ( self, material, uv_00, uv_11, pos, size, color ) : integer指定した UV 座標を使用して、左上と右下のコーナーにビットマップを作成(または描画)します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
material : | any(string, stingray.Material*) | 使用する .material リソース ファイルまたはマテリアル ポインタの名前を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
uv_00 : | UV 座標を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
uv_11 : | UV 座標を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
pos : | ビットマップの位置を指定します。Vector3 を渡す場合、z コンポーネントは描画レイヤを指定する整数です。描画レイヤの値が大きいオブジェクトは、他のオブジェクトの前面に表示されます。Vector2 を渡す場合、描画レイヤは 0 に設定されています。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
size : | 寸法を指定します。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
ID を返します。 |
その他の関連リファレンス項目
| |
create_material ( self, material ) : stingray.Material指定されたタイプの新しいマテリアルを作成して、この Gui に割り当てます。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
material : | string | .material リソース ファイルの名前を指定します。 |
|
新しく作成された Material オブジェクトです。 |
| |
destroy_bitmap ( self, id )保持モードでは、この関数は、指定された ID を持つオブジェクトを破壊します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
| この関数は値を返しません。 |
| |
destroy_bitmap_3d ( self, id )保持モードでは、この関数は、指定された ID を持つオブジェクトを破壊します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
| この関数は値を返しません。 |
| |
destroy_rect ( self, id )保持モードでは、この関数は、指定された ID を持つオブジェクトを破壊します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
| この関数は値を返しません。 |
| |
destroy_rect_3d ( self, id )保持モードでは、この関数は、指定された ID を持つオブジェクトを破壊します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
| この関数は値を返しません。 |
| |
destroy_text ( self, id )保持モードでは、この関数は、指定された ID を持つオブジェクトを破壊します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
| この関数は値を返しません。 |
| |
destroy_text_3d ( self, id )保持モードでは、この関数は、指定された ID を持つオブジェクトを破壊します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
| この関数は値を返しません。 |
| |
destroy_triangle ( self, id )保持モードでは、この関数は、指定された ID を持つオブジェクトを破壊します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
| この関数は値を返しません。 |
| |
destroy_video ( self, id )保持モードでは、この関数は、指定された ID を持つオブジェクトを破壊します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
| この関数は値を返しません。 |
| |
destroy_video_3d ( self, id )保持モードでは、この関数は、指定された ID を持つオブジェクトを破壊します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
| この関数は値を返しません。 |
| |
get_id ( self ) : integerこの GUI の(ワールドごとに)一意の ID を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
integer |
この GUI の(ワールドごとに)一意の ID を返します。 |
| |
has_all_glyphs ( self, text, font ) : booleanフォントがすべてのグリフを指定された文字列内に持っている場合は true を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
text : | string | テキストを指定します。 |
font : | string | フォントの名前を指定します。 |
boolean |
フォントがすべてのグリフを指定された文字列内に持っている場合は true を返します。 |
| |
has_video_player ( ) : stringエンジンに何のビデオ ライブラリがリンクされていたかに応じて、"IVF" または nil を返します。
|
| この関数はパラメータを受け入れません。 |
string |
"IVF" または nil を返します。 |
| |
material ( self, material ) : stingray.Material指定された .material リソース ファイルから、この Gui に割り当てられたマテリアルを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
material : | string | .material リソース ファイルの名前を指定します。 |
|
指定された名前を持つマテリアルを表す Material オブジェクトです。 |
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
pose : | Gui の左下コーナーの新しい移動と回転です。 |
| この関数は値を返しません。 |
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
x : | number | Gui の左下コーナーの新しい水平位置です。 |
y : | number | Gui の左下コーナーの新しい垂直位置です。 |
| この関数は値を返しません。 |
| |
rect ( self, pos, size, color, material ) : integergui で長方形を作成(またはイミディエイト モードで描画)します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
pos : | pos パラメータは、長方形の位置を指定する Vector3 です。(x,y)は、X 座標と Y 座標で、z は描画レイヤを指定する整数です。z の値が大きいオブジェクトが他のオブジェクトの前面に表示されます。 | |
size : | size パラメータは、長方形の寸法を指定する Vector2 です。 | |
color : | オプション。長方形の色を指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
material : | any(string, stingray.Material*)? | オプション。使用する .material リソース ファイルまたはマテリアル ポインタの名前を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
長方形を識別するための ID を返します。 |
この関数は、長方形を識別するための ID を返します。この ID は、保持モードでのみ有用です。
その他の関連リファレンス項目
| |
rect ( self, pos, size, color, material ) : integergui で長方形を作成(またはイミディエイト モードで描画)します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
pos : | pos パラメータは、長方形の位置を指定する Vector2 です。(x,y)は X 座標と Y 座標です。描画レイヤは 0 (ゼロ)に設定されています。 | |
size : | size パラメータは、長方形の寸法を指定する Vector2 です。 | |
color : | オプション。長方形の色を指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
material : | any(string, stingray.Material*)? | オプション。使用する .material リソース ファイルまたはマテリアル ポインタの名前を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
長方形を識別するための ID を返します。 |
この関数は、長方形を識別するための ID を返します。この ID は、保持モードでのみ有用です。
| |
rect_3d ( self, tm, pos, layer, size, color, material ) : integerこの関数は、Gui.rect() に似ていますが、トランスフォーム行列(tm)を使用してオブジェクトを 3D に配置するため、3D ワールドでオブジェクトを自由に回転できます。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
tm : | トランスフォーム行列です。オブジェクトを 3D で配置します。 | |
pos : | pos パラメータは、長方形の位置を指定する Vector3 です。 | |
layer : | integer | レイヤを指定します。 |
size : | size パラメータは、長方形の寸法を指定する Vector2 です。 | |
color : | オプション。長方形の色を指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
material : | any(string, stingray.Material*)? | オプション。使用する .material リソース ファイルまたはマテリアル ポインタの名前を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
長方形を識別するための ID を返します。 |
この関数を使用すると、1 つのワールド gui を使用してワールド内のさまざまな位置にオブジェクトを描画することができます。
注: この関数では、レイヤは位置とは別に指定されるため、位置の Z 座標を使用してオブジェクトの深さをオフセットすることができます。
その他の関連リファレンス項目
| |
reset ( self )Gui でプリミティブをクリアします。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 |
| この関数は値を返しません。 |
これは各フレームの最後に自動的に行われるため、通常、この関数を呼び出す必要はありません。この Gui が存在するワールドを 1 つのフレーム内に数回レンダリングして、別の Gui プリミティブを描画する場合は、Application.render_world() への呼び出しの間に、この関数を呼び出す必要があります。
| |
resolution ( viewport, window ) : number, number指定されたビューポートにレンダリングする際に、画面 gui で使用できるピクセルの幅と高さを返します。
|
viewport : | オプション。解像度が返されるビューポートです。省略した場合は、バック バッファの解像度が返されます。「Application.back_buffer_size()」を参照してください。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
window : | オプション。PC 上の複数のスワップ チェーンにレンダリングする場合にのみ使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
number |
指定したビューポートにレンダリングするときに使用できる幅です(ピクセル単位)。 |
number |
指定したビューポートにレンダリングするときに使用できる高さです(ピクセル単位)。 |
これは通常、Application.back_buffer_size() と同じです。画面が正方形のピクセルではない場合、またはビューポートの出力レンダー ターゲットがバック バッファと同じでない場合、2 つの値は異なります。その場合、サイズ(100,100)の Gui オブジェクトが完全な正方形を保つように、Gui ピクセルが水平方向にストレッチされます。これは、Gui ピクセルが実際の画面ピクセルより水平方向に少なくまたは多くなることを意味します。
関連サンプル コード
| |
text ( self, text, font, font_size, material, pos, color, options ) : integer1 行のテキストを描画します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
text : | string | 描画する文字列を指定します。 |
font : | string | フォントの名前を指定します。 |
font_size : | number | フォント サイズをピクセルで指定します。これはピクセル パーフェクトの描画のフォントを生成するために使用したフォント サイズと一致している必要があります。 |
material : | any(string, stingray.Material*) | 使用する .material リソース ファイルまたはマテリアル ポインタの名前を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
pos : | テキストの位置を指定します。Vector3 を渡す場合、z コンポーネントは描画レイヤを指定する整数です。描画レイヤの値が大きいオブジェクトは、他のオブジェクトの前面に表示されます。Vector2 を渡す場合、描画レイヤは 0 に設定されています。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
options : | string? | オプション。テキスト用の追加のオプションを指定します。各オプションは、オプションを識別する文字列と、そのオプションに設定する値が続きます。サポートされているオプションは次のとおりです。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
ID を返します。 |
\n または他の改行文字を使用して改行することはできません。テキストの追加の行を作成する必要がある場合は、異なる位置で text() を何度か呼び出す必要があります。
関連サンプル コード
その他の関連リファレンス項目
| |
texture_size ( resource_name ) : number, numberテクスチャ リソースの幅と高さを取得します。
|
resource_name : | string | テクスチャ リソースの名前です。 |
number |
ロードされたテクスチャの幅を返します。 |
number |
ロードされたテクスチャの高さを返します。 |
この関数は開発用のビルドでのみ使用可能です。
| |
text_3d ( self, text, font, font_size, material, tm, pos, layer, color, options ) : integerこの関数は、Gui.text() に似ていますが、トランスフォーム行列(tm)を使用してオブジェクトを 3D に配置するため、3D ワールドでオブジェクトを自由に回転できます。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
text : | string | 描画する文字列を指定します。 |
font : | string | フォントの名前を指定します。 |
font_size : | number | フォント サイズをピクセルで指定します。これはピクセル パーフェクトの描画のフォントを生成するために使用したフォント サイズと一致している必要があります。 |
material : | any(string, stingray.Material*) | 使用する .material リソース ファイルまたはマテリアル ポインタの名前を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
tm : | トランスフォーム行列です。オブジェクトを 3D で配置します。 | |
pos : | 位置を指定します。 | |
layer : | integer | レイヤを指定します。 |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
options : | string? | オプション。テキスト用の追加のオプションを指定します。各オプションは、オプションを識別する文字列と、そのオプションに設定する値が続きます。サポートされているオプションは次のとおりです。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
ID を返します。 |
この関数を使用すると、1 つのワールド gui を使用してワールド内のさまざまな位置にオブジェクトを描画することができます。
注: この関数では、レイヤは位置とは別に指定されるため、位置の Z 座標を使用してオブジェクトの深さをオフセットすることができます。
| |
text_extents ( self, text, font, font_size, options ) : stingray.Vector2, stingray.Vector2, stingray.Vector2指定されたフォントと font_size を使用して描画する際に、テキストの範囲を計算します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
text : | string | テキストを指定します。 |
font : | string | フォントの名前を指定します。 |
font_size : | number | フォント サイズをピクセルで指定します。 |
options : | any(string, number)* | オプション。テキスト用の追加のオプションを指定します。各オプションは、オプションを識別する文字列と、そのオプションに設定する値が続きます。サポートされているオプションは次のとおりです。
any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
|
min: 描画されたテキスト内の任意の文字の最小の X と Y の位置を表します。 | |
|
max: 描画されたテキスト内の任意の文字の最大の X と Y の位置を表します。 | |
|
caret: テキストを描画後のキャレットの位置(次の文字が配置される場所)を表します。 |
この関数を使用して、テキストを中心揃えまたは右揃えすることができます。
関連サンプル コード
| |
triangle ( self, p1, p2, p3, layer, color, material, uv0, uv1, uv2 ) : integergui で三角形を作成(または描画)します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
p1 : | 三角形のコーナーの Vector3 の位置です。 | |
p2 : | 三角形のコーナーの Vector3 の位置です。 | |
p3 : | 三角形のコーナーの Vector3 の位置です。 | |
layer : | integer | レイヤを指定します。 |
color : | オプション。三角形の色を指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
material : | string? | オプション。使用する .material リソース ファイルの名前を指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
uv0 : | オプション。三角形のコーナーの UV 座標です。uv0 を指定した場合、他の 2 つ(uv1 と uv2)の UV 座標も指定する必要があります。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
uv1 : | オプション。三角形のコーナーの UV 座標です。uv1 を指定した場合、他の 2 つ(uv0 と uv2)の UV 座標も指定する必要があります。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
uv2 : | オプション。三角形のコーナーの UV 座標です。uv2 を指定した場合、他の 2 つ(uv0 と uv1)の UV 座標も指定する必要があります。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
三角形を識別するための ID を返します。 |
p1、p2、p3 引数は三角形のコーナーの Vector3 の位置です。指定した場合、uv0、uv1、uv2 は、三角形のコーナーの UV 座標を提供します。
注: 三角関数は、GUI の他の大多数の関数のように 2D x-y 座標を使用するのではなく、実際の 3D 座標を使用します。これは、Y 座標の代わりに、Z 座標が GUI での上を表し、レイヤは別のパラメータを使用して指定されることを意味します。
| |
update_bitmap ( self, id, material, pos, size, color )保持モードでは、この関数は、指定された ID を持つオブジェクトを更新します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
material : | string | 使用する .material リソース ファイルの名前を指定します。 |
pos : | ビットマップの位置を指定します。Vector3 を渡す場合、z コンポーネントは描画レイヤを指定する整数です。描画レイヤの値が大きいオブジェクトは、他のオブジェクトの前面に表示されます。Vector2 を渡す場合、描画レイヤは 0 に設定されています。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
size : | ビットマップの寸法を指定します。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
update_bitmap_3d ( self, id, material, tm, pos, layer, size, color )保持モードでは、この関数は、指定された ID を持つオブジェクトを更新します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
material : | string | 使用する .material リソース ファイルまたはマテリアル ポインタの名前を指定します。 |
tm : | トランスフォーム行列です。オブジェクトを 3D で配置します。 | |
pos : | 位置を指定します。 | |
layer : | integer | レイヤを指定します。 |
size : | 寸法を指定します。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
update_bitmap_3d_uv ( self, id, material, uv_00, uv_11, tm, pos, layer, size, color )保持モードでは、この関数は、指定された ID を持つオブジェクトを更新します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
material : | string | 使用する .material リソース ファイルの名前を指定します。 |
uv_00 : | UV 座標を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
uv_11 : | UV 座標を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
tm : | トランスフォーム行列です。オブジェクトを 3D で配置します。 | |
pos : | 位置を指定します。 | |
layer : | integer | レイヤを指定します。 |
size : | 寸法を指定します。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
update_bitmap_uv ( self, id, material, uv_00, uv_11, pos, size, color )保持モードでは、この関数は、指定された ID を持つオブジェクトを更新します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
material : | string | 使用する .material リソース ファイルの名前を指定します。 |
uv_00 : | UV 座標を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
uv_11 : | UV 座標を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
pos : | ビットマップの位置を指定します。Vector3 を渡す場合、z コンポーネントは描画レイヤを指定する整数です。描画レイヤの値が大きいオブジェクトは、他のオブジェクトの前面に表示されます。Vector2 を渡す場合、描画レイヤは 0 に設定されています。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
size : | 寸法を指定します。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
update_rect ( self, id, pos, size, color )保持モードでは、この関数は、指定された ID を持つオブジェクトを更新します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
pos : | pos パラメータは、長方形の位置を指定する Vector3 です。(x,y)は、X 座標と Y 座標で、z は描画レイヤを指定する整数です。z の値が大きいオブジェクトが他のオブジェクトの前面に表示されます。 | |
size : | size パラメータは、長方形の寸法を指定する Vector2 です。 | |
color : | オプション。長方形の色を指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
update_rect_3d ( self, id, tm, pos, layer, size, color )保持モードでは、この関数は、指定された ID を持つオブジェクトを更新します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
tm : | トランスフォーム行列です。オブジェクトを 3D で配置します。 | |
pos : | pos パラメータは、長方形の位置を指定する Vector3 です。 | |
layer : | integer | レイヤを指定します。 |
size : | size パラメータは、長方形の寸法を指定する Vector2 です。 | |
color : | オプション。長方形の色を指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
update_text ( self, id, text, font, material, font_size, pos, color, options )保持モードでは、この関数は、指定された ID を持つオブジェクトを更新します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
text : | string | 描画する文字列を指定します。 |
font : | string | フォントの名前を指定します。 |
material : | string | 使用する .material リソース ファイルの名前を指定します。 |
font_size : | number | フォント サイズをピクセルで指定します。これはピクセル パーフェクトの描画のフォントを生成するために使用したフォント サイズと一致している必要があります。 |
pos : | テキストの位置を指定します。Vector3 を渡す場合、z コンポーネントは描画レイヤを指定する整数です。描画レイヤの値が大きいオブジェクトは、他のオブジェクトの前面に表示されます。Vector2 を渡す場合、描画レイヤは 0 に設定されています。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
options : | string? | オプション。テキスト用の追加のオプションを指定します。各オプションは、オプションを識別する文字列と、そのオプションに設定する値が続きます。サポートされているオプションは次のとおりです。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
update_text_3d ( self, id, text, font, material, font_size, tm, pos, layer, color, options )保持モードでは、この関数は、指定された ID を持つオブジェクトを更新します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
text : | string | 描画する文字列を指定します。 |
font : | string | フォントの名前を指定します。 |
material : | string | 使用する .material リソース ファイルの名前を指定します。 |
font_size : | number | フォント サイズをピクセルで指定します。これはピクセル パーフェクトの描画のフォントを生成するために使用したフォント サイズと一致している必要があります。 |
tm : | トランスフォーム行列です。オブジェクトを 3D で配置します。 | |
pos : | 位置を指定します。 | |
layer : | integer | レイヤを指定します。 |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
options : | string? | オプション。テキスト用の追加のオプションを指定します。各オプションは、オプションを識別する文字列と、そのオプションに設定する値が続きます。サポートされているオプションは次のとおりです。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
update_triangle ( self, id, p1, p2, p3, layer, color )保持モードでは、この関数は、指定された ID を持つオブジェクトを更新します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
p1 : | 三角形のコーナーの Vector3 の位置です。 | |
p2 : | 三角形のコーナーの Vector3 の位置です。 | |
p3 : | 三角形のコーナーの Vector3 の位置です。 | |
layer : | integer | レイヤを指定します。 |
color : | オプション。三角形の色を指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
update_video ( self, id, material, video_player, pos, size, color )保持モードでは、この関数は、指定された ID を持つオブジェクトを更新します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
material : | string | 使用する .material リソース ファイルの名前を指定します。 |
video_player : | video_player は、この Gui オブジェクトが表示する必要があるビデオの VideoPlayer への参照です。 | |
pos : | ビデオの位置を指定します。Vector3 を渡す場合、z コンポーネントは描画レイヤを指定する整数です。描画レイヤの値が大きいオブジェクトは、他のオブジェクトの前面に表示されます。Vector2 を渡す場合、描画レイヤは 0 に設定されています。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
size : | 寸法を指定します。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
update_video_3d ( self, id, material, video_player, tm, pos, layer, size, color )保持モードでは、この関数は、指定された ID を持つオブジェクトを更新します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
id : | integer | オブジェクトの ID を指定します。 |
material : | string | 使用する .material リソース ファイルの名前を指定します。 |
video_player : | video_player は、この Gui オブジェクトが表示する必要があるビデオの VideoPlayer への参照です。 | |
tm : | トランスフォーム行列です。オブジェクトを 3D で配置します。 | |
pos : | 位置を指定します。 | |
layer : | integer | レイヤを指定します。 |
size : | 寸法を指定します。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| この関数は値を返しません。 |
| |
video ( self, material, video_player, pos, size, color ) : integerビデオを描画する長方形を作成します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
material : | any(string, stingray.Material*) | 使用する .material リソース ファイルまたはマテリアル ポインタの名前を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
video_player : | video_player は、この Gui オブジェクトが表示する必要があるビデオの VideoPlayer への参照です。 | |
pos : | ビデオの位置を指定します。Vector3 を渡す場合、z コンポーネントは描画レイヤを指定する整数です。描画レイヤの値が大きいオブジェクトは、他のオブジェクトの前面に表示されます。Vector2 を渡す場合、描画レイヤは 0 に設定されています。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 | |
size : | 寸法を指定します。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
ID を返します。 |
ビデオは、指定したマテリアルを使用して描画されます。マテリアルは、YUV を RBG に変換するカスタム シェーダを使用する必要があります。使用しないと、ビデオから奇妙な出力見られます。VideoPlayer で関数を使用して、ビデオの再生をコントロールすることができます。
その他の関連リファレンス項目
| |
video_3d ( self, material, video_player, tm, pos, layer, size, color ) : integerこの関数は、Gui.video() に似ていますが、トランスフォーム行列(tm)を使用してオブジェクトを 3D に配置するため、3D ワールドでオブジェクトを自由に回転できます。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
material : | any(string, stingray.Material*) | 使用する .material リソース ファイルまたはマテリアル ポインタの名前を指定します。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
video_player : | video_player は、この Gui オブジェクトが表示する必要があるビデオの VideoPlayer への参照です。 | |
tm : | トランスフォーム行列です。オブジェクトを 3D で配置します。 | |
pos : | 位置を指定します。 | |
layer : | integer | レイヤを指定します。 |
size : | 寸法を指定します。 | |
color : | オプション。カラーを指定します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
integer |
ID を返します。 |
この関数を使用すると、1 つのワールド gui を使用してワールド内のさまざまな位置にオブジェクトを描画することができます。
注: この関数では、レイヤは位置とは別に指定されるため、位置の Z 座標を使用してオブジェクトの深さをオフセットすることができます。
| |
word_wrap ( self, text, font, font_size, width, whitespace, soft_dividers, return_dividers, options ) : table各文字列が指定した幅に収まるように分割された文字列のリストを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
text : | string | テキストを指定します。 |
font : | string | フォントの名前を指定します。 |
font_size : | number | フォント サイズをピクセルで指定します。 |
width : | number | 幅を指定します。 |
whitespace : | string | 空白文字の文字列。通常、これは " " になります。 |
soft_dividers : | string | 分割する必要のある文字列に空白がない場合に、改行する文字の文字列です。通常は、"-+&/" のようなものになります。 |
return_dividers : | string | 改行を強制する文字の文字列です。通常、これは "\n" になります。 |
options : | string? | オプション。テキスト用の追加のオプションを指定します。各オプションは、オプションを識別する文字列と、そのオプションに設定する値が続きます。サポートされているオプションは次のとおりです。
? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
table |
文字列のリストを返します。 |