Wikitude SDK APIリファレンスradarクラス
radarは、ユーザーの周辺に存在するGeoObjectの位置を示す2次元レーダーをカメラビューに表示できます。
このクラスのシングルトンインスタンスはARchitect Worldの起動時に自動的に生成され、AR.radarを介してアクセスできます。
raderの位置とサイズはHTMLページのDOM要素で定義します。raderのDOM要素はcontainerプロパティによって指定します。
<body>
<div style="position:absolute;top:10px;left:10px;width:50px;height:100px;" id="radarContainer"></div>
</body>
AR.radar.container = document.getElementById("radarContainer");
各プロパティの意味について以下に説明します。次の図もあわせて参照してください。
メソッド
notifyUpdateRadarPosition
()
raderを含むDOM要素の位置が変更されるたびにこのメソッドを呼び出す必要があります。これはraderの位置をDOM要素に同期します。
プロパティ
centerX
Number
実際の2次元レーダー領域の中心の水平位置を指定します。背景画像の幅を基準とした0〜1の範囲内の値を指定します。0.5を指定すると、2次元レーダー領域の中心が背景画像の水平方向の中央に配置されます。
centerY
Number
実際の2次元レーダー領域の中心の垂直位置を指定します。背景画像の高さを基準とした0〜1の範囲内の値を指定します。0.5を指定すると、2次元レーダー領域の中心が背景画像の垂直方向の中央に配置されます。
container
要素
raderを含むDOM要素。
enabled
Boolean
trueに設定すると2次元レーダーがカメラビューで有効になり、falseに設定すると完全に無効になります。
注: 2次元レーダーはnorthIndicatorを除くすべてのプロパティが有効な値に設定されている場合にのみ表示できます。
maxDistance
Number
raderがカバーする最大距離（m単位）を指定します。xメートルに設定すると、ユーザーからの距離がx未満であるGeoObjectのみが2次元レーダーに描画されます。特定の拡張オブジェクトまでの距離がxの場合、その拡張オブジェクトは2次元レーダーの境界に描画されます。
正の値またはundefinedにする必要があります。undefinedの場合、maxDistanceは自動的にGeoObjectの最大距離に設定されます。これにより、すべてのGeoObjectが2次元レーダーに表示されます。
northIndicator.image
ImageResource
2次元レーダーの真北を示すために使用されるインジケーター画像をImageResourceで指定します。2次元レーダーの背景画像がスケーリングされると、インジケーター画像も同じ比率でスケーリングされます。詳細については、radar.widthを参照してください。
northIndicator.radius
Number
インジケーターの半径を指定します。インジケーターはユーザーの向きにあわせて変化します。northIndicator.radiusは、インジケーター画像と2次元レーダー領域の中心との距離を示します。背景画像の幅を基準とした0〜1の範囲内の値を指定します。0.45を指定すると、インジケーターの半径が背景画像の幅全体の45%にスケーリングされます。
北インジケーターの半径はレーダーの半径より少し大きい値に設定することを推奨します。そうすると、北インジケーターがレーダー領域に重なりません。
radius
Number
実際の2次元レーダー領域の半径を指定します。2次元レーダーは、この半径を越えて表示されることはありません。背景画像の幅を基準とした0〜1の範囲内の値を指定します。0.4を指定すると、実際の2次元レーダー領域の半径が背景画像の幅全体の40%にスケーリングされます。
イベント
onClick
非推奨
このトリガーのデフォルト値はnullであり、トリガーが発生したときに何もアクションは実行されません。開発者はonClickトリガーにカスタム関数を指定することで、カスタム機能を追加できます。
このトリガーは、背景画像を含めた2次元レーダー領域がクリックされたときに発生します。