[前へ] [目次へ] [次へ]
このクラスはタイルレイヤーとイベントの重複監視を扱うクラスです。
このクラスでは一つの監視対象タイルレイヤーと、
それとの重複を監視するイベントオブジェクト配列を扱います。
重複を監視する対象のイベントオブジェクト配列は、
このオブジェクトがあたかも PPointerArray<INativeEventObject> であるかのようにして扱うことができます。
このクラスが扱う配列要素は INativeEventObject 参照です。
参照先のオブジェクトのメモリ管理には干渉しません。
このクラスの配列要素はFGESにおけるオブジェクトではなく、
C++レベルで確保および管理されています。
そのため、配列要素とのやり取りは必ずデータがコピーされ、
配列要素への直接の参照を取得することができません。
その代わり、このクラスの配列要素はC++レベルの高速なコードで処理を行えます。
●継承
このクラスは継承をしていません。
●インターフェイスとインターフェイスメソッド
このクラスはインターフェイスの実装宣言をしていません。
●クラスメソッド
このクラスはクラスメソッドを持っていません。
●クラスメンバメソッド
●クラス共有変数
このクラスはクラス共有変数を持っていません。
●インスタンス変数
このクラスはインスタンス変数を持っていません。
●C++レベル追加情報
クラスID： FGES_CLASSID_TILEMAPEVENTWATCHER
クラス名： FGESTileMapEventWatcher
TileMapEventWatcher::#operator[]
public INativeEventObject@ #operator[]( IInteger v)const
この配列の v 番の要素の値を返します。
このメソッドは指定した要素番号が無効な場合、例外が発生します。
このメソッドは最初に v から INativeInteger による取得を試みます。
これに失敗した場合、 v.Get を呼び出します。
戻り値：指定した要素番号の値を返します。
IInteger v ：取得する要素番号(0起算)
先頭へ
TileMapEventWatcher::#operator=[]
public SelfType@ #operator=[](...)
この配列に引数として渡した要素を一括して参照代入します。
この配列が既に持っていた要素は全て削除され、引数だけで構成された配列になります。
戻り値： this を返します。
可変長引数：参照代入する要素リスト。全て INativeEventObject をサポートする型でなければいけません。
先頭へ
TileMapEventWatcher::Get
public INativeEventObject@ Get( IInteger index)const
この配列の index 番の要素の値を返します。
このメソッドは指定した要素番号が無効な場合、例外が発生します。
このメソッドは最初に index から INativeInteger による取得を試みます。
これに失敗した場合、 index.Get を呼び出します。
このメソッドは #operator[] と同じ動作です。
戻り値：指定した要素番号の値を返します。
IInteger index ：取得する要素番号(0起算)
先頭へ
TileMapEventWatcher::Set
public Bool Set( IInteger index,editable INativeEventObject obj)
この配列の index 番の要素に obj を参照代入します。
このメソッドは指定した要素番号が無効な場合、偽を返し何も行いません。
このメソッドは最初に index から INativeInteger による取得を試みます。
これに失敗した場合、 index.Get を呼び出します。
戻り値：代入に成功すると真を返します。
IInteger index ：設定する要素番号(0起算)
editable INativeEventObject obj ：設定する値
先頭へ
TileMapEventWatcher::Alloc
public SelfType@ Alloc( IInteger count)
この配列の要素数を count まで増やします。
count がこの配列の要素数より少ない場合、何も起こりません。
このメソッドは最初に count から INativeInteger による取得を試みます。
これに失敗した場合、 count.Get を呼び出します。
このメソッドはメモリの確保に失敗した場合、例外が発生します。
戻り値： this を返します。
IInteger count ：確保する要素数
先頭へ
TileMapEventWatcher::Reserve
public SelfType@ Reserve( IInteger count)
この配列の要素数を変更せずに count 分のメモリを準備します。
このクラスは必要な場合、自動的にメモリを確保するため
通常はこのメソッドを明示的に呼び出す必要はありません。
このメソッドはパフォーマンスを最適化するためだけに存在します。
このメソッドは最初に count から INativeInteger による取得を試みます。
これに失敗した場合、 count.Get を呼び出します。
このメソッドはメモリの確保に失敗した場合、例外が発生します。
戻り値： this を返します。
IInteger count ：確保する要素数
先頭へ
TileMapEventWatcher::Move
public SelfType@ Move( IInteger target, IInteger dst, IInteger count=1)
この配列の target 番から count 個の要素を dst 番に移動します。
このメソッドは最初に各引数から INativeInteger による取得を試みます。
これに失敗した場合、 IInteger@@Get を呼び出します。
指定した要素番号が無効な場合例外が発生します。
戻り値： this を返します。
IInteger target ：移動元の要素番号(0起算)
IInteger dst ：移動先の要素番号(0起算)
IInteger count=1 ：移動する要素数
先頭へ
TileMapEventWatcher::Push
public SelfType@ Push(editable INativeEventObject val)
この配列の末尾に要素を追加します。
戻り値： this を返します。
editable INativeEventObject val ：追加した要素に設定する値
先頭へ
TileMapEventWatcher::PushList
public SelfType@ PushList( PPointerArray list)
この配列の末尾に配列を追加します。
追加された要素には要素型のオブジェクトが作成されて割り当てられ、引数の要素が順次代入されます。
戻り値： this を返します。
PPointerArray list ：代入する配列オブジェクト
先頭へ
TileMapEventWatcher::PushEx
public SelfType@ PushEx(editable INativeEventObject val1,...)
この配列の末尾に引数分の要素を追加します。
追加された要素には引数が順次参照代入されます。
引数は全て INativeEventObject をサポートする型でなければいけません。
戻り値： this を返します。
editable INativeEventObject val1 ：代入する要素オブジェクト
可変長引数：2個目以降の代入するオブジェクト
先頭へ
TileMapEventWatcher::Pop
public INativeEventObject@ Pop()
この配列の末尾の要素を削除し、削除した要素が保持していた参照を返します。
配列に要素がない場合、例外が発生します。
戻り値：削除した要素が保持していた参照を返します。
先頭へ
TileMapEventWatcher::UnShift
public SelfType@ UnShift(editable INativeEventObject val)
この配列の先頭に要素を追加します。
戻り値： this を返します。
editable INativeEventObject val ：追加した要素に設定する値
先頭へ
TileMapEventWatcher::Shift
public INativeEventObject@ Shift()
この配列の先頭の要素を削除し、削除した要素が保持していた参照を返します。
配列に要素がない場合、例外が発生します。
戻り値：削除した要素が保持していた参照を返します。
先頭へ
TileMapEventWatcher::Reverse
public SelfType@ Reverse()
この配列の要素の並びを逆順にします。
戻り値： this を返します。
先頭へ
TileMapEventWatcher::Insert
public SelfType@ Insert( IInteger index,editable INativeEventObject val)
この配列の index 番に要素を挿入します。
追加された要素は指定した要素番号になります。
このメソッドは最初に index から INativeInteger による取得を試みます。
これに失敗した場合、 index.Get を呼び出します。
指定する要素番号は追加後に有効な番号でなければいけません。
戻り値： this を返します。
IInteger index ：挿入する要素番号(0起算)
editable INativeEventObject val ：挿入した要素に設定する値
先頭へ
TileMapEventWatcher::Erase
public SelfType@ Erase( IInteger target, IInteger count=1)
この配列の target 番から count 個の要素を削除します。
削除した要素より後ろに要素がある場合、削除した数分番号が詰められます。
このメソッドは最初に各引数から INativeInteger による取得を試みます。
これに失敗した場合、 IInteger@@Get を呼び出します。
指定した要素番号が無効な場合例外が発生します。
戻り値： this を返します。
IInteger target ：削除する要素番号(0起算)
IInteger count=1 ：削除する要素数
先頭へ
TileMapEventWatcher::Exchange
public SelfType@ Exchange( IInteger index1, IInteger index2)
この配列の index1 番と index2 番の要素を交換します。
このメソッドは最初に各引数から INativeInteger による取得を試みます。
これに失敗した場合、 IInteger@@Get を呼び出します。
指定した要素番号が無効な場合例外が発生します。
戻り値： this を返します。
IInteger index1 ：対象の要素番号(0起算)
IInteger index2 ：対象の要素番号(0起算)
先頭へ
TileMapEventWatcher::AllClear
public SelfType@ AllClear()
この配列の全ての要素を削除し、メモリも解放します。
このメソッドは要素管理用のメモリも解放します。
配列をリセットしてすぐに再使用する場合は AllUnLock を使用すべきです。
戻り値： this を返します。
先頭へ
TileMapEventWatcher::AllUnLock
public SelfType@ AllUnLock()
この配列の全ての要素を削除します。
このメソッドは要素管理用のメモリは解放しません。
配列をリセットしてすぐに再使用する場合は AllClear より適切です。
戻り値： this を返します。
先頭へ
TileMapEventWatcher::GetCount
public Integer GetCount()const
この配列の要素数を返します。
戻り値：この配列の要素数を返します。
先頭へ
TileMapEventWatcher::GetFirst
public INativeEventObject@ GetFirst()const
この配列の先頭要素の値を返します。
配列に要素がない場合、例外が発生します。
戻り値：配列の先頭要素の値を返します。
先頭へ
TileMapEventWatcher::GetLast
public INativeEventObject@ GetLast()const
この配列の末尾要素の値を返します。
配列に要素がない場合、例外が発生します。
戻り値：配列の末尾要素の値を返します。
先頭へ
TileMapEventWatcher::GetAtByLast
public INativeEventObject@ GetAtByLast( IInteger index)const
この配列の (要素数-1-index) 番の要素の値を返します。
つまり、末尾を0とし、先頭に向かって数えた要素番号で index を指定します。
このメソッドは指定した要素番号が無効な場合、例外が発生します。
このメソッドは最初に index から INativeInteger による取得を試みます。
これに失敗した場合、 index.Get を呼び出します。
戻り値：指定した要素番号の値を返します。
IInteger index ：取得する要素番号(末尾起算逆順)
先頭へ
TileMapEventWatcher::Sort
public SelfType@ Sort( INativeClosure? comp_method=NULL)
この配列を昇順に整列します。
comp_method に有効な参照を与えた場合、要素の比較メソッドとして使用します。
この時、このメソッドは戻り値型 Integer 、
引数として INativeEventObject を2つ取る形であり、
第一引数 < 第二引数の時負値、二つが同じ時0、第一引数 > 第二引数の時正値を返すものでなければいけません。
大小関係と戻り値の符号関係を逆にすると降順ソートになりますが、
一貫性のない結果を返すと例外が発生する場合があります。
comp_method が空参照である場合、
各要素が持つ参照先オブジェクトの #operator< および #operator> を使用してソートします。
配列内の参照に複数の型のオブジェクトが混在する場合、その全てで一貫性のある結果が得られるようにしてください。
この時、空参照は常に大きいものとして扱われ、演算子メソッドの呼び出しは行いません。
このメソッドは比較をFGESレベルで行うため動作速度が遅くなります。
このためメソッドの実行時間に制限が掛けられており、
ソートに時間が掛かりすぎると例外が発生するようになっています。
比較に時間が掛かる場合や要素数が多い場合はこのメソッドの使用を避け、
ネイティブ配列クラスを使用できないか検討してください。
このメソッドの実行中、さらにこのメソッドを実行することはできません。
戻り値： this を返します。
INativeClosure? comp_method=NULL ：比較メソッド
先頭へ
TileMapEventWatcher::IndexOf
public Integer IndexOf( INativeEventObject obj, IInteger? startindex=NULL)const
この配列内の startindex 以降にある obj と一致する要素番号を検索します。
このメソッドは配列内の参照と obj の参照比較のみを行い、値の比較はしません。
検索範囲内で一致した最も小さい要素番号を返します。
検索範囲内に一致する要素が存在しない場合は-1を返します。
このメソッドは最初に startindex から INativeInteger による取得を試みます。
これに失敗した場合、 startindex.Get を呼び出します。
戻り値：指定したオブジェクトの参照を保持する要素番号か、見つからなければ-1を返します。
INativeEventObject obj ：検索するオブジェクト。
IInteger? startindex=NULL ：検索開始する要素番号(0起算)
空参照を指定した場合は0として扱います。
先頭へ
TileMapEventWatcher::ResetOverlapState
public void ResetOverlapState()
現在の重複判定状態をリセットします。
この時、重複状態になっている監視対象オブジェクトに対するオフハンドラは呼び出されません。
このメソッドは監視対象をリセットする時に使用することが想定されています。
先頭へ
TileMapEventWatcher::SetWatchInfo
public void SetWatchInfo(editable TileMapWindow target_obj,
INativeInteger watch_tilelayerid, INativeInteger watch_tileid,
INativeInteger tileid_mask, INativeInteger event_zlayerid,
INativeInteger eventgroup,editable Any? host_obj,
FGESMethod? on_handler,editable Any? on_param=NULL,
FGESMethod? in_handler=NULL,editable Any? in_param=NULL,
FGESMethod? off_handler=NULL,editable Any? off_param=NULL, HThread? call_thread=NULL,
INativeInteger? left_ext=NULL, INativeInteger? up_ext=NULL,
INativeInteger? right_ext=NULL, INativeInteger? down_ext=NULL, Any? watch_obj=NULL)
このオブジェクトが行う監視に関する設定を行います。
このオブジェクトの重複判定は
イベントのZレイヤーが指定値と同じで、イベントの平面存在領域と重なる、
指定したタイルレイヤー上のタイルIDを指定値でマスクした結果が指定IDと一致するかで判定します。
オンハンドラは target_obj の領域に監視対象配列内の領域が重なった時に予約されます。
インハンドラは target_obj の領域に重なっているオブジェクトが重なり続ける間、更新毎に予約されます。
ただし、重なった瞬間(オンハンドラが予約される時)はインハンドラが予約されません。
オフハンドラは target_obj の領域に重なっているオブジェクトが重ならなくなった時に予約されます。
オンハンドラおよびオフハンドラは以下の形で定義されているものとして扱われ、
call_thread が空参照であれば判定更新を実行したスレッド、それ以外であれば指定したスレッドに予約されます。
各引数に渡される型を把握できる場合、それらの型で定義していても構いません。
void(editable TileMapWindow target,editable INativeEventObject pair,editable Any? param)
editable TileMapWindow target ：基準監視対象オブジェクト。
editable INativeEventObject pair ：基準監視対象との重複状態が変化した監視対象オブジェクト。
editable Any? param ：ハンドラに渡すよう指定されたオブジェクト。
イン/オフハンドラの呼び出しは重複判定が出たオブジェクトに限られます。
重複判定はオンハンドラが呼び出される時の判定と同じですが、オンハンドラを設定していなくても判定は行われます。
また、重複判定が出たオブジェクトは監視対象配列から除外しても記憶されています。
現在、重複判定が出たオブジェクトに対するイン/オフハンドラの呼び出しをキャンセルするには、
ResetOverlapState による判定状態リセットか、このオブジェクト自体を消滅させるしかありません。
判定領域拡張は、判定に使用されるイベントの大きさに対する補正です。
正値を指定するとその方向に指定ピクセル分拡大し、
負値を指定するとその方向と逆に指定ピクセル分縮小します。
縮小した結果サイズが0以下になった場合は一切重複しなくなります。
共有監視オブジェクトはこのオブジェクトの監視対象配列と同様に監視対象として扱われます。
この監視オブジェクトには PPointerArray<INativeEventObject> か TileMapEventScene が指定できます。
シーンオブジェクトを指定した場合は管理する全てのイベントオブジェクトが対象になります。
editable TileMapWindow target_obj ：基準になる監視対象オブジェクト。
INativeInteger watch_tilelayerid ：監視対象のタイルレイヤーID。
INativeInteger watch_tileid ：監視対象のタイルID。
INativeInteger tileid_mask ：監視対象のタイルIDを評価するビットマスク。
INativeInteger event_zlayerid ：監視対象のイベントZレイヤーID。
INativeInteger eventgroup ：監視対象のイベントグループ。
指定したイベントグループを1つ以上持つイベントが対象になります。
editable Any? host_obj ：各ハンドラのホストオブジェクト。
FGESMethod? on_handler ：重複判定が発生した時に予約するハンドラ。
空参照を指定した場合は重複判定時にハンドラは予約されません。
editable Any? on_param=NULL ：オンハンドラの第3引数に渡すオブジェクト。
FGESMethod? in_handler=NULL ：重複判定が継続している時に予約するハンドラ。
空参照を指定した場合は重複判定継続時にハンドラは予約されません。
editable Any? in_param=NULL ：インハンドラの第3引数に渡すオブジェクト。
FGESMethod? off_handler=NULL ：重複判定が解除された時に予約するハンドラ。
空参照を指定した場合は重複判定解除時にハンドラは予約されません。
editable Any? off_param=NULL ：オフハンドラの第3引数に渡すオブジェクト。
HThread? call_thread=NULL ：オンハンドラおよびオフハンドラを予約するスレッド。
空参照を指定した場合は判定更新を実行したスレッドに予約されます。
INativeInteger? left_ext=NULL ：左側判定拡張サイズ(ピクセル単位)。
空参照を指定した場合は0として扱います。
INativeInteger? up_ext=NULL ：上側判定拡張サイズ(ピクセル単位)。
空参照を指定した場合は0として扱います。
INativeInteger? right_ext=NULL ：右側判定拡張サイズ(ピクセル単位)。
空参照を指定した場合は0として扱います。
INativeInteger? down_ext=NULL ：下側判定拡張サイズ(ピクセル単位)。
空参照を指定した場合は0として扱います。
Any? watch_obj=NULL ：監視対象に追加する共有判定リスト。
指定できるオブジェクト型は本文参照。
空参照を指定した場合は無視します。
先頭へ
TileMapEventWatcher::SingleUpdate
public Bool SingleUpdate()
単一反応の重複監視状態更新を行います。
このメソッドは重複判定が発生しているオブジェクトが一つでもある場合、
他の監視対象オブジェクトに対する重複判定を行いません。
このメソッドは同時に複数の重複判定が発生すべき状況であっても、
一番最初に判定された一つのオブジェクトに対してしか重複判定を行いません。
戻り値：処理に成功した場合、真を返します。
ここで処理に成功するとは、状態更新の成功を意味し、重複判定が発生したことではありません。
先頭へ
TileMapEventWatcher::MultipleUpdate
public Bool MultipleUpdate()
多重反応の重複監視状態更新を行います。
このメソッドは常に全ての監視対象オブジェクトに対して重複判定の更新処理を行います。
戻り値：処理に成功した場合、真を返します。
ここで処理に成功するとは、状態更新の成功を意味し、重複判定が発生したことではありません。
先頭へ
[前へ] [目次へ] [次へ]
最終更新 2023/07/03
#operator[]
#operator=[]
Alloc