xeogl / API Docs

API Docs for:

DirLight

Extends Component
Defined in: /home/lindsay/xeolabs/xeogl-next/xeogl/src/lighting/dirLight.js:1
Module: lighting
Parent Module: xeogl

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

Overview

  • 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.
  • AmbientLight, DirLight, SpotLight and PointLight instances are registered by ID on Scene#lights for convenient access.

Examples

Usage

In the example below we'll customize the default Scene's light sources, defining an AmbientLight and a couple of DirLights, then create a Phong-shaded box mesh.

new xeogl.AmbientLight({
       color: [0.8, 0.8, 0.8],
       intensity: 0.5
    });

new xeogl.DirLight({
       dir: [1, 1, 1],     // Direction the light is shining in
       color: [0.5, 0.7, 0.5],
       intensity: 1.0,
       space: "view",      // Other option is "world", for World-space
       shadow: false       // Default
    });

new xeogl.DirLight({
       dir: [0.2, -0.8, 0.8],
       color: [0.8, 0.8, 0.8],
       intensity: 0.5,
       space: "view",
       shadow: false
    });

// Create box mesh
new xeogl.Mesh({
   material: new xeogl.PhongMaterial({
       ambient: [0.5, 0.5, 0.5],
       diffuse: [1,0.3,0.3]
   }),
   geometry: new xeogl.BoxGeometry()
});

Constructor

DirLight

(
  • [owner]
  • [cfg]
  • [cfg.dir=[1.0,
  • [cfg.color=[0.7,
  • [cfg.intensity=1.0
)

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/lighting/dirLight.js:1

Parameters:

  • [owner] Component optional

    Owner component. When destroyed, the owner will destroy this component as well. Creates this component 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.

    • [space="view"] String optional

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

    • [shadow=false] Boolean optional

      Flag which indicates if this DirLight casts a shadow.

  • [cfg.dir=[1.0, Float32Array

    1.0, 1.0]] 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.

  • [cfg.color=[0.7, Float32Array

    0.7, 0.8 ]] The color of this DirLight.

  • [cfg.intensity=1.0 Number

    ] The intensity of this DirLight, as a factor in range [0..1].

Methods

create

(
  • [cfg]
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:896

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

The method is given a component configuration, like so:

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

Parameters:

  • [cfg] optional

    Configuration for the component instance.

Returns:

:

destroy

()

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:1005

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
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:583

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]
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:407

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

hasSubs

(
  • event
)
Boolean

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:534

Returns true if there are any subscribers to the given event on this component.

Parameters:

  • event String

    The event

Returns:

Boolean:

True if there are any subscribers to the given event on this component.

isType

(
  • type
)
Boolean

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:371

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 Component/superTypes:property, 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.Mesh); // Returns false, because xeogl.Rotate does not (even indirectly) extend xeogl.Mesh

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
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:545

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

(
  • subId
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:488

Cancels an event subscription that was previously made with Component#on() or Component#once().

Parameters:

  • subId String

    Publication subId

on

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

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:446

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]
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:513

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

This is equivalent to calling Component#on(), and then calling Component#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
)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:566

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

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/lighting/dirLight.js:179

The color of this DirLight.

Default: [0.7, 0.7, 0.8]

destroyed

Boolean

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:316

True as soon as this Component has been destroyed

dir

Float32Array

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/lighting/dirLight.js:162

The direction in which the light is shining.

Default: [1.0, 1.0, 1.0]

id

String final

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:307

Unique ID for this Component within its parent Scene.

intensity

Number

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/lighting/dirLight.js:195

The intensity of this DirLight.

Fires a DirLight/intensity:event event on change.

Default: 1.0

metadata

Object

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:299

Arbitrary, user-defined metadata on this component.

model

Model final

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:358

The Model which contains this Component, if any.

Will be null if this Component is not in a Model.

scene

Scene final

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:250

The parent Scene that contains this Component.

shadow

Boolean

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/lighting/dirLight.js:214

Flag which indicates if this DirLight casts a shadow.

Default: false

type

String final

Inherited from Component but overwritten in /home/lindsay/xeolabs/xeogl-next/xeogl/src/lighting/dirLight.js:86

JavaScript class name for this Component.

For example: "xeogl.AmbientLight", "xeogl.MetallicMaterial" etc.

Events

destroyed

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:1073

Fired when this Component is destroyed.