xeogl / API Docs

API Docs for:

LambertMaterial

Extends Material
Defined in: /home/lindsay/xeolabs/xeogl-next/xeogl/src/materials/lambertMaterial.js:1
Module: materials
Parent Module: xeogl

A LambertMaterial is a Material that defines the surface appearance of attached Meshes using the non-physically based Lambertian model for calculating reflectance.

Examples

TODO

Overview

  • Used for rendering non-realistic objects such as "helpers", wireframe objects, labels etc.
  • Use PhongMaterial when you need specular highlights.
  • Use the physically based MetallicMaterial or SpecularMaterial when you need more realism.

For LambertMaterial, the illumination calculation is performed at each triangle vertex, and the resulting color is interpolated across the face of the triangle. For PhongMaterial, MetallicMaterial and SpecularMaterial, vertex normals are interpolated across the surface of the triangle, and the illumination calculation is performed at each texel.

The following table summarizes LambertMaterial properties:

Property Type Range Default Value Space Description
ambient Array [0, 1] for all components [1,1,1,1] linear The RGB components of the ambient light reflected by the material.
color Array [0, 1] for all components [1,1,1,1] linear The RGB components of the diffuse light reflected by the material.
emissive Array [0, 1] for all components [0,0,0] linear The RGB components of the light emitted by the material.
alpha Number [0, 1] 1 linear The transparency of the material surface (0 fully transparent, 1 fully opaque).
lineWidth Number [0..100] 1 Line width in pixels.
pointSize Number [0..100] 1 Point size in pixels.
backfaces Boolean false Whether to render Geometry backfaces.
backfaces String "ccw", "cw" "ccw" The winding order for Geometry frontfaces - "cw" for clockwise, or "ccw" for counter-clockwise.

Usage

var torus = new xeogl.Mesh({
   material: new xeogl.LambertMaterial({
       ambient: [0.3, 0.3, 0.3],
       color: [0.5, 0.5, 0.0],
       alpha: 1.0 // Default
   }),

   geometry: new xeogl.TorusGeometry()
});

Constructor

LambertMaterial

(
  • [owner]
  • [cfg]
  • [cfg.ambient=[1.0,
  • [cfg.color=[
  • [cfg.emissive=[
)

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/materials/lambertMaterial.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 LambertMaterial configuration

    • [id] String optional

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

    • [meta=null] String:Object optional

      Metadata to attach to this LambertMaterial.

    • [alpha=1] Number optional

      Scalar in range 0-1 that controls alpha, where 0 is completely transparent and 1 is completely opaque.

    • [reflectivity=1] Number optional

      Scalar in range 0-1 that controls how much CubeMap is reflected.

    • [lineWidth=1] Number optional

      Scalar that controls the width of lines for Geometry with primitive set to "lines".

    • [pointSize=1] Number optional

      Scalar that controls the size of points for Geometry with primitive set to "points".

    • [backfaces=false] Boolean optional

      Whether to render Geometry backfaces.

    • [frontface="ccw"] Boolean optional

      The winding order for Geometry front faces - "cw" for clockwise, or "ccw" for counter-clockwise.

  • [cfg.ambient=[1.0, Array of Number

    1.0, 1.0 ]] LambertMaterial ambient color.

  • [cfg.color=[ Array of Number

    1.0, 1.0, 1.0 ]] LambertMaterial diffuse color.

  • [cfg.emissive=[ Array of Number

    0.0, 0.0, 0.0 ]] LambertMaterial emissive color.

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

alpha

Number

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/materials/lambertMaterial.js:209

Factor in the range [0..1] indicating how transparent the LambertMaterial is.

A value of 0.0 indicates fully transparent, 1.0 is fully opaque.

Default: 1.0

ambient

Float32Array

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/materials/lambertMaterial.js:118

The LambertMaterial's ambient color.

Default: [0.3, 0.3, 0.3]

backfaces

Boolean

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/materials/lambertMaterial.js:267

Whether backfaces are visible on attached Meshes.

The backfaces will belong to Geometry components that are also attached to the Meshes.

Default: false

color

Float32Array

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/materials/lambertMaterial.js:149

The LambertMaterial's diffuse color.

Default: [1.0, 1.0, 1.0]

destroyed

Boolean

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

True as soon as this Component has been destroyed

emissive

Float32Array

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/materials/lambertMaterial.js:179

The LambertMaterial's emissive color.

Default: [0.0, 0.0, 0.0]

frontface

String

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/materials/lambertMaterial.js:290

Indicates the winding direction of front faces on attached Meshes.

The faces will belong to Geometry components that are also attached to the Meshes.

Default: "ccw"

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.

lineWidth

Number

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/materials/lambertMaterial.js:234

The LambertMaterial's line width.

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.

pointSize

Number

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/materials/lambertMaterial.js:251

The LambertMaterial's point size.

Default: 1.0

scene

Scene final

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

The parent Scene that contains this Component.

type

String final

Inherited from Component but overwritten in /home/lindsay/xeolabs/xeogl-next/xeogl/src/materials/lambertMaterial.js:77

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.