Clutter::BehaviourBspline Class Reference

#include <behaviour-bspline.h>

Inheritance diagram for Clutter::BehaviourBspline:

List of all members.

Public Member Functions

virtual ~BehaviourBspline ()

ClutterBehaviourBspline * gobj ()

Provides access to the underlying C GObject.

const ClutterBehaviourBspline * gobj () const

Provides access to the underlying C GObject.

ClutterBehaviourBspline * 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 control point to the bezier spline bs.

void truncate (guint offset)

Truncates the bezier spline at the control point; if the control point at offset is not one of the on-curve points, the bspline will be truncated at the nearest preceeding on-curve point.

void join (const Glib::RefPtr< const BehaviourBspline > &bs2)

Joins a copy of bezier spline bs2 onto the end of bezier spline bs1; bs2 is not modified.

Glib::RefPtr< BehaviourBspline > split (guint offset)

Splits a bezier spline into two at the control point at offset; if the control point at offset is not one of the on-curve bezier points, the bspline will be split at the nearest on-curve point before the offset.

void clear ()

Empties a bspline.

void adjust (guint offset, Knot &knot)

Change the coordinaces of control point at index to those represented by the knot.

void set_origin (Knot &knot)

Sets the origin of the bezier to the point represented by knot.

Knot get_origin () const

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

Static Public Member Functions

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

Protected Member Functions

BehaviourBspline (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::BehaviourBspline > wrap (ClutterBehaviourBspline *object, bool take_copy=false)

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

Constructor & Destructor Documentation

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

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

Member Function Documentation

ClutterBehaviourBspline* Clutter::BehaviourBspline::gobj ( ) [inline]

Provides access to the underlying C GObject.

Reimplemented from Clutter::Behaviour.

const ClutterBehaviourBspline* Clutter::BehaviourBspline::gobj ( ) const [inline]

Provides access to the underlying C GObject.

Reimplemented from Clutter::Behaviour.

ClutterBehaviourBspline* Clutter::BehaviourBspline::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<BehaviourBspline> Clutter::BehaviourBspline::create	(	const Glib::RefPtr< Alpha > &	alpha,
		const ClutterKnot *	knots,
		guint	n_knots
	)			`[static]`

void Clutter::BehaviourBspline::append_knot ( const Knot & knot )

Appends a Clutter::Knot control point to the bezier spline bs.

Note, that since a bezier is defined by 4 control points, the point gets stored in a temporary chache, and only when there are enough control points to create a new bezier curve will the bspline extended.

Since: 0.4

Parameters:

knot

A Clutter::Knot control point to append.

void Clutter::BehaviourBspline::truncate ( guint offset )

Truncates the bezier spline at the control point; if the control point at offset is not one of the on-curve points, the bspline will be truncated at the nearest preceeding on-curve point.

Since: 0.4

Parameters:

offset

Offset of control where the bspline should be truncated.

void Clutter::BehaviourBspline::join ( const Glib::RefPtr< const BehaviourBspline > & bs2 )

Joins a copy of bezier spline bs2 onto the end of bezier spline bs1; bs2 is not modified.

Since: 0.4

Parameters:

bs2

A Clutter::BehaviourBspline.

Glib::RefPtr<BehaviourBspline> Clutter::BehaviourBspline::split ( guint offset )

Splits a bezier spline into two at the control point at offset; if the control point at offset is not one of the on-curve bezier points, the bspline will be split at the nearest on-curve point before the offset.

The original bspline is shortened appropriately.

Parameters:

offset

An offset of the control point at which to split the spline.

Returns:: New ClutterBehaviourBspline.

Since: 0.4.

void Clutter::BehaviourBspline::clear ( )

Empties a bspline.

Since: 0.4

void Clutter::BehaviourBspline::adjust	(	guint	offset,
		Knot &	knot
	)

Change the coordinaces of control point at index to those represented by the knot.

Since: 0.4

Parameters:

	offset	An index of control point to ajdust.
	knot	A Clutter::Knot with new coordinances for the control point.

void Clutter::BehaviourBspline::set_origin ( Knot & knot )

Sets the origin of the bezier to the point represented by knot.

(Initially the origin of a bspline is given by the position of the first control point of the first bezier curve.)

Since: 0.4

Parameters:

knot

A Clutter::Knot origin for the bezier.

Knot Clutter::BehaviourBspline::get_origin ( ) const

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

Prototype:: void on_my_knot_reached(const Knot& knot)

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

Friends And Related Function Documentation

Glib::RefPtr< Clutter::BehaviourBspline > wrap	(	ClutterBehaviourBspline *	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:

behaviour-bspline.h


Public Member Functions
virtual	~BehaviourBspline ()
ClutterBehaviourBspline *	gobj ()
	Provides access to the underlying C GObject.
const ClutterBehaviourBspline *	gobj () const
	Provides access to the underlying C GObject.
ClutterBehaviourBspline *	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 control point to the bezier spline bs.
void	truncate (guint offset)
	Truncates the bezier spline at the control point; if the control point at offset is not one of the on-curve points, the bspline will be truncated at the nearest preceeding on-curve point.
void	join (const Glib::RefPtr< const BehaviourBspline > &bs2)
	Joins a copy of bezier spline bs2 onto the end of bezier spline bs1; bs2 is not modified.
Glib::RefPtr< BehaviourBspline >	split (guint offset)
	Splits a bezier spline into two at the control point at offset; if the control point at offset is not one of the on-curve bezier points, the bspline will be split at the nearest on-curve point before the offset.
void	clear ()
	Empties a bspline.
void	adjust (guint offset, Knot &knot)
	Change the coordinaces of control point at index to those represented by the knot.
void	set_origin (Knot &knot)
	Sets the origin of the bezier to the point represented by knot.
Knot	get_origin () const
Glib::SignalProxy1< void, const Knot & >	signal_knot_reached ()
Static Public Member Functions
static Glib::RefPtr < BehaviourBspline >	create (const Glib::RefPtr< Alpha > &alpha, const ClutterKnot *knots, guint n_knots)
Protected Member Functions
	BehaviourBspline (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::BehaviourBspline >	wrap (ClutterBehaviourBspline *object, bool take_copy=false)
	A Glib::wrap() method for this object.