API Docs for: 0.7.0

StereoEffect

Extends Entity
Module: effects
Parent Module: xeogl

A StereoEffect sets up a stereo view for its Scene.

Overview

Examples

Usage

Stereo view of an Entity using the Scene's default Camera and Viewport:

// Both the Entity and the StereoEffect use their Scene's default Camera and Viewport

var entity = new xeogl.Entity({
    geometry: new xeogl.TorusGeometry()
});

var stereoEffect = new xeogl.StereoEffect({
    fov: 45, // Default
    active: true // Default
});

Constructor

StereoEffect

(
  • [scene]
  • [cfg]
)

Parameters:

  • [scene] Scene optional

    Parent Scene - creates this StereoEffect in the default Scene when omitted.

  • [cfg] optional

    Configs

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

    • [fov=45] optional

      Field-of-view angle in degrees.

    • [active=true] Boolean optional

      Whether or not this StereoEffect is active.

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

aabb

Float32Array final

World-space axis-aligned 3D boundary (AABB) of this Entity.

The AABB is represented by a six-element Float32Array containing the min/max extents of the axis-aligned volume, ie. [xmin, ymin,zmin,xmax,ymax, zmax].

active

Boolean

Flag which indicates whether this StereoEffect is active or not.

Default: true

billboard

String

Specifies the billboarding behaviour for this Entity.

Options are:

  • "none" - (default) - No billboarding.
  • "spherical" - Entity is billboarded to face the viewpoint, rotating both vertically and horizontally.
  • "cylindrical" - Entity is billboarded to face the viewpoint, rotating only about its vertically axis. Use this mode for things like trees on a landscape.

Default: "none"

castShadow

Boolean

Indicates whether this Entity casts shadows.

Default: true

center

Float32Array final

World-space 3D center of this Entity.

clippable

Boolean

Indicates whether this Entity is clippable by Clips components.

Default: true

collidable

Boolean

Indicates whether this Entity is included in boundary calculations.

Default: true

colorize

Float32Array

RGBA colorize color, multiplies by the outgoing fragment color and transparency.

Default: [1.0, 1.0, 1.0, 1.0]

culled

Boolean

Indicates whether or not this Entity is currently culled from view.

The Entity is only rendered when visible is true and culled is false.

Default: false

destroyed

Boolean

True as soon as this Component has been destroyed

fov

Number

Field-of-view angle in degrees.

Default: 45

geometry

Geometry

The Geometry attached to this Entity.

Must be within the same Scene as this Entity. Defaults to the parent Scene's default geometry (a simple box) when set to a null or undefined value.

Updates Entity/boundary, Entity/worldObb and Entity/center

ghosted

Boolean

Flag which indicates if this Entity is rendered with ghost effect.

The ghost effect is configured via the Entity's ghostMaterial.

Default: false

ghostMaterial

EmphasisMaterial

The EmphasisMaterial attached to this Entity.

Must be within the same Scene as this Entity. Defaults to the parent Scene's default ghostMaterial when set to a null or undefined value.

highlighted

Boolean

Indicates whether this Entity is highlighted.

The highlight effect is configured via the Entity's highlightMaterial.

Default: false

highlightMaterial

EmphasisMaterial

The EmphasisMaterial attached to this Entity.

Must be within the same Scene as this Entity. Defaults to the parent Scene's default highlightMaterial when set to a null or undefined value.

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.

layer

Number

Indicates this Entity's rendering order.

This can be set on multiple transparent Entities, to make them render in a specific order for correct alpha blending.

Default: 0

material

Material

The Material attached to this Entity.

Must be within the same Scene as this Entity. Defaults to the parent Scene's default material when set to a null or undefined value.

metadata

Object

Arbitrary, user-defined metadata on this component.

obb

Float32Array final

World-space oriented 3D boundary (OBB) of this Entity.

The OBB is represented by a 32-element Float32Array containing the eight vertices of the box, where each vertex is a homogeneous coordinate having [x,y,z,w] elements.

outlined

Boolean

Indicates whether this Entity is rendered with an outline.

The outline effect is configured via the Entity's outlineMaterial component.

Default: false

outlineMaterial

OutlineMaterial

The OutlineMaterial attached to this Entity.

Must be within the same Scene as this Entity. Defaults to the parent Scene's default outlineMaterial when set to a null or undefined value.

pickable

Boolean

Indicates whether this entity is pickable or not.

Picking is done via calls to Canvas/pick:method.

Default: true

receiveShadow

Boolean

Indicates whether this Entity receives shadows.

Default: true

scene

Scene final

The parent Scene that contains this Component.

selected

Boolean

Indicates whether this Entity is selected.

The selected effect is configured via the Entity's selectedMaterial.

Default: false

selectedMaterial

EmphasisMaterial

The EmphasisMaterial attached to this Entity.

Must be within the same Scene as this Entity. Defaults to the parent Scene's default selectedMaterial when set to a null or undefined value.

stationary

Boolean

Flag which indicates whether this Entity is stationary or not.

Setting this true will disable the effect of view transform translations for this Entity, while still alowing it to rotate. This is useful for skybox Entities.

Default: false

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.

transform

Transform

The Local-to-World-space (modelling) Transform attached to this Entity.

Must be within the same Scene as this Entity. Defaults to the parent Scene's default transform (an identity matrix) when set to a null or undefined value.

Updates Entity/boundary, Entity/worldObb and Entity/center

type

String final

JavaScript class name for this Component.

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

visible

Boolean

Indicates whether this Entity is visible or not.

The Entity is only rendered when visible is true and culled is false.

Default: true

worpdPositions

Float32Array final

World-space vertex positions of this Entity.

These are internally generated on-demand and cached. To free the cached vertex World positions when you're done with them, set this property to null or undefined.

Events

boundary

Fired whenever this Entity's World-space boundary changes.

Get the latest boundary from the Entity's aabb and obb properties.

destroyed

Fired when this Component is destroyed.

picked

Fired when this Entity is picked via a call to the Canvas/pick:method method on the parent Scene's Canvas.

Event Payload:

  • entityId String

    The ID of this Entity.

  • canvasX Number

    The X-axis Canvas coordinate that was picked.

  • canvasY Number

    The Y-axis Canvas coordinate that was picked.