エンジンイベント

このモジュールには、エンジンイベントに関連する Interhaptics GameMaker エクステンションの関数が含まれています。

関数

このモジュールは、特定のタスクに対応し、さまざまな目的に向けたユーティリティを提供する関数群を提供します。利用可能な関数を参照して、このモジュールが提供する機能を最大限に活用してください。

記事

• interhaptics_play_event
• interhaptics_stop_event
• interhaptics_stop_all_events
• interhaptics_add_target_to_event
• interhaptics_remove_target_from_event
• interhaptics_remove_all_targets_from_event
• interhaptics_compute_all_events
• interhaptics_update_event_positions
• interhaptics_set_event_offsets
• interhaptics_clear_inactive_events
• interhaptics_clear_active_events
• interhaptics_clear_event
• interhaptics_set_event_intensity
• interhaptics_set_event_loop
• interhaptics_set_target_intensity

interhaptics_play_event

この関数は、ハプティックソースのレンダリング再生を開始します。開始時刻を 0 + 各種オフセットに設定します。イベントがすでに再生中の場合は、新しいオフセットで再開します。ソースがまだ存在しない場合は作成されます。

構文:

interhaptics_play_event(material_ref, vibration_offset, texture_offset, stiffness_offset)

引数	データ型	説明
material_ref	実数	再生するソースの ID で、関連付けられているハプティック効果と同じです。
vibration_offset	実数	ソースの振動オフセットです。
texture_offset	実数	ソースのテクスチャオフセットです。
stiffness_offset	実数	ソースのスティフネスオフセットです。

戻り値:

N/A

interhaptics_stop_event

この関数は、ハプティックソースのレンダリング再生を停止します。

構文:

interhaptics_stop_event(material_ref)

引数	データ型	説明
material_ref	実数	停止するソースの ID で、関連付けられているハプティック効果と同じです。

戻り値:

N/A

interhaptics_stop_all_events

この関数は、すべてのハプティックソースのレンダリング再生を停止します。

構文:

interhaptics_stop_all_events()

戻り値:

N/A

interhaptics_add_target_to_event

この関数は、ソースの範囲内にターゲットを追加します。Interhaptics Engine は、デバイスのエンドポイントと範囲内のターゲットをデバイス管理レイヤーに再マッピングし、ハプティック再生を行います。

構文:

interhaptics_add_target_to_event(material_ref, target)

引数	データ型	説明
material_ref	実数	ターゲットを追加するソースの ID で、関連付けられているハプティック効果と同じです。
target	Interhaptics_CommandDataの配列	ターゲットには、ボディパーツのグループ、ラテラルフラグ、除外フラグが含まれます。

戻り値:

N/A

interhaptics_remove_target_from_event

この関数は、ソースの範囲内にターゲットを追加します。Interhaptics Engine は、デバイスのエンドポイントと範囲内のターゲットをデバイス管理レイヤーに再マッピングし、ハプティック再生を行います。

構文:

interhaptics_remove_target_from_event(material_ref, target)

引数	データ型	説明
material_ref	実数	ターゲットを追加するソースの ID で、関連付けられているハプティック効果と同じです。
target	Interhaptics_CommandDataの配列	ターゲットを構築するための Interhaptics_CommandData の配列です。ターゲットには、ボディパーツのグループ、ラテラルフラグ、除外フラグが含まれます。完全に一致するターゲットのみが削除されます。

戻り値:

N/A

interhaptics_remove_all_targets_from_event

この関数は、ソース範囲からすべてのターゲットを削除します。Interhaptics Engine は、デバイスのエンドポイントと範囲内のターゲットをデバイス管理レイヤーに再マッピングし、ハプティック再生を行います。

構文:

interhaptics_remove_all_targets_from_event(material_ref)

引数	データ型	説明
material_ref	実数	すべてのターゲットを削除するソースの ID で、関連付けられているハプティック効果と同じです。

戻り値:

N/A

interhaptics_compute_all_events

この関数は、特定の時刻にすべてのハプティックバッファのレンダリングをトリガーするため、アプリケーションのメインループ内で呼び出す必要があります。Interhaptics Engine は、現在の時刻を最後に既知の値と比較し、フレームドロップをカバーするのに十分な大きさのバッファを構築します。この関数はメインスレッドからも、並列ループからも呼び出すことができます。デバイス更新イベントをトリガーする前に、少なくとも一度は呼び出す必要があります。

構文:

interhaptics_compute_all_events(current_time)

引数	データ型	説明
current_time	実数	現在の時刻(秒)です。

戻り値:

N/A

interhaptics_update_event_positions

この関数は、特定のソースターゲットの空間位置を更新します。

構文:

interhaptics_update_event_positions(material_ref, target, texture_position, stiffness_position)

引数	データ型	説明
material_ref	実数	ソースの ID で、関連付けられているハプティック効果と同じです。
target	Interhaptics_CommandDataの配列	ターゲットを構築するための Interhaptics_CommandData のベクトルです。ターゲットには、ボディパーツのグループ、ラテラルフラグ、除外フラグが含まれます。完全に一致するターゲットのみが更新されます。
texture_position	実数	新しいテクスチャ位置です。
stiffness_position	実数	新しいスティフネス位置です。

戻り値:

N/A

interhaptics_set_event_offsets

この関数は、特定のハプティックソースのオフセットを設定します。

構文:

interhaptics_set_event_offsets(material_ref, vibration_offset, texture_offset, stiffness_offet)

引数	データ型	説明
material_ref	実数	ソースの ID で、関連付けられているハプティック効果と同じです。
vibration_offset	実数	振動オフセットです。
texture_offset	実数	テクスチャオフセットです。
stiffness_offet	実数	スティフネスオフセットです。

戻り値:

N/A

interhaptics_clear_inactive_events

この関数は、メモリからすべての非アクティブなソースをクリアします。非アクティブなソースは、ソースの再生と停止時の削除と作成を回避するためにメモリ内に保持されます。

構文:

interhaptics_clear_inactive_events()

戻り値:

N/A

interhaptics_clear_active_events

この関数は、メモリからすべてのアクティブなソースをクリアします。削除されたソースは、interhaptics_play_event 関数を呼び出すことで再作成できます。

構文:

interhaptics_clear_active_events()

戻り値:

N/A

interhaptics_clear_event

この関数は、特定のハプティックソースを、アクティブかどうかに関係なくクリアします。

構文:

interhaptics_clear_event(material_ref)

引数	データ型	説明
material_ref	実数	ソースの ID で、関連付けられているハプティック効果と同じです。

戻り値:

N/A

interhaptics_set_event_intensity

この関数は、特定のソースのハプティクス強度係数を設定します。

構文:

interhaptics_set_event_intensity(material_ref, intensity)

引数	データ型	説明
material_ref	実数	ソースの ID で、関連付けられているハプティック効果と同じです。
intensity	実数	強度係数の値です。常に 0 以上にクランプされます。

戻り値:

N/A

interhaptics_set_event_loop

この関数は、特定のソースのループフラグを設定します。

構文:

interhaptics_set_event_loop(material_ref, number_of_loops)

引数	データ型	説明
material_ref	実数	ソースの ID で、関連付けられているハプティック効果と同じです。
number_of_loops	実数	イベントのループ回数です。<= は 1 回のイテレーションです。

戻り値:

N/A

interhaptics_set_target_intensity

この関数は、ソースの特定のターゲットに対するハプティクス強度係数を設定します。

構文:

interhaptics_set_target_intensity(material_ref, target, intensity)

引数	データ型	説明
material_ref	実数	ソースの ID で、関連付けられているハプティック効果と同じです。
target	Interhaptics_CommandDataの配列	強度を変更するターゲットです。
intensity	実数	強度係数の値です。常に 0 以上にクランプされます。

戻り値:

N/A