API Docs for: 1.0.0

xeogl

Defined in: src/xeogl.js:1
Module: xeogl

The xeogl namespace.

Index

Properties

Events

Methods

_addScene

(
  • scene
)
private

Defined in src/xeogl.js:387

Registers a scene on xeogl. This is called within the xeogl.Scene constructor.

Parameters:

clear

()

Defined in src/xeogl.js:491

Destroys all user-created Scenes and clears the default Scene.

scheduleTask

(
  • callback
  • [scope]
)

Defined in src/xeogl.js:442

Schedule a task for xeogl to run at the next frame.

Internally, this pushes the task to a FIFO queue. Within each frame interval, xeogl processes the queue for a certain period of time, popping tasks and running them. After each frame interval, tasks that did not get a chance to run during the task are left in the queue to be run next time.

Parameters:

  • callback Function

    Callback that runs the task.

  • [scope] Object optional

    Scope for the callback.

Properties

scene

Scene final

Defined in src/xeogl.js:358

The default Scene.

Components created without an explicit parent Scene will be created within this Scene by default.

xeogl creates the default Scene as soon as you either reference this property for the first time, or create your first Entity without a specified Scene.

scenes

{String:xeogl.Scene}

Defined in src/xeogl.js:187

Existing Scenes , mapped to their IDs

stats

final

Defined in src/xeogl.js:126

Tracks statistics within xeogl, such as numbers of scenes, textures, geometries etc.

version

String

Defined in src/xeogl.js:61

Semantic version number. The value for this is set by an expression that's concatenated to the end of the built binary by the xeogl build script.

Events

tick

Defined in src/xeogl.js:302

Fired on each game loop iteration.

Event Payload:

  • sceneID String

    The ID of this Scene.

  • startTime Number

    The time in seconds since 1970 that this Scene was instantiated.

  • time Number

    The time in seconds since 1970 of this "tick" event.

  • prevTime Number

    The time of the previous "tick" event from this Scene.

  • deltaTime Number

    The time in seconds since the previous "tick" event from this Scene.