これは 3D 空間 ID の共通ライブラリの JavaScript 版のプロトタイプです。
このライブラリは位置情報と空間 ID を相互変換したり操作するための共通ライブラリとして利用されるべき機能を提供します。
コンストラクタである Space()
に対して、座標及び高度、または空間 ID を引数として渡して実行すると、空間オブジェクトを生成します。
空間オブジェクトは以下のプロパティを持っており、空間を移動するためのいくつかのメソッドも提供します。
- 中心点の緯度及び経度
- 高度
- ズームレベル(分解能)
- ZFXY(3次元タイル番号)
- タイルハッシュ(3次元タイル番号をハッシュ化した値)
メソッドについては以下のリンク先をご参照ください。
https://github.com/spatial-id/spatial-object-model-specification#readme
$ npm install https://github.com/spatial-id/javascript-sdk -S
以下の方法でモジュールを読み込んでください。
import { Space } from '@spatial-id/javascript-sdk'
Space( input, zoom? )
新しい空間オブジェクトを返します。
座標及び高度または空間 ID を以下のフォーマットで指定することができます。
- LngLatWithAltitude: 緯度経度及び高度を含むオブジェクト。(例:
{ lng: number, lat: number, alt?: number }
) - ZFXYTile: ZFXY(3次元タイル番号)を示す文字列。(例:
/15/6/2844/17952
) - TileHash: ZFXY をハッシュ化した値。(例:
100213200122640
)
ズームレベル(分解能)を整数で指定することができます。
この引数は省略も可能で、デフォルトは 25
です。
Space.boundingSpaceForGeometry( geometry, minZoom? )
geometry
に渡された GeoJSON の Geometry オブジェクトに対して、最小分解能(ズームレベル)での空間IDを返す。
minZoom
が指定している場合は、より少ない分解能(ズームレベル)の空間IDが作られるにしても、 minZoom
での空間IDを返す。
Space.spacesForGeometry( geometry, zoom )
geometry
に渡された GeoJSON の Geometry オブジェクトに対して、その Geometry と指定の zoom
での分解能(ズームレベル)の空間IDの共通集合を配列として返す。
このライブラリは Spatial Object Model を参照に実装しています。
Space
のメソッドのドキュメンテーションは下記となります。
- 現在の空間オブジェクトの**点 (3Dの
{lng: number, lat: number, alt: number}
型)
- 現在の空間オブジェクトの最低高さ (floor)
- 現在の空間オブジェクトのズームレベル(分解能)
- 現在の空間オブジェクトが表現している ZFXY を ZFXYTile 型 (
{ z: number, f: number, x: number, y: number }
)
- 現在の空間オブジェクトが表現している ZFXY の tilehash の文字列
- 現在の空間オブジェクトが表現している ZFXY を URL のパス型に変換したもの
- パラメータがない場合は、現在の空間オブジェクトのひとつ上の空間オブジェクトを返す
- パラメータが指定されている場合は、その個数分の空間オブジェクトを配列で返す
- パラメータがない場合は現在の空間オブジェクトのひとつ下の空間オブジェクトを返す
- パラメータが指定されている場合は、その個数分の空間オブジェクトを配列で返す
- パラメータがない場合は、現在の空間オブジェクトの隣のオブジェクトを返す
- パラメータが指定されている場合は、その個数分の空間オブジェクトを配列で返す
- 現在の空間オブジェクトから相対的な新しいオブジェクトを返す。
by
は少なくともx, y, f
の一つ以上を含めてください
space.move({x: 1, y: 5, f: -1})
上記の例の場合では、返り値は西1マス、北5マス、下1マスにある空間オブジェクト
- 現在の空間オブジェクトのまわりにあるすべての空間オブジェクトを配列で返す。
- 現在の空間オブジェクトから、分解能(ズームレベル)を
atZoom
のズームレベルまで下げる。デフォルトでは1段階下げます。
- 現在の空間オブジェクトから、分解能(ズームレベル)を一つ上げて、そこに含まれるすべての空間オブジェクトを返す。
- 指定された緯度経度が、指定されたボクセル内に含まれるかどうかを判定して bool 値を返す。
- 現在の空間オブジェクトの3Dバウンディングボックスを作る8点の座標を配列として返す。