メインコンテンツまでスキップ

エンジン制御

記事​

Init​

bool Init();

Interhaptics Engine の各種コンポーネントとモジュールを初期化します。この関数は、他の API 関数を使用する前に呼び出す必要があります。

戻り値: モジュールが正しく初期化されなかった場合でも、常に true を返します。

Quit​

void Quit();

Interhaptics Engine の各種コンポーネントとモジュールをクリーンアップします。この関数は、アプリケーションを終了する前に呼び出す必要があります。

AddHM​

int AddHM(const char* _content);
  • .haps ファイルの内容を Interhaptics Engine に追加し、後で使用できるようにします。

パラメータ

  • _content: ロードする .haps ファイルの JSON 内容。Interhaptics の .haps 形式に従う必要があります。

戻り値: ロードが成功した場合はハプティック効果の ID、失敗した場合は -1。

AddParametricEffect​

int AddParametricEffect(double* _amplitude, int _amplitudeSize, double* _pitch, int _pitchSize, double _pitchMin, double _pitchMax, double* _transient, int _transientSize, bool _isLooping);
  • 振幅、ピッチ、トランジェントなどのパラメータを処理することでハプティック効果を作成します。この関数は、与えられた入力パラメータに基づいてハプティック効果を生成し、オプションでループさせることができます。

パラメータ

  • double _amplitude:* 振幅値の配列。配列は Time -- Value のペアとしてフォーマットされ、各 Value は 0 から 1 の間の値である必要があります。
  • int _amplitudeSize: 振幅配列のサイズ。
  • double _pitch*: ピッチ値の配列。配列は Time -- Value のペアとしてフォーマットされ、各 Value は 0 から 1 の間の値である必要があります。
  • int _pitchSize: ピッチ配列のサイズ。
  • double _freqMin: 周波数範囲の最小値。
  • double _freqMax: 周波数範囲の最大値。
  • double _transient*: トランジェント値の配列。配列は Time -- Amplitude -- Pitch の三つ組としてフォーマットされ、Amplitude と Pitch の値はいずれも 0 から 1 の範囲である必要があります。
  • int _transientSize: トランジェント配列のサイズ。
  • bool _isLooping: オーディオ効果をループさせるかどうかを示します。

戻り値

  • 作成されたハプティック効果の ID。

UpdateHM​

bool UpdateHM(int _hMaterialID, const char* _content);

すでにロードされているハプティック効果の内容を置き換えます。この関数は、ハプティック効果の ID を永続化する必要がある場合に有用です。

パラメータ

  • _hMaterialID: 置き換えるハプティック効果の ID。
  • _content: ロードする .haps ファイルの JSON 内容。Interhaptics の .haps 形式に従う必要があります。

戻り値: 効果が正しく更新された場合は true、それ以外は false。

UpdateParametricEffect​

bool UpdateParametricEffect(int _hMaterialID, double* _amplitude, int _amplitudeSize, double* _pitch, int _pitchSize, double _pitchMin, double _pitchMax, double* _transient, int _transientSize, bool _isLooping);
  • すでにロードされているパラメトリックハプティック効果の内容を、振幅、ピッチ、トランジェントなどのパラメータを処理することで置き換えます。この関数は、ハプティック効果の ID を永続化する必要がある場合に有用です。

パラメータ

  • _hMaterialID: 置き換えるパラメトリックハプティック効果の ID。
  • double _amplitude:* 振幅値の配列。配列は Time -- Value のペアとしてフォーマットされ、各 Value は 0 から 1 の間の値である必要があります。
  • int _amplitudeSize: 振幅配列のサイズ。
  • double _pitch*: ピッチ値の配列。配列は Time -- Value のペアとしてフォーマットされ、各 Value は 0 から 1 の間の値である必要があります。
  • int _pitchSize: ピッチ配列のサイズ。
  • double _freqMin: 周波数範囲の最小値。
  • double _freqMax: 周波数範囲の最大値。
  • double _transient*: トランジェント値の配列。配列は Time -- Amplitude -- Pitch の三つ組としてフォーマットされ、Amplitude と Pitch の値はいずれも 0 から 1 の範囲である必要があります。
  • int _transientSize: トランジェント配列のサイズ。
  • bool _isLooping: オーディオ効果をループさせるかどうかを示します。

戻り値: 効果が正しく更新された場合は true、それ以外は false。

GetGlobalIntensity​

double GetGlobalIntensity();
  • エンジン全体のグローバルレンダリング強度係数を取得します。

戻り値: グローバル強度。ミキサーが初期化されていない場合は -1。

SetGlobalIntensity​

void SetGlobalIntensity(double _intensity);
  • エンジン全体のグローバルレンダリング強度係数を設定します。

パラメータ

  • _intensity: 正の値。0 は何も無し。基準値は 1。