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

説明

ゲーム ワールド内でデバッグ ラインを描画するために使用されます。

LineObject は World.create_line_object() で作成されます。

add_* 関数を呼び出すことでライン オブジェクトにラインを追加することができ、dispatch() を呼び出すことでそれをレンダリング用に待ち行列に入れることができます。ライン オブジェクト内のラインは、フレーム間で自動的にクリアされないため、追加するすべてのラインは、ライン オブジェクトをディスパッチし続ける限り、画面上に保持されます。reset() を呼び出して、ライン オブジェクトのラインを消去します。

移動するオブジェクトを追跡するラインを描画するには、フレームごとに reset() を呼び出して古いラインを消去して、オブジェクトの新しい位置に新しいラインを追加してから、dispatch() を呼び出します。

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

stingray.World.create_line_object()

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

	stingray.Actor.debug_draw() stingray.NavigationMesh.visualize_last_search() stingray.World.destroy_line_object()
	Debugging

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

	「リリース ノート > Stingray 1.1 リリース ノート」
	「ゲームプレイを作成する > AI とパスファインディング > Gameware Navigation をゲームのランタイムに統合する」

関数

add_axes ( self, pose, length ) 各軸に指定した長さのラインを追加します。

パラメータ

self :	stingray.LineObject	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
pose :	stingray.Matrix4x4	軸の位置と方向を指定します。
length :	stingray.Vector3?	軸のラインの長さです。既定値は 1 です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

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

カラーは固定されており、X は赤、Y は緑、Z は青です。

add_box ( self, color, pose, extents ) 方向付けされたボックスを追加します。

パラメータ

self :	stingray.LineObject	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
color :	stingray.Vector4	ボックスのカラーです。これは各コンポーネントとともに Vector4 に保存されている ARGB 値(0 ～ 255 の範囲)です。Color() を呼び出し、RGB 値の 3 つの引数または ARGB 値の 4 つの引数を渡すことで、これらの値を作成することができます。たとえば、明るい黄色のラインを描画するには、Color(255, 255, 0) を使用します。
pose :	stingray.Matrix4x4	ボックスの位置と方向を指定します。
extents :	stingray.Vector3	ボックスのローカルの右軸、前方軸および上方軸のサイズです。

戻り値

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

add_capsule ( self, color, from, to, radius, segments, circles, bars ) 指定した半径に膨らませた from と to の間にカプセルをラインをとして追加します。

パラメータ

self :	stingray.LineObject	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
color :	stingray.Vector4	カプセルのカラーです。これは各コンポーネントとともに Vector4 に保存されている ARGB 値(0 ～ 255 の範囲)です。Color() を呼び出し、RGB 値の 3 つの引数または ARGB 値の 4 つの引数を渡すことで、これらの値を作成することができます。たとえば、明るい黄色のラインを描画するには、Color(255, 255, 0) を使用します。
from :	stingray.Vector3	始点です。
to :	stingray.Vector3	終点です。
radius :	number	カプセルの半径です。
segments :	integer?	(オプション) 各円内のライン セグメントの数です。省略した場合、既定値の 20 が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
circles :	integer?	(オプション) カプセルの長さに沿った円の数です。省略した場合、既定値の 4 が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
bars :	integer?	(オプション) カプセル内のバーの数です。省略した場合、既定値の 10 が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

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

segments、circles、bars の各パラメータは、カプセルをどの程度詳細にするかを指定します。

add_circle ( self, color, center, radius, normal, segments ) center の位置に指定した半径と法線ベクトルの 2 次元の円を追加します。

パラメータ

self :	stingray.LineObject	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
color :	stingray.Vector4	円のカラーです。これは各コンポーネントとともに Vector4 に保存されている ARGB 値(0 ～ 255 の範囲)です。Color() を呼び出し、RGB 値の 3 つの引数または ARGB 値の 4 つの引数を渡すことで、これらの値を作成することができます。たとえば、明るい黄色のラインを描画するには、Color(255, 255, 0) を使用します。
center :	stingray.Vector3	円の中心点です。
radius :	number	円の半径です。
normal :	stingray.Vector3	法線ベクトルです。
segments :	integer?	(オプション) 円を描画するために使用されるライン セグメントの数です。省略した場合、既定値の 20 が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

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

add_cone ( self, color, from, to, radius, segments, bars ) 先端が from で底面の中心が to の円錐を追加します。

パラメータ

self :	stingray.LineObject	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
color :	stingray.Vector4	円錐のカラーです。これは各コンポーネントとともに Vector4 に保存されている ARGB 値(0 ～ 255 の範囲)です。Color() を呼び出し、RGB 値の 3 つの引数または ARGB 値の 4 つの引数を渡すことで、これらの値を作成することができます。たとえば、明るい黄色のラインを描画するには、Color(255, 255, 0) を使用します。
from :	stingray.Vector3	始点です。
to :	stingray.Vector3	終点です。
radius :	number	円錐の底面の半径です。
segments :	integer?	(オプション) 円錐内のライン セグメントの数です。省略した場合、既定値の 20 が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
bars :	integer?	(オプション) 円錐内のバーの数です。省略した場合、既定値の 10 が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

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

add_half_sphere ( self, color, center, radius, normal, segments, parts ) center の位置に円形平面からの指定した法線で半球を追加します。

パラメータ

self :	stingray.LineObject	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
color :	stingray.Vector4	球のカラーです。これは各コンポーネントとともに Vector4 に保存されている ARGB 値(0 ～ 255 の範囲)です。Color() を呼び出し、RGB 値の 3 つの引数または ARGB 値の 4 つの引数を渡すことで、これらの値を作成することができます。たとえば、明るい黄色のラインを描画するには、Color(255, 255, 0) を使用します。
center :	stingray.Vector3	球の中心点です。
radius :	number	球の半径です。
normal :	stingray.Vector3	法線ベクトルです。
segments :	integer?	(オプション) 各円を描画するために使用されるライン セグメントの数です。省略した場合、既定値の 20 が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
parts :	integer?	(オプション) 半球内の円の数です。省略した場合、既定値の 2 が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

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

add_line ( self, color, from, to ) ライン オブジェクトに from と to 間の新しいラインを指定したカラーで追加します。

パラメータ

self :	stingray.LineObject	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
color :	stingray.Vector4	ラインのカラーです。これは各コンポーネントとともに Vector4 に保存されている ARGB 値(0 ～ 255 の範囲)です。Color() を呼び出し、RGB 値の 3 つの引数または ARGB 値の 4 つの引数を渡すことで、これらの値を作成することができます。たとえば、明るい黄色のラインを描画するには、Color(255, 255, 0) を使用します。
from :	stingray.Vector3	ラインの始点です。
to :	stingray.Vector3	ラインの終点です。

戻り値

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

add_sphere ( self, color, center, radius, segments, parts ) center の位置に指定された半径で 3D の球を追加します。

パラメータ

self :	stingray.LineObject	この関数を機能させるオブジェクト インスタンスを指定します。 この関数を呼び出す場合は、常にこの self パラメータを指定する必要があります。ドット . 呼び出し構文(オブジェクト指向のコロン : 呼び出し構文ではなく)を使用する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。
color :	stingray.Vector4	球のカラーです。これは各コンポーネントとともに Vector4 に保存されている ARGB 値(0 ～ 255 の範囲)です。Color() を呼び出し、RGB 値の 3 つの引数または ARGB 値の 4 つの引数を渡すことで、これらの値を作成することができます。たとえば、明るい黄色のラインを描画するには、Color(255, 255, 0) を使用します。
center :	stingray.Vector3	球の中心点です。
radius :	number	球の半径です。
segments :	integer?	(オプション) 各円を描画するために使用されるライン セグメントの数です。省略した場合、既定値の 20 が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。
parts :	integer?	(オプション) 球内の円の数です。省略した場合、既定値の 2 が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。

戻り値

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

dispatch ( world, line_object ) 指定したワールド内にレンダリングするためのライン オブジェクトを待ち行列に入れます。

パラメータ

world :	stingray.World	ライン オブジェクトがレンダリングされるワールドです。
line_object :	stingray.LineObject	レンダリングにディスパッチするライン オブジェクトです。

戻り値

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

ワールドはライン オブジェクトを作成したのと同じワールドである必要があります。

reset ( self ) ライン オブジェクトのラインを消去します。

パラメータ

self :

stingray.LineObject

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

戻り値

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