Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImageProvider Abstract

地図画像プロバイダ

レンダラーに地図画像を与えるための抽象クラスである。

このインスタンスには状態 ( mapray.ImageProvider.Status 型) があり、{@link mapray.ImageProvider#status|status()} メソッドにより状態を確認することができる。

初期状態は READY または NOT_READY でなければならず、状態の変化は NOT_READY から READY または NOT_READY から FAILED しか存在しない。 READY 以外の状態では {@link mapray.ImageProvider#status|status()} を除くメソッドを呼び出すことはできない。

初期状態が NOT_READY になる可能性があるプロバイダは、{@link mapray.ImageProvider#status|status()} メソッドをオーバーライドする必要がある。

以下の抽象メソッドは既定の動作がないので、利用者はこれらのメソッドをオーバーライドした具象クラスを使用しなければならない。

see

mapray.StandardImageProvider

see

mapray.Viewer

Hierarchy

Index

Constructors

Methods

  • cancelRequest(id: object): void
  • 地図タイル画像の要求を取り消す [requestTile()]{@link mapray.ImageProvider#requestTile} による要求を可能であれば取り消す。

    Parameters

    • id: object

      要求 ID ([requestTile()]{@link mapray.ImageProvider#requestTile} から得たオブジェクト)

    Returns void

  • getImageSize(): number
  • 地図タイル画像の寸法を取得

    サーバーが提供する地図タイル画像の寸法をする。 地図タイル画像は正方形を前提とし、水平方向の画素数を返す。

    制限: this が同じなら常に同じ値を返さなければならない。

    Returns number

    地図タイル画像の画素数

  • getZoomLevelRange(): Range
  • 地図画像ズームレベルの範囲を取得

    サーバーが提供する地図タイル画像のズームレベルの範囲を取得する。 制限: this が同じなら常に同じ範囲を返さなければならない。

    Returns Range

  • 地図タイル画像を要求

    座標が (z, x, y) の地図タイル画像を要求する。 指定したタイル画像の取得が成功または失敗したときに callback が非同期に呼び出されなければならない。 だたし [cancelRequest()]{@link mapray.ImageProvider#cancelRequest} により要求が取り消されたとき、callback は呼び出しても呼び出さなくてもよい。また非同期呼び出しである必要もない。

    Parameters

    Returns object

    要求 ID ([cancelRequest()]{@link mapray.ImageProvider#cancelRequest} に与えるオブジェクト)

  • 状態の取得

    現在の ImageProvider 状態を返す。 callback を与えたとき、状態が NOT_READY から READY または FAILED に変化したときに callback が呼び出される。 NOT_READY 以外の状態で callback 与えても、それは無視されコールバック関数は登録されない。

    デフォルトの実装は、常に READY を返却し状態は変化しない。 継承クラスで必要に応じて実装される。

    Parameters

    • Optional callback: StatusCallback

      状態変化コールバック関数

    Returns mapray.ImageProvider.Status

    現在の ImageProvider 状態