API Docs for:

StereoEffect

A StereoEffect sets up a stereo view for its Scene.

Overview

Examples

Usage

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

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

var mesh = new xeogl.Mesh({
    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 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
)

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
)

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

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

removeChild

(
  • object
)

Removes the given child.

Parameters:

  • object Object

    Child to remove.

removeChildren

()

Removes all children.

rotate

(
  • angle
)

Rotates about the given local axis by the given increment.

Parameters:

  • angle Number

    Angle increment in degrees.

rotateX

(
  • angle
)

Rotates about the local X-axis by the given increment.

Parameters:

  • angle Number

    Angle increment in degrees.

rotateY

(
  • angle
)

Rotates about the local Y-axis by the given increment.

Parameters:

  • angle Number

    Angle increment in degrees.

rotateZ

(
  • angle
)

Rotates about the local Z-axis by the given increment.

Parameters:

  • angle Number

    Angle increment in degrees.

translate

(
  • axis
  • distance
)

Translates along local space vector by the given increment.

Parameters:

  • axis Float32Array

    Normalized local space 3D vector along which to translate.

  • distance Number

    Distance to translate along the vector.

translateX

(
  • distance
)

Translates along the local X-axis by the given increment.

Parameters:

  • distance Number

    Distance to translate along the X-axis.

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 3D axis-aligned bounding box (AABB).

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

aabbVisible

Boolean

Indicates if the 3D World-space axis-aligned bounding box (AABB) is visible.

Default: false

active

Boolean

Flag which indicates whether this StereoEffect is active or not.

Default: true

billboard

String final

Indicates the billboarding behaviour.

Options are:

  • "none" - (default) - No billboarding.
  • "spherical" - Mesh is billboarded to face the viewpoint, rotating both vertically and horizontally.
  • "cylindrical" - Mesh 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 if casting shadows.

Default: true

center

Float32Array final

World-space 3D center.

childIDs

Array final

IDs of child Objects.

childMap

final

Child Objects mapped to their IDs.

children

Array final

Array of child Objects.

clippable

Boolean

Indicates if clippable.

When false, the Scene's Clips will have no effect on the Mesh.

Default: true

collidable

Boolean

Indicates if included in boundary calculations.

When false, this Mesh will not be included in the bounding boxes provided by parent components (

Default: true

colorize

Float32Array

RGB colorize color, multiplies by the rendered fragment colors.

Default: [1.0, 1.0, 1.0]

culled

Boolean

Indicates if culled from view.

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

Default: false

destroyed

Boolean

True as soon as this Component has been destroyed

edgeMaterial

EdgeMaterial

Defines surface appearance when edges are shown.

edges

Boolean

Indicates if edges are shown.

The edges appearance is configured by edgeMaterial.

Default: false

entityType

String final

Optional entity classification when using within a semantic data model.

See the Object documentation on "Applying a semantic data model" for usage.

Default: null

fov

Number

Field-of-view angle in degrees.

Default: 45

geometry

Geometry final

Defines the shape of this Mesh.

ghosted

Boolean

Indicates if ghosted.

The ghosted appearance is configured by ghostMaterial.

Each ghosted Mesh is registered in its Scene's ghostedEntities map when its entityType is set to a value.

Default: false

ghostMaterial

EmphasisMaterial final

Defines surface appearance when ghosted.

guid

String final

Globally unique identifier.

This is unique not only within the Scene, but throughout the entire universe.

Only defined when given to the constructor.

highlighted

Boolean

Indicates if highlighted.

The highlight appearance is configured by highlightMaterial.

Each highlighted Mesh is registered in its Scene's highlightedEntities map when its entityType is set to a value.

Default: false

highlightMaterial

EmphasisMaterial final

Defines surface appearance when highlighted.

id

String final

Unique ID for this Component within its parent Scene.

layer

Number

The rendering order.

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

Default: 0

material

Material final

Defines appearance when rendering normally, ie. when not ghosted, highlighted or selected.

matrix

Float32Array

Local matrix.

Default: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]

metadata

Object

Arbitrary, user-defined metadata on this component.

model

Model final

The Model which contains this Component, if any.

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

numChildren

Number final

Number of child Objects.

opacity

Number

Opacity factor, multiplies by the rendered fragment alpha.

This is a factor in range [0..1].

Default: 1.0

outlined

Boolean

Indicates if rendered with an outline.

The outline appearance is configured by outlineMaterial.

Default: false

outlineMaterial

OutlineMaterial

Defines surface appearance when outlined.

parent

Group

The parent.

The parent Group may also be set by passing the Object to the Group/Model's Group/addChild:method method.

pickable

Boolean

Indicates if pickable.

When false, the Mesh will never be picked by calls to the Scene pick() method, and picking will happen as "through" the Mesh, to attempt to pick whatever lies on the other side of it.

Default: true

position

Float32Array

Local translation.

Default: [0,0,0]

quaternion

Float32Array

Local rotation quaternion.

Default: [0,0,0, 1]

receiveShadow

Boolean

Indicates if receiving shadows.

Default: true

rotation

Float32Array

Local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.

Default: [0,0,0]

scale

Float32Array

Local scale.

Default: [1,1,1]

scene

Scene final

The parent Scene that contains this Component.

selected

Boolean

Indicates if selected.

The selected appearance is configured by selectedMaterial.

Each selected Mesh is registered in its Scene's selectedEntities map when its entityType is set to a value.

Default: false

selectedMaterial

EmphasisMaterial

Defines surface appearance when selected.

stationary

Boolean final

Indicates if the position is stationary.

When true, will disable the effect of Lookat translations for this Mesh, while still allowing it to rotate. This is useful for skybox Meshes.

Default: false

type

String final

JavaScript class name for this Component.

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

visible

Boolean

Indicates if visible.

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

Each visible Mesh is registered in the Scene's visibleEntities map when its entityType is set to a value.

Default: true

worldMatrix

Float32Array

The World matrix.

worldNormalMatrix

Float32Array

This World normal matrix.

Default: [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]

worldPositions

Float32Array final

World-space 3D vertex positions.

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

destroyed

Fired when this Component is destroyed.

picked

Fired when this Mesh is picked via a call to Scene#pick().

The event parameters will be the hit result returned by the Scene#pick() method.