Wikitude SDK APIリファレンス

バージョン: 8.1.0
表示:

ImageResourceクラス

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

ImageResourceは拡張オブジェクトに使用する画像をカプセル化します。ImageResourceは、画像を指すURIによって表されます。ImageResourceは画像の実際のピクセル単位の幅と高さを持ちます。

インスタンスを生成した後すぐに画像がデバイスへロードされます。

例:

var imageres = new AR.ImageResource("http://path.to.my/image/resource.png");

コンストラクター

ImageResource

(
  • uri
  • options
)

パラメーター:

  • uri String

    画像ファイルを指すURI。

  • options Object オプション

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

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

項目索引

プロパティ

イベント

メソッド

destroy

()

継承元: ARchitectObject

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

getHeight

() Number

画像の実際の高さ(ピクセル単位)を返します。画像がまだロードされていない場合は(ImageResource.onLoaded()トリガーを参照)、-1が返されます。

戻り値:

Number:

URIによって表される画像の高さ(ピクセル単位)。

getUri

() String

ImageResourceを指すURIを返します。

戻り値:

String:

ImageResourceを指すURI。

getWidth

() Number

画像の実際の幅(ピクセル単位)を返します。画像がまだロードされていない場合は(ImageResource.onLoaded()トリガーを参照)、-1が返されます。

戻り値:

Number:

URIによって表される画像の幅(ピクセル単位)。

isLoaded

() Boolean

ImageResourceがすでに正常にロードされているかどうかをチェックします。

戻り値:

Boolean:

ImageResourceがすでにロードされている場合はtrue。まだロードされていない場合はfalse。

プロパティ

destroyed

Boolean

継承元: ARchitectObject

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

イベント

onError

このトリガーは、画像をロードできなかったときに発生します。

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

onLoaded

このトリガーは、画像がロードされたときに発生します。

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

イベントペイロード:

  • width Number

    ImageResourceの幅(ピクセル単位)。

  • height Number

    ImageResourceの高さ(ピクセル単位)。