Class SceneLoader

シーンの読み込み

Hierarchy

Loader
- SceneLoader

Index

Constructors

Properties

_finished _glenv _onEntity _references _resource _scene

Accessors

resource scene status

Methods

_cancel _check_cancel _load _load_entity_list _load_model_container _load_model_register _load_object _postload_object _setReference cancel getReference load

Constructors

constructor

new SceneLoader(scene: mapray.Scene, resource: string | Resource, options?: mapray.SceneLoader.Option): SceneLoader
url で指定したシーンデータの読み込みを開始し、scene にエンティティを構築する。読み込みが終了したとき options.callback を呼び出す。
Parameters
- scene: mapray.Scene
  
  読み込み先のシーン
- resource: string | Resource
  
  シーンリソース
- options: mapray.SceneLoader.Option = {}
  
  オプション集合
Returns SceneLoader
Overrides Loader.constructor
- Defined in packages/mapray/src/SceneLoader.ts:38

Properties

`Private` _finished

_finished: boolean

`Private` _glenv

_glenv: GLEnv

`Protected` _onEntity

_onEntity: EntityCallback

`Private` _references

_references: ReferenceMap

`Protected` _resource

_resource: Resource

`Protected` _scene

_scene: mapray.Scene

Accessors

resource

get resource(): Resource
シーンリソース

Returns Resource
Inherited from Loader.resource
- Defined in packages/mapray/src/Loader.ts:48

scene

get scene(): mapray.Scene
読み込み先のシーン

Returns mapray.Scene
Inherited from Loader.scene
- Defined in packages/mapray/src/Loader.ts:42

status

get status(): Status
ローダー読み込みの状態

Returns Status
Inherited from Loader.status
- Defined in packages/mapray/src/Loader.ts:54

Methods

`Protected` _cancel

_cancel(): void
キャンセル時に行う処理。継承クラスによって実装される。

Returns void
Inherited from Loader._cancel
- Defined in packages/mapray/src/Loader.ts:133

`Protected` _check_cancel

_check_cancel(): void
取り消し状態のとき例外を投げる

Returns void
Inherited from Loader._check_cancel
- Defined in packages/mapray/src/Loader.ts:141

`Protected` _load

_load(): Promise<void>
読み込み処理の実態。継承クラスによって実装される。

Returns Promise<void>
Overrides Loader._load
- Defined in packages/mapray/src/SceneLoader.ts:98

`Private` _load_entity_list

_load_entity_list(oscene: SceneJson): void
Parameters
- oscene: SceneJson
Returns void
- Defined in packages/mapray/src/SceneLoader.ts:199

`Private` _load_model_container

_load_model_container(oscene: SceneJson, id: string, model: ModelContainer): Promise<void>
Parameters
- oscene: SceneJson
- id: string
- model: ModelContainer
Returns Promise<void>
- Defined in packages/mapray/src/SceneLoader.ts:161

`Private` _load_model_register

_load_model_register(oscene: SceneJson): undefined | Promise<void[]>
Parameters
- oscene: SceneJson
Returns undefined | Promise<void[]>
- Defined in packages/mapray/src/SceneLoader.ts:142

`Private` _load_object

_load_object(oscene: SceneJson): Promise<void>
JSON シーンオブジェクトを解析
Parameters
- oscene: SceneJson
Returns Promise<void>
- Defined in packages/mapray/src/SceneLoader.ts:115

`Private` _postload_object

_postload_object(oscene: SceneJson): void
残りのオブジェクトを読み込む
Parameters
- oscene: SceneJson
Returns void
- Defined in packages/mapray/src/SceneLoader.ts:132

`Private` _setReference

_setReference(id: string, item: ModelContainer | Entity): void
オブジェクト参照を設定

オブジェクト item を識別子 id で参照できるように this に設定する。
Parameters
- id: string
  
  識別子
- item: ModelContainer | Entity
  
  オブジェクト
Returns void
- Defined in packages/mapray/src/SceneLoader.ts:88

cancel

cancel(): void
読み込みの取り消し

終了コールバック関数は isSuccess == false で呼び出される。

Returns void
Inherited from Loader.cancel
- Defined in packages/mapray/src/Loader.ts:118

getReference

getReference(id: string): null | ModelContainer | Entity
オブジェクト参照を取得

注意: シーンの読み込みが終了したことを確認してからこのメソッドを呼び出すこと。

Returns
オブジェクト
Parameters
- id: string
  
  識別子
Returns null | ModelContainer | Entity
- Defined in packages/mapray/src/SceneLoader.ts:74

load

load(): Promise<void>
読み込みを実行します。

Returns Promise<void>
Inherited from Loader.load
- Defined in packages/mapray/src/Loader.ts:68