Wikitude SDK APIリファレンス

バージョン: 8.1.0
表示:

contextクラス

モジュール: AR

contextには、システムコンポーネントとやり取りできる一般的な関数が含まれます。

このクラスのシングルトンインスタンスはARchitect Worldの起動時に自動的に生成され、AR.contextを介してアクセスできます。

contextにはいくつかのカスタム機能も用意されており、たとえばonLocationChangedトリガーはユーザーのロケーションが変わったときにシステムによって実行されます。これにより、ユーザーのロケーションに関する情報が通知されるので、ニーズに合わせてARchitect Worldをセットアップできます。

例:
AR.context.onLocationChanged = function(latitude, longitude, altitude, accuracy){
  //now, add custom functionality to build the AR scene based on the location
  ...
}

メソッド

destroyAll

()

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

この呼び出しの結果については、AR.ARchitectObject.destroy()を参照してください。

openInBrowser

(
  • url
  • forceNativeBrowser
)

指定したURLをネイティブブラウザで開きます。forceNativeBrowserがtrueの場合はURLがネイティブブラウザ（たとえば、iOSではSafari）で開き、それ以外の場合は新しいWebビューで開きます。

パラメーター:

  • url String

    開くURL。

  • forceNativeBrowser（デフォルト値: false）Boolean オプション

    URLをネイティブブラウザで開く場合はtrue。アプリケーション内のWebビューで開く場合はfalse。

setCloudRecognitionServerRegion

(
  • region
  • options
)
非推奨

非推奨: 代わりにAR.CloudRecognitionService cloudRecognitionServerURLオプションを使用してください。

使用する地域サーバーを設定します。 地域サーバーはAmericas、Europe、Chinaの中から選択できます。 デフォルトではEuropeが使用されます。不正なパラメータを使用した場合、Europeが自動で選択されます。

パラメーター:

  • region String

    地域を識別する整数値。{1 : Americas、2 : China、3 : Europe}

  • options Object オプション

    クラウド認識サーバーをURLで指定するための追加パラメータ。カスタムのクラウド認識サーバーのURLを指定すると、地域パラメータは無視されることに注意してください。

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

startVideoPlayer

(
  • uri
)

ネイティブの動画プレーヤーを起動し、指定したURIにある動画を再生します。動画が終了すると動画プレーヤーは自動的に閉じます。

パラメーター:

プロパティ

clickBehavior

String

clickBehaviorは、何をクリックと見なすかを制御します。以下のオプションが使用できます。

  • AR.CONST.CLICK_BEHAVIOR.CLICK: ユーザーが画面を指で押し、同じ画面領域で指を離したときにのみ、クリックしたと見なします。ユーザーが画面から指を離した後にクリックが発生します。
  • AR.CONST.CLICK_BEHAVIOR.TOUCH_DOWN: ユーザーが画面にタッチすると同時にクリックが発生します。
  • AR.CONST.CLICK_BEHAVIOR.TOUCH_UP: 画面のどこでタッチを開始したかにかかわらず、ユーザーが画面から指を離すと同時にクリックが発生します。

デフォルト値: AR.CONST.CLICK_BEHAVIOR.CLICK

scene.cullingDistance

Number

オブジェクトがカメラビューに表示される最大距離（m単位）。ユーザーからオブジェクトまでの距離がカリング距離を超えると、オブジェクトはカメラビューに表示されません。正の整数にする必要があります。

デフォルト値: 50000

scene.globalScale

Float

カメラビューのすべてのDrawableに適用されるスケール。デバイスが違ってもARchitect Worldが同じ見た目で表示されるようにするため、このプロパティを使用してデバイスごとにDrawableのサイズを変えることができます。

-1〜MAX_FLOATの範囲内にある必要があります。

グローバルスケールを0に設定すると、すべてのDrawableがサイズ0にスケーリングされます。
グローバルスケールを-1に設定すると、すべてのDrawableがデバイス間で同じピクセルサイズになるように値が自動的に計算されます。

自動スケーリング
基準デバイスは4インチのiPhone画面です（例: iPhone 5）。その他すべてのデバイスでは、ARchitect Worldを基準デバイスで実行している場合と同じサイズでDrawableが表示されるようにグローバルスケールが調整されます。

デフォルト値: 1.0

scene.maxScalingDistance

Number

ユーザーが遠く離れたときにもカメラビューに表示されるオブジェクトのサイズを維持する距離（m単位）。ユーザーの位置がmaxScalingDistanceを超えた場合、オブジェクトのサイズはmaxScalingDistance時点のサイズより小さくなりません。正の整数にする必要があります。

デフォルト値: 20000

scene.minScalingDistance

Number

ユーザーが近づいたときにカメラビューに表示されるオブジェクトのサイズがこれ以上拡大されない距離（m単位）。ユーザーの位置がminScalingDistanceより近い場合、オブジェクトのサイズはminScalingDistance時点のサイズより大きくなりません。正の整数にする必要があります。

デフォルト値: 10

scene.scalingFactor

Number

minScalingDistanceからmaxScalingDistanceの間に適用されるスケール。scalingFactorには、maxScalingDistance時点でのオブジェクトのサイズをminScalingDistance時点のサイズのパーセンテージで指定します。

0〜1の範囲内にある必要があります。

オブジェクトにスケーリングを適用しない場合はscalingFactorを1に設定します。

デフォルト値: 0.1

versionNumber

String

Wikitude SDKのバージョン番号を返します。この文字列はメジャーリリース、マイナーリリース、およびバグフィックスを表す数字をドットで区切ったものです（例: 4.0.0）。

イベント

on2FingerGestureEnded

ユーザーが2本の指のジェスチャーを終了したときに実行されますが、1本の指のジェスチャーがまだアクティブになっている可能性があります。

on2FingerGestureStarted

ユーザーが2本の指のジェスチャーを開始したときに実行されますが、1本の指のジェスチャーがこの前にアクティブだった可能性があります。

onDragBegan

ユーザーが1本の指で画面のドラッグを開始したとき実行されます。開始タッチによってHTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • DrawableまたはInstantTrackbleに開始タッチがヒットしない
  • DrawableまたはInstantTrackableに開始タッチがヒットしたが、タッチキューの最後で、onDragBeganトリガーによってfalseが返された。

イベントペイロード:

  • xNormalized Number

    開始タッチ位置と更新タッチ位置[-1,1]との間のX軸上の距離。 ドラッグジェスチャへの変更が発生していない場合、onDragBeganは常に0です。

  • yNormalized Number

    開始タッチ位置と更新タッチ位置[-1,1]との間のY軸上の距離。 ドラッグジェスチャへの変更が発生していない場合、onDragBeganは常に0です。

onDragChanged

ユーザーが1本の指で画面をドラッグしたとき実行されます。更新されたタッチによってHTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • DrawableまたはInstantTrackbleに更新されたタッチが当たっていない
  • DrawableまたはInstantTrackableに更新されたタッチがヒットしたが、タッチキューの最後で、onDragChangedトリガーによってfalseが返された。

イベントペイロード:

  • xNormalized Number

    開始タッチ位置と更新タッチ位置[-1,1]との間のX軸上の距離。

  • yNormalized Number

    開始タッチ位置と更新タッチ位置[-1,1]との間のY軸上の距離。

onDragEnded

ユーザーが1本の指で画面のドラッグを停止したとき実行されます。最後のタッチによってHTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • DrawableやInstantTrackbleに最後のタッチがヒットしなかった。
  • DrawableまたはInstantTrackableに最後のタッチがヒットしたが、タッチキューの最後で、onDragEndedトリガーによってfalseが返された。

イベントペイロード:

  • xNormalized Number

    開始タッチ位置と更新タッチ位置[-1,1]との間のX軸上の距離。 onDragChangedで受信した最新の距離と常に同じ

  • yNormalized Number

    開始タッチ位置と更新タッチ位置[-1,1]との間のY軸上の距離。 onDragChangedで受信した最新の距離と常に同じ

onLocationChanged

この関数は以下のときに呼び出されます。

  • ロケーションがはじめて取得されたとき
  • ユーザーのロケーションが変わったとき

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

イベントペイロード:

  • latitude Number

    WGS84に基づくユーザーの現在の緯度。

  • longitude Number

    WGS84に基づくユーザーの現在の経度。

  • altitude Number

    WGS84に基づくユーザーの現在の高度。

  • accuracy Number

    報告されるロケーションの精度。詳細については、AR.CONST.LOCATION_ACCURACYを参照してください。

onPanBegan

ユーザーが2本の指で画面のドラッグを開始したとき実行されます。開始タッチによってHTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • DrawableまたはInstantTrackbleに開始タッチがヒットしない。
  • DrawableまたはInstantTrackableに開始タッチがヒットしたが、タッチキューの最後で、onPanBeganトリガーによってfalseが返された。

イベントペイロード:

  • xNormalized Number

    開始タッチ位置と更新タッチ位置[-1,1]との間のX軸上の距離。パンジェスチャへの変更が発生していない場合、onPanBeganは常に0です。第1のタッチと第2のタッチとの間の中間点はスケールと回転のジェスチャーの同時動作のための距離の計算に使用されます。

  • yNormalized Number

    開始タッチ位置と更新タッチ位置[-1,1]との間のY軸上の距離。パンジェスチャへの変更が発生していない場合、onPanBeganは常に0です。第1のタッチと第2のタッチとの間の中間点はスケールと回転のジェスチャーの同時動作のための距離の計算に使用されます。

onPanChanged

ユーザーが1本の指で画面をドラッグしたとき実行されます。最初のタッチによってHTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • DrawableまたはInstantTrackbleに最初のタッチがヒットしない。 。
  • DrawableまたはInstantTrackableに最初のタッチがヒットしたが、タッチキューの最後で、onPanChangedトリガーによってfalseが返された。

イベントペイロード:

  • xNormalized Number

    開始タッチ位置と更新タッチ位置[-1,1]との間のX軸上の距離。第1のタッチと第2のタッチとの間の中間点はスケールと回転のジェスチャーの同時動作のための距離の計算に使用されます。

  • yNormalized Number

    開始タッチ位置と更新タッチ位置[-1,1]との間のY軸上の距離。第1のタッチと第2のタッチとの間の中間点はスケールと回転のジェスチャーの同時動作のための距離の計算に使用されます。

onPanEnded

ユーザーが2本の指で画面のドラッグを停止したとき実行されます。最初のタッチによってHTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • DrawableまたはInstantTrackbleに最初のタッチがヒットしない。
  • DrawableまたはInstantTrackableに最初のタッチがヒットしたが、タッチキューの最後で、onPanEndedトリガーによってfalseが返された。

イベントペイロード:

  • xNormalized Number

    開始タッチ位置と更新タッチ位置[-1,1]との間のX軸上の距離。onPanChangedで受信した最新の距離と常に同じです。第1のタッチと第2のタッチとの間の中間点はスケールと回転のジェスチャーの同時動作のための距離の計算に使用されます。

  • yNormalized Number

    開始タッチ位置と更新タッチ位置[-1,1]との間のY軸上の距離。onPanChangedで受信した最新の距離と常に同じです。第1のタッチと第2のタッチとの間の中間点はスケールと回転のジェスチャーの同時動作のための距離の計算に使用されます。

onRotationBegan

ユーザーが2本の指で画面を回転し始めたとき実行されます。最初のタッチによってHTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • DrawableまたはInstantTrackbleに最初のタッチがヒットしない。
  • DrawableまたはInstantTrackableは最初のタッチでヒットしたが、タッチキューの最後で、onRotationBeganトリガーによってfalseが返された。

イベントペイロード:

  • angle Number

    開始タッチ位置によって定義された線と更新されたタッチ位置[0,360]によって定義される線との間の角度でのCCW角度。回転ジェスチャの変更が発生していない場合、onRotationBeganは常に0です。

onRotationChanged

ユーザーが2本の指で画面を回転したとき実行されます。開始タッチによってHTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • DrawableまたはInstantTrackbleに開始タッチがヒットしない。
  • DrawableまたはInstantTrackableに最初のタッチがヒットしたが、タッチキューの最後で、onRotationChangedトリガーによってfalseが返された。

イベントペイロード:

  • angle Number

    開始タッチ位置によって定義された線と更新されたタッチ位置[0,360]によって定義される線との間の角度でのCCW角度。

onRotationEnded

ユーザーが2本の指で画面の回転を停止したとき実行されます。開始タッチによってHTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • DrawableまたはInstantTrackbleに開始タッチがヒットしない。
  • DrawableまたはInstantTrackableに最初のタッチがヒットしたが、タッチキューの最後で、onRotationEndedトリガーによってfalseが返された。

イベントペイロード:

  • angle Number

    開始タッチ位置によって定義された線と更新されたタッチ位置[0,360]によって定義される線との間の角度でのCCW角度。onRotationChangedで受け取った最新の角度と常に同じ。

onScaleBegan

ユーザーが2本の指で画面の拡大縮小を開始したとき実行されます。開始タッチによってHTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • DrawableまたはInstantTrackbleに開始タッチがヒットしない。
  • DrawableまたはInstantTrackableに最初のタッチがヒットしたが、タッチキューの最後で、onScaleBeganトリガーによってfalseが返された。

イベントペイロード:

  • scale Number

    開始タッチと更新されたタッチ間の距離の比を定義した[0、inf]のスケール値。 スケールジェスチャへの変更が発生していない場合、onScaleBeganは常に1です。

onScaleChanged

ユーザーが2本の指で画面の拡大縮小をするとき実行されます。開始タッチによってHTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • DrawableまたはInstantTrackbleに開始タッチがヒットしない。
  • DrawableまたはInstantTrackableに最初のタッチがヒットしたが、タッチキューの最後で、onScaleChangedトリガーによってfalseが返された。

イベントペイロード:

  • scale Number

    開始タッチと更新されたタッチ間の距離の比を定義した[0、inf]のスケール値。

onScaleEnded

ユーザーが2本の指で画面の拡大縮小を終了するときに実行されます。最初のタッチでHTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • DrawableまたはInstantTrackbleに開始タッチがヒットしない。
  • DrawableまたはInstantTrackableに最初のタッチがヒットしたが、タッチキューの最後で、onScaleEndedトリガーによってfalseが返された。

イベントペイロード:

  • scale Number

    開始タッチと更新されたタッチ間の距離の比を定義した[0、inf]のスケール値。 onScaleChangedで受信した最新のスケールと常に同じ。

onScreenClick

ユーザーが画面をクリックしたときに実行されます。HTMLエレメントがヒットしなかった場合、および以下のどちらかの場合は実行されません。

  • Drawableがクリックによってヒットしなかった。
  • Drawableがクリックによってヒットしたが、クリックキューの最後のDrawableがonClickトリガーでfalseを返した

クリックキューの詳細については、AR.Drawable.onClick()トリガーを参照してください。