SceneGraphComponent - stingray.SceneGraphComponent オブジェクト リファレンス - Stingray Lua API リファレンス
説明
エンティティにシーン グラフ(ノード階層)を割り当てるコンポーネントです。
シーン グラフはエンティティのアニメートやスキニングに使用されます。
コンストラクタとアクセサ 
その他の関連リファレンス項目
この参照ページは、次の概要トピックと関連付けられています
関数
 |
create ( self, entity, id ) : integer 指定されたコンポーネント ID を持つエンティティのコンポーネント インスタンスを作成します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
id : | any(integer, string) | コンポーネント ID です。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
integer |
コンポーネントのインスタンスです。 |
| |
destroy ( self, instance )エンティティの特定のコンポーネント インスタンスを破壊します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
instance : | integer | 破棄するコンポーネントのインスタンスです。 |
| この関数は値を返しません。 |
| |
destroy_all ( self, entity )エンティティのすべてのコンポーネント インスタンスを破棄します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | すべてのコンポーネント インスタンスを破棄するエンティティです。 |
| この関数は値を返しません。 |
| |
get_property ( self, instance, key ) : any*プロパティ キーの値を取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
instance : | integer | コンポーネントのインスタンスです。 |
key : | any(string, string[]) | 取得する値を持つプロパティのキーです。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
any* |
キーの値です。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
キーは、ドット区切りの文字列 "fog.color.red" または文字配列 {"fog", "color", "red"} にすることができます。どちらも同じように使用できます。
値はプロパティシ ステムでサポートされているいずれかの値(nil、ブール、数値、文字列、または float 配列)になります。
float 配列は複数の戻り値として返されます。テーブルまたは Vector3 としてこれらが必要な場合は、ラッパーを使用します。
キーが存在しない場合、nil が返されます。
| |
get_property_by_id ( self, entity, id, key ) : any*指定された ID と一致するコンポーネント インスタンスのプロパティ値を取得します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
id : | integer | コンポーネント インスタンスの ID です。 |
key : | any(string, string[]) | 取得する値を持つプロパティのキーです。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
any* |
キーの値です。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
キーは、ドット区切りの文字列 "fog.color.red" または文字配列 {"fog", "color", "red"} にすることができます。どちらも同じように使用できます。
値はプロパティシ ステムでサポートされているいずれかの値(nil、ブール、数値、文字列、または float 配列)になります。
float 配列は複数の戻り値として返されます。テーブルまたは Vector3 としてこれらが必要な場合は、ラッパーを使用します。
キーが存在しない場合、nil が返されます。
この関数を呼び出すと、指定されたコンポーネント ID からコンポーネント インスタンスへの追加ルックアップが実行されます。複数のプロパティを取得する場合は、コンポーネント ID を指定してコンポーネント インスタンスをルックアップしてから、get_property を呼び出すと便利です。
| |
instances ( self, entity ) : integer*指定されたエンティティのすべてのコンポーネント インスタンスを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 |
integer* |
すべてのエンティティのコンポーネント インスタンスです。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
このインスタンスはスタック上で返されます。
| |
instance_ids ( self, entity ) : integer*すべてのエンティティのコンポーネントの ID を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 |
integer* |
すべてのエンティティ インスタンスの ID です。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
この ID は、スタック上で返されます。
| |
local_pose ( self, entity, node ) : stingray.Matrix4x4親を基準としたノードのローカル ポーズを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
node : | integer | ノードのインデックスを指定します。 |
|
ノードのローカル ポーズを返します。 |
| |
local_position ( self, entity, node ) : stingray.Vector3親を基準としたノードのローカル位置を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
node : | integer | ノードのインデックスを指定します。 |
|
ノードのローカル位置を返します。 |
| |
local_rotation ( self, entity, node ) : stingray.Quaternion親を基準としたノードのローカル回転を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
node : | integer | ノードのインデックスを指定します。 |
|
ノードのローカル回転を返します。 |
| |
local_scale ( self, entity, node ) : stingray.Vector3親を基準としたエンティティのローカル スケールを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
node : | integer | ノードのインデックスを指定します。 |
|
ノードのローカル スケールを返します。 |
| |
lookup ( self, entity, id ) : integer指定された ID のコンポーネント インスタンスを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
id : | integer | コンポーネント インスタンスの ID です。 |
integer |
コンポーネントのインスタンスです。 |
| |
node_index ( self, entity, name ) : integername で指定されたノードのシーン グラフ内におけるインデックスを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
name : | string | ノードの名前を指定します。 |
integer |
シーン グラフ内で指定された名前を持つノードのインデックスを返します。 |
指定されたノードが存在しない場合はエラーになります。
| |
num_nodes ( self, entity ) : integerエンティティのシーン グラフ コンポーネント内のノード数を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 |
integer |
エンティティのシーン グラフ コンポーネント内のノード数を返します。 |
| |
parent ( self, entity, node ) : integer?シーン グラフ コンポーネント内のノードの親を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
node : | integer | ノードのインデックスを指定します。 |
integer? |
指定されたノードの親ノードのインデックスを返し、親が存在しない場合は nil を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| |
set_local_pose ( self, entity, node, pose )ノードのローカル ポーズを設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
node : | integer | ノードのインデックスを指定します。 |
pose : | ノードの新しいローカル ポーズを指定します。 |
| この関数は値を返しません。 |
ローカル ポーズを変更すると、新しいポーズを反映してノードのワールド ポーズとすべての子がただちに変更されます。
| |
set_local_position ( self, entity, node, position )ノードのローカル位置を設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
node : | integer | ノードのインデックスを指定します。 |
position : | ノードの新しいローカル位置を指定します。 |
| この関数は値を返しません。 |
ローカル位置を変更すると、新しいローカル位置を反映してノードのワールド位置とすべての子がただちに変更されます。
| |
set_local_rotation ( self, entity, node, rotation )ノードのローカル回転を設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
node : | integer | ノードのインデックスを指定します。 |
rotation : | ノードの新しいローカル回転を指定します。 |
| この関数は値を返しません。 |
ローカル回転を変更すると、新しいローカル回転を反映してノードのワールド回転とすべての子がただちに変更されます。
| |
set_local_scale ( self, entity, node, scale )ノードのローカル スケールを設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
node : | integer | ノードのインデックスを指定します。 |
scale : | ノードの新しいローカル スケールを指定します。 |
| この関数は値を返しません。 |
ローカル スケールを変更すると、新しいローカル スケールを反映してノードのワールド スケールとすべての子がただちに変更されます。
| |
set_parent ( self, entities, parent_indices )エンティティごとに parent_indices を検索し、親を特定の親インデックスに指定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entities : | table | 親/子のリレーションシップを設定するエンティティのリストです。 |
parent_indices : | table | 親インデックスのエンティティ リストと同じ長さのリストです。親のないエンティティのインデックスとして false を使用します。 |
| この関数は値を返しません。 |
この関数は、すべてのコンポーネントを追加および設定してから、spawned を実行するまでの間に呼び出す必要があります。
| |
set_property ( self, instance, key, value )プロパティ キーに値を設定します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
instance : | integer | コンポーネントのインスタンスです。 |
key : | any(string, string[]) | 設定する値を持つプロパティのキーです。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
value : | any | キーに設定する値 |
| この関数は値を返しません。 |
キーは、ドット区切りの文字列 "fog.color.red" または文字配列 {"fog", "color", "red"} にすることができます。どちらも同じように使用できます。
値はプロパティシ ステムでサポートされている任意の値(nil、ブール、数値、文字列、または float 配列)にすることができます。
3 つまたは 4 つの float 配列を渡す代わりに、Vector3 または Quaternion を使用することができます。
値を nil に設定すると、プロパティを削除することができます。
| |
set_property_by_id ( self, entity, id, key, value ) : integerプロパティ値を設定し、指定された ID と一致するコンポーネント インスタンスを返します
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
id : | integer | コンポーネント インスタンスの ID です。 |
key : | any(string, string[]) | 設定する値を持つプロパティのキーです。 any(...) 表記は、この項目が括弧内に示されている任意のタイプのインスタンスであることを示しています。 |
value : | any | キーに設定する値 |
integer |
コンポーネントのインスタンスです。 |
キーは、ドット区切りの文字列 "fog.color.red" または文字配列 {"fog", "color", "red"} にすることができます。どちらも同じように使用できます。
値はプロパティシ ステムでサポートされている任意の値(nil、ブール、数値、文字列、または float 配列)にすることができます。
3 つまたは 4 つの float 配列を渡す代わりに、Vector3 または Quaternion を使用することができます。
値を nil に設定すると、プロパティを削除することができます。
この関数を呼び出すと、指定されたコンポーネント ID からコンポーネント インスタンスへの追加ルックアップが実行されます。複数のプロパティを設定する場合は、コンポーネント ID を指定してコンポーネント インスタンスをルックアップしてから、set_property を呼び出すと便利です。
| |
spawned ( self, entities )エンティティごとに、このコンポーネント タイプに対して spawned を呼び出します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entities : | table | spawned を呼び出すエンティティのリストです。 |
| この関数は値を返しません。 |
これは、エンティティおよびそのコンポーネントを作成および設定した後に、ワールドへの導入を仕上げる目的で呼び出す必要があります。
| |
world_pose ( self, entity, node ) : stingray.Matrix4x4ノードのワールド ポーズを返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
node : | integer | ノードのインデックスを指定します。 |
|
ノードのワールド ポーズを返します。 |
| |
world_position ( self, entity, node ) : stingray.Vector3ノードのワールド位置を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
node : | integer | ノードのインデックスを指定します。 |
|
ノードのワールド位置を返します。 |
| |
world_rotation ( self, entity, node ) : stingray.Quaternionノードのワールド回転を返します。
|
self : | この関数を機能させるオブジェクト インスタンスを指定します。 このオブジェクトのインスタンスでこの関数を呼び出すために、コロン : 呼び出し構文を使用できます。その場合、このパラメータは省略する必要があります。詳細については、この Stingray ヘルプ トピック、または Lua ドキュメントのこのページを参照してください。 | |
entity : | エンティティです。 | |
node : | integer | ノードのインデックスを指定します。 |
|
ノードのワールド回転を返します。 |