Queuing and management of arbitrary events in a timeline

Introduced properties

fun add(event: E, delay: Float, duration: nullable Float): EventInfo[E]

event_queue :: EventQueue :: add

Register an event in the queue to be active in delay units of time.
fun add_at(event: E, start: Float, duration: nullable Float): EventInfo[E]

event_queue :: EventQueue :: add_at

Register an event in the queue executed at a specific time.
fun time: Float

event_queue :: EventQueue :: time

Global time since the creation of the queue
protected fun time=(time: Float)

event_queue :: EventQueue :: time=

Global time since the creation of the queue
fun update(dt: Float): SequenceRead[EventInfo[E]]

event_queue :: EventQueue :: update

Add a given amount of time and return all the events that were active during the delay.

Redefined properties

redef type SELF: EventQueue[E]

event_queue $ EventQueue :: SELF

Type of this instance, automatically specialized in every class

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
fun add(event: E, delay: Float, duration: nullable Float): EventInfo[E]

event_queue :: EventQueue :: add

Register an event in the queue to be active in delay units of time.
fun add_at(event: E, start: Float, duration: nullable Float): EventInfo[E]

event_queue :: EventQueue :: add_at

Register an event in the queue executed at a specific time.
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun time: Float

event_queue :: EventQueue :: time

Global time since the creation of the queue
protected fun time=(time: Float)

event_queue :: EventQueue :: time=

Global time since the creation of the queue
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun update(dt: Float): SequenceRead[EventInfo[E]]

event_queue :: EventQueue :: update

Add a given amount of time and return all the events that were active during the delay.
package_diagram event_queue::EventQueue EventQueue core::Object Object event_queue::EventQueue->core::Object

Parents

interface Object

core :: Object

The root of the class hierarchy.

Class definitions

event_queue $ EventQueue
# Queuing and management of arbitrary events in a timeline
class EventQueue[E]
	# Comparator used by the queue
	private var event_comparator = new EventComparator

	# Efficient queue
	private var queue = new MinHeap[EventInfo[E]](event_comparator)

	# List of current active event
	private var actives = new Array[EventInfo[E]]

	# List of previously active event
	private var old_actives = new Array[EventInfo[E]]

	# Global time since the creation of the queue
	var time = 0.0

	# Nearest deadline, used to optimise queue access
	#
	# `inf` if no deadline is set
	private var next: Float = inf

	# Register an `event` in the queue to be active in `delay` units of time.
	#
	# If `duration` is given, this is duration after what the event is automatically discarded.
	# If `null`, 0.0 or not given, the event will be executed only once
	# Use `inf` for an event with an infinite duration.
	fun add(event: E, delay: Float, duration: nullable Float): EventInfo[E]
	do
		return add_at(event, time + delay, duration)
	end

	# Register an `event` in the queue executed at a specific time.
	fun add_at(event: E, start: Float, duration: nullable Float): EventInfo[E]
	do
		if start < next then next = start
		var ei = new EventInfo[E](event, self, start, duration or else 0.0)
		queue.add ei

		return ei
	end

	# Add a given amount of time and return all the events that were active during the delay.
	#
	# Note that events that expired during the delay are marked `has_expired` and are still returned.
	fun update(dt: Float): SequenceRead[EventInfo[E]]
	do
		var time = self.time
		time += dt
		self.time = time

		# Switch things
		var tmp = old_actives
		old_actives = actives
		actives = tmp

		# Discard dead events
		actives.clear
		for ei in old_actives do
			if not ei.has_expired then actives.add ei
		end

		# Start new events
		if time >= next then loop
			if queue.is_empty then
				next = inf
				break
			end
			var ei = queue.peek
			if ei.start > time then
				next = ei.start
				break
			end
			ei = queue.take
			if not ei.has_expired then
				actives.add ei
				ei.occurrences = 0
			end
		end

		if actives.is_empty then return actives

		# Update event information
		for ei in actives do ei.update(time, dt)

		return actives
	end
end
lib/event_queue/event_queue.nit:168,1--255,3