API Docs for: 1.0.0

DirLight

Extends Component
Module: lighting
Parent Module: xeogl

A DirLight is a directional light source that illuminates all attached Entities equally from a given direction.

Overview

  • DirLights are grouped, along with other light source types, within Lights components, which are attached to Entities.
  • DirLights have a direction, but no position.
  • The direction is the direction that the light is emitted in.
  • DirLights may be defined in either World or View coordinate space. When in World-space, their direction is relative to the World coordinate system, and will appear to move as the Camera moves. When in View-space, their direction is relative to the View coordinate system, and will behave as if fixed to the viewer's head as the Camera moves.
  • A DirLight can also have a Shadow component, to configure it to cast a shadow.

Examples

Usage

var entity = new xeogl.Entity({

   lights: new xeogl.Lights({
       lights: [
           new xeogl.DirLight({

               // Note that this is the direction the light is shining,
               // not the direction to the light source

               dir:         [1, 1, 1],
               color:       [0.5, 0.7, 0.5],
               intensity:   1.0,
               space:      "view"  // Other option is "world", for World-space
           })
       ]
   }),

   material: new xeogl.PhongMaterial({
       ambient:    [0.3, 0.3, 0.3],
       diffuse:    [0.7, 0.7, 0.7],
       specular:   [1. 1, 1],
       shininess:  30
   }),

   geometry: new xeogl.BoxGeometry()
});

Constructor

DirLight

(
  • [scene]
  • [cfg]
)

Parameters:

  • [scene] Scene optional

    Parent Scene, creates this DirLight within the default Scene when omitted

  • [cfg] optional

    The DirLight configuration

    • [id] String optional

      Optional ID, unique among all components in the parent Scene, generated automatically when omitted.

    • [meta] String:Object optional

      Optional map of user-defined metadata to attach to this DirLight.

    • [dir=[1.0, 1.0, 1.0]] Float32Array optional

      A unit vector indicating the direction that the light is shining, given in either World or View space, depending on the value of the space parameter.

    • [color=[0.7, 0.7, 0.8 ]] Float32Array optional

      The color of this DirLight.

    • [intensity=1.0] Number optional

      The intensity of this DirLight.

    • [space="view"] String optional

      The coordinate system the DirLight is defined in - "view" or "space".

    • [shadow=undefined] Shadow optional

      Defines a Shadow that is cast by this DirLight. Must be within the same Scene as this DirLight.

Methods

create

(
  • [cfg]
  • [instanceId]
)

Convenience method for creating a Component within this Component's Scene.

You would typically use this method to conveniently instantiate components that you'd want to share (ie. "instance") among your Entities.

The method is given a component type, configuration and optional instance ID, like so:

var material = myComponent.create(xeogl.PhongMaterial, {
     diffuse: [1,0,0],
     specular: [1,1,0]
}, "myMaterial");

The first time you call this method for the given type and instanceId, this method will create the PhongMaterial, passing the given attributes to the component's constructor.

If you call this method again, specifying the same type and instanceId, the method will return the same component instance that it returned the first time, and will ignore the configuration:

var material2 = component.create(xeogl.PhongMaterial, { specular: [1,1,0] }, "myMaterial");

So in this example, our PhongMaterial will continue to have the red specular and diffuse color that we specified the first time.

Each time you call this method with the same type and instanceId, the Scene will internally increment a reference count for the component instance. You can release the shared component instance with a call to Scene/putSharedComponent:method, and once you have released it as many times as you got it, the Scene will destroy the component.

Parameters:

  • [cfg] optional

    Configuration for the component instance - only used if this is the first time you are getting the component, ignored when reusing an existing instance.

  • [instanceId] String | Number optional

    Identifies the shared component instance. Note that this is not used as the ID of the component - you can specify the component ID in the cfg parameter.

Returns:

:

destroy

()

Destroys this component.

Fires a destroyed event on this Component.

Automatically disassociates this component from other components, causing them to fall back on any defaults that this component overrode on them.

TODO: describe effect with respect to #create

error

(
  • message
)

Logs an error for this component to the JavaScript console.

The console message will have this format: [ERROR] [<component type> =<component id>: <message>

Also fires the message as an error event on the parent Scene.

Parameters:

  • message String

    The message to log

fire

(
  • event
  • value
  • [forget=false]
)

Fires an event on this component.

Notifies existing subscribers to the event, optionally retains the event to give to any subsequent notifications on the event as they are made.

Parameters:

  • event String

    The event type name

  • value Object

    The event parameters

  • [forget=false] Boolean optional

    When true, does not retain for subsequent subscribers

isType

(
  • type
)
Boolean

Tests if this component is of the given type, or is a subclass of the given type.

The type may be given as either a string or a component constructor.

This method works by walking up the inheritance type chain, which this component provides in property superTypes, returning true as soon as one of the type strings in the chain matches the given type, of false if none match.

Examples:

var myRotate = new xeogl.Rotate({ ... });

myRotate.isType(xeogl.Component); // Returns true for all xeogl components
myRotate.isType("xeogl.Component"); // Returns true for all xeogl components
myRotate.isType(xeogl.Rotate); // Returns true
myRotate.isType(xeogl.Transform); // Returns true
myRotate.isType("xeogl.Transform"); // Returns true
myRotate.isType(xeogl.Entity); // Returns false, because xeogl.Rotate does not (even indirectly) extend xeogl.Entity

Parameters:

  • type String | Function

    Component type to compare with, eg "xeogl.PhongMaterial", or a xeogl component constructor.

Returns:

Boolean:

True if this component is of given type or is subclass of the given type.

log

(
  • message
)

Logs a console debugging message for this component.

The console message will have this format: [LOG] [<component type> <component id>: <message>

Also fires the message as a log event on the parent Scene.

Parameters:

  • message String

    The message to log

off

(
  • handle
)

Cancels an event subscription that was previously made with on or once.

Parameters:

  • handle String

    Publication handle

on

(
  • event
  • callback
  • [scope=this]
)
String

Subscribes to an event on this component.

The callback is be called with this component as scope.

Parameters:

  • event String

    The event

  • callback Function

    Called fired on the event

  • [scope=this] Object optional

    Scope for the callback

Returns:

String:

Handle to the subscription, which may be used to unsubscribe with {@link #off}.

once

(
  • event
  • callback
  • [scope=this]
)

Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is handled.

This is equivalent to calling on, and then calling off inside the callback function.

Parameters:

  • event String

    Data event to listen to

  • callback Function(data)

    Called when fresh data is available at the event

  • [scope=this] Object optional

    Scope for the callback

warn

(
  • message
)

Logs a warning for this component to the JavaScript console.

The console message will have this format: [WARN] [<component type> =<component id>: <message>

Also fires the message as a warn event on the parent Scene.

Parameters:

  • message String

    The message to log

Properties

color

Float32Array

The color of this DirLight.

Fires a color event on change.

Default: [0.7, 0.7, 0.8]

destroyed

Boolean

True as soon as this Component has been destroyed

dir

Float32Array

The direction in which the light is shining.

Fires a dir event on change.

Default: [1.0, 1.0, 1.0]

id

String final

Unique ID for this Component within its parent Scene.

intensity

Number

The intensity of this DirLight.

Fires a intensity event on change.

Default: 1.0

isDefault

Boolean

Indicates whether this is one of the Scene's built-in Components.

json

JSON final

JSON object containing the state of this Component.

metadata

Object

Arbitrary, user-defined metadata on this component.

scene

Scene final

The parent Scene that contains this Component.

shadow

Shadow

Defines a Shadow that is cast by this DirLight. Must be within the same Scene as this DirLight. Fires a shadow event on change.

Default: undefined

space

String

Specifies which coordinate space this DirLight is in.

Supported values are:

  • "view" - View space, aligned within the view volume as if fixed to the viewer's head
  • "world" - World space, fixed within the world, moving within the view volume with respect to camera

Fires a space event on change.

Default: "view"

string

String final

Inherited from Component but overwritten in src/component.js:1056

String containing the serialized JSON state of this Component.

superTypes

Array of String final

An array of strings that indicates the chain of super-types within this component's inheritance hierarchy.

For example, if this component is a Rotate, which extends Transform, which in turn extends Component, then this property will have the value:

["xeogl.Component", "xeogl.Transform"]
                    

Note that the chain is ordered downwards in the hierarchy, ie. from super-class down towards sub-class.

type

String final

JavaScript class name for this Component.

This is used when loading Scenes from JSON, and is included in the JSON representation of this Component, so that this class may be instantiated when loading it from the JSON representation.

For example: "xeogl.AmbientLight", "xeogl.ColorTarget", "xeogl.Lights" etc.

Events

color

Fired whenever this DirLight's color property changes.

Event Payload:

  • value Object

    The property's new value

destroyed

Fired when this Component is destroyed.

dir

Fired whenever this DirLight's dir property changes.

Event Payload:

  • value Object

    The property's new value

intensity

Fired whenever this DirLight's intensity property changes.

Event Payload:

  • value Object

    The property's new value

shadow

Fired whenever this DirLight's shadow property changes.

Event Payload:

  • value Object

    Number The property's new value

space

Fired whenever this DirLight's space property changes.

Event Payload:

  • value Object

    The property's new value