TouchPanel - stingray.TouchPanel ネームスペース リファレンス - Stingray Lua API リファレンス
説明
廃止予定です。stingray.TouchPanel1 を使用してください。
その他の関連リファレンス項目 
関数
 |
accelerator_resolution ( ) : stingray.Vector3 コントローラのアクセラレータの解像度を取得します。
|
| |
active ( ) : booleanコントローラがアクティブであるかどうか、つまり接続されていて予期したとおりに動作しているかどうかを示します。
|
| この関数はパラメータを受け入れません。 |
boolean |
コントローラがアクティブである場合は true、それ以外の場合は false を返します。 |
| |
connected ( ) : booleanコントローラがこのフレームにアタッチされているかどうかを示します。
|
| この関数はパラメータを受け入れません。 |
boolean |
コントローラがこのフレームにアタッチされている場合は true、それ以外の場合は false を返します。 |
| |
disconnected ( ) : booleanコントローラがこのフレームから接続解除されているかどうかを示します。
|
| この関数はパラメータを受け入れません。 |
boolean |
コントローラがこのフレームから接続解除されている場合は true、それ以外の場合は false を返します。 |
| |
name ( ) : stringコントローラの一意の名前を返します(例: 「Xbox Controller 1」)。
|
| この関数はパラメータを受け入れません。 |
string |
コントローラの一意の名前が含まれている文字列です。 |
ほとんどの場合、この名前は type()で返される文字列の変形にカウンタを追加したものです。
| |
type ( ) : stringこのコントローラで使用されるハードウェア デバイスの説明を返します。
|
| この関数はパラメータを受け入れません。 |
string |
コントローラ デバイスの種類を説明する文字列です。 |
この識別子は、同じモデルのすべてのコントローラで同じになります(いくつかの例外はあります)。たとえば、xbox_controller、logitech_mx518_mouse、 generic_105_key_keyboard などです。この値は、いくつかのプラットフォームでは入力デバイス モデルには関係なく同じになる場合があることに注意してください。
その他の関連リファレンス項目
ボタンと軸
このグループ内の関数は、このコントローラによって追跡されるボタンと軸からの値の取得に関連しています。
| |
any_pressed ( ) : integer?現在のフレームでプレイヤーがいずれかのボタンを押したかどうかを示します。
|
| この関数はパラメータを受け入れません。 |
integer? |
プレイヤーがこのフレームで押した最初のボタンの ID、またはプレイヤーがいずれのボタンも押さなかった場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
その場合、プレイヤーが押した最初のボタンの ID を返します。
| |
any_released ( ) : integer?プレイヤーが現在のフレームでいずれかのボタンを放したかどうかを示します。
|
| この関数はパラメータを受け入れません。 |
integer? |
プレイヤーがこのフレームで放した最初のボタンの ID、またはプレイヤーがいずれのボタンも放さなかった場合は nil です。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
その場合、プレイヤーが放した最初のボタンの ID を返します。
| |
axis ( id, dead_zone_mode, dead_zone_size ) : stingray.Vector3コントローラの 1 つの軸の入力値を返します。
|
id : | integer | 値が取得される軸の ID です。 |
dead_zone_mode : | integer? | コントローラから読み込まれた値を返す前に適用するデッド ゾーンの種類を指定します。この値は、デッド ゾーン モード定数のいずれかです。このパラメータを指定する場合は、dead_zone_size も指定する必要があります。省略した場合は、[InputController.set_dead_zone()] を使用して設定した既定のデッド ゾーン値が使用されます。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
dead_zone_size : | number? | コントローラから読み込まれた値に適用するデッド ゾーンのサイズです。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
|
指定された ID を持つ軸に対するコントローラの入力値です。 |
デッド ゾーンの環境設定コントロールは、非接触型インタフェースの場合にのみ使用できることに注意してください。
| |
axis_id ( name ) : integerコントローラ内の指定された名前を持つ軸の ID を取得します(ある場合)。
|
name : | string | ID を取得する対象の軸の名前。 |
integer |
軸の ID、または一致する名前を持つ軸が見つからない場合は nil です。 |
その他の関連リファレンス項目
| |
axis_name ( id ) : stringコントローラ内の指定された ID を持つ軸の名前を取得します。
|
id : | integer | 名前を取得する対象の軸の ID です。 |
string |
軸の名前です。 |
| |
button ( id ) : number指定された ID を持つボタンの現在の入力値を返します。
|
| |
button_id ( name ) : integerコントローラ内の指定された名前を持つボタンの ID を取得します(ある場合)。
|
name : | string | ID を取得する対象のボタンの名前です。 |
integer |
ボタンの ID、または一致する名前を持つボタンが見つからない場合は nil です。 |
その他の関連リファレンス項目
| |
button_name ( id ) : stringコントローラ内の指定された ID を持つボタンの名前を取得します。
|
| |
num_axes ( ) : integerコントローラの軸の数を返します。
|
| この関数はパラメータを受け入れません。 |
integer |
コントローラの軸の数です。 |
| |
num_buttons ( ) : integerコントローラのボタンの数を返します。
|
| |
pressed ( id ) : booleanプレイヤーがこのフレームの間に指定された ID を持つボタンを押したかどうかを示します。
|
id : | integer | テストするボタンの ID です。 |
boolean |
プレイヤーがこのフレームの間にそのボタンを押した場合は true、それ以外の場合は false を返します。 |
| |
released ( id ) : booleanプレイヤーがこのフレームの間に指定された ID を持つボタンを放したかどうかを示します。
|
id : | integer | テストするボタンの ID です。 |
boolean |
プレイヤーがこのフレームの間にそのボタンを放した場合は true、それ以外の場合は false を返します。 |
接触
このグループの関数は、タッチ コントローラから指の接触データを取得するために使用されます。
| |
contacts ( ) : integer*コントローラで現在アクティブなすべての接触を取得します。
|
| この関数はパラメータを受け入れません。 |
integer* |
すべての現在の接触のインデックスを返します。 * の注記は、指定されたタイプのゼロ以上のインスタンスがある場合があることを示します。 |
| |
edge ( contact_id ) : string?この接触の発生元となっている端を示します(存在する場合)。
|
contact_id : | integer | テストする接触の ID です。 |
string? |
タッチ パネルの端がこの接触の発生元となっている場合、この文字列は TOP、BOTTOM、RIGHT、または LEFT のいずれかの値です。この接触の発生元が端でない場合、または端の検出がこのデバイスによってサポートされていない場合、この関数は nil を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
Android プラットフォームのみで使用できます。
| |
has_contact ( contact_id ) : boolean指定した ID を持つ接触が存在するかどうかを示します。
|
contact_id : | integer | テストする接触の ID です。 |
boolean |
接触が存在する場合は true を返し、それ以外の場合は false を返します。 |
| |
is_primary ( contact_id ) : boolean指定した ID を持つ接触が、一次的な接触点とみなされるかどうかを示します。
|
contact_id : | integer | テストする接触の ID です。 |
boolean |
接触が一次的なものである場合は、true を返します。 |
| |
is_touch_down ( contact_id ) : boolean指定した ID を持つ接触が、このフレームで開始されたかどうかを示します。
|
contact_id : | integer | テストする接触の ID です。 |
boolean |
接触がこのフレームで開始された場合は true を返します。 |
| |
is_touch_up ( contact_id ) : boolean指定した ID を持つ接触が、このフレームで解放されたかどうかを示します。
|
contact_id : | integer | テストする接触の ID です。 |
boolean |
接触がこのフレームで解放された場合は true を返します。 |
| |
location ( contact_id ) : stingray.Vector3タッチ パネルの指定した接触の位置を取得します。
|
| |
location_delta ( contact_id ) : stingray.Vector3前のフレーム内の接触位置と現在のフレームの接触位置の差を取得します。
|
| |
major_axis_size ( contact_id ) : number主軸に沿って指定した接触のサイズ(接触領域の長い方の寸法)を取得します。
|
contact_id : | integer | テストする接触の ID です。 |
number |
主軸上の指定した接触のサイズ(ピクセル単位)です。 |
Android プラットフォームのみで使用できます。
| |
minor_axis_size ( contact_id ) : number副軸に沿って指定した接触のサイズ(接触領域の短い方の寸法)を取得します。
|
contact_id : | integer | テストする接触の ID です。 |
number |
副軸上の指定した接触のサイズ(ピクセル単位)です。 |
Android プラットフォームのみで使用できます。
| |
num_contacts ( ) : integerコントローラで現在アクティブなすべてのタッチの接触数を取得します。
|
| この関数はパラメータを受け入れません。 |
integer |
現在アクティブなタッチの接触数です。 |
| |
pressure ( contact_id ) : numberタッチ パネル表面の指定した接触の圧力を取得します。
|
contact_id : | integer | テストする接触の ID です。 |
number |
タッチ パネルの指定した接触の圧力です。 |
Android プラットフォームのみで使用できます。
| |
resolution ( ) : stingray.Vector3コントローラの入力座標の解像度を取得します。
|
| この関数はパラメータを受け入れません。 |
|
コントローラの入力座標の解像度です。 |
これは通常、X 軸および Y 軸上のピクセルに 1:1 でマッピングされます。Z 座標には、接触の最大圧力値が含まれています。
| |
size ( contact_id ) : number指定した接触のサイズを取得します。
|
contact_id : | integer | テストする接触の ID です。 |
number |
指定した接触のサイズです。 |
これは、デバイスが検出できる、考えられる最大のタッチの接触を基準にして正規化された値です。考えられる最小の正規化サイズは 0.0 (接触なし、または測定不可能)で、考えられる最大の正規化サイズは 1.0 (センサ領域が飽和状態)です。Android プラットフォームのみで使用できます。
ジェスチャ
このグループの関数は、タッチ コントローラからジェスチャ データを取得するために使用されます。
| |
gesture_long_press ( ) : stingray.Vector2?長押しジェスチャが発生した場合は nil を返し、それ以外の場合はジェスチャが開始された位置を返します。
|
| この関数はパラメータを受け入れません。 |
|
長押しジェスチャが開始された位置を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| |
gesture_pinch ( ) : boolean?, boolean?, stingray.Vector2?, number?, number?アクティブなピンチ ジェスチャがない場合は nil を返し、それ以外の場合はピンチ ジェスチャに関連するすべての値を返します。
|
| この関数はパラメータを受け入れません。 |
boolean? |
最後のフレームでジェスチャが開始したかどうかを返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
boolean? |
最後のフレームでジェスチャが終了したかどうかを返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
|
ジェスチャが開始された中心位置を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
number? |
ピンチ ジェスチャの現在のスケール値を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
number? |
ピンチ ジェスチャの現在の scale_per_second を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
低フレームレートのときには、同一の呼び出しの開始および終了の両方で true が返される可能性があります。
| |
gesture_rotate ( ) : boolean?, boolean?, stingray.Vector2?, number?, number?アクティブな回転ジェスチャがない場合は nil を返し、それ以外の場合は回転ジェスチャに関連するすべての値を返します。
|
| この関数はパラメータを受け入れません。 |
boolean? |
最後のフレームでジェスチャが開始したかどうかを返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
boolean? |
最後のフレームでジェスチャが終了したかどうかを返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
|
ジェスチャが開始された中心位置を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 | |
number? |
ジェスチャの合計の累積回転値(ラジアン)を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
number? |
ジェスチャの現在の 1 秒ごとの値を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
低フレームレートのときには、同一の呼び出しの開始および終了の両方で true が返される可能性があります。
| |
gesture_swipe ( ) : stingray.SwipeDirection?スワイプ ジェスチャがされていない場合は nil を返し、それ以外の場合はスワイプ ジェスチャの方向を返します。
|
| この関数はパラメータを受け入れません。 |
|
スワイプの方向を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| |
gesture_tap ( ) : stingray.Vector2?タップが発生していない場合は、nil を返し、それ以外の場合は連続しない最新のタップ位置を返します。
|
| この関数はパラメータを受け入れません。 |
|
連続しない最新のタップ位置を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
| |
gesture_tap_sequence ( ) : number?, stingray.Vector2?タップが発生しなかった場合は nil を返し、それ以外の場合は、後続の確認された連続して起きたタップの数を返します。各タップは、0.35 秒待機してから次のタップがないことが確認されます。
|
| この関数はパラメータを受け入れません。 |
number? |
後続のタップの数を返します。(iOS で 2 ～ 5、Android では無制限) ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
|
最新のタップ位置を返します。 ? 表記は、このタイプが省略可能であることを示しています。ゼロ個または 1 個のインスタンスが存在します。 |
廃止予定の関数
代わりにこれらの関数の _id バージョンを使用します。
| |
axis_index ( name ) : integer廃止予定です。
|
name : | string | ID を取得する対象の軸の名前。 |
integer |
軸のインデックス、または一致する名前を持つ軸が見つからない場合は nil です。 |
軸は、インデックスではなく ID で参照する必要があります。代わりに axis_id()を使用してください。
| |
button_index ( name ) : integer廃止予定です。
|