Wikitude SDK APIリファレンス

バージョン: 8.1.0
表示:

InstantTrackerクラス

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

InstantTrackerはインスタントトラッキングアルゴリズムを表します。既存のターゲット情報は必要ありませんが、ただちに追跡を開始できます。最小限、パラメータなしでインスタンス化できます 。

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

  • 新しいトラッカーが作成されると、enabledをfalseにして作成した場合を除き、自動的にアクティブなトラッカーに設定されます。
  • 特定のトラッカーが有効になっている場合、自動的にアクティブなトラッカーに設定されます。以前アクティブなトラッカーは、システムによって無効になっています。

トラッカーがシステムによって無効になっている場合、開発者はonDisabledトリガーを介して通知を受けます。

インスタントトラッキング最小例:
this.tracker = new AR.InstantTracker();
インスタントトラッキング例:
this.tracker = new AR.InstantTracker({
    onChangedState:  function onChangedStateFn(state) {
        // react to a change in tracking state here
    },
    // device height needs to be as accurate as possible to have an accurate scale
    // returned by the Wikitude SDK
    deviceHeight: 1.0,

 // The initial orientation at which the instant tracking plane should be displayed in degrees.
 // Default value is AR.CONST.INITIAL_INSTANT_TRACKING_PLANE_ORIENTATION.HORIZONTAL (0属).
    trackingPlaneOrientation: 45.0
});

コンストラクター

InstantTracker

(
  • options
)

パラメーター:

  • options Object オプション

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

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

    • enabled （デフォルト値: true） Boolean オプション
    • onError Function オプション
    • onDisabled Function オプション
    • onChangedState Function オプション
    • deviceHeight Number オプション
    • trackingPlaneOrientation Number オプション

      smartEnabledがtrueの場合はサポートされていません。

    • smartEnabled Boolean オプション

      SMARTを使用するかどうかを定義します。デフォルト値はEnabledです。

    • trackerEfficiencyMode Number optional

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

メソッド

destroy

()

継承元: ARchitectObject

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

loadExistingInstantTarget

(
  • targetCollectionResource
  • completionHandler
  • errorHandler
  • options
)

提供されたインスタントターゲットをロードし、トラッキングを開始します。

この機能は、プラットフォーム独自のトラッキング機能が有効な場合は使用できません。

e.g.:

instantTracker.saveCurrentInstantTarget(url, function () {}, function (error) {});

...

var mapResource = new AR.TargetCollectionResource(url);

instantTracker.loadExistingInstantTarget(mapResource, function () {}, function (error) {});

パラメーター:

  • targetCollectionResource AR.TargetCollectionResource

    ロードするインスタントターゲット。

  • completionHandler Function

    マップが正常にロードされたときに呼び出されるコールバック。

  • errorHandler Function

    マップの読み込みエラー時に呼び出されるコールバック。問題を説明するAR.Errorを提供します。

  • options Object optional

    ロードされたインスタントターゲットの動作設定。

    受け入れられるオプションプロパティは

    • expansionPolicy (デフォルトは DISALLOW_EXPANSION) AR.CONST.INSTANT_TARGET_EXPANSION_POLICY optional

      拡張が許可されると、保存時にカメラフレームになかった領域が検出された場合、トラッカーはインスタントターゲットを拡張します。

saveCurrentInstantTarget

(
  • uri
  • completionHandler
  • errorHandler
)

InstantTrackerで作成された現在のシーンを保存します。 保存されたファイルは、loadExistingInstantTargetを使用してTargetCollectionResourceとしてロードできます。

これにより、デバイスやオペレーティングシステム間で複数のユーザーがAR体験に永続的にアクセスできるようになります。

この機能は、プラットフォーム独自のトラッキング機能が有効な場合は使用できません。

e.g.:

instantTracker.saveCurrentInstantTarget(url, function () {}, function (error) {});

...

var mapResource = new AR.TargetCollectionResource(url);

instantTracker.loadExistingInstantTarget(mapResource, function () {}, function (error) {});

パラメーター:

  • uri String

    マップを保存する場所を示すURI。

  • completionHandler Function

    マップが正常に保存されたときに呼び出されるコールバック。

  • errorHandler Function

    マップの読み込みエラー時に呼び出されるコールバック。問題を説明するAR.Errorを提供します。

パラメーター:

canStartTracking

Boolean

AR.InstantTrackerState.INITIALIZINGからAR.InstantTrackerState.TRACKINGに状態を切り替えることができるかどうかを確認します。Wikitudeのインスタントトラッキングが使用されている場合、このプロパティは常にtrueを返します。プラットフォームアシストトラッキングを使用する場合は初期化に時間がかかりますが、その後はトラッキングをすぐに開始できるようになります。

destroyed

Boolean

継承元: ARchitectObject

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

deviceHeight

Number

インスタントトラッキングアルゴリズムのスケール推定に使用されるデバイスの高さ（メートル単位）。

enabled

Boolean

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

state

Number

トラッカーの現在の内部状態。AR.InstantTrackerState.INITIALIZINGまたはAR.InstantTrackerState.TRACKINGのいずれかを指定できます。

trackingPlaneOrientation

Number

インスタントトラッキングの平面を表示する角度の初期状態の向き。

デフォルト値はAR.CONST.INITIAL_INSTANT_TRACKING_PLANE_ORIENTATION.HORIZONTAL (0属)です。

この設定はプラットフォームアシスタントトラッキングでInstantTrackingが実行されている場合は使用することができません。

イベント

onChangedState

トラッカーが内部状態を変更すると、トリガーが発生します。

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

onDisabled

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

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

onError

トリガーはトラッカーエラーによって起動します。

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

イベントペイロード:

  • AR.Error Object

    エラーの詳細を含むオブジェクト。