Timeline

---

Object Hierarchy:

Description:

Content:

Properties:

• public bool auto_reverse { get; set; }
  If the direction of the timeline should be automatically reversed when reaching the end.
• public uint delay { get; set; }
  A delay, in milliseconds, that should be observed by the timeline before actually starting.
• public TimelineDirection direction { get; set; }
  The direction of the timeline, either FORWARD or BACKWARD.
• public uint duration { get; set; }
  Duration of the timeline in milliseconds, depending on the ClutterTimeline:fps value.
• public bool loop { get; set; }
  Whether the timeline should automatically rewind and restart.
• public AnimationMode progress_mode { get; set; }
  Controls the way a Timeline computes the normalized progress.
• public int repeat_count { get; set; }
  Defines how many times the timeline should repeat.

Creation methods:

• public Timeline (uint msecs)
  Creates a new Timeline with a duration of msecs.

Methods:

• public void add_marker (string marker_name, double progress)
  Adds a named marker that will be hit when the timeline has reached the specified progress.
• public void add_marker_at_time (string marker_name, uint msecs)
  Adds a named marker that will be hit when the timeline has been running for msecs milliseconds.
• public void advance (uint msecs)
  Advance timeline to the requested point.
• public void advance_to_marker (string marker_name)
  Advances this to the time of the given marker_name.
• public Timeline clone ()
  Create a new Timeline instance which has property values matching that of supplied timeline.
• public bool get_auto_reverse ()
  Retrieves the value set by set_auto_reverse.
• public bool get_cubic_bezier_progress (out Point c_1, out Point c_2)
  Retrieves the control points for the cubic bezier progress mode.
• public int get_current_repeat ()
  Retrieves the current repeat for a timeline.
• public uint get_delay ()
  Retrieves the delay set using set_delay.
• public uint get_delta ()
  Retrieves the amount of time elapsed since the last ClutterTimeline::new-frame signal.
• public TimelineDirection get_direction ()
  Retrieves the direction of the timeline set with set_direction.
• public uint get_duration ()
  Retrieves the duration of a Timeline in milliseconds.
• public int64 get_duration_hint ()
  Retrieves the full duration of the this, taking into account the current value of the repeat_count property.
• public uint get_elapsed_time ()
  Request the current time position of the timeline.
• public bool get_loop ()
  Gets whether this is looping
• public double get_progress ()
  The position of the timeline in a normalized [-1, 2] interval.
• public AnimationMode get_progress_mode ()
  Retrieves the progress mode set using set_progress_mode or set_progress_func.
• public int get_repeat_count ()
  Retrieves the number set using set_repeat_count.
• public bool get_step_progress (out int n_steps, out StepMode step_mode)
  Retrieves the parameters of the step progress mode used by this.
• public bool has_marker (string marker_name)
  Checks whether this has a marker set with the given name.
• public bool is_playing ()
  Queries state of a Timeline.
• public string[] list_markers (int msecs)
  Retrieves the list of markers at time msecs.
• public void pause ()
  Pauses the Timeline on current frame
• public void remove_marker (string marker_name)
  Removes marker_name, if found, from this.
• public void rewind ()
  Rewinds Timeline to the first frame if its direction is FORWARD and the last frame if it is BACKWARD.
• public void set_auto_reverse (bool reverse)
  Sets whether this should reverse the direction after the emission of the completed signal.
• public void set_cubic_bezier_progress (Point c_1, Point c_2)
  Sets the progress_mode of this to CUBIC_BEZIER, and sets the two control points for the cubic bezier.
• public void set_delay (uint msecs)
  Sets the delay, in milliseconds, before this should start.
• public void set_direction (TimelineDirection direction)
  Sets the direction of this, either FORWARD or BACKWARD.
• public void set_duration (uint msecs)
  Sets the duration of the timeline, in milliseconds.
• public void set_loop (bool loop)
  Sets whether this should loop.
• public void set_progress_func (owned TimelineProgressFunc? func)
  Sets a custom progress function for this.
• public void set_progress_mode (AnimationMode mode)
  Sets the progress function using a value from the AnimationMode enumeration.
• public void set_repeat_count (int count)
  Sets the number of times the this should repeat.
• public void set_step_progress (int n_steps, StepMode step_mode)
  Sets the progress_mode of the this to STEPS and provides the parameters of the step function.
• public void skip (uint msecs)
  Advance timeline by the requested time in milliseconds
• public void start ()
  Starts the Timeline playing.
• public void stop ()
  Stops the Timeline and moves to frame 0

Signals:

• public virtual signal void completed ()
  The completed signal is emitted when the timeline's elapsed time reaches the value of the duration property.
• public virtual signal void marker_reached (string marker_name, int msecs)
  The marker_reached signal is emitted each time a timeline reaches a marker set with add_marker_at_time.
• public virtual signal void new_frame (int msecs)
  The new_frame signal is emitted for each timeline running timeline before a new frame is drawn to give animations a chance to update the scene.
• public virtual signal void paused ()
  The paused signal is emitted when pause is invoked.
• public virtual signal void started ()
  The started signal is emitted when the timeline starts its run.
• public virtual signal void stopped (bool is_finished)
  The stopped signal is emitted when the timeline has been stopped, either because stop has been called, or because it has been exhausted.

Inherited Members: