API Docs for: 0.7.0

LambertMaterial

Extends Material
Module: materials
Parent Module: xeogl

A LambertMaterial is a Material that defines the surface appearance of attached Entities 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.Entity({
   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

(
  • [scene]
  • [cfg]
)

Parameters:

  • [scene] Scene optional

    Parent Scene, creates this LambertMaterial 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.

    • [ambient=[1.0, 1.0, 1.0 ]] Array of Number optional

      LambertMaterial ambient color.

    • [color=[ 1.0, 1.0, 1.0 ]] Array of Number optional

      LambertMaterial diffuse color.

    • [emissive=[ 0.0, 0.0, 0.0 ]] Array of Number optional

      LambertMaterial emissive color.

    • [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.

Methods

create

(
  • [cfg]
)

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

()

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

hasSubs

(
  • event
)
Boolean

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

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

alpha

Number

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

The LambertMaterial's ambient color.

Default: [0.3, 0.3, 0.3]

backfaces

Boolean

Whether backfaces are visible on attached Entities.

The backfaces will belong to Geometry compoents that are also attached to the Entities.

Default: false

color

Float32Array

The LambertMaterial's diffuse color.

Default: [1.0, 1.0, 1.0]

destroyed

Boolean

True as soon as this Component has been destroyed

emissive

Float32Array

The LambertMaterial's emissive color.

Default: [0.0, 0.0, 0.0]

frontface

String

Indicates the winding direction of front faces on attached Entities.

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

Default: "ccw"

id

String final

Unique ID for this Component within its parent Scene.

isDefault

Boolean

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

lineWidth

Number

The LambertMaterial's line width.

Default: 1.0

metadata

Object

Arbitrary, user-defined metadata on this component.

pointSize

Number

The LambertMaterial's point size.

Default: 1.0

scene

Scene final

The parent Scene that contains 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.

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

Events

destroyed

Fired when this Component is destroyed.