cluttermm: Clutter::PageTurnEffect Class Reference

Inheritance diagram for Clutter::PageTurnEffect:
Collaboration diagram for Clutter::PageTurnEffect:

Public Member Functions

virtual ~PageTurnEffect ()
 
ClutterPageTurnEffect* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterPageTurnEffect* gobj () const
 Provides access to the underlying C GObject. More...

 
ClutterPageTurnEffect* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
void set_period (double period)
 Sets the period of the page curling, between 0.0 (no curling) and 1.0 (fully curled) More...

 
double get_period () const
 Retrieves the value set using get_period() More...

 
void set_angle (double angle)
 Sets the angle of the page curling, in degrees. More...

 
double get_angle () const
 Retrieves the value set using get_angle() More...

 
void set_radius (float radius)
 Sets the radius of the page curling. More...

 
float get_radius () const
 Retrieves the value set using set_radius() More...

 
Glib::PropertyProxy< double > property_angle ()
 The angle of the page rotation, in degrees. More...

 
Glib::PropertyProxy_ReadOnly

< double > 
property_angle () const
 The angle of the page rotation, in degrees. More...

 
Glib::PropertyProxy< double > property_period ()
 The period of the page turn. More...

 
Glib::PropertyProxy_ReadOnly

< double > 
property_period () const
 The period of the page turn. More...

 
Glib::PropertyProxy< float > property_radius ()
 The radius of the page curl. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_radius () const
 The radius of the page curl. More...

 
- Public Member Functions inherited from Clutter::DeformEffect
virtual ~DeformEffect ()
 
ClutterDeformEffect* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterDeformEffect* gobj () const
 Provides access to the underlying C GObject. More...

 
ClutterDeformEffect* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
void set_back_material (CoglHandle material)
 Sets the material that should be used when drawing the back face of the actor during a deformation. More...

 
CoglHandle get_back_material ()
 Retrieves the handle to the back face material used by effect. More...

 
void set_n_tiles (guint x_tiles, guint y_tiles)
 Sets the number of horizontal and vertical tiles to be used when applying the effect. More...

 
void get_n_tiles (guint& x_tiles, guint& y_tiles) const
 Retrieves the number of horizontal and vertical tiles used to sub-divide the actor's geometry during the effect. More...

 
void invalidate ()
 Invalidates the effect's vertices and, if it is associated to an actor, it will queue a redraw. More...

 
Glib::PropertyProxy< CoglHandle* > property_back_material ()
 The material to be used when painting the back of the actor. More...

 
Glib::PropertyProxy_ReadOnly

< CoglHandle* > 
property_back_material () const
 The material to be used when painting the back of the actor. More...

 
Glib::PropertyProxy< guint > property_x_tiles ()
 The number of horizontal tiles. More...

 
Glib::PropertyProxy_ReadOnly

< guint > 
property_x_tiles () const
 The number of horizontal tiles. More...

 
Glib::PropertyProxy< guint > property_y_tiles ()
 The number of vertical tiles. More...

 
Glib::PropertyProxy_ReadOnly

< guint > 
property_y_tiles () const
 The number of vertical tiles. More...

 
- Public Member Functions inherited from Clutter::OffscreenEffect
virtual ~OffscreenEffect ()
 
ClutterOffscreenEffect* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterOffscreenEffect* gobj () const
 Provides access to the underlying C GObject. More...

 
ClutterOffscreenEffect* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
CoglHandle get_texture ()
 Retrieves the texture used as a render target for the offscreen buffer created by effect. More...

 
CoglHandle create_texture (float width, float height)
 Calls the create_texture() virtual function of the effect. More...

 
void paint_target ()
 Calls the paint_target() virtual function of the effect. More...

 
- Public Member Functions inherited from Clutter::Effect
virtual ~Effect ()
 
ClutterEffect* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterEffect* gobj () const
 Provides access to the underlying C GObject. More...

 
ClutterEffect* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
void queue_repaint ()
 Queues a repaint of the effect. More...

 
- Public Member Functions inherited from Clutter::ActorMeta
virtual ~ActorMeta ()
 
ClutterActorMeta* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterActorMeta* gobj () const
 Provides access to the underlying C GObject. More...

 
ClutterActorMeta* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
void set_name (const Glib::ustring& name)
 Sets the name of meta. More...

 
Glib::ustring get_name () const
 Retrieves the name set using set_name() More...

 
void set_enabled (bool is_enabled=true)
 Sets whether meta should be enabled or not. More...

 
bool get_enabled () const
 Retrieves whether meta is enabled. More...

 
Glib::RefPtr< Actorget_actor ()
 Retrieves a pointer to the Clutter::Actor that owns meta. More...

 
Glib::RefPtr< const Actorget_actor () const
 Retrieves a pointer to the Clutter::Actor that owns meta. More...

 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static Glib::RefPtr

< PageTurnEffect
create (double period, double angle, float radius)
 
- Static Public Member Functions inherited from Clutter::DeformEffect
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static Glib::RefPtr< DeformEffectcreate ()
 
- Static Public Member Functions inherited from Clutter::OffscreenEffect
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Clutter::Effect
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
- Static Public Member Functions inherited from Clutter::ActorMeta
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 

Protected Member Functions

 PageTurnEffect (double period, double angle, float radius)
 
- Protected Member Functions inherited from Clutter::DeformEffect
 DeformEffect ()
 
- Protected Member Functions inherited from Clutter::OffscreenEffect
 OffscreenEffect ()
 
- Protected Member Functions inherited from Clutter::Effect
 Effect ()
 
- Protected Member Functions inherited from Clutter::ActorMeta
 ActorMeta ()
 
virtual void set_actor_vfunc (const Glib::RefPtr< const Actor >& actor)
 
Glib::PropertyProxy_ReadOnly

< Glib::RefPtr< Actor > > 
property_actor () const
 The actor attached to the meta. More...

 
Glib::PropertyProxy< bool > property_enabled ()
 Whether the meta is enabled. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_enabled () const
 Whether the meta is enabled. More...

 
Glib::PropertyProxy

< Glib::ustring
property_name ()
 The name of the meta. More...

 
Glib::PropertyProxy_ReadOnly

< Glib::ustring
property_name () const
 The name of the meta. More...

 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr

< Clutter::PageTurnEffect
wrap (ClutterPageTurnEffect* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Constructor & Destructor Documentation

virtual Clutter::PageTurnEffect::~PageTurnEffect ( )
virtual
Clutter::PageTurnEffect::PageTurnEffect ( double  period,
double  angle,
float  radius 
)
explicitprotected

Member Function Documentation

static Glib::RefPtr<PageTurnEffect> Clutter::PageTurnEffect::create ( double  period,
double  angle,
float  radius 
)
static
double Clutter::PageTurnEffect::get_angle ( ) const

Retrieves the value set using get_angle()

Since cluttermm 1.4:
Returns
The angle of the page curling.
double Clutter::PageTurnEffect::get_period ( ) const

Retrieves the value set using get_period()

Since cluttermm 1.4:
Returns
The period of the page curling.
float Clutter::PageTurnEffect::get_radius ( ) const

Retrieves the value set using set_radius()

Since cluttermm 1.4:
Returns
The radius of the page curling.
static GType Clutter::PageTurnEffect::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

ClutterPageTurnEffect* Clutter::PageTurnEffect::gobj ( )
inline

Provides access to the underlying C GObject.

const ClutterPageTurnEffect* Clutter::PageTurnEffect::gobj ( ) const
inline

Provides access to the underlying C GObject.

ClutterPageTurnEffect* Clutter::PageTurnEffect::gobj_copy ( )

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

Glib::PropertyProxy< double > Clutter::PageTurnEffect::property_angle ( )

The angle of the page rotation, in degrees.

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 value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< double > Clutter::PageTurnEffect::property_angle ( ) const

The angle of the page rotation, in degrees.

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

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< double > Clutter::PageTurnEffect::property_period ( )

The period of the page turn.

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 value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< double > Clutter::PageTurnEffect::property_period ( ) const

The period of the page turn.

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

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< float > Clutter::PageTurnEffect::property_radius ( )

The radius of the page curl.

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 value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< float > Clutter::PageTurnEffect::property_radius ( ) const

The radius of the page curl.

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

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Clutter::PageTurnEffect::set_angle ( double  angle)

Sets the angle of the page curling, in degrees.

Since cluttermm 1.4:
Parameters
angleThe angle of the page curl, in degrees.
void Clutter::PageTurnEffect::set_period ( double  period)

Sets the period of the page curling, between 0.0 (no curling) and 1.0 (fully curled)

Since cluttermm 1.4:
Parameters
periodThe period of the page curl, between 0.0 and 1.0.
void Clutter::PageTurnEffect::set_radius ( float  radius)

Sets the radius of the page curling.

Since cluttermm 1.4:
Parameters
radiusThe radius of the page curling, in pixels.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::PageTurnEffect > wrap ( ClutterPageTurnEffect *  object,
bool  take_copy = false 
)
related

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

Parameters
objectThe C instance.
take_copyFalse 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:
  • cluttermm/page-turn-effect.h