AuralTimelineBase

Type Members

type ElemHandle = AuralTimelineBase.ElemHandle[S, Elem]

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
final class IPlaying extends ITimedState

Attributes
protected
Definition Classes
AuralScheduledBase
final class IPreparing extends ITimedState

Attributes
protected
Definition Classes
AuralScheduledBase
sealed trait ITimedState extends InternalState

Attributes
protected
Definition Classes
AuralScheduledBase
sealed trait InternalState extends Disposable[S.Tx]

Attributes
protected
Definition Classes
AuralScheduledBase
type Model = Obj[S]

An opaque type coming out of processPrepare and ending up in mkView and elemAdded.
An opaque type coming out of processPrepare and ending up in mkView and elemAdded. Typically Obj[S].

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
type PrepareResult = (ViewId, SpanLike, Model)

Attributes
protected
Definition Classes
AuralScheduledBase
type ViewId = S.Id

An opaque type passed into playView that may be used by an overriding implementation.
An opaque type passed into playView that may be used by an overriding implementation. Otherwise it may simply be set to Unit.

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase

Abstract Value Members

implicit abstract val context: AuralContext[S]

Attributes
protected
Definition Classes
AuralScheduledBase
abstract def iSys: (S.Tx) ⇒ I.Tx

Attributes
protected
abstract def makeViewElem(obj: Obj[S])(implicit tx: S.Tx): Elem

Attributes
protected
abstract def objH: Source[S.Tx, Timeline[S]]

The view must store a handle to its underlying model.
The view must store a handle to its underlying model.

Definition Classes
AuralTimelineBase → ObjViewBase
abstract def tree: SkipOctree[I, TwoDim, (SpanLike, IndexedSeq[(Source[S.Tx, S.Id], Elem)])]

Attributes
protected
abstract def viewPlaying(h: ElemHandle)(implicit tx: S.Tx): Unit

A notification method that may be used to fire an event such as AuralObj.Timeline.ViewAdded.
A notification method that may be used to fire an event such as AuralObj.Timeline.ViewAdded.

Attributes
protected
abstract def viewStopped(h: ElemHandle)(implicit tx: S.Tx): Unit

A notification method that may be used to fire an event such as AuralObj.Timeline.ViewRemoved.
A notification method that may be used to fire an event such as AuralObj.Timeline.ViewRemoved.

Attributes
protected

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
object IStopped extends InternalState with Product with Serializable

Attributes
protected
Definition Classes
AuralScheduledBase
final def addObject(id: S.Id, span: SpanLikeObj[S], obj: Obj[S])(implicit tx: S.Tx): Unit
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def checkReschedule(h: ElemHandle, currentOffset: Long, oldTarget: Long, elemPlays: Boolean)(implicit tx: S.Tx): Boolean

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
final def childPreparedOrRemoved(childView: Elem)(implicit tx: S.Tx): Unit

Attributes
protected
Definition Classes
AuralScheduledBase
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def dispose()(implicit tx: S.Tx): Unit

Sub-classes may override this and call super.dispose() if they wish to free additional observers, e.g.
Sub-classes may override this and call super.dispose() if they wish to free additional observers, e.g. the timeline or grapheme observer.

Definition Classes
AuralTimelineBase → AuralScheduledBase → Disposable
final def elemAdded(vid: ViewId, span: SpanLike, obj: Model)(implicit tx: S.Tx): Unit

Attributes
protected
Definition Classes
AuralScheduledBase
def elemFromHandle(h: ElemHandle): Elem

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
final def elemRemoved(h: ElemHandle, elemPlays: Boolean)(implicit tx: S.Tx): Unit

Attributes
protected
Definition Classes
AuralScheduledBase
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def fire(update: State)(implicit tx: S.Tx): Unit

Attributes
protected
Definition Classes
ObservableImpl
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def getView(timed: Timed[S])(implicit tx: S.Tx): Option[Elem]
final def getViewById(id: S.Id)(implicit tx: S.Tx): Option[Elem]
def hashCode(): Int

Definition Classes
AnyRef → Any
def init(tl: Timeline[S])(implicit tx: S.Tx): AuralTimelineBase.this.type

Initializes the object.
Initializes the object.
tl
the timeline to listen to. If null (yes, ugly), requires manual additional of views
final def internalState(implicit tx: S.Tx): InternalState

Attributes
protected
Definition Classes
AuralScheduledBase
final def internalState_=(value: InternalState)(implicit tx: S.Tx): Unit

Attributes
protected
Definition Classes
AuralScheduledBase
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def mkView(tid: S.Id, span: SpanLike, obj: Obj[S])(implicit tx: S.Tx): ElemHandle

Should create a new view for the given object and return a handle to it.
Should create a new view for the given object and return a handle to it. As a side effect should also memorize the view in a view-tree, if such structure is maintained, for later retrieval in viewEventAfter

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
final def modelEventAfter(offset: Long)(implicit tx: S.Tx): Long

Report the next interesting frame greater than the given frame for which gridReached (internal) and processPrepare will be called.
Report the next interesting frame greater than the given frame for which gridReached (internal) and processPrepare will be called. If no such event exists, the method must return Long.MaxValue.

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def playView(h: ElemHandle, timeRef: Option, target: Target)(implicit tx: S.Tx): Unit

Should be called from processPlay.
Should be called from processPlay. It calls play on the view and adds it to the list of playing views. Note: timeRef must already have been updated through appropriate intersection.
Sub-classes may override this if they call super.playView

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
final def prepare(timeRef: Option)(implicit tx: S.Tx): Unit

Definition Classes
AuralScheduledBase → ViewBase
final def prepareSpan()(implicit tx: S.Tx): Span

Note: the prepare span will always start from current-frame and have a duration of at least LOOK_STOP.
Note: the prepare span will always start from current-frame and have a duration of at least LOOK_STOP. I.e. during playback it contains the current play position.

Attributes
protected
Definition Classes
AuralScheduledBase
final def processEvent(play: IPlaying, timeRef: TimeRef)(implicit tx: S.Tx): Unit

Called when a next interesting frame has been reached.
Called when a next interesting frame has been reached. The method should look for and invoke the events such as starting or stopping a view.

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
final def processPlay(timeRef: TimeRef, target: Target)(implicit tx: S.Tx): Unit

Called during play.
Called during play. Sub-classes should intersect the current elements and for each of them call playView.

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
final def processPrepare(span: Span, timeRef: TimeRef, initial: Boolean)(implicit tx: S.Tx): Iterator[PrepareResult]

Called during preparation of armed elements.
Called during preparation of armed elements. This happens either during initial prepare or during grid-events. Given the prepareSpan, the sub-class should
- find the elements using an intersect - for each build a view and store it somewhere - for each view call prepareChild - accumulate the results of prepareChild into a Map that is returned.
The map will become part of IPreparing.
initial
if true this is an initial preparation which means the method must include views that start before prepareSpan if their span overlaps with prepareSpan. If false this is a follow up from gridReached and the search must be restricted to views that start no earlier than prepareSpan.

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
final def react(fun: (S.Tx) ⇒ (State) ⇒ Unit)(implicit tx: S.Tx): Disposable[S.Tx]

Definition Classes
ObservableImpl → Observable
def reactNow(fun: (S.Tx) ⇒ (State) ⇒ Unit)(implicit tx: S.Tx): Disposable[S.Tx]

Definition Classes
ViewBase
final def removeObject(id: S.Id, span: SpanLikeObj[S], obj: Obj[S])(implicit tx: S.Tx): Unit
final def run(timeRef: Option, target: Target)(implicit tx: S.Tx): Unit

Ensures state is consistent, then checks preparation of children.
Ensures state is consistent, then checks preparation of children. If all is good, sets internal state to IPlaying and calls processPlay. Next instructs scheduler and sets external state to Playing.

Definition Classes
AuralScheduledBase → ViewBase
final def scheduledEvent()(implicit tx: S.Tx): Scheduled

Attributes
protected
Definition Classes
AuralScheduledBase
final def scheduledGrid()(implicit tx: S.Tx): Scheduled

Attributes
protected
Definition Classes
AuralScheduledBase
final def state(implicit tx: S.Tx): State

Definition Classes
AuralScheduledBase → ViewBase
final def stop()(implicit tx: S.Tx): Unit

Definition Classes
AuralScheduledBase → ViewBase
final def stopView(h: ElemHandle)(implicit tx: S.Tx): Unit

Should be called from processEvent for views that should be stopped and disposed.
Should be called from processEvent for views that should be stopped and disposed. The caller is responsible for removing the view also from a view-tree if such structure is maintained. NOT: This method ends by calling viewRemoved.

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
final def stopViews()(implicit tx: S.Tx): Unit

Stops and disposes all currently playing views.
Stops and disposes all currently playing views.

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final def targetOption(implicit tx: S.Tx): Option[Target]

Definition Classes
AuralScheduledBase
def toString(): String

Definition Classes
AnyRef → Any
final def tpe: Type

Definition Classes
AuralTimelineBase → ObjViewBase
final def viewEventAfter(offset: Long)(implicit tx: S.Tx): Long

Report the next interesting frame greater than the given frame for which eventReached (internal) and processEvent will be called.
Report the next interesting frame greater than the given frame for which eventReached (internal) and processEvent will be called. If no such event exists, the method must return Long.MaxValue.

Attributes
protected
Definition Classes
AuralTimelineBase → AuralScheduledBase
final def views(implicit tx: S.Tx): Set[Elem]
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object AuralTimelineBase | package impl

trait AuralTimelineBase[S <: Sys[S], I <: Sys[I], Target, Elem <: ViewBase[S, Target]] extends AuralScheduledBase[S, Target, Elem] with ObservableImpl[S, State]

Type Members

type ElemHandle = AuralTimelineBase.ElemHandle[S, Elem]

final class IPlaying extends ITimedState

final class IPreparing extends ITimedState

sealed trait ITimedState extends InternalState

sealed trait InternalState extends Disposable[S.Tx]

type Model = Obj[S]

type PrepareResult = (ViewId, SpanLike, Model)

type ViewId = S.Id

Abstract Value Members

implicit abstract val context: AuralContext[S]

abstract def iSys: (S.Tx) ⇒ I.Tx

abstract def makeViewElem(obj: Obj[S])(implicit tx: S.Tx): Elem

abstract def objH: Source[S.Tx, Timeline[S]]

abstract def tree: SkipOctree[I, TwoDim, (SpanLike, IndexedSeq[(Source[S.Tx, S.Id], Elem)])]

abstract def viewPlaying(h: ElemHandle)(implicit tx: S.Tx): Unit

abstract def viewStopped(h: ElemHandle)(implicit tx: S.Tx): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object IStopped extends InternalState with Product with Serializable

final def addObject(id: S.Id, span: SpanLikeObj[S], obj: Obj[S])(implicit tx: S.Tx): Unit

final def asInstanceOf[T0]: T0

final def checkReschedule(h: ElemHandle, currentOffset: Long, oldTarget: Long, elemPlays: Boolean)(implicit tx: S.Tx): Boolean

final def childPreparedOrRemoved(childView: Elem)(implicit tx: S.Tx): Unit

def clone(): AnyRef

def dispose()(implicit tx: S.Tx): Unit

final def elemAdded(vid: ViewId, span: SpanLike, obj: Model)(implicit tx: S.Tx): Unit

def elemFromHandle(h: ElemHandle): Elem

final def elemRemoved(h: ElemHandle, elemPlays: Boolean)(implicit tx: S.Tx): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def fire(update: State)(implicit tx: S.Tx): Unit

final def getClass(): Class[_]

final def getView(timed: Timed[S])(implicit tx: S.Tx): Option[Elem]

final def getViewById(id: S.Id)(implicit tx: S.Tx): Option[Elem]

def hashCode(): Int

def init(tl: Timeline[S])(implicit tx: S.Tx): AuralTimelineBase.this.type

final def internalState(implicit tx: S.Tx): InternalState

final def internalState_=(value: InternalState)(implicit tx: S.Tx): Unit

final def isInstanceOf[T0]: Boolean

final def mkView(tid: S.Id, span: SpanLike, obj: Obj[S])(implicit tx: S.Tx): ElemHandle

final def modelEventAfter(offset: Long)(implicit tx: S.Tx): Long

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def playView(h: ElemHandle, timeRef: Option, target: Target)(implicit tx: S.Tx): Unit

final def prepare(timeRef: Option)(implicit tx: S.Tx): Unit

final def prepareSpan()(implicit tx: S.Tx): Span

final def processEvent(play: IPlaying, timeRef: TimeRef)(implicit tx: S.Tx): Unit

final def processPlay(timeRef: TimeRef, target: Target)(implicit tx: S.Tx): Unit

final def processPrepare(span: Span, timeRef: TimeRef, initial: Boolean)(implicit tx: S.Tx): Iterator[PrepareResult]

final def react(fun: (S.Tx) ⇒ (State) ⇒ Unit)(implicit tx: S.Tx): Disposable[S.Tx]

def reactNow(fun: (S.Tx) ⇒ (State) ⇒ Unit)(implicit tx: S.Tx): Disposable[S.Tx]

final def removeObject(id: S.Id, span: SpanLikeObj[S], obj: Obj[S])(implicit tx: S.Tx): Unit

final def run(timeRef: Option, target: Target)(implicit tx: S.Tx): Unit

final def scheduledEvent()(implicit tx: S.Tx): Scheduled

final def scheduledGrid()(implicit tx: S.Tx): Scheduled

final def state(implicit tx: S.Tx): State

final def stop()(implicit tx: S.Tx): Unit

final def stopView(h: ElemHandle)(implicit tx: S.Tx): Unit

final def stopViews()(implicit tx: S.Tx): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

final def targetOption(implicit tx: S.Tx): Option[Target]

def toString(): String

final def tpe: Type

final def viewEventAfter(offset: Long)(implicit tx: S.Tx): Long

final def views(implicit tx: S.Tx): Set[Elem]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AuralScheduledBase[S, Target, Elem]

Inherited from ObservableImpl[S, State]

Inherited from ObjViewBase[S, Target]

Inherited from ViewBase[S, Target]