copper3d / Modules / Renderer/copperRenderer / copperRenderer

Class: copperRenderer ​

Renderer/copperRenderer.copperRenderer

Hierarchy ​

• baseRenderer

  ↳ copperRenderer

Table of contents ​

Constructors ​

• constructor

Properties ​

• container
• currentScene
• delta
• fps
• gui
• interval
• options
• pmremGenerator
• preRenderCallbackFunctions
• renderClock
• renderer
• running
• sceneMap
• stats

Methods ​

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

Constructors ​

constructor ​

• new copperRenderer(container, options?)

Parameters ​

Overrides ​

baseRenderer.constructor

Defined in ​

src/Renderer/copperRenderer.ts:19

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

delta ​

• Private delta: number = 0

Defined in ​

src/Renderer/copperRenderer.ts:14

fps ​

• Private fps: number = 30

Defined in ​

src/Renderer/copperRenderer.ts:12

gui ​

• gui: null | GUI

Inherited from ​

baseRenderer.gui

Defined in ​

src/Renderer/baseRenderer.ts:17

interval ​

• Private interval: number

Defined in ​

src/Renderer/copperRenderer.ts:15

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

preRenderCallbackFunctions ​

• preRenderCallbackFunctions: Function[] = []

Defined in ​

src/Renderer/copperRenderer.ts:17

renderClock ​

• Private renderClock: Clock

Defined in ​

src/Renderer/copperRenderer.ts:13

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 ​

• Private sceneMap: SceneMapType = {}

Defined in ​

src/Renderer/copperRenderer.ts:11

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

addPreRenderCallbackFunction ​

▸ addPreRenderCallbackFunction(callbackFunction): void

Parameters ​

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:60

animate ​

▸ animate(time?): void

Parameters ​

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:66

closeGui ​

▸ closeGui(): void

Returns ​

void

Inherited from ​

baseRenderer.closeGui

Defined in ​

src/Renderer/baseRenderer.ts:136

createScene ​

▸ createScene(name): undefined | copperScene

Parameters ​

Returns ​

undefined | copperScene

Defined in ​

src/Renderer/copperRenderer.ts:41

dispose ​

▸ dispose(): void

Returns ​

void

Inherited from ​

baseRenderer.dispose

Defined in ​

src/Renderer/baseRenderer.ts:151

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/copperRenderer.ts:23

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

onWindowResize ​

▸ onWindowResize(): void

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:64

render ​

▸ render(): void

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:92

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/copperRenderer.ts:31

setFPS ​

▸ setFPS(fps): void

Parameters ​

Returns ​

void

Defined in ​

src/Renderer/copperRenderer.ts:27

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