Timeline

A timeline that keeps track of the elapsed time in an animation.

Warning: timelines contain state, even though the state is not directly modifiable by an outsider. The state changes as an animated scene renders and the timeline advances.

Note: the start time does not correspond to frame 0. The time 0.0 seconds corresponds to frame 0; all other values will be interpolated based on the frame rate.

Use the default startTime and endTime parameters for a single-frame (static) sequence.

fps: the frame rate of the animation
startTime: the start time of the animation; the animation will begin at the closest frame to this time, which can be queried through the firstFrameTime value
endTime: the end time of the animation; the animation will end at the closest frame to this time, which can be queries through the lastFrameTime value

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new Timeline(fps: Float = 24.0, startTime: Float = 0.0, endTime: Float = 0.0)

fps
the frame rate of the animation
startTime
the start time of the animation; the animation will begin at the closest frame to this time, which can be queried through the firstFrameTime value
endTime
the end time of the animation; the animation will end at the closest frame to this time, which can be queries through the lastFrameTime value

Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val endTime: Float

the end time of the animation; the animation will end at the closest frame to this time, which can be queries through the lastFrameTime value
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val firstFrame: Int

The frame number of the first frame in this animation sequence.
val firstFrameTime: Float

The actual starting time of the animation; this is the time of the first frame.
val fps: Float

the frame rate of the animation
def frame: Int

Gets the current frame state of the clock.
Gets the current frame state of the clock.
returns
the current frame number
def frameToTime(frame: Int): Float

Converts a frame number to the exact corresponding time.
Converts a frame number to the exact corresponding time.
frame
a frame number
returns
the exact corresponding time
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val lastFrame: Int

The frame number of the last frame in this animation sequence.
val lastFrameTime: Float

The actual ending time of the animation; this is the time of the last frame.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def renderSequence(cam: Camera, sceneRoot: SurfaceNode, lights: Vector[ShadowMappedLight] = Vector.empty): Sequence
def renderSequenceInteractive(cam: Camera, sceneRoot: SurfaceNode, lights: Vector[ShadowMappedLight] = Vector.empty): Sequence
val startTime: Float

the start time of the animation; the animation will begin at the closest frame to this time, which can be queried through the firstFrameTime value
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def time: Float

Gets the current time state of the clock.
Gets the current time state of the clock.
returns
the current time, in seconds
def timeToFrame(secs: Float): Int

Converts a time to the closest frame number.
Converts a time to the closest frame number.
secs
a time
returns
the closest frame number
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( ... )

case class Timeline(fps: Float = 24.0, startTime: Float = 0.0, endTime: Float = 0.0) extends Product with Serializable

Instance Constructors

new Timeline(fps: Float = 24.0, startTime: Float = 0.0, endTime: Float = 0.0)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val endTime: Float

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

val firstFrame: Int

val firstFrameTime: Float

val fps: Float

def frame: Int

def frameToTime(frame: Int): Float

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

val lastFrame: Int

val lastFrameTime: Float

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def renderSequence(cam: Camera, sceneRoot: SurfaceNode, lights: Vector[ShadowMappedLight] = Vector.empty): Sequence

def renderSequenceInteractive(cam: Camera, sceneRoot: SurfaceNode, lights: Vector[ShadowMappedLight] = Vector.empty): Sequence

val startTime: Float

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

def time: Float

def timeToFrame(secs: Float): Int

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped