Class PebbleScene

Index

Constructors

Properties

_camera _debug _debugCamera _gridHelper _objects _paused _renderer clock onAnimate? threeScene

Accessors

camera debug debugCamera objects paused renderer scene

Methods

assignCamera dispose initializeObjects instantiate loadScene removeObject renderScene reset setOnAnimate start startObj togglePause

Constructors

constructor

new PebbleScene(__namedParameters): PebbleScene
Parameters
- __namedParameters: {
  renderer: Pick<Renderer, "domElement">;
  scene: Pick<Scene, "type">;
  }
  - renderer: Pick<Renderer, "domElement">
  - scene: Pick<Scene, "type">
Returns PebbleScene
- Defined in packages/pebble/core/src/scene.ts:48

Properties

`Private` _camera

_camera: undefined | Camera

`Private` _debug

_debug: boolean = false

`Private` _debugCamera

_debugCamera: Camera

`Private` _gridHelper

_gridHelper: InfiniteGridHelper

`Private` _objects

_objects: BaseObject<any>[]

`Private` _paused

_paused: boolean = false

`Private` _renderer

_renderer: Renderer

`Private` clock

clock: Clock

`Private` `Optional` onAnimate

onAnimate?: (() => void)

Type declaration

- (): void
- Returns void

`Private` threeScene

threeScene: Scene

Accessors

camera

get camera(): undefined | Camera
Returns undefined | Camera
- Defined in packages/pebble/core/src/scene.ts:25

debug

get debug(): boolean
Returns boolean
- Defined in packages/pebble/core/src/scene.ts:36
set debug(value): void
Parameters
- value: boolean
Returns void
- Defined in packages/pebble/core/src/scene.ts:40

debugCamera

get debugCamera(): Camera
Returns Camera
- Defined in packages/pebble/core/src/scene.ts:29

objects

get objects(): BaseObject<any>[]
Returns BaseObject<any>[]
- Defined in packages/pebble/core/src/scene.ts:170

paused

get paused(): boolean
Returns boolean
- Defined in packages/pebble/core/src/scene.ts:182
set paused(value): void
Parameters
- value: boolean
Returns void
- Defined in packages/pebble/core/src/scene.ts:17

renderer

get renderer(): Renderer
Returns Renderer
- Defined in packages/pebble/core/src/scene.ts:21

scene

get scene(): Scene
Returns Scene
- Defined in packages/pebble/core/src/scene.ts:32

Methods

`Private` assignCamera

assignCamera(): void
Returns void
- Defined in packages/pebble/core/src/scene.ts:116

dispose

dispose(): void
Returns void
- Defined in packages/pebble/core/src/scene.ts:244

initializeObjects

initializeObjects(initialObjects): void
Parameters
- initialObjects: BaseObject<any>[]
Returns void
- Defined in packages/pebble/core/src/scene.ts:150

instantiate

instantiate(obj): Promise<void>
Parameters
- obj: BaseObject<any>
Returns Promise<void>
- Defined in packages/pebble/core/src/scene.ts:122

loadScene

loadScene(__namedParameters): Promise<void>
Parameters
- __namedParameters: {
  prefabs: Record<string, typeof BaseObject>;
  sceneData: Scene;
  }
  - prefabs: Record<string, typeof BaseObject>
  - sceneData: Scene
Returns Promise<void>
- Defined in packages/pebble/core/src/scene.ts:78

removeObject

removeObject(obj): void
Parameters
- obj: BaseObject<any>
Returns void
- Defined in packages/pebble/core/src/scene.ts:174

`Private` renderScene

renderScene(): void
Returns void
- Defined in packages/pebble/core/src/scene.ts:190

reset

reset(): void
Returns void
- Defined in packages/pebble/core/src/scene.ts:223

setOnAnimate

setOnAnimate(onAnimate): void
Parameters
- onAnimate: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in packages/pebble/core/src/scene.ts:44

start

start(): void
Returns void
- Defined in packages/pebble/core/src/scene.ts:143

startObj

startObj(obj): void
Parameters
- obj: BaseObject<any>
Returns void
- Defined in packages/pebble/core/src/scene.ts:135

togglePause

togglePause(): void
Returns void
- Defined in packages/pebble/core/src/scene.ts:186

Generated using TypeDoc