Clutter::BehaviourPath Class Reference

#include <behaviour-path.h>

Inheritance diagram for Clutter::BehaviourPath:

Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~BehaviourPath ()
ClutterBehaviourPath * gobj ()
 Provides access to the underlying C GObject.
const ClutterBehaviourPath * gobj () const
 Provides access to the underlying C GObject.
ClutterBehaviourPath * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void append_knot (const Knot &knot)
 Appends a Clutter::Knot to the path.
void insert_knot (guint offset, const Knot &knot)
 Inserts a Clutter::Knot in the path at specified position.
void remove_knot (guint offset)
 Removes a Clutter::Knot in the path at specified offset.
void clear ()
 Removes all knots from a path.
Glib::SignalProxy1< void,
const Knot & > 
signal_knot_reached ()
Glib::PropertyProxy_WriteOnly
< Knot
property_knot ()
 Can be used to append a knot to the path.

Static Public Member Functions

static Glib::RefPtr
< BehaviourPath
create (const Glib::RefPtr< Alpha > &alpha, const ClutterKnot *knots, guint n_knots)

Protected Member Functions

 BehaviourPath (const Glib::RefPtr< Alpha > &alpha, const ClutterKnot *knots, guint n_knots)
virtual void on_knot_reached (const Knot &knot)

Related Functions

(Note that these are not member functions.)

Glib::RefPtr
< Clutter::BehaviourPath
wrap (ClutterBehaviourPath *object, bool take_copy=false)
 A Glib::wrap() method for this object.


Constructor & Destructor Documentation

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

Clutter::BehaviourPath::BehaviourPath ( const Glib::RefPtr< Alpha > &  alpha,
const ClutterKnot *  knots,
guint  n_knots 
) [explicit, protected]


Member Function Documentation

ClutterBehaviourPath* Clutter::BehaviourPath::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Clutter::Behaviour.

const ClutterBehaviourPath* Clutter::BehaviourPath::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Clutter::Behaviour.

ClutterBehaviourPath* Clutter::BehaviourPath::gobj_copy (  ) 

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

Reimplemented from Clutter::Behaviour.

static Glib::RefPtr<BehaviourPath> Clutter::BehaviourPath::create ( const Glib::RefPtr< Alpha > &  alpha,
const ClutterKnot *  knots,
guint  n_knots 
) [static]

void Clutter::BehaviourPath::append_knot ( const Knot knot  ) 

Appends a Clutter::Knot to the path.

Since: 0.2

Parameters:
knot A Clutter::Knot to append.

void Clutter::BehaviourPath::insert_knot ( guint  offset,
const Knot knot 
)

Inserts a Clutter::Knot in the path at specified position.

Values greater than total number of knots will append the knot at the end of path.

Since: 0.2

Parameters:
offset Position in path to insert knot.
knot A Clutter::Knot to append.

void Clutter::BehaviourPath::remove_knot ( guint  offset  ) 

Removes a Clutter::Knot in the path at specified offset.

Since: 0.2

Parameters:
offset Position in path to remove knot.

void Clutter::BehaviourPath::clear (  ) 

Removes all knots from a path.

Since: 0.2

Glib::SignalProxy1< void,const Knot& > Clutter::BehaviourPath::signal_knot_reached (  ) 

Prototype:
void on_my_knot_reached(const Knot& knot)

Glib::PropertyProxy_WriteOnly<Knot> Clutter::BehaviourPath::property_knot (  ) 

Can be used to append a knot to the path.

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.

virtual void Clutter::BehaviourPath::on_knot_reached ( const Knot knot  )  [protected, virtual]


Friends And Related Function Documentation

Glib::RefPtr< Clutter::BehaviourPath > wrap ( ClutterBehaviourPath *  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:17:45 2008 for cluttermm by  doxygen 1.5.5