Anatomography map API 仕様

基本構成

Anatomography map APIのリクエスト先は下記構成のURLです。

http://lifesciencedb.jp/bp3d/API/[method]?[configuration]


method

Anatomography map APIには目的別に5種類のmethodが用意されています。

画像を生成するmethod

method 概要 指定可能なconfiguration category
image map configuration parameterと共にリクエストすることで、静止画像が得られます。 CommonWindowCameraObjectRotatePartLegendPinLight
animation map configuration parameterと共にリクエストすることで、回転アニメーション画像が得られます。 CommonWindowCameraObjectRotatePartLegendPinLightAnimation

情報を取得するmethod

method 概要 指定可能なconfiguration category
focus map configuration parameterと共にリクエストすることで、パーツを表示するための最適な拡大率が得られます。 CommonWindowCameraPart
pick map configuration parameterおよび二次元画像上のxy座標と共にリクエストすることで、対応する三次元空間上の点が得られます。 CommonWindowCameraObjectRotatePartPick
map map configuration parameterおよび三次元空間上のxyz座標と共にリクエストすることで、対応する二次元画像上の点が得られます。 CommonWindowCameraObjectRotatePartPin


configuration

Anatomography map API methodにJSON形式のconfigurationを与える(httpリクエスト)ことで、目的の情報(httpレスポンス)を得ることができます。
configurationには10種類のcategoryがあり、合計100程度のparameterから構成されています。

Configuration category

Configuration category 概要
Common 全般に関わる共通項目を設定します。 ex)バージョン、ツリーなど
Window 描画画像に関わる項目を設定します。 ex)画像のサイズ、背景色など
Camera 描画時のカメラ(視点)に関わる項目を設定します。 ex)カメラ位置、ズーム、カメラの回転角度など
ObjectRotate パーツ群の回転に関わる項目を設定します。 ex)パーツの回転角度、回転中心、回転軸など
Part 描画対象パーツに関わる項目を設定します。 ex)パーツのID、色、不透明度など
Legend 画像の説明文に関わる項目を設定します。 ex)説明文描画有無、説明文など
Pin ピンに関わる項目を設定します。 ex)ピンのxyz座標、色、サイズ、形状など
Pick pickに関わる項目を設定します。 ex)ピックする最大数、画像上のxy座標
Light 光源に関わる項目を設定します。 ex)光源のxyz座標、光源種別など
Animation アニメーションGIFに関わる項目を設定します。 ex)分割フレーム数、1フレーム秒数など

Map configuration parameterとmethodの対応

各methodに指定できるmap configuration parameterは以下の対応関係になっています。

  Map configuration category
Common Window Camera ObjectRotate Light Legend Part Pin Animation Pick
Method image
animation
focus
pick
map