Clutter::Timeline Class Reference

#include <timeline.h>

Inheritance diagram for Clutter::Timeline:

List of all members.

Public Member Functions

virtual ~Timeline ()

ClutterTimeline * gobj ()

Provides access to the underlying C GObject.

const ClutterTimeline * gobj () const

Provides access to the underlying C GObject.

ClutterTimeline * gobj_copy ()

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Glib::RefPtr< Timeline > clone () const

Create a new Clutter::Timeline instance which has property values matching that of supplied timeline.

void set_duration (guint msecs)

Sets the duration of the timeline, in milliseconds.

guint get_duration () const

Retrieves the duration of a Clutter::Timeline in milliseconds.

void set_speed (guint fps)

Set the speed in frames per second of the timeline.

guint get_speed () const

Gets the frames per second played by timeline.

void start ()

Starts the Clutter::Timeline playing.

void pause ()

Pauses the Clutter::Timeline on current frame.

void stop ()

Stops the Clutter::Timeline and moves to frame 0.

void rewind ()

Rewinds Clutter::Timeline to the first frame if its direction is CLUTTER_TIMELINE_FORWARD and the last frame if it is CLUTTER_TIMELINE_BACKWARD.

void set_loop (bool loop=true)

Sets whether timeline should loop.

bool get_loop () const

Gets whether timeline is looping.

void skip (guint n_frames)

Advance timeline by requested number of frames.

void advance (guint frame_num)

Advance timeline to requested frame number.

int get_current_frame () const

Request the current frame number of the timeline.

guint get_delta (guint &msecs) const

Retrieves the number of frames and the amount of time elapsed since the last ClutterTimeline::new-frame signal.

guint get_delta () const

void set_n_frames (guint n_frames)

Sets the total number of frames for timeline.

guint get_n_frames () const

Request the total number of frames for the Clutter::Timeline.

bool is_playing () const

Query state of a Clutter::Timeline instance.

void set_delay (guint msecs)

Sets the delay, in milliseconds, before timeline should start.

guint get_delay () const

Retrieves the delay set using set_delay().

double get_progress () const

The position of the timeline in a [0, 1] interval.

Fixed get_progressx () const

Fixed point version of get_progress().

void set_direction (TimelineDirection direction)

Sets the direction of timeline, either Clutter::TIMELINE_FORWARD or Clutter::TIMELINE_BACKWARD.

TimelineDirection get_direction () const

Retrieves the direction of the timeline set with set_direction().

Glib::StringArrayHandle list_markers (gint frame_num) const

Retrieves the list of markers at frame_num.

void add_marker_at_time (const Glib::ustring &marker_name, guint msecs)

Time-based variant of add_marker_at_frame().

void add_marker_at_frame (const Glib::ustring &marker_name, guint frame_num)

Adds a named marker at frame_num.

bool has_marker (const Glib::ustring &marker_name)

Checks whether timeline has a marker set with the given name.

void remove_marker (const Glib::ustring &marker_name)

Removes marker_name, if found, from timeline.

void advance_to_marker (const Glib::ustring &marker_name)

Advances timeline to the frame of the given marker_name.

Glib::PropertyProxy< guint > property_delay ()

Delay before start.

Glib::PropertyProxy_ReadOnly
< guint > property_delay () const

Delay before start.

Glib::PropertyProxy
< TimelineDirection > property_direction ()

Direction of the timeline.

Glib::PropertyProxy_ReadOnly
< TimelineDirection > property_direction () const

Direction of the timeline.

Glib::PropertyProxy< guint > property_duration ()

Duration of the timeline in milliseconds.

Glib::PropertyProxy_ReadOnly
< guint > property_duration () const

Duration of the timeline in milliseconds.

Glib::PropertyProxy< guint > property_fps ()

Timeline frames per second.

Glib::PropertyProxy_ReadOnly
< guint > property_fps () const

Timeline frames per second.

Glib::PropertyProxy< bool > property_loop ()

Should the timeline automatically restart.

Glib::PropertyProxy_ReadOnly
< bool > property_loop () const

Should the timeline automatically restart.

Glib::PropertyProxy< guint > property_num_frames ()

Timelines total number of frames.

Glib::PropertyProxy_ReadOnly
< guint > property_num_frames () const

Timelines total number of frames.

Glib::SignalProxy0< void > signal_completed ()

Glib::SignalProxy1< void, gint > signal_new_frame ()

Glib::SignalProxy0< void > signal_paused ()

Glib::SignalProxy0< void > signal_started ()

Glib::SignalProxy2< void,
const Glib::ustring &, int > signal_marker_reached ()

Static Public Member Functions

static Glib::RefPtr< Timeline > create (guint n_frames, guint fps)

static Glib::RefPtr< Timeline > create (guint msecs)

Protected Member Functions

Timeline (guint num_frames, guint fps)

Timeline (guint msecs)

virtual void on_completed ()

virtual void on_new_frame (gint fram_num)

virtual void on_paused ()

virtual void on_started ()

virtual void on_marker_reached (const Glib::ustring &marker_name, int frame_num)

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Clutter::Timeline > wrap (ClutterTimeline *object, bool take_copy=false)

A Glib::wrap() method for this object.

Constructor & Destructor Documentation

virtual Clutter::Timeline::~Timeline ( ) [virtual]

Clutter::Timeline::Timeline	(	guint	num_frames,
		guint	fps
	)			`[explicit, protected]`

Clutter::Timeline::Timeline ( guint msecs ) [explicit, protected]

Member Function Documentation

ClutterTimeline* Clutter::Timeline::gobj ( ) [inline]

Provides access to the underlying C GObject.

const ClutterTimeline* Clutter::Timeline::gobj ( ) const [inline]

Provides access to the underlying C GObject.

ClutterTimeline* Clutter::Timeline::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

static Glib::RefPtr<Timeline> Clutter::Timeline::create	(	guint	n_frames,
		guint	fps
	)			`[static]`

static Glib::RefPtr<Timeline> Clutter::Timeline::create ( guint msecs ) [static]

Glib::RefPtr<Timeline> Clutter::Timeline::clone ( ) const

Create a new Clutter::Timeline instance which has property values matching that of supplied timeline.

The cloned timeline will not be started and will not be positioned to the current position of timeline: you will have to start it with start().

Returns:: A new Clutter::Timeline, cloned from timeline

Since 0.4.

void Clutter::Timeline::set_duration ( guint msecs )

Sets the duration of the timeline, in milliseconds.

The speed of the timeline depends on the ClutterTimeline:fps setting.

Since: 0.6

Parameters:

msecs

Duration of the timeline in milliseconds.

guint Clutter::Timeline::get_duration ( ) const

Retrieves the duration of a Clutter::Timeline in milliseconds.

See set_duration().

Returns:: The duration of the timeline, in milliseconds.

Since: 0.6.

void Clutter::Timeline::set_speed ( guint fps )

Set the speed in frames per second of the timeline.

Parameters:

fps

New speed of timeline as frames per second.

guint Clutter::Timeline::get_speed ( ) const

Gets the frames per second played by timeline.

Returns:: The number of frames per second.

void Clutter::Timeline::start ( )

Starts the Clutter::Timeline playing.

void Clutter::Timeline::pause ( )

Pauses the Clutter::Timeline on current frame.

void Clutter::Timeline::stop ( )

Stops the Clutter::Timeline and moves to frame 0.

void Clutter::Timeline::rewind ( )

Rewinds Clutter::Timeline to the first frame if its direction is CLUTTER_TIMELINE_FORWARD and the last frame if it is CLUTTER_TIMELINE_BACKWARD.

void Clutter::Timeline::set_loop ( bool loop = true )

Sets whether timeline should loop.

Parameters:

loop true for enable looping.

bool Clutter::Timeline::get_loop ( ) const

Gets whether timeline is looping.

Returns:: true if the timeline is looping.

void Clutter::Timeline::skip ( guint n_frames )

Advance timeline by requested number of frames.

Parameters:

n_frames

Number of frames to skip.

void Clutter::Timeline::advance ( guint frame_num )

Advance timeline to requested frame number.

Parameters:

frame_num

Frame number to advance to.

int Clutter::Timeline::get_current_frame ( ) const

Request the current frame number of the timeline.

Returns:: Current frame number.

guint Clutter::Timeline::get_delta ( guint & msecs ) const

Retrieves the number of frames and the amount of time elapsed since the last ClutterTimeline::new-frame signal.

This function is only useful inside handlers for the new-frame signal, and its behaviour is undefined if the timeline is not playing.

Parameters:

msecs Return location for the milliseconds elapsed since the last frame, or 0.

Returns:: The amount of frames elapsed since the last one

Since: 0.6.

guint Clutter::Timeline::get_delta ( ) const

void Clutter::Timeline::set_n_frames ( guint n_frames )

Sets the total number of frames for timeline.

Parameters:

n_frames

The number of frames.

guint Clutter::Timeline::get_n_frames ( ) const

Request the total number of frames for the Clutter::Timeline.

Returns:: Number of frames for this Clutter::Timeline.

bool Clutter::Timeline::is_playing ( ) const

Query state of a Clutter::Timeline instance.

Returns:: true if timeline is currently playing, false if not.

void Clutter::Timeline::set_delay ( guint msecs )

Sets the delay, in milliseconds, before timeline should start.

Since: 0.4

Parameters:

msecs

Delay in milliseconds.

guint Clutter::Timeline::get_delay ( ) const

Retrieves the delay set using set_delay().

Returns:: The delay in milliseconds.

Since: 0.4.

double Clutter::Timeline::get_progress ( ) const

The position of the timeline in a [0, 1] interval.

Returns:: The position of the timeline.

Since: 0.6.

Fixed Clutter::Timeline::get_progressx ( ) const

Fixed point version of get_progress().

Returns:: The position of the timeline as a fixed point value

Since: 0.6.

void Clutter::Timeline::set_direction ( TimelineDirection direction )

Sets the direction of timeline, either Clutter::TIMELINE_FORWARD or Clutter::TIMELINE_BACKWARD.

Since: 0.6

Parameters:

direction

The direction of the timeline.

TimelineDirection Clutter::Timeline::get_direction ( ) const

Retrieves the direction of the timeline set with set_direction().

Returns:: The direction of the timeline

Since: 0.6.

Glib::StringArrayHandle Clutter::Timeline::list_markers ( gint frame_num ) const

Retrieves the list of markers at frame_num.

If frame_num is a negative integer, all the markers attached to timeline will be returned.

Parameters:

	frame_num	The frame number to check, or -1.
	n_markers	The number of markers returned.

Returns:: A newly allocated, 0 terminated string array containing the names of the markers. Use Glib::strfreev() when done.

Since: 0.8.

void Clutter::Timeline::add_marker_at_time	(	const Glib::ustring &	marker_name,
		guint	msecs
	)

Time-based variant of add_marker_at_frame().

Adds a named marker at msecs.

Since: 0.8

Parameters:

	marker_name	The unique name for this marker.
	msecs	Position of the marker in milliseconds.

void Clutter::Timeline::add_marker_at_frame	(	const Glib::ustring &	marker_name,
		guint	frame_num
	)

Adds a named marker at frame_num.

Markers are unique string identifiers for a specific frame. Once timeline reaches frame_num, it will emit a marker-reached signal for each marker attached to that frame.

A marker can be removed with remove_marker(). The timeline can be advanced to a marker using advance_to_marker().

Since: 0.8

Parameters:

	marker_name	The unique name for this marker.
	frame_num	The marker's frame.

bool Clutter::Timeline::has_marker ( const Glib::ustring & marker_name )

Checks whether timeline has a marker set with the given name.

Parameters:

marker_name

The name of the marker.

Returns:: true if the marker was found

Since: 0.8.

void Clutter::Timeline::remove_marker ( const Glib::ustring & marker_name )

Removes marker_name, if found, from timeline.

Since: 0.8

Parameters:

marker_name

The name of the marker to remove.

void Clutter::Timeline::advance_to_marker ( const Glib::ustring & marker_name )

Advances timeline to the frame of the given marker_name.

Since: 0.8

Parameters:

marker_name

The name of the marker.

Glib::PropertyProxy<guint> Clutter::Timeline::property_delay ( )

Delay before start.