API Docs for: 0.2.0
Show:

Scene Class

Defined in: src\scenes\Scene.js:1
Module: LE

The Scene class contains the objects that are rendered with the WebGLRenderer

Constructor

Scene

(
  • [parameters]
)

Defined in src\scenes\Scene.js:1

Parameters:

  • [parameters] Object optional

    Parameters is an object that contains the Scenes properties

    • [ambientLight=new LE.AmbientLight(new LE.Colour(255, 255, 255, 255))] AmbientLight optional

      Default value is an ambient light with maximum brightness.

Methods

addLight

(
  • light
)

Defined in src\scenes\Scene.js:469

Adds a PointLight, DirectionalLight or RadialPointLight to the scene

Parameters:

  • light Object

addObject

(
  • object
)

Defined in src\scenes\Scene.js:507

Adds a Polygon or Texture to the scene. This object will not cast shadows

Parameters:

  • object Object

addShadowObject

(
  • object
)

Defined in src\scenes\Scene.js:485

Adds a Polygon or Texture to the scene. This object will cast shadows

Parameters:

  • object Object

assignTextureIndices

(
  • array
  • i
)
private

Defined in src\scenes\Scene.js:351

Assigns a texture index to an object

Parameters:

  • array Array
  • i Number

    Index in the given array

comparePolygons

(
  • object1
  • object2
)
private

Defined in src\scenes\Scene.js:239

Checks if a given polygon is equal to another polygon

Parameters:

  • object1 Object
  • object2 Object

handleLoadedTexture

(
  • texture
)
private

Defined in src\scenes\Scene.js:392

Prepares the loaded texture for WebGL use

Parameters:

  • texture Object

init

(
  • gl
)
private

Defined in src\scenes\Scene.js:123

Initialise the scene with a WebGL context

Parameters:

  • gl Object

initBuffers

(
  • gl
)
private

Defined in src\scenes\Scene.js:136

Initialise all buffers, this includes object, texture and light buffers

Parameters:

  • gl Object

initLightBuffer

(
  • array
  • i
)
private

Defined in src\scenes\Scene.js:410

Initialise a light buffer

Parameters:

  • array Array
  • i Number

    Index in the given array

initPolygonBuffer

(
  • array
  • i
)
private

Defined in src\scenes\Scene.js:276

Initialise a polygon buffer

Parameters:

  • array Array
  • i Number

    Index in the given array

initTextureBuffer

(
  • array
  • i
)
private

Defined in src\scenes\Scene.js:179

Initialise a texture buffer

Parameters:

  • array Array
  • i Number

    Index in the given array

initTextures

() private

Defined in src\scenes\Scene.js:331

Initialises all textures

removeLight

(
  • light
)

Defined in src\scenes\Scene.js:529

Removes a PointLight, DirectionalLight or RadialPointLight from the scene

Parameters:

  • light Object

removeObject

(
  • object
)

Defined in src\scenes\Scene.js:555

Removes a Polygon or Texture from the scene. This object does not cast shadows

Parameters:

  • object Object

removeShadowObject

(
  • object
)

Defined in src\scenes\Scene.js:542

Removes a Polygon or Texture from the scene. This object casts shadows

Parameters:

  • object Object

Properties

ambientLight

AmbientLight

Defined in src\scenes\Scene.js:47

Stores the ambient light

Default: new LE.AmbientLight(new LE.Colour(255, 255, 255, 255))

gl

Object private

Defined in src\scenes\Scene.js:15

Stores a reference to the WebGL canvas context

lightBuffers

Array private

Defined in src\scenes\Scene.js:97

Stores all the WebGL light vertex buffers

lights

Array private

Defined in src\scenes\Scene.js:23

Stores the lights

objectBuffers

Array private

Defined in src\scenes\Scene.js:65

Stores all the WebGL vertex buffers

objectColourBuffers

Array private

Defined in src\scenes\Scene.js:73

Stores all the WebGL colour vertex buffers

objectIndexBuffers

Array private

Defined in src\scenes\Scene.js:81

Stores all the WebGL object indices

objects

Array private

Defined in src\scenes\Scene.js:39

Stores the objects that do not cast shadows

objectTextureBuffers

Array private

Defined in src\scenes\Scene.js:89

Stores all the WebGL texture vertex buffers

shadowBuffers

Array private

Defined in src\scenes\Scene.js:105

Stores all the WebGL shadow vertex buffers

shadowColourBuffers

Array private

Defined in src\scenes\Scene.js:113

Stores all the WebGL shadow colour vertex buffers

shadowObjects

Array private

Defined in src\scenes\Scene.js:31

Stores the objects that cast shadows

textures

Array private

Defined in src\scenes\Scene.js:55

Stores all the texture data to be rendered by WebGL