Wikitude SDK APIリファレンス

バージョン: 8.1.0
表示:

Circleクラス

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

Circleはプレーンな円を拡張オブジェクトとして表します。

インスタンス生成時にパラメーターを渡して、Circleのプロパティをカスタマイズできます。

例:
//create a new circle and pass some setup parameters to the circle
var circle = new AR.Circle(30, {
  offsetX : 1,
  onClick : function() {
    circle.radius *= 2;
  },
  horizontalAnchor : AR.CONST.HORIZONTAL_ANCHOR.LEFT,
  opacity : 0.9
});

コンストラクター

Circle

(
  • radius
  • options
)

Parameters:

  • radius Number

    円の半径（SDU単位）。正の数値にする必要があります。

  • options Object オプション

    Setup-Parameters to customize additional object properties.

    Accepted options-properties are

    • enabled （デフォルト値: true） Boolean オプション
    • mirrored （デフォルト値: true） Boolean オプション
    • onClick Function オプション
    • onDragBegan Function オプション
    • onDragChanged Function オプション
    • onDragEnded Function オプション
    • onPanBegan Function オプション
    • onPanChanged Function オプション
    • onPanEnded Function オプション
    • onRotationBegan Function オプション
    • onRotationChanged Function オプション
    • onRotationEnded Function オプション
    • onScaleBegan Function オプション
    • onScaleChanged Function オプション
    • onScaleEnded Function オプション
    • rotate.x （デフォルト値: 0） Number オプション
    • rotate.y （デフォルト値: 0） Number オプション
    • rotate.z （デフォルト値: 0） Number オプション
    • rotate.global.x （デフォルト値: 0） Number オプション
    • rotate.global.y （デフォルト値: 0） Number オプション
    • rotate.global.z （デフォルト値: 0） Number オプション
    • translate.x （デフォルト値: 0） Number オプション
    • translate.y （デフォルト値: 0） Number オプション
    • translate.z （デフォルト値: 0） Number オプション
    • translate.global.x （デフォルト値: 0） Number オプション
    • translate.global.y （デフォルト値: 0） Number オプション
    • translate.global.z （デフォルト値: 0） Number オプション
    • scale.x （デフォルト値: 1） Number オプション
    • scale.y （デフォルト値: 1） Number オプション
    • scale.z （デフォルト値: 1） Number オプション
    • horizontalAnchor （デフォルト値: AR.CONST.HORIZONTAL_ANCHOR.CENTER） Object オプション
    • verticalAnchor （デフォルト値: AR.CONST.VERTICAL_ANCHOR.MIDDLE） Object オプション
    • zOrder （デフォルト値: 0） Number オプション
    • opacity （デフォルト値: 1） Number オプション
    • style.fillColor String オプション
    • style.outlineColor String オプション
    • style.outlineSize Number オプション

メソッド

destroy

()

継承元: ARchitectObject

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

getBoundingRectangle

() BoundingRectangle

継承元: Drawable2D

このDrawable2DのBoundingRectangleを返します。エラーの場合はnullが返されます。

戻り値:

BoundingRectangle:

Drawable2DのBoundingRectangle。

プロパティ

destroyed

Boolean

継承元: ARchitectObject

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

enabled

Boolean

継承元: Drawable

Drawableを有効または無効にするフラグ。Drawableが無効になっていると、画面には表示されず、トリガは決して発生しません。 有効な場合は、画面にレンダリングすることでトリガーを発生できます。

デフォルト値: true

horizontalAnchor

Number

継承元: Drawable2D

Drawable2Dによって表されるGeoObjectのスクリーン位置に、Drawable2Dのどのピクセル（水平ピクセル列内）が配置されるか、水平方向のアンカーを設定します。

有効な値はAR.CONST.HORIZONTAL_ANCHORで定義されています。たとえば、ImageDrawableの水平アンカーとしてLEFTを設定した場合は、拡張オブジェクトの左端がアンカーポイントとして設定されます。

デフォルトの水平アンカーポイントは、Drawable2Dによって表される拡張オブジェクトの種類によって異なります。

mirrored

Boolean

継承元: Drawable

このDrawableのミラーリングを有効または無効にするフラグ。フロントカメラを使用したとき、ミラーリングしたDrawableはy軸を中心に180°回転します。

デフォルト値: 一般的なDrawableの場合はtrue、ラベルとHTMLDrawableの場合はfalse

offsetX

Number 非推奨

継承元: Drawable2D

非推奨: 代わりにtranslate.yを使用してください。

offsetY

Number 非推奨

継承元: Drawable2D

非推奨: 代わりにtranslate.yを使用してください。

opacity

Number

継承元: Drawable2D

Drawable2Dによって表される拡張オブジェクトの透明度を定義する0.0～1.0の範囲内の値。値に0を設定すると拡張オブジェクトは完全に透明になり、値に1を設定すると完全に不透明で表示されます。

デフォルト値: 1

radius

Number

円の半径（SDU単位）。 正の数値にする必要があります。

rotate

Object

継承元: Drawable

Drawableの中央を中心とする回転を定義します。 このプロパティを使用すると、最高のパフォーマンスを出すために、Wikitude SDKのネイティブサイドへの1回の呼び出しで、x、y、zコンポーネントを同時に設定できます。 Objectは、x、y、z、またはそのサブセットを含むことができます。

rotate.global.x

Number

継承元: Drawable

x軸を中心としたDrawableの回転（度単位）を定義します。 値には360の剰余が適用されます。 つまり、361°を設定した場合と1°を設定した場合は同じ結果になります。 すべてのグローバル変換は、ローカル変換後に適用されます。

デフォルト値: 0

rotate.global.y

Number

継承元: Drawable

y軸を中心としたDrawableの回転（度単位）を定義します。 値には360の剰余が適用されます。 つまり、361°を設定した場合と1°を設定した場合は同じ結果になります。 すべてのグローバル変換は、ローカル変換後に適用されます。

デフォルト値: 0

rotate.global.z

Number

継承元: Drawable

z軸を中心としたDrawableの回転（度単位）を定義します。 値には360の剰余が適用されます。 つまり、361°を設定した場合と1°を設定した場合は同じ結果になります。 すべてのグローバル変換は、ローカル変換後に適用されます。

デフォルト値: 0

rotate.heading

Number 非推奨

継承元: Drawable

非推奨: 代わりにrotate.yまたはrotate.global.yを使用してください。

rotate.roll

Number 非推奨

継承元: Drawable

非推奨: 代わりにrotate.zまたはrotate.global.zを使用してください。

rotate.tilt

Number 非推奨

継承元: Drawable

非推奨: 代わりにrotate.xまたはrotate.global.xを使用してください。

rotate.x

Number

継承元: Drawable

x軸を中心としたDrawableの回転（度単位）を定義します。 値には360の剰余が適用されます。 つまり、361°を設定した場合と1°を設定した場合は同じ結果になります。

デフォルト値: 0

rotate.y

Number

継承元: Drawable

y軸を中心としたDrawableの回転（度単位）を定義します。 値には360の剰余が適用されます。 つまり、361°を設定した場合と1°を設定した場合は同じ結果になります。

デフォルト値: 0

rotate.z

Number

継承元: Drawable

z軸を中心としたDrawableの回転（度単位）を定義します。 値には360の剰余が適用されます。 つまり、361°を設定した場合と1°を設定した場合は同じ結果になります。

デフォルト値: 0

rotatesToCamera

Boolean

継承元: Drawable

drawableがカメラに向いているかどうかを定義します。これは、GeoObject にアタッチされたDrawablesに対してのみ可能です。

デフォルト値:一般的なdrawableの場合はtrue、モデルの場合はfalse。

rotation

Number 非推奨

継承元: Drawable2D

非推奨: 代わりにrotate.zを使用してください。

scale

Number 非推奨

継承元: Drawable

非推奨: 代わりにscale.xとscale.yを使用してください。

scale.x

Number

継承元: Drawable

x方向のスケール。 負でない必要があります。

デフォルト値: 1

scale.y

Number

継承元: Drawable

y方向のスケール。 負でない必要があります。

デフォルト値: 1

scale.z

Number

継承元: Drawable

z方向のスケール。 負でない必要があります。

デフォルト値: 1

style

Object

Circlのスタイルを記述するStyleオブジェクト。

Sub-properties:

  • object.fillColor String オプション
  • object.outlineSize Number オプション
  • object.outlineColor String オプション

イベント

translate

Object

継承元: Drawable

Drawableの平行移動を定義します。 このプロパティを使用すると、最高のパフォーマンスを出すために、Wikitude SDKのネイティブサイドへの1回の呼び出しで、x、y、zコンポーネントを同時に設定できます。 Objectは、x、y、z、またはそのサブセットを含むことができます。

translate.global.x

Number

継承元: Drawable

Drawableの計算された位置への水平オフセット（ SDU 単位）。 正の数xはDrawableを右に移動させ、負の数xは左に移動させます。 すべてのグローバル変換は、ローカル変換後に適用されます。

デフォルト値: 0

translate.global.y

Number

継承元: Drawable

Drawableの計算された位置への垂直オフセット（ SDU 単位）。 正の数xはDrawableを上に移動させ、負の数xは下に移動させます。 すべてのグローバル変換は、ローカル変換後に適用されます。

デフォルト値: 0

translate.global.z

Number

継承元: Drawable

Drawableの計算された位置までの深さオフセット（ SDU 単位）。 正の数zはDrawableをユーザーの方に移動させ、負の数zは奥に移動させます。 すべてのグローバル変換は、ローカル変換後に適用されます。

デフォルト値: 0

translate.x

Number

継承元: Drawable

Drawableの計算された位置への水平オフセット（ SDU 単位）。 正の数xはDrawableを右に移動させ、負の数xは左に移動させます。

デフォルト値: 0

translate.y

Number

継承元: Drawable

Drawableの計算された位置への垂直オフセット（ SDU 単位）。 正の数yはDrawableを上に移動させ、負の数yは下に移動させます。

デフォルト値: 0

translate.z

Number

継承元: Drawable

Drawableの計算された位置までの深さオフセット（ SDU 単位）。 正の数zはDrawableをユーザーの方に移動させ、負の数zは奥に移動させます。

デフォルト値: 0

verticalAnchor

Number

継承元: Drawable2D

Drawable2Dによって表されるGeoObjectのスクリーン位置に、Drawable2Dのどのピクセル（垂直ピクセル列内）が配置されるか、垂直方向のアンカーを設定します

有効な値はAR.CONST.VERTICAL_ANCHORで定義されています。たとえば、Imageの垂直アンカーとしてTOPを設定した場合は、拡張オブジェクトの上端がアンカーポイントとして設定されます。

デフォルトの垂直アンカーポイントは、Drawable2Dによって表される拡張オブジェクトの種類によって異なります。

zOrder

Number

継承元: Drawable2D

特定のGeoObjectに複数のDrawable2Dが割り当てられている場合、zOrderによってそれらのDrawableの描画順序が決まります。複数のDrawableが重なる場合は、zOrder値の高いDrawableの方が前面にレンダリングされます（たとえば、zOrder = 1のDrawableはzOrder = 0のDrawableより前面にレンダリングされます）。同じzOrderを持つDrawableが重なった場合の動作は不定であり、予期しない結果になる可能性があります。そのため、重なる可能性のあるDrawableにはzOrderを定義することを推奨します。

異なるGeoObjectに属するDrawableのレンダリング順序を指定するには、GeoObject.renderingOrderを参照してください。

整数にする必要があります。

デフォルト値: 0

onClick

継承元: Drawable

Drawableをクリックすると、Drawable.onClickトリガーが実行されます。画面上のクリックは複数のDrawableにヒットする場合があるため、最前面のDrawableを先頭とする"クリックされたDrawableのキュー"が作成されます。トリガーの戻り値は、このDrawableのonClick()トリガーが実行された後にキューの次のDrawableのonClick()トリガーを実行するかどうかを決定します。キューの最後のDrawableがさらにonClick()トリガーの実行を要求した場合は、ARObject.onClick()トリガーが実行されます。さらにキューの実行が要求された場合は、context.onScreenClick()トリガーが実行されます。

このトリガーの戻り値により後続のクリックキューの処理を決定します。falseの場合、クリックキューの実行はこのDrawableで停止しません。したがって、次のDrawableのonClick()トリガーが実行されます。これは、戻り値が設定されていない場合、またはこのDrawableに対してonClickトリガーが定義されていない場合のデフォルト値です。trueの場合、キューの実行は現在のDrawableで停止し、後続のDrawableのonClick()トリガーは実行されません。

イベントペイロード:

  • arObject ARObject

    クリックされたDrawableにアタッチされているARObject。

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

onDragBegan

継承元: Drawable

ユーザーが1本の指でDrawableのドラッグを開始したときに実行されます。このコールバックは、イベント伝播の流れとしてonClickコールバックと同じように動作します。

イベントペイロード:

  • xNormalized Number

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

  • yNormalized Number

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

  • xIntersection Number

    ワールド空間における、開始タッチレイとインスタントトラッキング平面の交点位置のX座標 [-無限, 無限]。InstantTrackableが使用できない場合は未定義

  • yIntersection Number

    ワールド空間における、開始タッチレイとインスタントトラッキング平面の交点位置のY座標 [-無限, 無限]。InstantTrackableが使用できない場合は未定義

onDragChanged

継承元: Drawable

ユーザーが1本の指でDrawableをドラッグすると実行されます。このコールバックは、イベント伝播の流れとしてonClickコールバックと同じように動作します。

イベントペイロード:

  • xNormalized Number

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

  • yNormalized Number

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

  • xIntersection Number

    ワールド空間における、更新されたタッチレイとインスタントトラッキング平面の交点位置のX座標 [-無限, 無限]。InstantTrackableが使用できない場合は未定義

  • yIntersection Number

    ワールド空間における、更新されたタッチレイとインスタントトラッキング平面の交点位置のY座標 [-無限, 無限]。InstantTrackableが使用できない場合は未定義

onDragEnded

継承元: Drawable

ユーザーが1本の指でDrawableのドラッグを停止したときに実行されます。このコールバックは、イベント伝播の流れとしてonClickコールバックと同じように動作します。

イベントペイロード:

  • xNormalized Number

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

  • yNormalized Number

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

  • xIntersection Number

    ワールド空間における、終了タッチレイとインスタントトラッキング平面の交点位置のX座標 [-無限, 無限]。InstantTrackableが使用できない場合は未定義

  • yIntersection Number

    ワールド空間における、終了タッチレイとインスタントトラッキング平面の交点位置のY座標 [-無限, 無限]。InstantTrackableが使用できない場合は未定義

onPanBegan

継承元: Drawable

ユーザーが2本の指でDrawableのドラッグを開始したときに実行されます。このコールバックは、イベント伝播の流れとしてonClickコールバックと同じように動作します。

イベントペイロード:

  • xNormalized Number

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

  • yNormalized Number

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

onPanChanged

継承元: Drawable

ユーザーが2本の指でDrawableをドラッグすると実行されます。このコールバックは、イベント伝播の流れとしてonClickコールバックと同じように動作します。

イベントペイロード:

  • xNormalized Number

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

  • yNormalized Number

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

onPanEnded

継承元: Drawable

ユーザーが2本の指でDrawableのドラッグを停止したときに実行されます。このコールバックは、イベント伝播の流れとしてonClickコールバックと同じように動作します。

イベントペイロード:

  • xNormalized Number

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

  • yNormalized Number

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

onRotationBegan

継承元: Drawable

ユーザーが2本の指でDrawableの回転を開始したときに実行されます。このコールバックは、イベント伝播の流れとしてonClickコールバックと同じように動作します。

イベントペイロード:

  • angle Number

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

onRotationChanged

継承元: Drawable

ユーザーが2本の指でDrawableを回転したときに実行されます。このコールバックは、イベント伝播の流れとしてonClickコールバックと同じように動作します。

イベントペイロード:

  • angle Number

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

onRotationEnded

継承元: Drawable

ユーザーが2本の指でDrawableの回転を停止したときに実行されます。このコールバックは、イベント伝播の流れとしてonClickコールバックと同じように動作します。

イベントペイロード:

  • angle Number

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

onScaleBegan

継承元: Drawable

ユーザーが2本の指でDrawableの拡大縮小を開始するときに実行されます。このコールバックは、イベント伝播の流れとしてonClickコールバックと同じように動作します。

イベントペイロード:

  • scale Number

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

onScaleChanged

継承元: Drawable

ユーザーが2本の指でDrawableを拡大縮小するときに実行されます。このコールバックは、イベント伝播の流れとしてonClickコールバックと同じように動作します。

イベントペイロード:

  • scale Number

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

onScaleEnded

継承元: Drawable

ユーザーが2本の指でDrawableのスケーリングを停止したときに実行されます。このコールバックは、イベント伝播の流れとしてonClickコールバックと同じように動作します。

イベントペイロード:

  • scale Number

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