HemisphereLight

Table of content

components/lights/ HemisphereLight

Constructor

.new HemisphereLight(paramsopt)

HemisphereLight is a light source positioned directly above the scene.
It also doesn't need position and target properties.

Source:
Parameters:
Name Type Attributes Default Description
params Object <optional>
 {light: {skyColor: 0xffffff, groundColor: 0xffffff, intensity: 1}}

The params.
Example

Creating a HemisphereLight

new HemisphereLight({
  skyColor: 0xff0000,
  groundColor: 0x0000ff,
  intensity: 0.2
}).addTo(app);

Extends module:core.LightComponent

Members

(private) ._wait :Array

Array of promises that should be resolved before Component is ready.

Inherited From:
Source:

.children :Array

Collection of child Components.

Inherited From:
Source:

.defaults :Object

Default values for parameters

Inherited From:
Default Value:
                  {
  build: true,

  shadow: {
    cast: true,

    bias: 0,
    radius: 1,

    mapSize: {
      width: 1024,
      height: 1024
    },

    camera: {
      near: true,
      far: 400,
      fov: 90,

      top: 200,
      bottom: -200,
      left: -200,
      right: 200
    }
  },

  position: {x: 0, y: 0, z: 0},
  rotation: {x: 0, y: 0, z: 0}
}
Source:

.instructions :Object

Static instructions

Inherited From:
Default Value:
                  {
  position: ['x', 'y', 'z'],
  rotation: ['x', 'y', 'z']
}
Source:

.isDeffered :Boolean

Returns whether the object is async (wait promises are more than 0).

Inherited From:
Source:

.manager :ModuleManager

Returns the ModuleManager used for this component.

Inherited From:
Source:

.modules :Array

Collection of modules.

Inherited From:
Source:

.native :Object

Returns the native object used for this component.

Inherited From:
Source:

Methods

.add(object) → {Promise}

Add a child Component.

Inherited From:
Source:
Parameters:
Name Type Description
object Component

Component that should be added as a child.

.addTo(object)

Adds this Component to specified App/Component.

Inherited From:
Source:
Parameters:
Name Type Description
object Component

Component that will be a parent of this.

.build()

Build livecycle should return a native object.

Inherited From:
Source:
Throws:
CompositionError

.clone() → {LightComponent}

Make a clone of this LightComponent using .copy()

Inherited From:
Source:

.copy() → {this}

Copy source transforms & execute Component.copy()

Inherited From:
Source:

.defer(func)

Execute func (Callback) when Component is ready.

Inherited From:
Source:
Parameters:
Name Type Description
func function

Callback.

.remove(object)

Remove a child Component.

Inherited From:
Source:
Parameters:
Name Type Description
object Component

Component that should be a child of this Component.

.updateParams() → {Object}

Updates parameters of the Component.

Inherited From:
Source:

.wait(promiseopt) → {Promise}

Wait for a promise.

Inherited From:
Source:
Parameters:
Name Type Attributes Description
promise Promise <optional>

The promise that should be added to a queue.

.wrap() → {Promise}

Wraps transforms (position & rotation)

Inherited From:
Source:

.wrapShadow()

Wraps shadow properties

Inherited From:
Source: