API Docs for: 0.7.0

CameraControl

Extends Component
Module: controls
Parent Module: xeogl

Rotates, pans and zooms the Scene's Camera with keyboard, mouse and touch input.

CameraControl fires these events:

"hover" - Hover enters a new object "hoverSurface" - Hover continues over an object surface - fired continuously as mouse moves over an object "hoverLeave" - Hover has left the last object we were hovering over "hoverOff" - Hover continues over empty space - fired continuously as mouse moves over nothing "picked" - Clicked or tapped object "pickedSurface" - Clicked or tapped object, with event containing surface intersection details "doublePicked" - Double-clicked or double-tapped object "doublePickedSurface" - Double-clicked or double-tapped object, with event containing surface intersection details "pickedNothing" - Clicked or tapped, but not on any objects "doublePickedNothing" - Double-clicked or double-tapped, but not on any objects

CameraControl only fires "hover" events when the mouse is up.

For efficiency, CameraControl only does surface intersection picking when you subscribe to "doublePicked" and "doublePickedSurface" events. Therefore, only subscribe to those when you're OK with the overhead incurred by the surface intersection tests.

Panning

Rotating

Zooming

Events

Activating and deactivating

Inertia

First person

Keyboard layout

Fly-to

Constructor

CameraControl

(
  • [scene]
  • [cfg]
)

Parameters:

  • [scene] Scene optional

    Parent Scene.

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

    • [firstPerson=false] Boolean optional

      Whether or not this CameraControl is in "first person" mode.

    • [walking=false] Boolean optional

      Whether or not this CameraControl is in "walking" mode.

    • [keyboardLayout="qwerty"] String optional

      Keyboard layout.

    • [doublePickFlyTo=true] Boolean optional

      Whether to fly the camera to each Entity that's double-clicked.

    • [active=true] Boolean optional

      Indicates whether or not this CameraControl is active.

    • [inertia=0.5] A factor in range [0..1] Number optional

      indicating how much the camera keeps moving after you finish panning or rotating it.

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

active

Boolean

Indicates whether this CameraControl is active or not.

Fires a active event on change.

Default: true

active

Boolean

Indicates whether this CameraControl is active or not.

Fires a active event on change.

Default: true

active

Boolean

Indicates whether this CameraControl is active or not.

Fires a active event on change.

Default: true

destroyed

Boolean

True as soon as this Component has been destroyed

doublePickFlyTo

Boolean

TODO Fires a KeyboardRotateCamera/doublePickFlyTo:event event on change.

Default: true

doublePickFlyTo

Boolean

TODO Fires a KeyboardRotateCamera/doublePickFlyTo:event event on change.

Default: true

doublePickFlyTo

Boolean

TODO Fires a KeyboardRotateCamera/doublePickFlyTo:event event on change.

Default: true

firstPerson

Boolean

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

In "first person" mode (disabled by default) the look position rotates about the eye position. Otherwise, the eye rotates about the look.

Fires a KeyboardRotateCamera/firstPerson:event event on change.

Default: false

firstPerson

Boolean

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

In "first person" mode (disabled by default) the look position rotates about the eye position. Otherwise, the eye rotates about the look.

Fires a KeyboardRotateCamera/firstPerson:event event on change.

Default: false

firstPerson

Boolean

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

In "first person" mode (disabled by default) the look position rotates about the eye position. Otherwise, the eye rotates about the look.

Fires a KeyboardRotateCamera/firstPerson:event event on change.

Default: false

id

String final

Unique ID for this Component within its parent Scene.

inertia

Number

A fact in range [0..1] indicating how much the camera keeps moving after you finish panning or rotating it.

A value of 0.0 causes it to immediately stop, 0.5 causes its movement to decay 50% on each tick, while 1.0 causes no decay, allowing it continue moving, by the current rate of pan or rotation.

You may choose an inertia of zero when you want be able to precisely position or rotate the camera, without interference from inertia. ero inertia can also mean that less frames are rendered while you are positioning the camera.

Fires a KeyboardRotateCamera/inertia:event event on change.

Default: 0.5

inertia

Number

A fact in range [0..1] indicating how much the camera keeps moving after you finish panning or rotating it.

A value of 0.0 causes it to immediately stop, 0.5 causes its movement to decay 50% on each tick, while 1.0 causes no decay, allowing it continue moving, by the current rate of pan or rotation.

You may choose an inertia of zero when you want be able to precisely position or rotate the camera, without interference from inertia. ero inertia can also mean that less frames are rendered while you are positioning the camera.

Fires a KeyboardRotateCamera/inertia:event event on change.

Default: 0.5

inertia

Number

A fact in range [0..1] indicating how much the camera keeps moving after you finish panning or rotating it.

A value of 0.0 causes it to immediately stop, 0.5 causes its movement to decay 50% on each tick, while 1.0 causes no decay, allowing it continue moving, by the current rate of pan or rotation.

You may choose an inertia of zero when you want be able to precisely position or rotate the camera, without interference from inertia. ero inertia can also mean that less frames are rendered while you are positioning the camera.

Fires a KeyboardRotateCamera/inertia:event event on change.

Default: 0.5

isDefault

Boolean

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

keyboardLayout

String

TODO Fires a KeyboardRotateCamera/keyboardLayout:event event on change.

Default: "qwerty"

keyboardLayout

String

TODO Fires a KeyboardRotateCamera/keyboardLayout:event event on change.

Default: "qwerty"

keyboardLayout

String

TODO Fires a KeyboardRotateCamera/keyboardLayout:event event on change.

Default: "qwerty"

metadata

Object

Arbitrary, user-defined metadata on this component.

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.

type

String final

JavaScript class name for this Component.

type

String final

Inherited from Component but overwritten in src/controls/cameraControl.js:65

JavaScript class name for this Component.

walking

Boolean

Flag which indicates whether this CameraControl is in "walking" mode.

When set true, this constrains eye movement to the horizontal X-Z plane. When doing a walkthrough, this is useful to allow us to look upwards or downwards as we move, while keeping us moving in the horizontal plane.

This only has an effect when also in "first person" mode.

Fires a KeyboardRotateCamera/walking:event event on change.

Default: false

walking

Boolean

Flag which indicates whether this CameraControl is in "walking" mode.

When set true, this constrains eye movement to the horizontal X-Z plane. When doing a walkthrough, this is useful to allow us to look upwards or downwards as we move, while keeping us moving in the horizontal plane.

This only has an effect when also in "first person" mode.

Fires a KeyboardRotateCamera/walking:event event on change.

Default: false

walking

Boolean

Flag which indicates whether this CameraControl is in "walking" mode.

When set true, this constrains eye movement to the horizontal X-Z plane. When doing a walkthrough, this is useful to allow us to look upwards or downwards as we move, while keeping us moving in the horizontal plane.

This only has an effect when also in "first person" mode.

Fires a KeyboardRotateCamera/walking:event event on change.

Default: false

Events

active

Fired whenever this CameraControl's active property changes.

Event Payload:

  • value Boolean

    The property's new value

active

Fired whenever this CameraControl's active property changes.

Event Payload:

  • value Boolean

    The property's new value

active

Fired whenever this CameraControl's active property changes.

Event Payload:

  • value Boolean

    The property's new value

destroyed

Fired when this Component is destroyed.

doublePickedNothing

Fired when the pointer attempted a double-pick (ie. double-clicked or double-tapped), but has hit nothing.

doublePickedNothing

Fired when the pointer attempted a double-pick (ie. double-clicked or double-tapped), but has hit nothing.

doublePickedNothing

Fired when the pointer attempted a double-pick (ie. double-clicked or double-tapped), but has hit nothing.

doublePickedSurface

Fired when the pointer has double-picked (ie. double-clicked or double-tapped) the surface of an Entity.

This event provides 3D information about the point on the surface that the pointer has picked.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result, containing the ID of the Entity and 3D info on the surface possition - see }{{/crossLink}}.

doublePickedSurface

Fired when the pointer has double-picked (ie. double-clicked or double-tapped) the surface of an Entity.

This event provides 3D information about the point on the surface that the pointer has picked.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result, containing the ID of the Entity and 3D info on the surface possition - see }{{/crossLink}}.

doublePickedSurface

Fired when the pointer has double-picked (ie. double-clicked or double-tapped) the surface of an Entity.

This event provides 3D information about the point on the surface that the pointer has picked.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result, containing the ID of the Entity and 3D info on the surface possition - see }{{/crossLink}}.

doublePickFlyTo

Fired whenever this CameraControl's doublePickFlyTo property changes.

Event Payload:

  • value Object

    The property's new value

doublePickFlyTo

Fired whenever this CameraControl's doublePickFlyTo property changes.

Event Payload:

  • value Object

    The property's new value

doublePickFlyTo

Fired whenever this CameraControl's doublePickFlyTo property changes.

Event Payload:

  • value Object

    The property's new value

firstPerson

Fired whenever this CameraControl's firstPerson property changes.

Event Payload:

  • value Object

    The property's new value

firstPerson

Fired whenever this CameraControl's firstPerson property changes.

Event Payload:

  • value Object

    The property's new value

firstPerson

Fired whenever this CameraControl's firstPerson property changes.

Event Payload:

  • value Object

    The property's new value

hover

Fired continuously while the pointer is moving while hovering over an Entity.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A pick hit result containing the ID of the Entity - see }{{/crossLink}}.

hover

Fired continuously while the pointer is moving while hovering over an Entity.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A pick hit result containing the ID of the Entity - see }{{/crossLink}}.

hover

Fired continuously while the pointer is moving while hovering over an Entity.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A pick hit result containing the ID of the Entity - see }{{/crossLink}}.

hoverEnter

Fired when the pointer is over a new Entity.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A pick hit result containing the ID of the Entity - see }{{/crossLink}}.

hoverEnter

Fired when the pointer is over a new Entity.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A pick hit result containing the ID of the Entity - see }{{/crossLink}}.

hoverOff

Fired continuously while the pointer is moving but not hovering over anything.

hoverOff

Fired continuously while the pointer is moving but not hovering over anything.

hoverOff

Fired continuously while the pointer is moving but not hovering over anything.

hoverOut

Fired whenever the pointer no longer hovers over an Entity.

Event Payload:

  • entity Object

    The Entity

hoverOut

Fired whenever the pointer no longer hovers over an Entity.

Event Payload:

  • entity Object

    The Entity

hoverOut

Fired whenever the pointer no longer hovers over an Entity.

Event Payload:

  • entity Object

    The Entity

hoverOut

Fired whenever the pointer no longer hovers over an Entity.

Event Payload:

  • entity Object

    The Entity

hoverOut

Fired whenever the pointer no longer hovers over an Entity.

Event Payload:

  • entity Object

    The Entity

hoverOut

Fired whenever the pointer no longer hovers over an Entity.

Event Payload:

  • entity Object

    The Entity

hoverSurface

Fired while the pointer hovers over the surface of an Entity.

This event provides 3D information about the point on the surface that the pointer is hovering over.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result, containing the ID of the Entity and 3D info on the surface possition - see }{{/crossLink}}.

hoverSurface

Fired while the pointer hovers over the surface of an Entity.

This event provides 3D information about the point on the surface that the pointer is hovering over.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result, containing the ID of the Entity and 3D info on the surface possition - see }{{/crossLink}}.

hoverSurface

Fired while the pointer hovers over the surface of an Entity.

This event provides 3D information about the point on the surface that the pointer is hovering over.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result, containing the ID of the Entity and 3D info on the surface possition - see }{{/crossLink}}.

inertia

Fired whenever this CameraControl's inertia property changes.

Event Payload:

  • value Object

    The property's new value

inertia

Fired whenever this CameraControl's inertia property changes.

Event Payload:

  • value Object

    The property's new value

inertia

Fired whenever this CameraControl's inertia property changes.

Event Payload:

  • value Object

    The property's new value

keyboardLayout

Fired whenever this CameraControl's keyboardLayout property changes.

Event Payload:

  • value Object

    The property's new value

keyboardLayout

Fired whenever this CameraControl's keyboardLayout property changes.

Event Payload:

  • value Object

    The property's new value

keyboardLayout

Fired whenever this CameraControl's keyboardLayout property changes.

Event Payload:

  • value Object

    The property's new value

picked

Fired whenever the pointer has double-picked (ie. double-clicked or double-tapped) an Entity.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result containing the ID of the Entity - see }{{/crossLink}}.

picked

Fired whenever the pointer has picked (ie. clicked or tapped) an Entity.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result containing the ID of the Entity - see }{{/crossLink}}.

picked

Fired whenever the pointer has double-picked (ie. double-clicked or double-tapped) an Entity.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result containing the ID of the Entity - see }{{/crossLink}}.

picked

Fired whenever the pointer has double-picked (ie. double-clicked or double-tapped) an Entity.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result containing the ID of the Entity - see }{{/crossLink}}.

picked

Fired whenever the pointer has picked (ie. clicked or tapped) an Entity.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result containing the ID of the Entity - see }{{/crossLink}}.

picked

Fired whenever the pointer has picked (ie. clicked or tapped) an Entity.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result containing the ID of the Entity - see }{{/crossLink}}.

pickedNothing

Fired when the pointer attempted a pick (ie. clicked or tapped), but has hit nothing.

pickedNothing

Fired when the pointer attempted a pick (ie. clicked or tapped), but has hit nothing.

pickedNothing

Fired when the pointer attempted a pick (ie. clicked or tapped), but has hit nothing.

pickedSurface

Fired when the pointer has picked (ie. clicked or tapped) the surface of an Entity.

This event provides 3D information about the point on the surface that the pointer has picked.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result, containing the ID of the Entity and 3D info on the surface possition - see }{{/crossLink}}.

pickedSurface

Fired when the pointer has picked (ie. clicked or tapped) the surface of an Entity.

This event provides 3D information about the point on the surface that the pointer has picked.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result, containing the ID of the Entity and 3D info on the surface possition - see }{{/crossLink}}.

pickedSurface

Fired when the pointer has picked (ie. clicked or tapped) the surface of an Entity.

This event provides 3D information about the point on the surface that the pointer has picked.

Event Payload:

  • hit #crossLink "Scene/pick:method"

    A surface pick hit result, containing the ID of the Entity and 3D info on the surface possition - see }{{/crossLink}}.

walking

Fired whenever this CameraControl's walking property changes.

Event Payload:

  • value Object

    The property's new value

walking

Fired whenever this CameraControl's walking property changes.

Event Payload:

  • value Object

    The property's new value

walking

Fired whenever this CameraControl's walking property changes.

Event Payload:

  • value Object

    The property's new value