Wikitude SDK APIリファレンス

バージョン: 8.1.0
表示:

ImageTargetクラス

継承元: ARchitectObject
モジュール: AR

ImageTargetはトラッキングしているターゲット画像を示します。

以下のように使用できます。

  • トラッキングしているターゲット画像を特定します。
  • 特定のAR.Drawablesをアタッチします。
  • 別のImageTargetとの距離を取得します。
  • 別のImageTargetとの平行移動を取得します。
  • 別のImageTargetとの回転を取得します。

ターゲット画像が認識されるとImageTargetのインスタンスが生成されます。このインスタンスはAR.ImageTrackable.onImageRecognizedで使用できます。 AR.ImageTrackable.onImageLostが呼び出されると、AR.ImageTargetインスタンスは破棄されます。

例:
new AR.ImageTrackable(tracker, "*", { // The AR.ImageTrackable handles all targets available in the .wtc file
    onImageRecognized: function (target) {
        // Once an target image was recognized an ImageTarget is created in the SDK and passed in onImageRecognized.

        // Creates a 3d model drawable.
        var model = new AR.Model("assets/dino.wt3");

        // Assigns the model drawable to this specific ImageTarget.
        this.addImageTargetCamDrawables(target, model);
    }
    onImageLost: function (target) {
        // After onImageLost is called the ImageTarget(target) is destroyed.
        // This means that even if the same target image is recognized again, the ImageTarget is different.
    }
});

注意: ImageTargetはSDKによって作成されるため、手動で作成しないでください。

メソッド

destroy

()

継承元: ARchitectObject

オブジェクトを破棄します。

getDistanceTo

(
  • destinationTarget
)
Number

別のImageTargetまでの距離を返します。 正しい距離を返すには、両方のImageTargetを同じAR.ImageTrackableで作成する必要があることに注意してください。

パラメーター:

  • destinationTarget ImageTarget

    距離の計算が必要なImageTarget

戻り値:

Number:

ImageTargetとdestinationTargetの距離

getRotationTo

(
  • destinationTarget
)
Number

別のImageTargetに回転を返します。正しい回転を返すには、両方のImageTargetを同じAR.ImageTrackableで作成する必要があることに注意してください。

パラメーター:

  • destinationTarget ImageTarget

    回転の計算が必要なImageTarget

戻り値:

Number:

ImageTargetとdestinationTargetの回転

getTranslationTo

(
  • destinationTarget
)
Number

平行移動を別のImageTargetに返します。正しい平行移動を返すには、両方のImageTargetを同じAR.ImageTrackableで作成する必要があることに注意してください。

パラメーター:

  • destinationTarget ImageTarget

    平行移動の計算が必要なImageTarget

戻り値:

Number:

ImageTargetとdestinationTargetの平行移動

プロパティ

destroyed

Boolean

継承元: ARchitectObject

オブジェクトがすでに破棄されているかどうかを示します。

name

String

ターゲットコレクション(.wtc)のターゲット画像に関連する名前

このプロパティは変更することができません。

uniqueId

Number

ImageTargetのユニークID。ユニークIDは同じターゲットの認識ごとにインクリメントされます。

このプロパティは変更することができません。

イベント

onDistanceChanged

onDistanceChangedコールバックは、他のターゲット画像との距離がAR.ImageTracker.onDistanceChangedThreshold以上に変更されたときにトリガーされます。
コールバックは、同じAR.ImageTrackableによって作成されたImageTargetに対してのみトリガーされることに注意してください。

このトリガーのデフォルト値はnullであり、トリガーが発生したときに何もアクションは実行されません。開発者はonDistanceChangedトリガーにカスタム関数を指定することで、カスタム機能を追加できます。

イベントペイロード:

  • distance Number
  • destinationTarget ImageTarget

    距離がしきい値を超えて変更された2番目のImageTarget

onRotationChanged

onRotationChangedコールバックは、他のターゲット画像との回転がAR.ImageTracker.onRotationChangedThreshold以上に変更されたときにトリガーされます。
コールバックは、同じAR.ImageTrackableによって作成されたImageTargetに対してのみトリガーされることに注意してください。

このトリガーのデフォルト値はnullであり、トリガーが発生したときに何もアクションは実行されません。開発者はonRotationChangedトリガーにカスタム関数を指定することで、カスタム機能を追加できます。

イベントペイロード:

  • rotation Number
  • destinationTarget ImageTarget

    回転がしきい値を超えて変更された2番目のImageTarget

onTranslationChanged

onTranslationChangedコールバックは、他のターゲット画像との平行移動がAR.ImageTracker.onTranslationChangedThreshold以上に変更されたときにトリガーされます。
コールバックは、同じAR.ImageTrackableによって作成されたImageTargetに対してのみトリガーされることに注意してください。

このトリガーのデフォルト値はnullであり、トリガーが発生したときに何もアクションは実行されません。開発者はonTranslationChangedトリガーにカスタム関数を指定することで、カスタム機能を追加できます。

イベントペイロード:

  • translation Number
  • destinationTarget ImageTarget

    平行移動がしきい値を超えて変更された2番目のImageTarget