Wikitude SDK APIリファレンス

バージョン: 8.1.0
表示:

ImageTrackerクラス

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

ImageTrackerは、カメラ画像ストリーム内のターゲットコレクション（AR.TargetCollectionResource または AR.CloudRecognitionServiceで表される）で定義されたターゲットイメージの位置を特定します。この情報は、AR.ImageTrackablesと組み合わせて使用され、正しい位置に正しい拡大（AR.Drawables）を描画します。

Trackerオブジェクトは、特定のAR.ImageTrackables（ターゲットコレクション内のターゲット）を参照するために使用されます。

トラッカーを有効または無効にすることができます。一度にアクティブにできるトラッカーは1つだけです。トラッカーの現在の有効/無効状態はenabledプロパティに反映されます。ARchitectファイルで複数のトラッカーが使用されている場合は、次のロジックが適用されて現在アクティブなトラッカーを指定します。

  • 新しいトラッカーが作成されると、enabledをfalseにして作成した場合を除き、自動的にアクティブなトラッカーに設定されます。

  • 特定のトラッカーが有効になっている場合、自動的にアクティブなトラッカーに設定されます。以前アクティブなトラッカーは、システムによって無効になっています。
トラッカーがシステムによって無効になっている場合、開発者はonDisabledトリガーを介して通知を受けます。

クライアント認識の例:
// a Tracker referencing a target collection on a server
var targetCollection1 = new AR.TargetCollectionResource("http://myserver.com/targetCollection1.wtc");
var tracker1 = new AR.ImageTracker(resource1 , {
  onDisabled : function(){
    //tracker has been disabled by the system
  }
});
var enabled = tracker1.enabled; //true

// a second tracker, which will cause tracker1 to be disabled
var targetCollection2 = new AR.TargetCollectionResource("http://myserver.com/targetCollection2.wtc");
var tracker2 = new AR.ImageTracker(resource2);

enabled = tracker1.enabled; //false
enabled = tracker2.enabled; //true

クラウド認識例:

// a ImageTracker referencing a target collection with a specific client token token
var cloudRecognitionService = new AR.CloudRecognitionService("__your_client_token__", "__target_collection_id__", {
        onLoaded: function onLoadedFn() {
            // enable UI elements to start recognition calls
        }
});
var tracker = new AR.ImageTracker(cloudRecognitionService);

// ... additional code...

// to start a single recognition process, call the cloud recognition service's recognize function.
cloudRecognitionService.recognize(function(recognized, responseData) {
        if ( recognized )
        {
            // A target image was found in the processed camera frame.
            // The name of the recognized target can be retrieved from the responseData object.
            alert('recognized target image: ' + responseData.targetInfo.name);
        }
        else
        {
            // No target image could be found in the processed camera frame.
        }
});

コンストラクター

ImageTracker

(
  • Tracker
  • options
)

パラメーター:

  • Tracker TargetCollectionResource | CloudRecognitionService

    Wikitude Studio Managerで作成されたTarget Collectionを保持するソース。

  • options Object オプション

    追加のオブジェクトプロパティをカスタマイズするためのパラメーター。

    設定可能なプロパティは以下のとおりです。

    • enabled （デフォルト値: true） Boolean オプション
    • physicalTargetImageHeights Object オプション
    • extendedRangeRecognition Number optional
    • maximumNumberOfConcurrentlyTrackableTargets Number optional

      同時にトラッキングできるターゲットの最大数。 デフォルト値は1で、1以上の値を設定する必要があります。

    • trackerEfficiencyMode Number optional

      実行中のトラッカーの効率モード。 詳細については、AR.CONST.TRACKER_EFFICIENCY_MODEの項を参照してください。

    • onTargetsLoaded Function オプション
    • onError Function オプション
    • onDisabled Function オプション
    • onDistanceChangedThreshold Number オプション

      AR.ImageTarget.onDistanceChangedがトリガーされるために必要なしきい値。

    • onTranslationChangedThreshold Number オプション

      AR.ImageTarget.onTranslationChangedがトリガーされるために必要なしきい値。

    • onRotationChangedThreshold Number オプション

      AR.ImageTarget.onRotationChangedがトリガーされるために必要なしきい値。

メソッド

destroy

()

継承元: ARchitectObject

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

プロパティ

destroyed

Boolean

継承元: ARchitectObject

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

enabled

Boolean

トラッカーの現在の活動状態。このプロパティは、別のトラッカーが有効になっている場合にシステムによって自動的に変更され、トラッカーが無効になる可能性があります。この場合、onDisabledトリガーが呼び出されます。

onDistanceChangedThreshold

Number

ImageTarget.onDistanceChangedがトリガーされるために必要なしきい値。

デフォルト値は0なので、すべての変更でImageTarget.onDistanceChangedがトリガーされます。

onRotationChangedThreshold

Number

ImageTarget.onRotationChangedがトリガーされるために必要なしきい値。

デフォルト値は0なので、すべての変更でImageTarget.onRotationChangedがトリガーされます。

onTranslationChangedThreshold

Number

ImageTarget.onTranslationChangedがトリガーされるために必要なしきい値。

デフォルト値は0なので、すべての変更でImageTarget.onTranslationChangedがトリガーされます。

physicalTargetImageHeights

Object

このオプションを使用して、.wtcファイルに含まれるイメージターゲットの物理的な高さを指定します。これらのオプションは、distanceToUser機能が使用され、.wtcファイルのバージョンが4.1未満の場合にのみ必要です。物理的な高さはミリメートルで表され、このオブジェクトにはターゲット名をキーとして使用するマップが含まれています。

イベント

onDisabled

トリガーは、システムによってトラッカーが無効になっているときに起動します。enabledがfalseに手動で設定されている場合は起動しません。

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

onError

トラッカーがエンジンによってロードできなかったときにトリガーが発生します。

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

onTargetsLoaded

トラッカーのターゲットコレクションが正常にロードされ、トラッカーがエンジンによってロードされたときにトリガーが発生します。 このトラッカーに関連するImageTrackableは、トラッカーが正常に読み込まれた後にのみトラッキングできます。

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