copper3d / Modules / Renderer/copperRendererOnDemond / copperRendererOnDemond

Class: copperRendererOnDemond ​

Renderer/copperRendererOnDemond.copperRendererOnDemond

Hierarchy ​

• baseRenderer

  ↳ copperRendererOnDemond

Table of contents ​

Constructors ​

• constructor

Properties ​

• container
• currentScene
• gui
• options
• pmremGenerator
• renderer
• running
• sceneMap
• stats

Methods ​

• addGui
• animate
• closeGui
• createScene
• dispose
• disposeScene
• getCurrentScene
• getSceneByName
• hideGui
• init
• render
• setClearColor
• setCurrentScene
• stop
• updateEnvironment
• updateGui

Constructors ​

constructor ​

• new copperRendererOnDemond(container, options?)

Parameters ​

Overrides ​

baseRenderer.constructor

Defined in ​

src/Renderer/copperRendererOnDemond.ts:13

Properties ​

container ​

• container: HTMLDivElement

Inherited from ​

baseRenderer.container

Defined in ​

src/Renderer/baseRenderer.ts:15

currentScene ​

• currentScene: baseScene

Inherited from ​

baseRenderer.currentScene

Defined in ​

src/Renderer/baseRenderer.ts:20

gui ​

• gui: null | GUI

Inherited from ​

baseRenderer.gui

Defined in ​

src/Renderer/baseRenderer.ts:17

options ​

• options: undefined | ICopperRenderOpt

Inherited from ​

baseRenderer.options

Defined in ​

src/Renderer/baseRenderer.ts:23

pmremGenerator ​

• pmremGenerator: PMREMGenerator

Inherited from ​

baseRenderer.pmremGenerator

Defined in ​

src/Renderer/baseRenderer.ts:21

renderer ​

• renderer: WebGLRenderer

Inherited from ​

baseRenderer.renderer

Defined in ​

src/Renderer/baseRenderer.ts:16

running ​

• Protected running: boolean = true

Inherited from ​

baseRenderer.running

Defined in ​

src/Renderer/baseRenderer.ts:24

sceneMap ​

• sceneMap: SceneMapType = {}

Public so disposeScene can unregister an entry. Nothing else removes one, so a long-lived renderer otherwise accumulates every scene it has ever built, decoded volumes included.

Defined in ​

src/Renderer/copperRendererOnDemond.ts:12

stats ​

• stats: Stats

Inherited from ​

baseRenderer.stats

Defined in ​

src/Renderer/baseRenderer.ts:18

Methods ​

addGui ​

▸ addGui(): void

Returns ​

void

Inherited from ​

baseRenderer.addGui

Defined in ​

src/Renderer/baseRenderer.ts:163

animate ​

▸ animate(): void

Returns ​

void

Defined in ​

src/Renderer/copperRendererOnDemond.ts:67

closeGui ​

▸ closeGui(): void

Returns ​

void

Inherited from ​

baseRenderer.closeGui

Defined in ​

src/Renderer/baseRenderer.ts:136

createScene ​

▸ createScene(name, opt?): undefined | copperSceneOnDemond

opt is per-scene and new in 3.9.0 -- { controls: "copper3d" } builds the scene with Copper3dTrackballControls instead of the default OrbitControls. Omit it for exactly the previous behaviour.

Deliberately a parameter rather than a read of this renderer's own options.controls: that option has never had any effect on on-demand scenes, so honouring it now would swap the controls under anyone who set it and never noticed.

Parameters ​

Returns ​

undefined | copperSceneOnDemond

Defined in ​

src/Renderer/copperRendererOnDemond.ts:51

dispose ​

▸ dispose(): void

Returns ​

void

Inherited from ​

baseRenderer.dispose

Defined in ​

src/Renderer/baseRenderer.ts:151

disposeScene ​

▸ disposeScene(name): undefined | DisposableScene

Unregisters a scene and frees its geometries, materials and textures. Returns the scene that was disposed, or undefined if there was none.

Parameters ​

Returns ​

undefined | DisposableScene

Defined in ​

src/Renderer/copperRendererOnDemond.ts:25

getCurrentScene ​

▸ getCurrentScene(): baseScene

Returns ​

baseScene

Inherited from ​

baseRenderer.getCurrentScene

Defined in ​

src/Renderer/baseRenderer.ts:130

getSceneByName ​

▸ getSceneByName(name): copperScene | baseScene | copperMScene

Parameters ​

Returns ​

copperScene | baseScene | copperMScene

Defined in ​

src/Renderer/copperRendererOnDemond.ts:17

hideGui ​

▸ hideGui(): void

Returns ​

void

Inherited from ​

baseRenderer.hideGui

Defined in ​

src/Renderer/baseRenderer.ts:133

init ​

▸ init(): void

Returns ​

void

Inherited from ​

baseRenderer.init

Defined in ​

src/Renderer/baseRenderer.ts:86

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Renderer/copperRendererOnDemond.ts:72

setClearColor ​

▸ setClearColor(clearColor?, alpha?): void

Parameters ​

Returns ​

void

Inherited from ​

baseRenderer.setClearColor

Defined in ​

src/Renderer/baseRenderer.ts:140

setCurrentScene ​

▸ setCurrentScene(sceneIn): void

Parameters ​

Returns ​

void

Defined in ​

src/Renderer/copperRendererOnDemond.ts:32

stop ​

▸ stop(): void

Returns ​

void

Inherited from ​

baseRenderer.stop

Defined in ​

src/Renderer/baseRenderer.ts:145

updateEnvironment ​

▸ updateEnvironment(vignette?): void

Parameters ​

Returns ​

void

Inherited from ​

baseRenderer.updateEnvironment

Defined in ​

src/Renderer/baseRenderer.ts:98

updateGui ​

▸ updateGui(): void

Returns ​

void

Inherited from ​

baseRenderer.updateGui

Defined in ​

src/Renderer/baseRenderer.ts:221