Scene¶
モデルシーン
表示するエンティティを管理するクラスである。 インスタンスは mapray.Viewer.scene から得ることができる。
Accessors¶
animation¶
getanimation():BindingBlock
アニメーションパラメータ設定
Returns¶
frame_buffer_for_ground_and_structure_texture¶
getframe_buffer_for_ground_and_structure_texture():undefined|FrameBuffer
Returns¶
undefined | FrameBuffer
frame_buffer_for_ground_texture¶
getframe_buffer_for_ground_texture():undefined|FrameBuffer
Returns¶
undefined | FrameBuffer
frame_buffer_for_structure_texture¶
getframe_buffer_for_structure_texture():undefined|FrameBuffer
Returns¶
undefined | FrameBuffer
global_clock¶
getglobal_clock():undefined|GlobalClock
Scene ファイル v2 のグローバル時計。
v2 の load() が完了するまでは undefined。v1 のシーンでも undefined。 Viewer が毎フレーム進める。
Returns¶
undefined | GlobalClock
num_entities¶
getnum_entities():number
エンティティ数
Returns¶
number
viewer¶
getviewer():Viewer
this を保有する親オブジェクト
Returns¶
Methods¶
addDataset()¶
addDataset(
id,source):Promise<undefined|SceneDataset>
データセットを足す。データファイルの取得と宣言のパケットの反映が終わると、SceneDataset で解決する。
不正な id、使用中の id、オブジェクトでない宣言は、警告して無視し、undefined で解決する。 v2 の load() が完了する前に呼んだ場合も、警告して undefined で解決する。 データファイルを読み込めない場合は、警告して、空のデータセットで解決する。 取得中か反映中に removeDataset で外した場合は、データセットを登録せず、undefined で解決する（警告しない）。
Parameters¶
| Parameter | Type | Description |
|---|---|---|
id |
string |
データセットの id。 |
source |
Source |
url、packets、visibility の宣言。相対 URL は Scene ファイルが基点。 |
Returns¶
Promise<undefined | SceneDataset>
addEntity()¶
addEntity(
entity):void
エンティティを末尾に追加
Parameters¶
| Parameter | Type | Description |
|---|---|---|
entity |
Entity |
エンティティ |
Returns¶
void
clearEntities()¶
clearEntities():
void
すべてのエンティティを削除
Returns¶
void
getAnimation()¶
getAnimation(
id):undefined|SceneAnimation
Scene ファイル v2 のアニメーションを id で取得する。未登録の id は undefined。
Parameters¶
| Parameter | Type |
|---|---|
id |
string |
Returns¶
undefined | SceneAnimation
getDataset()¶
getDataset(
id):undefined|SceneDataset
Scene ファイル v2 のデータセットを取得する。未登録の id は undefined。
Parameters¶
| Parameter | Type |
|---|---|
id |
string |
Returns¶
undefined | SceneDataset
getEntity()¶
getEntity(
index):Entity
エンティティを取得
Parameters¶
| Parameter | Type | Description |
|---|---|---|
index |
number |
インデックス |
Returns¶
エンティティ
getEntityById()¶
getEntityById(
id):null|Entity
Scene ファイル v2 の JSON の id でエンティティを取得する。
存在期間の外にあるものも返す。点群、B3D、未登録の id は null。
データセットのエンティティは <データセットの id>/<エンティティ id> で指定する。
Parameters¶
| Parameter | Type |
|---|---|
id |
string |
Returns¶
null | Entity
getEntityId()¶
getEntityId(
entity):undefined|string
エンティティから Scene ファイル v2 の JSON の id を取得する。 id が省略されたものと、v2 で登録されていないものは undefined。
Parameters¶
| Parameter | Type |
|---|---|
entity |
Entity |
Returns¶
undefined | string
getModel()¶
getModel(
name):null|ModelContainer
Scene ファイル v2 のモデルを名前で取得する。未登録の名前は null。
データセットのモデルは <データセットの id>/<名前> で指定する。
Parameters¶
| Parameter | Type |
|---|---|
name |
string |
Returns¶
null | ModelContainer
removeDataset()¶
removeDataset(
id):void
データセットを外し、id を空ける。エンティティ、点群、B3D、サンプル、モデルがすべて外れる。
反映中と待機中のパケットは以後反映されず、その Promise は解決する。 データファイルを取得中のデータセットは、取得が終わっても登録されない。 削除前の SceneDataset への操作は警告して無視する。
Parameters¶
| Parameter | Type | Description |
|---|---|---|
id |
string |
外すデータセットの id。知らない id は警告して無視する。 |
Returns¶
void
removeEntity()¶
removeEntity(
entity):void
エンティティを削除
Parameters¶
| Parameter | Type | Description |
|---|---|---|
entity |
Entity |
エンティティ |
Returns¶
void
usingBakeTarget()¶
usingBakeTarget():
object
Returns¶
object
ground¶
ground:
boolean
ground_and_structure¶
ground_and_structure:
boolean
structure¶
structure:
boolean