3D 空間 ID 共通ライブラリ (ローカル空間ID用)

注意：このライブラリはまだ設計段階です。それぞれのクラス名・メソッド名は変わる可能性があるのでご注意ください。

このライブラリの内容

• LocalNamespace - ローカル空間を管理します。
• LocalSpatialId - ローカル空間内の空間を指すためのローカル空間IDを管理します。

LocalNamespace

コンストラクタ

new LocalNamespace( options: LocalNamespaceOptions )

ローカル空間をインスタンス化します。新しい空間を作るときや、既存の空間に対して処理を行うときに使います。このローカル空間では、XYZ座標を使います。ぞれぞれの軸の定義は下記となります:

• x は右左
• y は前奥
• z は上下

interface LocalNamespaceOptions {
  /// 任意な一意な文字列。他のローカル空間と識別するために使います。
  id?: string

  /// ローカル空間全体の１軸の最大長さ。メートルで指定。例えば 1 の場合、該当のローカル空間の最大収容可能な地物は 1m×1m×1m の 1m3 となります。
  scale: number

  name?: string
  description?: string

  /// ローカル空間をグローバル空間とマッピングする場合、基準点をしていしなければなりません。 `altitude` または `angle` はデフォルトで `0` となります。
  origin_latitude?: number
  origin_longitude?: number
  origin_altitude?: number
  origin_angle?: number
}

メソッド

LocalNamespace をインスタンス化されたあとで、その空間内のローカル空間IDを操作することができます。

.space(input) -> LocalSpatialId

input 座標及び高度または空間 ID を以下のフォーマットで指定することができます。

• XYZObject: XYZ座標を含むオブジェクト。単位はメートル。 （例: { x: number, y: number, z: number }）
• ZFXYTile: ZFXY（3次元タイル番号）を示す文字列。（例: /15/6/2844/17952）
• TileHash: ZFXY をハッシュ化した値。（例: 100213200122640）

XYZObject で指定された座標がローカル空間により外の場合、例外が発生します。

.spacesFromGeoJSON(zoom: number, input: GeoJSON.Geometry) -> LocalSpatialId[]

• GeoJSON Feature がインプットとし、内包する指定のズームレベルのローカル空間IDを算出します。
• 基準点の設定が未設定の場合、例外が発生します。

.boundingSpaceFromGeoJSON(input: GeoJSON.Geometry) -> LocalSpatialId

• GeoJSON Feature がインプットとし、内包する最小のローカル空間IDを算出します。
• 基準点の設定が未設定の場合、例外が発生します。

LocalSpatialId

LocalSpatialId は基本的に LocalNamespace#space で作成します。

メソッド

グローバル空間IDのメソッド と同等な機能を持たしております。該当するメソッドを、下記に引用しております。

.center -> {x: number, y: number, z: number}

• 現在の空間オブジェクトの中央点 (3Dの {x: number, y: number, z: number} 型)

.vertices -> [x, y, z][8]

• 現在の空間オブジェクトの8頂点がそれぞれ配列として返す。

.alt -> number

• 現在の空間オブジェクトの最低高さ (floor)

.zoom -> number

• 現在の空間オブジェクトのズームレベル（分解能）

.zfxy -> { z: number, f: number, x: number, y: number }

• 現在の空間オブジェクトが表現している ZFXY を ZFXYTile 型 ({ z: number, f: number, x: number, y: number })

.id, .tilehash -> string

• 現在の空間オブジェクトが表現している ZFXY の tilehash の文字列

.zfxyStr -> string

• 現在の空間オブジェクトが表現している ZFXY を URL のパス型に変換したもの

.up(by?: number) -> LocalNamespace

• パラメータがない場合は、現在の空間オブジェクトのひとつ上の空間オブジェクトを返す
• パラメータが指定されている場合は、その個数分の空間オブジェクトを配列で返す

.down(by?: number) -> LocalNamespace

• パラメータがない場合は現在の空間オブジェクトのひとつ下の空間オブジェクトを返す
• パラメータが指定されている場合は、その個数分の空間オブジェクトを配列で返す

.north(by?: number), .east(by?: number), south(by?: number), .west(by?: number) -> LocalNamespace

• こちらの東西南北はローカル座標系内の方位となります。
• パラメータがない場合は、現在の空間オブジェクトの隣のオブジェクトを返す
• パラメータが指定されている場合は、その個数分の空間オブジェクトを配列で返す

.move(by: Partial<Omit<ZFXYTile, 'z'>>) -> LocalNamespace

• 現在の空間オブジェクトから相対的な新しいオブジェクトを返す。 by は少なくとも x, y, f の一つ以上を含めてください

space.move({x: 1, y: 5, f: -1})

上記の例の場合では、返り値は西1マス、北5マス、下1マスにある空間オブジェクト

.surroundings() -> LocalNamespace[]

• 現在の空間オブジェクトのまわりにあるすべての空間オブジェクトを配列で返す。

.parent(atZoom?: number) -> LocalNamespace

• 現在の空間オブジェクトから、分解能（ズームレベル）を atZoom のズームレベルまで下げる。デフォルトでは1段階下げます。

.children() -> LocalNamespace[]

• 現在の空間オブジェクトから、分解能（ズームレベル）を一つ上げて、そこに含まれるすべての空間オブジェクトを返す。

.contains(input: LocalSpatialId | GeoJSON.Geometry) -> bool

• 指定されたローカル空間IDまたは任意なGeoJSONが、指定されたボクセル内に含まれるかどうかを判定して bool 値を返す。
• input の ローカル空間ID が違うローカル空間で作られたものの場合、例外が発生します。
• input が GeoJSON かつ、基準点の設定が未設定の場合、例外が発生します。

.toContainingGlobalSpatialId() -> Space

• 現在の空間オブジェクトがすべて内包できるグローバル空間IDを返します。
• 基準点の設定が未設定の場合、例外が発生します。

.toGlobalSpatialIds(zoom: number) -> Space[]

• 現在の空間オブジェクトを内包できるグローバル空間IDを、指定のズームレベルのグローバル空間オブジェクトを配列で返します。
• 基準点の設定が未設定の場合、例外が発生します。

.toGeoJSON() -> GeoJSON.Geometry

• 現在の空間オブジェクトをGeoJSONとして出力する（２次元）
• 基準点の設定が未設定の場合、例外が発生します。