一覧に戻る

Titaniumモジュールリファレンス

2017.09.22Titaniumモジュール

Titaniumモジュールリファレンス

Wikitude Titaniumモジュールに存在するすべての利用可能なTitaniumAPIバインドについて説明します。

Wikitude Titaniumモジュール

このセクションに記載されているすべてのサンプルコードは、下記コードで生成されたWikitude変数が存在することを前提します。

var wikitude = require('com.wikitude.ti');

ARchitectViewの管理

isDeviceSupported

使用しているデバイス上でARchitect Worldを実行できるかどうかを確認するには、この関数を使用します。

@param {string} augmentedRealityMode: Refines the type of ARchitect Worlds that should be loaded. 
Possible values are: 'IR', 'Geo' & 'IrAndGeo'
@return {bool} true if the device is supported, false otherwise

使用方法:

wikitude.isDeviceSupported('IrAndGeo');

createWikitudeView

Wikitude Titaniumモジュールの新しいインスタンスを生成するには、この関数を使用します。

@param {string} licenseKey: The Wikitude SDK license key that you received with the purchase of the Wikitude SDK.
@param {string} augmentedRealityMode (iOS only): Refines the type of ARchitect Worlds that should be loaded.
Possible values are: 'IR', 'Geo' and 'IrAndGeo'
@return {object} a new instance of the Wikitude Titanium Module

使用方法:

var arView = wikitude.createWikitudeView({
            "licenseKey": "kDc867UKvVb4YuftUQio+qnZAWWyXBy6s...",
            "augmentedRealityMode": 'IrAndGeo',
            bottom: 0,
            left: 0,
            right: 0,
            top: 0
        });

loadArchitectWorldFromURL

Webまたは、アプリバンドルからARchitect Worldをロードするには、この関数を使用します。

@param {string} URL: The URL where the Architect World is located. This can either be a relative local path, or the URL to a remote resource.

使用方法:

arView.loadArchitectWorldFromURL(URL);

callJavaScript

ロード中のARchitect Worldのコンテキストで実行するJavaScriptを呼び出すには、この関数を使用します。

@param {string} javascript: The JavaScript that should be evaluated in the ARchitect World context.

使用方法:

arView.callJavaScript('alert(\'Hello!\');');

injectLocation

Wikitude SDKにロケーションを設定するには、この関数を使用します。ロケーションは、3次元空間の座標と精度を示す値です。使用される座標系はWGS 84です。

@param {object} location: a object that contains each value separately. Valid value names are: 'latitude', 'longitude', 'altitude', 'accuracy'

使用方法:

arView.injectLocation({
         "latitude": 47.22234,
         "longitude": -18.77464,
         "altitude": 250,
         "accuracy": 10
    });

captureScreen

カメラビューからスクリーンショットを生成するには、この関数を使用します。

@param {bool} includeWebView: Indicates if the ARchitect web view should be included in the generated screenshot or not.
@param {string} imagePathInBundleorNullForPhotoLibrary: If a file path or file name is given, the generated screenshot will be saved in the application bundle. Passing null will save the photo in the device photo library.
@param {function} onSuccess: A function that is called when the screen could be successfully captured. The bundle path is passed to the function when the photo was saved into the application bundle.
@param {function} onError: A function that is called when an error occurred during screen capturing.

使用方法:

arView.captureScreen(includeWebView, "/Path/In/Bundle/toImage.png", {
        onSuccess: function(path) {
            alert('success: ' + path);
        },
        onError: function(errorDescription) {
            alert('error: ' + errorDescription);
        }
    });

プロパティ

cullingDistance

Wikitude SDKで使用されているカリング距離を変更するには、このプロパティを使用します。カリング距離の単位はメートルです。既定値は50キロメートルです。

使用方法:

    arView.cullingDistance = 10000;
    alert(arView.cullingDistance);

イベントリスナー

WORLD_IS_LOADED

ARchitect Worldのロードに成功または失敗した場合に通知を受け取るには、このイベントリスナーを使用します。

使用方法:

arView.addEventListener('WORLD_IS_LOADED', function(event){
    if (true === event.result) {
        alert('world loaded');
    } else {
        alert('error loading ARchitect World: ' + event.error);
    }
});

JSON_OBJECT_RECEIVED

この関数は、ARchitect World内でAR.platform.sendJSONObjectへの呼び出しが行われたときに通知を受け取るには、このイベントリスナーを使用します。

使用方法:

arView.addEventListener('JSON_OBJECT_RECEIVED', function(event){
    alert('json object received: ' + event.jsonObject);
});