エンジンイベント

記事

• PlayEvent
• StopEvent
• StopAllEvents
• AddTargetToEvent
• AddTargetToEventMarshal
• RemoveTargetFromEvent
• RemoveTargetFromEventMarshal
• RemoveAllTargetsFromEvent
• ComputeAllEvents
• UpdateEventPositions
• UpdateEventPositionsMarshal
• SetEventIntensity
• SetTargetIntensity
• SetTargetIntensityMarshal
• SetEventLoop
• SetEventOffsets
• ClearInactiveEvents
• ClearActiveEvents
• ClearEvent

PlayEvent

void PlayEvent(int _hMaterialID, double _vibrationOffset, double _textureOffset, double _stiffnessOffset);

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

パラメータ

• _hMaterialID: 再生するソースの ID。アタッチされたハプティック効果と同じです。
• _vibrationOffset: ソースの振動オフセット。
• _textureOffset: ソースのテクスチャオフセット。
• _stiffnessOffset: ソースのスティフネスオフセット。

StopEvent

void StopEvent(int _hMaterialID);

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

パラメータ

• _hMaterialID: 停止するソースの ID。アタッチされたハプティック効果と同じです。

StopAllEvents

void StopAllEvents();

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

AddTargetToEvent

void AddTargetToEvent(int _hMaterialID, std::vector<CommandData> _target);

ソースの範囲内にターゲットを追加します。Interhaptics Engine は、ハプティック再生のためにデバイスエンドポイントと範囲内のターゲットをデバイス管理層にリマップします。

パラメータ

• _hMaterialID: ターゲットを追加するソースの ID。アタッチされたハプティック効果と同じです。
• _target: ターゲットを構築する CommandData のベクター。ターゲットには、ボディパーツのグループ、ラテラルフラグ、除外フラグが含まれます。

AddTargetToEventMarshal

void AddTargetToEventMarshal(int _hMaterialID, CommandData* _target, int _size);

AddTargetToEvent 関数のマーシャル版です。ソースの範囲内にターゲットを追加します。Interhaptics Engine は、ハプティック再生のためにデバイスエンドポイントと範囲内のターゲットをデバイス管理層にリマップします。

パラメータ

• _hMaterialID: ターゲットを追加するソースの ID。アタッチされたハプティック効果と同じです。
• _target: ターゲットを構築する CommandData のポインタ。ターゲットには、ボディパーツのグループ、ラテラルフラグ、除外フラグが含まれます。このエントリーポイントを呼び出す前にメモリを割り当てる必要があります。
• _size: _target 配列のサイズ。

RemoveTargetFromEvent

void RemoveTargetFromEvent(int _hMaterialID, std::vector<CommandData> _target);

ソース範囲からターゲットを削除します。Interhaptics Engine は、ハプティック再生のためにデバイスエンドポイントと範囲内のターゲットをデバイス管理層にリマップします。

パラメータ

• _hMaterialID: ターゲットを削除するソースの ID。アタッチされたハプティック効果と同じです。
• _target: ターゲットを構築する CommandData のベクター。ターゲットには、ボディパーツのグループ、ラテラルフラグ、除外フラグが含まれます。完全に一致するターゲットのみが削除されます。

RemoveTargetFromEventMarshal

void RemoveTargetFromEventMarshal(int _hMaterialID, CommandData* _target, int _size);

RemoveTargetFromEvent 関数のマーシャル版です。ソース範囲からターゲットを削除します。Interhaptics Engine は、ハプティック再生のためにデバイスエンドポイントと範囲内のターゲットをデバイス管理層にリマップします。

パラメータ

• _hMaterialID: ターゲットを削除するソースの ID。アタッチされたハプティック効果と同じです。
• _target: ターゲットを構築する CommandData のポインタ。ターゲットには、ボディパーツのグループ、ラテラルフラグ、除外フラグが含まれます。完全に一致するターゲットのみが削除されます。このエントリーポイントを呼び出す前にメモリを割り当てる必要があります。
• _size: _target 配列のサイズ。

RemoveAllTargetsFromEvent

void RemoveAllTargetsFromEvent(int _hMaterialID);

ソース範囲からすべてのターゲットを削除します。Interhaptics Engine は、ハプティック再生のためにデバイスエンドポイントと範囲内のターゲットをデバイス管理層にリマップします。

パラメータ

• _hMaterialID: すべてのターゲットを削除するソースの ID。アタッチされたハプティック効果と同じです。

ComputeAllEvents

void ComputeAllEvents(double _curTime);

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

パラメータ

• _curTime: 秒単位の現在の時刻。

UpdateEventPositions

void UpdateEventPositions(int _hMaterialID, std::vector<CommandData> _target, double _texturePosition, double _stiffnessPosition);

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

パラメータ

• _hMaterialID: ソースの ID。アタッチされたハプティック効果と同じです。
• _target: ターゲットを構築する CommandData のベクター。ターゲットには、ボディパーツのグループ、ラテラルフラグ、除外フラグが含まれます。完全に一致するターゲットのみが更新されます。
• _texturePosition: 新しいテクスチャ位置。
• _stiffnessPosition: 新しいスティフネス位置。

UpdateEventPositionsMarshal

void UpdateEventPositionsMarshal(int _hMaterialID, CommandData* _target, int _size, double _texturePosition, double _stiffnessPosition);

UpdateEventPositions 関数のマーシャル版です。特定のソースターゲットの空間位置を更新します。

パラメータ

• _hMaterialID: ソースの ID。アタッチされたハプティック効果と同じです。
• _target: ターゲットを構築する CommandData のポインタ。ターゲットには、ボディパーツのグループ、ラテラルフラグ、除外フラグが含まれます。完全に一致するターゲットのみが更新されます。この関数を呼び出す前にメモリを割り当てる必要があります。
• _size: _target 配列のサイズ。
• _texturePosition: 新しいテクスチャ位置。
• _stiffnessPosition: 新しいスティフネス位置。

SetEventIntensity

void SetEventIntensity(int _hMaterialID, double _intensity);

• 特定のハプティックソースに対するハプティクス強度係数を設定します。

パラメータ

• int _hMaterialID: ハプティック効果の識別子。
• double _intensity: ハプティック効果の新しい強度係数。常に 0 以上にクランプされます。

SetTargetIntensity

void SetTargetIntensity(int _hMaterialID, std::vector<CommandData> _target, double _intensity);

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

パラメータ

• int _hMaterialID: ハプティックソースの識別子。
• std::vector<CommandData> _target: 強度変更のターゲット。
• double _intensity: ターゲットの新しい強度係数。常に 0 以上にクランプされます。

SetTargetIntensityMarshal

void SetTargetIntensityMarshal(int _hMaterialID, CommandData* _target, int _size, double _intensity);

• マーシャリング技術を使用して、ソースの特定のターゲットに対するハプティクス強度係数を設定します。

パラメータ

• int _hMaterialID: ハプティックソースの識別子。
• CommandData _target*: ターゲットデータ配列へのポインタ。
• int _size: ターゲットデータ配列のサイズ。
• double _intensity: ターゲットの新しい強度係数。常に 0 以上にクランプされます。

SetEventLoop

void SetEventLoop(int _hMaterialID, bool _isLooping);

特定のハプティック効果のループフラグを設定します。

パラメータ

• int _hMaterialID: ハプティック効果の識別子。
• bool _isLooping: ハプティック効果をループさせるかどうかを示すブール値。

SetEventOffsets

void SetEventOffsets(int _hMaterialID, double _vibrationOffset, double _textureOffset, double _stiffnessOffset);

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

パラメータ

• _hMaterialID: ソースの ID。アタッチされたハプティック効果と同じです。
• _vibrationOffset: 振動オフセット。
• _textureOffset: テクスチャオフセット。
• _stiffnessOffset: スティフネスオフセット。

ClearInactiveEvents

void ClearInactiveEvents();

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

ClearActiveEvents

void ClearActiveEvents();

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

ClearEvent

void ClearEvent(int _hMaterialID);

特定のハプティックソースを、アクティブかどうかに関わらずクリアします。

パラメータ:

• _hMaterialID: ソースの ID。アタッチされたハプティック効果と同じです。