API Docs for: 1.0.0

Outline

Extends Component
Module: emphasis
Parent Module: xeogl

A Outline renders an outline around attached Entities.

Overview

TODO

Usage


var outline = new xeogl.Outline({
   thickness: 15,      // Default
   color: [1,0,0]      // Default
});

new xeogl.Entity({
    geometry: new xeogl.TorusGeometry(),
    outline: outline,
    outlined: false  // Hide the outline (default)
});

new xeogl.Entity({
    geometry: new xeogl.BoxGeometry(),
    outline: outline,
    outlined: true  // Show the outline
});

Constructor

Outline

(
  • [scene]
  • [cfg]
)

Parameters:

  • [scene] Scene optional

    Parent Scene, creates this Outline within the default Scene when omitted.

  • [cfg] optional

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

    • [thickness=15] Number optional

      Thickness of the outline in pixels.

    • [color=[1,1,0]] Float32Array optional

      The RGB outline color.

Methods

create

(
  • [cfg]
  • [instanceId]
)

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

You would typically use this method to conveniently instantiate components that you'd want to share (ie. "instance") among your Entities.

The method is given a component type, configuration and optional instance ID, like so:

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

The first time you call this method for the given type and instanceId, this method will create the PhongMaterial, passing the given attributes to the component's constructor.

If you call this method again, specifying the same type and instanceId, the method will return the same component instance that it returned the first time, and will ignore the new configuration:

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

So in this example, our PhongMaterial will continue to have the red specular and diffuse color that we specified the first time.

Each time you call this method with the same type and instanceId, the Scene will internally increment a reference count for the component instance.

Parameters:

  • [cfg] optional

    Configuration for the component instance - only used if this is the first time you are getting the component, ignored when reusing an existing instance.

  • [instanceId] String | Number optional

    Identifies the shared component instance. Note that this is not used as the ID of the component - you can specify the component ID in the cfg parameter.

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

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

active

Boolean

Provided by the controls module.

Defined in src/controls/mousePickEntity.js:87

Flag which indicates whether this MousePickEntity is active or not.

Fires a MousePickEntity/active:event event on change.

active

Boolean

Provided by the controls module.

Defined in src/controls/mouseZoomCamera.js:149

Indicates whether this MouseZoomCamera is active or not.

Fires an MouseZoomCamera/active:event event on change.

active

Boolean

Provided by the controls module.

Defined in src/controls/mouseRotateCamera.js:201

Flag which indicates whether this MouseRotateCamera is active or not.

Fires an MouseRotateCamera/active:event event on change.

active

Boolean

Provided by the controls module.

Defined in src/controls/mousePanCamera.js:159

Flag which indicates whether this MousePanCamera is active or not.

Fires an MousePanCamera/active:event event on change.

active

Boolean

Provided by the controls module.

Defined in src/controls/keyboardAxisCamera.js:135

Flag which indicates whether this KeyboardAxisCamera is active or not.

Fires an KeyboardAxisCamera/active:event event on change.

active

Boolean

Provided by the controls module.

Defined in src/controls/keyboardPanCamera.js:155

Flag which indicates whether this KeyboardPanCamera is active or not.

Fires an KeyboardPanCamera/active:event event on change.

active

Boolean

Provided by the controls module.

Defined in src/controls/keyboardZoomCamera.js:148

Flag which indicates whether this KeyboardZoomCamera is active or not.

Fires an KeyboardZoomCamera/active:event event on change.

active

Boolean

Provided by the controls module.

Defined in src/controls/keyboardRotateCamera.js:197

Flag which indicates whether this KeyboardRotateCamera is active or not.

Fires an KeyboardRotateCamera/active:event event on change.

camera

Camera

Provided by the controls module.

Defined in src/controls/mousePanCamera.js:94

The Camera attached to this MousePanCamera.

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

Fires a MousePanCamera/camera:event event on change.

camera

Camera

Provided by the controls module.

Defined in src/controls/mouseRotateCamera.js:100

The Camera attached to this MouseRotateCamera.

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

Fires a MouseRotateCamera/camera:event event on change.

camera

Camera

Provided by the controls module.

Defined in src/controls/keyboardAxisCamera.js:96

The Camera attached to this KeyboardAxisCamera.

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

Fires a KeyboardAxisCamera/camera:event event on change.

camera

Camera

Provided by the controls module.

Defined in src/controls/keyboardZoomCamera.js:83

The Camera attached to this KeyboardZoomCamera.

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

Fires a KeyboardZoomCamera/camera:event event on change.

camera

Camera

Provided by the controls module.

Defined in src/controls/mouseZoomCamera.js:84

The Camera attached to this MouseZoomCamera.

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

Fires a MouseZoomCamera/camera:event event on change.

camera

Camera

Provided by the controls module.

Defined in src/controls/keyboardPanCamera.js:90

The Camera attached to this KeyboardPanCamera.

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

Fires a KeyboardPanCamera/camera:event event on change.

camera

Camera

Provided by the controls module.

Defined in src/controls/keyboardRotateCamera.js:96

The Camera attached to this KeyboardRotateCamera.

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

Fires a KeyboardRotateCamera/camera:event event on change.

color

Float32Array

The Outline's RGB color.

Fires a color event on change.

Default: [1.0, 1.0, 0.0]

destroyed

Boolean

True as soon as this Component has been destroyed

firstPerson

Boolean

Provided by the controls module.

Defined in src/controls/keyboardRotateCamera.js:161

Flag which indicates whether this KeyboardRotateCamera is in "first person" mode.

A KeyboardRotateCamera updates the Lookat attached to its target Camera. In 'first person' mode, the Lookat's look position orbits the eye position, otherwise the eye orbits look.

Fires a KeyboardRotateCamera/firstPerson:event event on change.

Default: false

firstPerson

Boolean

Provided by the controls module.

Defined in src/controls/mouseRotateCamera.js:165

Flag which indicates whether this MouseRotateCamera is in "first person" mode.

A MouseRotateCamera updates the Lookat attached to its target Camera. In 'first person' mode, the Lookat's look position orbits the eye position, otherwise the eye orbits look.

Fires a MouseRotateCamera/firstPerson:event event on change.

Default: false

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.

json

JSON final

JSON object containing the state of this Component.

metadata

Object

Arbitrary, user-defined metadata on this component.

pickSurface

Boolean

Provided by the controls module.

Defined in src/controls/mousePickEntity.js:205

Indicates whether this MousePickEntity will try to pick a Geometry primitive whenever it picks an Entity.

When true, this MousePickEntity will try to return the primitive index in a MousePickEntity/picked:event event.

Fires a MousePickEntity/pickSurface:event event on change.

scene

Scene final

The parent Scene that contains this Component.

sensitivity

Number

Provided by the controls module.

Defined in src/controls/mouseRotateCamera.js:136

The sensitivity of this MouseRotateCamera.

Fires a MouseRotateCamera/sensitivity:event event on change.

Default: 0.5

sensitivity

Number

Provided by the controls module.

Defined in src/controls/mousePanCamera.js:130

The sensitivity of this MousePanCamera.

Fires a MousePanCamera/sensitivity:event event on change.

Default: 0.5

sensitivity

Number

Provided by the controls module.

Defined in src/controls/keyboardPanCamera.js:126

The sensitivity of this KeyboardPanCamera.

Fires a KeyboardPanCamera/sensitivity:event event on change.

Default: 0.5

sensitivity

Number

Provided by the controls module.

Defined in src/controls/keyboardZoomCamera.js:119

The sensitivity of this KeyboardZoomCamera.

Fires a KeyboardZoomCamera/sensitivity:event event on change.

Default: 0.5

sensitivity

Number

Provided by the controls module.

Defined in src/controls/mouseZoomCamera.js:120

The sensitivity of this MouseZoomCamera.

Fires a MouseZoomCamera/sensitivity:event event on change.

Default: 0.5

sensitivity

Number

Provided by the controls module.

Defined in src/controls/keyboardRotateCamera.js:132

The sensitivity of this KeyboardRotateCamera.

Fires a KeyboardRotateCamera/sensitivity:event event on change.

Default: 1.0

string

String final

Inherited from Component but overwritten in src/component.js:1055

String containing the serialized JSON state of 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.

thickness

Number

The Outline's thickness in pixels.

Fires a thickness event on change.

Default: 15

type

String final

Provided by the controls module.

Defined in src/controls/mouseZoomCamera.js:59

JavaScript class name for this Component.

type

String final

Provided by the controls module.

Defined in src/controls/mouseRotateCamera.js:73

JavaScript class name for this Component.

type

String final

Provided by the controls module.

Defined in src/controls/mousePickEntity.js:69

JavaScript class name for this Component.

type

String final

Provided by the controls module.

Defined in src/controls/mousePanCamera.js:67

JavaScript class name for this Component.

type

String final

Provided by the controls module.

Defined in src/controls/keyboardZoomCamera.js:59

JavaScript class name for this Component.

type

String final

Provided by the controls module.

Defined in src/controls/keyboardRotateCamera.js:72

JavaScript class name for this Component.

type

String final

Provided by the controls module.

Defined in src/controls/keyboardPanCamera.js:66

JavaScript class name for this Component.

type

String final

Inherited from Component but overwritten in src/controls/keyboardAxisCamera.js:66

JavaScript class name for this Component.

Events

active

Provided by the controls module.

Defined in src/controls/mousePanCamera.js:250

Fired whenever this MousePanCamera's MousePanCamera/active:property property changes.

Event Payload:

  • value Object

    The property's new value

active

Provided by the controls module.

Defined in src/controls/mouseZoomCamera.js:262

Fired whenever this MouseZoomCamera's MouseZoomCamera/active:property property changes.

Event Payload:

  • value Object

    The property's new value

active

Provided by the controls module.

Defined in src/controls/keyboardPanCamera.js:242

Fired whenever this KeyboardPanCamera's KeyboardPanCamera/active:property property changes.

Event Payload:

  • value Object

    The property's new value

active

Provided by the controls module.

Defined in src/controls/mouseRotateCamera.js:356

Fired whenever this MouseRotateCamera's MouseRotateCamera/active:property property changes.

Event Payload:

  • value Object

    The property's new value

active

Provided by the controls module.

Defined in src/controls/keyboardRotateCamera.js:285

Fired whenever this KeyboardRotateCamera's KeyboardRotateCamera/active:property property changes.

Event Payload:

  • value Object

    The property's new value

active

Provided by the controls module.

Defined in src/controls/keyboardZoomCamera.js:215

Fired whenever this KeyboardZoomCamera's KeyboardZoomCamera/active:property property changes.

Event Payload:

  • value Object

    The property's new value

active

Provided by the controls module.

Defined in src/controls/mousePickEntity.js:192

Fired whenever this MousePickEntity's MousePickEntity/active:property property changes.

Event Payload:

  • value Object

    The property's new value

active

Provided by the controls module.

Defined in src/controls/keyboardAxisCamera.js:191

Fired whenever this KeyboardAxisCamera's KeyboardAxisCamera/active:property property changes.

Event Payload:

  • value Object

    The property's new value

camera

Provided by the controls module.

Defined in src/controls/keyboardPanCamera.js:106

Fired whenever this KeyboardPanCamera's KeyboardPanCamera/camera:property property changes.

Event Payload:

  • value Object

    The property's new value

camera

Provided by the controls module.

Defined in src/controls/keyboardZoomCamera.js:99

Fired whenever this KeyboardZoomCamera's KeyboardZoomCamera/camera:property property changes.

Event Payload:

  • value Object

    The property's new value

camera

Provided by the controls module.

Defined in src/controls/mouseRotateCamera.js:116

Fired whenever this MouseRotateCamera's MouseRotateCamera/camera:property property changes.

Event Payload:

  • value Object

    The property's new value

camera

Provided by the controls module.

Defined in src/controls/keyboardRotateCamera.js:112

Fired whenever this KeyboardRotateCamera's KeyboardRotateCamera/camera:property property changes.

Event Payload:

  • value Object

    The property's new value

camera

Provided by the controls module.

Defined in src/controls/mousePanCamera.js:110

Fired whenever this MousePanCamera's MousePanCamera/camera:property property changes.

Event Payload:

  • value Object

    The property's new value

camera

Provided by the controls module.

Defined in src/controls/mouseZoomCamera.js:100

Fired whenever this MouseZoomCamera's MouseZoomCamera/camera:property property changes.

Event Payload:

  • value Object

    The property's new value

camera

Provided by the controls module.

Defined in src/controls/keyboardAxisCamera.js:112

Fired whenever this KeyboardAxisCamera's KeyboardAxisCamera/camera:property property changes.

Event Payload:

  • value Object

    The property's new value

color

Fired whenever this Outline's color property changes.

Event Payload:

  • value Float32Array

    The property's new value

destroyed

Fired when this Component is destroyed.

firstPerson

Provided by the controls module.

Defined in src/controls/keyboardRotateCamera.js:184

Fired whenever this KeyboardRotateCamera's KeyboardRotateCamera/firstPerson:property property changes.

Event Payload:

  • value Object

    The property's new value

firstPerson

Provided by the controls module.

Defined in src/controls/mouseRotateCamera.js:188

Fired whenever this MouseRotateCamera's MouseRotateCamera/firstPerson:property property changes.

Event Payload:

  • value Object

    The property's new value

nopick

Provided by the controls module.

Defined in src/controls/mousePickEntity.js:173

Fired whenever an attempt to pick Entity picks empty space.

Event Payload:

  • canvasPos Array of Number

    The Canvas-space coordinate at which the pick was attempted.

picked

Provided by the controls module.

Defined in src/controls/mousePickEntity.js:160

Fired whenever an Entity is picked.

Event Payload:

  • entityId String

    The ID of the picked Entity within the parent Scene.

  • canvasPos Array of Number

    The Canvas-space coordinate that was picked.

  • worldPos Array of Number

    When MousePickEntity/pickSurface is true, provides the World-space coordinate that was ray-picked on the pickSurface of the Entity.

pickSurface

Provided by the controls module.

Defined in src/controls/mousePickEntity.js:229

Fired whenever this MousePickEntity's MousePickEntity/pickSurface:property property changes.

Event Payload:

  • value Object

    The property's new value

sensitivity

Provided by the controls module.

Defined in src/controls/keyboardZoomCamera.js:134

Fired whenever this KeyboardZoomCamera's KeyboardZoomCamera/sensitivity:property property changes.

Event Payload:

  • value Object

    The property's new value

sensitivity

Provided by the controls module.

Defined in src/controls/mouseRotateCamera.js:151

Fired whenever this MouseRotateCamera's MouseRotateCamera/sensitivity:property property changes.

Event Payload:

  • value Object

    The property's new value

sensitivity

Provided by the controls module.

Defined in src/controls/keyboardRotateCamera.js:147

Fired whenever this KeyboardRotateCamera's KeyboardRotateCamera/sensitivity:property property changes.

Event Payload:

  • value Object

    The property's new value

sensitivity

Provided by the controls module.

Defined in src/controls/mouseZoomCamera.js:135

Fired whenever this MouseZoomCamera's MouseZoomCamera/sensitivity:property property changes.

Event Payload:

  • value Object

    The property's new value

sensitivity

Provided by the controls module.

Defined in src/controls/keyboardPanCamera.js:141

Fired whenever this KeyboardPanCamera's KeyboardPanCamera/sensitivity:property property changes.

Event Payload:

  • value Object

    The property's new value

sensitivity

Provided by the controls module.

Defined in src/controls/mousePanCamera.js:145

Fired whenever this MousePanCamera's MousePanCamera/sensitivity:property property changes.

Event Payload:

  • value Object

    The property's new value

thickness

Fired whenever this Outline's thickness property changes.

Event Payload:

  • value Object

    The property's new value