Input

Extends Component

Defined in: /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1

Module: input
Parent Module: xeogl

Publishes keyboard and mouse events that occur on the parent Scene's Canvas.

Each Scene provides an Input on itself as a read-only property.

Usage

In this example, we're subscribing to some mouse and key events that will occur on a Scene's Canvas.

var myScene = new xeogl.Scene();

var input = myScene.input;

// We'll save a handle to this subscription
// to show how to unsubscribe, further down
var handle = input.on("mousedown", function(coords) {
      console.log("Mouse down at: x=" + coords[0] + ", y=" + coords[1]);
});

input.on("mouseup", function(coords) {
      console.log("Mouse up at: x=" + coords[0] + ", y=" + coords[1]);
});

input.on("mouseclicked", function(coords) {
     console.log("Mouse clicked at: x=" + coords[0] + ", y=" + coords[1]);
});

input.on("dblclick", function(coords) {
      console.log("Double-click at: x=" + coords[0] + ", y=" + coords[1]);
});

input.on("keydown", function(keyCode) {
       switch (keyCode) {

           case this.KEY_A:
              console.log("The 'A' key is down");
              break;

           case this.KEY_B:
              console.log("The 'B' key is down");
              break;

           case this.KEY_C:
              console.log("The 'C' key is down");
              break;

           default:
              console.log("Some other key is down");
      }
    });

input.on("keyup", function(keyCode) {
       switch (keyCode) {

           case this.KEY_A:
              console.log("The 'A' key is up");
              break;

           case this.KEY_B:
              console.log("The 'B' key is up");
              break;

           case this.KEY_C:
              console.log("The 'C' key is up");
              break;

           default:
              console.log("Some other key is up");
       }
    });

// TODO: ALT and CTRL keys etc

Unsubscribing from Events

In the snippet above, we saved a handle to one of our event subscriptions.

We can then use that handle to unsubscribe again, like this:

input.off(handle);

Index
Methods
Properties
Events

Index

Methods

`create`

(

[cfg]

)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:896

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`

()

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:1005

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

)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:583

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]

)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:407

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

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:534

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

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:371

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

)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:545

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

)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:488

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

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:446

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]

)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:513

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

`warn`

(

message

)

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:566

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

`destroyed`

Boolean

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:316

True as soon as this Component has been destroyed

`id`

String final

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:307

Unique ID for this Component within its parent Scene.

`KEY_A`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:361

Code for the A key.

`KEY_A`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1146

Code for the A key.

`KEY_ADD`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:681

Code for the ADD key.

`KEY_ADD`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1466

Code for the ADD key.

`KEY_ALT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:169

Code for the ALT key.

`KEY_ALT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:954

Code for the ALT key.

`KEY_B`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1154

Code for the B key.

`KEY_B`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:369

Code for the B key.

`KEY_BACK_SLASH`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1674

Code for the BACK_SLASH key.

`KEY_BACK_SLASH`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:889

Code for the BACK_SLASH key.

`KEY_BACKSPACE`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:121

Code for the BACKSPACE key.

`KEY_BACKSPACE`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:129

Code for the BACKSPACE key.

`KEY_C`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:377

Code for the C key.

`KEY_C`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1162

Code for the C key.

`KEY_CAPS_LOCK`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:970

Code for the CAPS_LOCK key.

`KEY_CAPS_LOCK`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:185

Code for the CAPS_LOCK key.

`KEY_CLOSE_BRACKET`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:897

Code for the CLOSE_BRACKET key.

`KEY_CLOSE_BRACKET`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1682

Code for the CLOSE_BRACKET key.

`KEY_COMMA`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:841

Code for the COMMA key.

`KEY_COMMA`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1626

Code for the COMMA key.

`KEY_CTRL`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:946

Code for the CTRL key.

`KEY_CTRL`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:161

Code for the CTRL key.

`KEY_D`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:385

Code for the D key.

`KEY_D`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1170

Code for the D key.

`KEY_DASH`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:849

Code for the DASH key.

`KEY_DASH`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1634

Code for the DASH key.

`KEY_DECIMAL_POINT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1482

Code for the DECIMAL POINT key.

`KEY_DECIMAL_POINT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:697

Code for the DECIMAL POINT key.

`KEY_DELETE`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:273

Code for the DELETE key.

`KEY_DELETE`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1058

Code for the DELETE key.

`KEY_DIVIDE`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1490

Code for the DIVIDE key.

`KEY_DIVIDE`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:705

Code for the DIVIDE key.

`KEY_DOWN_ARROW`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:257

Code for the DOWN_ARROW key.

`KEY_DOWN_ARROW`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1042

Code for the DOWN_ARROW key.

`KEY_E`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:393

Code for the E key.

`KEY_E`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1178

Code for the E key.

`KEY_END`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1002

Code for the END key.

`KEY_END`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:217

Code for the END key.

`KEY_ENTER`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:930

Code for the ENTER key.

`KEY_ENTER`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:145

Code for the ENTER key.

`KEY_EQUAL_SIGN`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1618

Code for the EQUAL_SIGN key.

`KEY_EQUAL_SIGN`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:833

Code for the EQUAL_SIGN key.

`KEY_ESCAPE`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:193

Code for the ESCAPE key.

`KEY_ESCAPE`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:978

Code for the ESCAPE key.

`KEY_F`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1186

Code for the F key.

`KEY_F`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:401

Code for the F key.

`KEY_F1`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1498

Code for the F1 key.

`KEY_F1`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:713

Code for the F1 key.

`KEY_F10`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1570

Code for the F10 key.

`KEY_F10`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:785

Code for the F10 key.

`KEY_F11`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:793

Code for the F11 key.

`KEY_F11`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1578

Code for the F11 key.

`KEY_F12`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:801

Code for the F12 key.

`KEY_F12`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1586

Code for the F12 key.

`KEY_F2`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1506

Code for the F2 key.

`KEY_F2`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:721

Code for the F2 key.

`KEY_F3`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:729

Code for the F3 key.

`KEY_F3`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1514

Code for the F3 key.

`KEY_F4`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1522

Code for the F4 key.

`KEY_F4`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:737

Code for the F4 key.

`KEY_F5`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1530

Code for the F5 key.

`KEY_F5`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:745

Code for the F5 key.

`KEY_F6`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1538

Code for the F6 key.

`KEY_F6`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:753

Code for the F6 key.

`KEY_F7`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:761

Code for the F7 key.

`KEY_F7`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1546

Code for the F7 key.

`KEY_F8`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:769

Code for the F8 key.

`KEY_F8`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1554

Code for the F8 key.

`KEY_F9`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:777

Code for the F9 key.

`KEY_F9`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1562

Code for the F9 key.

`KEY_FORWARD_SLASH`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:865

Code for the FORWARD_SLASH key.

`KEY_FORWARD_SLASH`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1650

Code for the FORWARD_SLASH key.

`KEY_G`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1194

Code for the G key.

`KEY_G`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:409

Code for the G key.

`KEY_GRAVE_ACCENT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1658

Code for the GRAVE_ACCENT key.

`KEY_GRAVE_ACCENT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:873

Code for the GRAVE_ACCENT key.

`KEY_H`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1202

Code for the H key.

`KEY_H`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:417

Code for the H key.

`KEY_HOME`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:225

Code for the HOME key.

`KEY_HOME`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1010

Code for the HOME key.

`KEY_I`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1210

Code for the I key.

`KEY_I`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:425

Code for the I key.

`KEY_INSERT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1050

Code for the INSERT key.

`KEY_INSERT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:265

Code for the INSERT key.

`KEY_J`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1218

Code for the J key.

`KEY_J`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:433

Code for the J key.

`KEY_K`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1226

Code for the K key.

`KEY_K`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:441

Code for the K key.

`KEY_L`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:449

Code for the L key.

`KEY_L`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1234

Code for the L key.

`KEY_LEFT_ARROW`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1018

Code for the LEFT_ARROW key.

`KEY_LEFT_ARROW`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:233

Code for the LEFT_ARROW key.

`KEY_LEFT_WINDOW`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:569

Code for the LEFT_WINDOW key.

`KEY_LEFT_WINDOW`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1354

Code for the LEFT_WINDOW key.

`KEY_M`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:457

Code for the M key.

`KEY_M`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1242

Code for the M key.

`KEY_MULTIPLY`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:673

Code for the MULTIPLY key.

`KEY_MULTIPLY`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1458

Code for the MULTIPLY key.

`KEY_N`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:465

Code for the N key.

`KEY_N`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1250

Code for the N key.

`KEY_NUM_0`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1066

Code for the 0 key.

`KEY_NUM_0`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:281

Code for the 0 key.

`KEY_NUM_1`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:289

Code for the 1 key.

`KEY_NUM_1`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1074

Code for the 1 key.

`KEY_NUM_2`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1082

Code for the 2 key.

`KEY_NUM_2`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:297

Code for the 2 key.

`KEY_NUM_3`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:305

Code for the 3 key.

`KEY_NUM_3`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1090

Code for the 3 key.

`KEY_NUM_4`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:313

Code for the 4 key.

`KEY_NUM_4`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1098

Code for the 4 key.

`KEY_NUM_5`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:321

Code for the 5 key.

`KEY_NUM_5`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1106

Code for the 5 key.

`KEY_NUM_6`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:329

Code for the 6 key.

`KEY_NUM_6`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1114

Code for the 6 key.

`KEY_NUM_7`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1122

Code for the 7 key.

`KEY_NUM_7`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:337

Code for the 7 key.

`KEY_NUM_8`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1130

Code for the 8 key.

`KEY_NUM_8`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:345

Code for the 8 key.

`KEY_NUM_9`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1138

Code for the 9 key.

`KEY_NUM_9`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:353

Code for the 9 key.

`KEY_NUM_LOCK`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1594

Code for the NUM_LOCK key.

`KEY_NUM_LOCK`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:809

Code for the NUM_LOCK key.

`KEY_NUMPAD 2`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1394

Code for the number pad 2 key.

`KEY_NUMPAD 2`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:609

Code for the number pad 2 key.

`KEY_NUMPAD_0`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:593

Code for the number pad 0 key.

`KEY_NUMPAD_0`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1378

Code for the number pad 0 key.

`KEY_NUMPAD_1`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:601

Code for the number pad 1 key.

`KEY_NUMPAD_1`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1386

Code for the number pad 1 key.

`KEY_NUMPAD_3`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1402

Code for the number pad 3 key.

`KEY_NUMPAD_3`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:617

Code for the number pad 3 key.

`KEY_NUMPAD_4`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1410

Code for the number pad 4 key.

`KEY_NUMPAD_4`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:625

Code for the number pad 4 key.

`KEY_NUMPAD_5`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1418

Code for the number pad 5 key.

`KEY_NUMPAD_5`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:633

Code for the number pad 5 key.

`KEY_NUMPAD_6`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1426

Code for the number pad 6 key.

`KEY_NUMPAD_6`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:641

Code for the number pad 6 key.

`KEY_NUMPAD_7`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1434

Code for the number pad 7 key.

`KEY_NUMPAD_7`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:649

Code for the number pad 7 key.

`KEY_NUMPAD_8`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:657

Code for the number pad 8 key.

`KEY_NUMPAD_8`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1442

Code for the number pad 8 key.

`KEY_NUMPAD_9`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:665

Code for the number pad 9 key.

`KEY_NUMPAD_9`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1450

Code for the number pad 9 key.

`KEY_O`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1258

Code for the O key.

`KEY_O`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:473

Code for the O key.

`KEY_OPEN_BRACKET`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1666

Code for the OPEN_BRACKET key.

`KEY_OPEN_BRACKET`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:881

Code for the OPEN_BRACKET key.

`KEY_P`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1266

Code for the P key.

`KEY_P`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:481

Code for the P key.

`KEY_PAGE_DOWN`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:994

Code for the PAGE_DOWN key.

`KEY_PAGE_DOWN`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:209

Code for the PAGE_DOWN key.

`KEY_PAGE_UP`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:201

Code for the PAGE_UP key.

`KEY_PAGE_UP`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:986

Code for the PAGE_UP key.

`KEY_PAUSE_BREAK`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:177

Code for the PAUSE_BREAK key.

`KEY_PAUSE_BREAK`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:962

Code for the PAUSE_BREAK key.

`KEY_PERIOD`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1642

Code for the PERIOD key.

`KEY_PERIOD`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:857

Code for the PERIOD key.

`KEY_Q`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:489

Code for the Q key.

`KEY_Q`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1274

Code for the Q key.

`KEY_R`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1282

Code for the R key.

`KEY_R`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:497

Code for the R key.

`KEY_RIGHT_ARROW`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1034

Code for the RIGHT_ARROW key.

`KEY_RIGHT_ARROW`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:249

Code for the RIGHT_ARROW key.

`KEY_RIGHT_WINDOW`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1362

Code for the RIGHT_WINDOW key.

`KEY_RIGHT_WINDOW`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:577

Code for the RIGHT_WINDOW key.

`KEY_S`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:505

Code for the S key.

`KEY_S`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1290

Code for the S key.

`KEY_SCROLL_LOCK`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:817

Code for the SCROLL_LOCK key.

`KEY_SCROLL_LOCK`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1602

Code for the SCROLL_LOCK key.

`KEY_SELECT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1370

Code for the SELECT key.

`KEY_SELECT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:585

Code for the SELECT key.

`KEY_SEMI_COLON`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1610

Code for the SEMI_COLON key.

`KEY_SEMI_COLON`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:825

Code for the SEMI_COLON key.

`KEY_SHIFT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:153

Code for the SHIFT key.

`KEY_SHIFT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:938

Code for the SHIFT key.

`KEY_SINGLE_QUOTE`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1690

Code for the SINGLE_QUOTE key.

`KEY_SINGLE_QUOTE`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:905

Code for the SINGLE_QUOTE key.

`KEY_SPACE`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1698

Code for the SPACE key.

`KEY_SPACE`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:913

Code for the SPACE key.

`KEY_SUBTRACT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:689

Code for the SUBTRACT key.

`KEY_SUBTRACT`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1474

Code for the SUBTRACT key.

`KEY_T`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:513

Code for the T key.

`KEY_T`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1298

Code for the T key.

`KEY_TAB`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:137

Code for the TAB key.

`KEY_TAB`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:922

Code for the TAB key.

`KEY_U`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1306

Code for the U key.

`KEY_U`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:521

Code for the U key.

`KEY_UP_ARROW`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1026

Code for the UP_ARROW key.

`KEY_UP_ARROW`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:241

Code for the UP_ARROW key.

`KEY_V`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1314

Code for the V key.

`KEY_V`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:529

Code for the V key.

`KEY_W`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1322

Code for the W key.

`KEY_W`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:537

Code for the W key.

`KEY_X`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1330

Code for the X key.

`KEY_X`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:545

Code for the X key.

`KEY_Y`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1338

Code for the Y key.

`KEY_Y`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:553

Code for the Y key.

`KEY_Z`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1346

Code for the Z key.

`KEY_Z`

Number final

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:561

Code for the Z key.

`metadata`

Object

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:299

Arbitrary, user-defined metadata on this component.

`model`

Model final

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:358

The Model which contains this Component, if any.

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

`scene`

Scene final

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:250

The parent Scene that contains this Component.

`type`

String final

Inherited from Component but overwritten in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:100

JavaScript class name for this Component.

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

Events

`dblclick`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1963

Fired whenever the mouse is double-clicked over the parent Scene's Canvas.

Event Payload:

value Number, Number

The mouse coordinates within the Canvas,

`destroyed`

Inherited from Component: /home/lindsay/xeolabs/xeogl-next/xeogl/src/component.js:1073

Fired when this Component is destroyed.

`devicemotion`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:2135

Fires on a regular interval and returns data about the rotation (in degrees per second) and acceleration (in meters per second squared) of the device, at that moment in time. Some devices do not have the hardware to exclude the effect of gravity.

Event Payload:

Float32Array Object

acceleration The acceleration of the device, in meters per second squared, as a 3-element vector. This value has taken into account the effect of gravity and removed it from the figures. This value may not exist if the hardware doesn't know how to remove gravity from the acceleration data.
Float32Array Object

accelerationIncludingGravity The acceleration of the device, in meters per second squared, as a 3-element vector. This value includes the effect of gravity, and may be the only value available on devices that don't have a gyroscope to allow them to properly remove gravity from the data.
, Object

Number interval The interval, in milliseconds, at which this event is fired. The next event will be fired in approximately this amount of time.
Float32Array Object

rotationRate The rates of rotation of the device about each axis, in degrees per second.

`deviceorientation`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:2159

Fired when fresh data is available from an orientation sensor about the current orientation of the device as compared to the Earth coordinate frame. This data is gathered from a magnetometer inside the device. See Orientation and motion data explained for more info.

Event Payload:

Number Object

alpha The current orientation of the device around the Z axis in degrees; that is, how far the device is rotated around a line perpendicular to the device.
Number Object

beta The current orientation of the device around the X axis in degrees; that is, how far the device is tipped forward or backward.
Number Object

gamma The current orientation of the device around the Y axis in degrees; that is, how far the device is turned left or right.
Boolean Object

absolute This value is true if the orientation is provided as a difference between the device coordinate frame and the Earth coordinate frame; if the device can't detect the Earth coordinate frame, this value is false.

`keydown`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1772

Fired whenever a key is pressed while the parent Scene's Canvas has input focus.

Event Payload:

value Number

The key code, for example KEY_LEFT_ARROW,

`keyup`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1805

Fired whenever a key is released while the parent Scene's Canvas has input focus.

Event Payload:

value Number

The key code, for example KEY_LEFT_ARROW,

`mouseclicked`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:2036

Fired whenever the mouse is clicked over the parent Scene's Canvas.

Event Payload:

value Number, Number

The mouse coordinates within the Canvas,

`mousedown`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1883

Fired whenever the mouse is pressed over the parent Scene's Canvas.

Event Payload:

value Number, Number

The mouse coordinates within the Canvas,

`mousedown`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1984

Fired whenever the mouse is moved over the parent Scene's Canvas.

Event Payload:

value Number, Number

The mouse coordinates within the Canvas,

`mouseenter`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1826

Fired whenever the mouse is moved into of the parent Scene's Canvas.

Event Payload:

value Number, Number

The mouse coordinates within the Canvas,

`mouseleave`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1845

Fired whenever the mouse is moved out of the parent Scene's Canvas.

Event Payload:

value Number, Number

The mouse coordinates within the Canvas,

`mouseup`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:1922

Fired whenever the mouse is released over the parent Scene's Canvas.

Event Payload:

value Number, Number

The mouse coordinates within the Canvas,

`mousewheel`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:2005

Fired whenever the mouse wheel is moved over the parent Scene's Canvas.

Event Payload:

delta Number

The mouse wheel delta,

`orientationchange`

Defined in /home/lindsay/xeolabs/xeogl-next/xeogl/src/input/input.js:2093

Fired when the orientation of the device has changed.

Event Payload:

orientation Object

The orientation: "landscape-primary", "landscape-secondary", "portrait-secondary" or "portrait-primary"
orientationAngle Object

The orientation angle in degrees: 90 for landscape-primary, -90 for landscape-secondary, 180 for portrait-secondary or 0 for portrait-primary.

xeogl / API Docs

Input

Usage

Unsubscribing from Events

Index

Methods

Properties

Events

Methods

create

Parameters:

Returns:

destroy

error

Parameters:

fire

Parameters:

hasSubs

Parameters:

Returns:

isType

Examples:

Parameters:

Returns:

log

Parameters:

off

Parameters:

on

Parameters:

Returns:

once

Parameters:

warn

Parameters:

Properties

destroyed

id

KEY_A

KEY_A

KEY_ADD

KEY_ADD

KEY_ALT

KEY_ALT

KEY_B

KEY_B

KEY_BACK_SLASH

KEY_BACK_SLASH

KEY_BACKSPACE

KEY_BACKSPACE

KEY_C

KEY_C

KEY_CAPS_LOCK

KEY_CAPS_LOCK

KEY_CLOSE_BRACKET

KEY_CLOSE_BRACKET

KEY_COMMA

KEY_COMMA

KEY_CTRL

KEY_CTRL

KEY_D

KEY_D

KEY_DASH

KEY_DASH

KEY_DECIMAL_POINT

KEY_DECIMAL_POINT

KEY_DELETE

KEY_DELETE

KEY_DIVIDE

KEY_DIVIDE

KEY_DOWN_ARROW

KEY_DOWN_ARROW

KEY_E

KEY_E

KEY_END

KEY_END

KEY_ENTER

KEY_ENTER

KEY_EQUAL_SIGN

KEY_EQUAL_SIGN

`create`

`destroy`

`error`

`fire`

`hasSubs`

`isType`

`log`

`off`

`on`

`once`

`warn`

`destroyed`

`id`

`KEY_A`

`KEY_A`

`KEY_ADD`

`KEY_ADD`

`KEY_ALT`

`KEY_ALT`

`KEY_B`

`KEY_B`

`KEY_BACK_SLASH`

`KEY_BACK_SLASH`

`KEY_BACKSPACE`

`KEY_BACKSPACE`

`KEY_C`

`KEY_C`

`KEY_CAPS_LOCK`

`KEY_CAPS_LOCK`

`KEY_CLOSE_BRACKET`

`KEY_CLOSE_BRACKET`

`KEY_COMMA`

`KEY_COMMA`

`KEY_CTRL`

`KEY_CTRL`

`KEY_D`

`KEY_D`

`KEY_DASH`

`KEY_DASH`

`KEY_DECIMAL_POINT`

`KEY_DECIMAL_POINT`

`KEY_DELETE`

`KEY_DELETE`

`KEY_DIVIDE`

`KEY_DIVIDE`

`KEY_DOWN_ARROW`

`KEY_DOWN_ARROW`

`KEY_E`

`KEY_E`

`KEY_END`

`KEY_END`

`KEY_ENTER`

`KEY_ENTER`

`KEY_EQUAL_SIGN`

`KEY_EQUAL_SIGN`

`KEY_ESCAPE`

`KEY_ESCAPE`

`KEY_F`

`KEY_F`

`KEY_F1`

`KEY_F1`

`KEY_F10`

`KEY_F10`

`KEY_F11`

`KEY_F11`

`KEY_F12`

`KEY_F12`

`KEY_F2`

`KEY_F2`

`KEY_F3`

`KEY_F3`

`KEY_F4`

`KEY_F4`

`KEY_F5`

`KEY_F5`

`KEY_F6`

`KEY_F6`

`KEY_F7`

`KEY_F7`

`KEY_F8`