Timing Object API¶

class TimingObject(options)¶

Timing object constructor.

Arguments:	options (object) – options for timing object creation options.range (Array) – range of timing object timeline [low, high] options.position (float) – initial position options.velocity (float) – initial velocity options.acceleration (float) – initial acceleration

TimingObject.vector¶

Current state vector of timing object.

Returns object:	initial state vector.

TimingObject.range¶

Current range restrictions on timing object.

Param Array range:
	new range : [low, high]
Returns Array:	range : [low, high]

TimingObject.ready¶

Promise resolved when timing object is ready

Returns Promise:
	ready promise

TimingObject.pos¶

Convenience accessor for timing object position, based on query.

Returns float:	current position

TimingObject.vel¶

Convenience accessor for timing object velocity, based on query.

Returns float:	current velocity

TimingObject.acc¶

Convenience accessor for timing object acceleration, based on query.

Returns float:	current acceleration

TimingObject.timingsrc¶

Setter/getter property current parent of timing object.

timingsrc is undefined if timing object is local object (does not have a parent). Otherwise timingsrc may be Timing Object or Timing Provider

Param object timingsrc:
	new timingsrc
Returns object:	timingsrc

TimingObject.isReady()¶

Timing object ready state (internal vector defined)

Returns boolean:
	true if timing object is ready

TimingObject.query()¶

Query timing object.

Returns vector:	current state vector

TimingObject.update(vector)¶

Update timing object.

Returns Promise:
	update promise

TimingObject.on(name, callback[, options])¶

Register event handler

TimingObject.off(name, subscription)¶

Unregister event handler