#include <effecttemplate.h>
Public Types | |
typedef sigc::slot< guint32, const Glib::RefPtr< Alpha > & > | SlotAlphaFunc |
typedef sigc::slot< void, const Glib::RefPtr< Actor > & > | SlotEffectCompleteFunc |
Public Member Functions | |
virtual | ~EffectTemplate () |
ClutterEffectTemplate * | gobj () |
Provides access to the underlying C GObject. | |
const ClutterEffectTemplate * | gobj () const |
Provides access to the underlying C GObject. | |
ClutterEffectTemplate * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
void | set_timeline_clone (bool setting) |
Sets if effects using this template should make a copy of the templates timeline (default) or reference the effects timeline. | |
bool | get_timeline_clone () const |
Gets whether timelines should be cloned when creating a new effect or just referenced. | |
Glib::RefPtr< Timeline > | fade (const Glib::RefPtr< Actor > &actor, guint8 opacity_end, const SlotEffectCompleteFunc &func) |
Simple effect for fading a single Clutter::Actor. | |
Glib::RefPtr< Timeline > | depth (const Glib::RefPtr< Actor > &actor, int depth_end, const SlotEffectCompleteFunc &func) |
Simple effect for changing the depth of a single Clutter::Actor. | |
Glib::RefPtr< Timeline > | move (const Glib::RefPtr< Actor > &actor, int x, int y, const SlotEffectCompleteFunc &func) |
Simple effect for moving a single Clutter::Actor along to a destination point. | |
Glib::RefPtr< Timeline > | path (const Glib::RefPtr< Actor > &actor, const ClutterKnot *knots, guint n_knots, const SlotEffectCompleteFunc &func) |
Simple effect for moving a single Clutter::Actor along a path. | |
Glib::RefPtr< Timeline > | scale (const Glib::RefPtr< Actor > &actor, double x_scale_end, double y_scale_end, const SlotEffectCompleteFunc &func) |
Simple effect for scaling a single Clutter::Actor. | |
Glib::RefPtr< Timeline > | rotate (const Glib::RefPtr< Actor > &actor, RotateAxis axis, double angle_end, int center_x, int center_y, int center_z, RotateDirection direction, const SlotEffectCompleteFunc &func) |
Simple effect for rotating a single Clutter::Actor. | |
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Timeline > > | property_timeline () const |
Timeline to use as a reference for the Template. | |
Glib::PropertyProxy< bool > | property_clone () |
controls if effects should clone or reference the templated timeline. | |
Glib::PropertyProxy_ReadOnly < bool > | property_clone () const |
controls if effects should clone or reference the templated timeline. | |
Static Public Member Functions | |
static Glib::RefPtr < EffectTemplate > | create (const Glib::RefPtr< Timeline > &timeline, const SlotAlphaFunc &alpha_func) |
static Glib::RefPtr < EffectTemplate > | create (guint msecs, const SlotAlphaFunc &alpha_func) |
Protected Member Functions | |
EffectTemplate (const Glib::RefPtr< Timeline > &timeline, const SlotAlphaFunc &alpha_func) | |
EffectTemplate (guint msecs, const SlotAlphaFunc &alpha_func) | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr < Clutter::EffectTemplate > | wrap (ClutterEffectTemplate *object, bool take_copy=false) |
A Glib::wrap() method for this object. |
typedef sigc::slot<guint32, const Glib::RefPtr<Alpha>&> Clutter::EffectTemplate::SlotAlphaFunc |
typedef sigc::slot<void, const Glib::RefPtr<Actor>&> Clutter::EffectTemplate::SlotEffectCompleteFunc |
virtual Clutter::EffectTemplate::~EffectTemplate | ( | ) | [virtual] |
Clutter::EffectTemplate::EffectTemplate | ( | const Glib::RefPtr< Timeline > & | timeline, | |
const SlotAlphaFunc & | alpha_func | |||
) | [protected] |
Clutter::EffectTemplate::EffectTemplate | ( | guint | msecs, | |
const SlotAlphaFunc & | alpha_func | |||
) | [protected] |
ClutterEffectTemplate* Clutter::EffectTemplate::gobj | ( | ) | [inline] |
Provides access to the underlying C GObject.
const ClutterEffectTemplate* Clutter::EffectTemplate::gobj | ( | ) | const [inline] |
Provides access to the underlying C GObject.
ClutterEffectTemplate* Clutter::EffectTemplate::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<EffectTemplate> Clutter::EffectTemplate::create | ( | const Glib::RefPtr< Timeline > & | timeline, | |
const SlotAlphaFunc & | alpha_func | |||
) | [static] |
static Glib::RefPtr<EffectTemplate> Clutter::EffectTemplate::create | ( | guint | msecs, | |
const SlotAlphaFunc & | alpha_func | |||
) | [static] |
void Clutter::EffectTemplate::set_timeline_clone | ( | bool | setting | ) |
Sets if effects using this template should make a copy of the templates timeline (default) or reference the effects timeline.
Since: 0.6
setting | A boolean indicating if effects should clone the timeline. |
bool Clutter::EffectTemplate::get_timeline_clone | ( | ) | const |
Gets whether timelines should be cloned when creating a new effect or just referenced.
true
if the templates timeline is to be cloned.Glib::RefPtr<Timeline> Clutter::EffectTemplate::fade | ( | const Glib::RefPtr< Actor > & | actor, | |
guint8 | opacity_end, | |||
const SlotEffectCompleteFunc & | func | |||
) |
Simple effect for fading a single Clutter::Actor.
template | A Clutter::EffectTemplate. | |
actor | A Clutter::Actor to apply the effect to. | |
opacity_end | Final opacity value to apply to actor. | |
func | A Clutter::EffectCompleteFunc to call on effect completion or 0 . | |
data | Data to pass to supplied Clutter::EffectCompleteFunc or 0 . |
Glib::RefPtr<Timeline> Clutter::EffectTemplate::depth | ( | const Glib::RefPtr< Actor > & | actor, | |
int | depth_end, | |||
const SlotEffectCompleteFunc & | func | |||
) |
Simple effect for changing the depth of a single Clutter::Actor.
template | A Clutter::EffectTemplate. | |
actor | A Clutter::Actor to apply the effect to. | |
depth_end | Final depth value to apply to actor. | |
func | A Clutter::EffectCompleteFunc to call on effect completion or 0 . | |
data | Data to pass to supplied Clutter::EffectCompleteFunc or 0 . |
Glib::RefPtr<Timeline> Clutter::EffectTemplate::move | ( | const Glib::RefPtr< Actor > & | actor, | |
int | x, | |||
int | y, | |||
const SlotEffectCompleteFunc & | func | |||
) |
Simple effect for moving a single Clutter::Actor along to a destination point.
template | A Clutter::EffectTemplate. | |
actor | A Clutter::Actor to apply the effect to. | |
x | X coordinate of the destination. | |
y | Y coordinate of the destination. | |
func | A Clutter::EffectCompleteFunc to call on effect completion or 0 . | |
data | Data to pass to supplied Clutter::EffectCompleteFunc or 0 . |
Glib::RefPtr<Timeline> Clutter::EffectTemplate::path | ( | const Glib::RefPtr< Actor > & | actor, | |
const ClutterKnot * | knots, | |||
guint | n_knots, | |||
const SlotEffectCompleteFunc & | func | |||
) |
Simple effect for moving a single Clutter::Actor along a path.
template | A Clutter::EffectTemplate. | |
actor | A Clutter::Actor to apply the effect to. | |
knots | An array of Clutter::Knots representing path for the actor. | |
n_knots | Number of Clutter::Knots in passed array. | |
func | A Clutter::EffectCompleteFunc to call on effect completion or 0 . | |
data | Data to pass to supplied Clutter::EffectCompleteFunc or 0 . |
Glib::RefPtr<Timeline> Clutter::EffectTemplate::scale | ( | const Glib::RefPtr< Actor > & | actor, | |
double | x_scale_end, | |||
double | y_scale_end, | |||
const SlotEffectCompleteFunc & | func | |||
) |
Simple effect for scaling a single Clutter::Actor.
template | A Clutter::EffectTemplate. | |
actor | A Clutter::Actor to apply the effect to. | |
x_scale_end | Final X axis scale factor to apply to actor. | |
y_scale_end | Final Y axis scale factor to apply to actor. | |
func | A Clutter::EffectCompleteFunc to call on effect completion or 0 . | |
data | Data to pass to supplied Clutter::EffectCompleteFunc or 0 . |
Glib::RefPtr<Timeline> Clutter::EffectTemplate::rotate | ( | const Glib::RefPtr< Actor > & | actor, | |
RotateAxis | axis, | |||
double | angle_end, | |||
int | center_x, | |||
int | center_y, | |||
int | center_z, | |||
RotateDirection | direction, | |||
const SlotEffectCompleteFunc & | func | |||
) |
Simple effect for rotating a single Clutter::Actor.
template | A Clutter::EffectTemplate. | |
actor | A Clutter::Actor to apply the effect to. | |
axis | Axis of rotation. | |
angle | Final angle to apply to actor. | |
center_x | Position on X axis to rotate about. | |
center_y | Position on Y axis to rotate about. | |
center_z | Position on Z axis to rotate about. | |
direction | A Clutter::RotateDirection for the rotation. | |
func | A Clutter::EffectCompleteFunc to call on effect completion or 0 . | |
data | User data to pass to supplied func or 0 . |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Timeline> > Clutter::EffectTemplate::property_timeline | ( | ) | const |
Timeline to use as a reference for the Template.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool> Clutter::EffectTemplate::property_clone | ( | ) |
controls if effects should clone or reference the templated timeline.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<bool> Clutter::EffectTemplate::property_clone | ( | ) | const |
controls if effects should clone or reference the templated timeline.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::RefPtr< Clutter::EffectTemplate > wrap | ( | ClutterEffectTemplate * | object, | |
bool | take_copy = false | |||
) | [related] |
A Glib::wrap() method for this object.
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. |