On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package bogue
On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
Animated variables.
An Avar.t is a variable that evolves in time. It is updated at every frame (i.e. every iteration of the main loop). Bogue uses Avars for animations.
Dependency graph
Avar creation
val create :
?duration:Time.t ->
?init:callback ->
?ending:callback ->
?finished:bool ->
?update:('a t -> float -> 'a) ->
'a ->
'a tGeneric Avar creation. If finished = true, the var never gets further updated, ie behaves like a normal variable. Otherwise, the update parameter is compulsory.
apply f v creates a new Avar by composing with f; the old Avar v is still active
fromto x1 x2 creates a integer Avar.t with initial value x1 and, as time elapses, moves continuously to x2, with a final slowdown.
Similar to fromto but with uniform speed (no slowdown).
val oscillate : ?duration:int -> ?frequency:float -> int -> int -> int toscillate amplitude x0 will oscillate with the given amplitude around the initial value x0
val var : 'a -> 'a tCreate an Avar which behaves like a normal Var (no animation).
Avar information
val get : 'a t -> 'aStart the animation (if necessary) and compute the current value of the variable.
val progress : 'a t -> floatprogress v is a float in [0,1] giving the percentage of the animation when the last v.value was computed. In case of infinite animation, this is just the elapsed Time (in ms).
Misc
On This Page