Clutter::Timeline Class Reference

#include <timeline.h>

Inheritance diagram for Clutter::Timeline:

Inheritance graph
[legend]

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< Timelineclone () 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 frame 0.
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.
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::PropertyProxy< guint > property_delay ()
 Delay before start.
Glib::PropertyProxy_ReadOnly
< guint > 
property_delay () const
 Delay before start.
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 ()

Static Public Member Functions

static Glib::RefPtr< Timelinecreate (guint n_frames, guint fps)
static Glib::RefPtr< Timelinecreate (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 ()

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Clutter::Timelinewrap (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 frame 0.

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.

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::PropertyProxy<guint> Clutter::Timeline::property_delay (  ) 

Delay before start.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<guint> Clutter::Timeline::property_delay (  )  const

Delay before start.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

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

Timeline frames per second.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<guint> Clutter::Timeline::property_fps (  )  const

Timeline frames per second.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy<bool> Clutter::Timeline::property_loop (  ) 

Should the timeline automatically restart.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<bool> Clutter::Timeline::property_loop (  )  const

Should the timeline automatically restart.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

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

Timelines total number of frames.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::PropertyProxy_ReadOnly<guint> Clutter::Timeline::property_num_frames (  )  const

Timelines total number of frames.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Glib::SignalProxy0< void > Clutter::Timeline::signal_completed (  ) 

Prototype:
void on_my_completed()

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

Prototype:
void on_my_new_frame(gint fram_num)

Glib::SignalProxy0< void > Clutter::Timeline::signal_paused (  ) 

Prototype:
void on_my_paused()

Glib::SignalProxy0< void > Clutter::Timeline::signal_started (  ) 

Prototype:
void on_my_started()

virtual void Clutter::Timeline::on_completed (  )  [protected, virtual]

virtual void Clutter::Timeline::on_new_frame ( gint  fram_num  )  [protected, virtual]

virtual void Clutter::Timeline::on_paused (  )  [protected, virtual]

virtual void Clutter::Timeline::on_started (  )  [protected, virtual]


Friends And Related Function Documentation

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

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

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.


The documentation for this class was generated from the following file:

Generated on Fri Jun 6 02:16:48 2008 for cluttermm by  doxygen 1.5.5