Inheritance diagram for Clutter::BehaviourEllipse:

Collaboration diagram for Clutter::BehaviourEllipse:

Public Member Functions
virtual	~BehaviourEllipse ()
ClutterBehaviourEllipse*	gobj ()
	Provides access to the underlying C GObject. More...
const ClutterBehaviourEllipse*	gobj () const
	Provides access to the underlying C GObject. More...
ClutterBehaviourEllipse*	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_center (int x, int y)
	Sets the center of the elliptical path to the point represented by knot. More...
void	get_center (int& x, int& y) const
	Gets the center of the elliptical path path. More...
void	set_height (int height)
	Sets the height of the elliptical path. More...
int	get_height () const
	Gets the height of the elliptical path. More...
void	set_width (int width)
	Sets the width of the elliptical path. More...
int	get_width () const
	Gets the width of the elliptical path. More...
void	set_angle_start (double angle_start)
	Sets the angle at which movement starts; angles >= 360 degress get clamped to the canonical interval <0, 360). More...
double	get_angle_start () const
	Gets the angle at which movements starts. More...
void	set_angle_end (double angle_end)
	Sets the angle at which movement ends; angles >= 360 degress get clamped to the canonical interval <0, 360). More...
double	get_angle_end () const
	Gets the at which movements ends. More...
void	set_angle_tilt (RotateAxis axis, double angle_tilt)
	Sets the angle at which the ellipse should be tilted around it's center. More...
double	get_angle_tilt (RotateAxis axis) const
	Gets the tilt of the ellipse around the center in the given axis. More...
void	set_tilt (double angle_tilt_x, double angle_tilt_y, double angle_tilt_z)
	Sets the angles at which the ellipse should be tilted around it's center. More...
void	get_tilt (double& angle_tilt_x, double& angle_tilt_y, double& angle_tilt_z) const
	Gets the tilt of the ellipse around the center in Y axis. More...
void	set_direction (RotateDirection direction)
	Sets the rotation direction used by the ellipse behaviour. More...
RotateDirection	get_direction () const
	Retrieves the Clutter::RotateDirection used by the ellipse behaviour. More...
Glib::PropertyProxy< double >	property_angle_end ()
	Final angle. More...
Glib::PropertyProxy_ReadOnly < double >	property_angle_end () const
	Final angle. More...
Glib::PropertyProxy< double >	property_angle_start ()
	Initial angle. More...
Glib::PropertyProxy_ReadOnly < double >	property_angle_start () const
	Initial angle. More...
Glib::PropertyProxy< double >	property_angle_tilt_x ()
	Tilt of the ellipse around x axis. More...
Glib::PropertyProxy_ReadOnly < double >	property_angle_tilt_x () const
	Tilt of the ellipse around x axis. More...
Glib::PropertyProxy< double >	property_angle_tilt_y ()
	Tilt of the ellipse around y axis. More...
Glib::PropertyProxy_ReadOnly < double >	property_angle_tilt_y () const
	Tilt of the ellipse around y axis. More...
Glib::PropertyProxy< double >	property_angle_tilt_z ()
	Tilt of the ellipse around z axis. More...
Glib::PropertyProxy_ReadOnly < double >	property_angle_tilt_z () const
	Tilt of the ellipse around z axis. More...
Glib::PropertyProxy< Knot >	property_center ()
	Center of ellipse. More...
Glib::PropertyProxy_ReadOnly < Knot >	property_center () const
	Center of ellipse. More...
Glib::PropertyProxy < RotateDirection >	property_direction ()
	Direction of rotation. More...
Glib::PropertyProxy_ReadOnly < RotateDirection >	property_direction () const
	Direction of rotation. More...
Glib::PropertyProxy< int >	property_height ()
	Height of ellipse. More...
Glib::PropertyProxy_ReadOnly< int >	property_height () const
	Height of ellipse. More...
Glib::PropertyProxy< int >	property_width ()
	Width of the ellipse. More...
Glib::PropertyProxy_ReadOnly< int >	property_width () const
	Width of the ellipse. More...
Public Member Functions inherited from Clutter::Behaviour
virtual	~Behaviour ()
ClutterBehaviour*	gobj ()
	Provides access to the underlying C GObject. More...
const ClutterBehaviour*	gobj () const
	Provides access to the underlying C GObject. More...
ClutterBehaviour*	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	apply (const Glib::RefPtr< Actor >& actor)
	Applies behave to actor. More...
void	remove (const Glib::RefPtr< Actor >& actor)
	Removes actor from the list of Clutter::Actors to which behave applies. More...
void	remove_all ()
	Removes every actor from the list that behave holds. More...
bool	is_applied (const Glib::RefPtr< Actor >& actor)
	Check if behave applied to actor. More...
std::vector< Glib::RefPtr < Actor > >	get_actors ()
std::vector< Glib::RefPtr < Actor const > >	get_actors () const
int	get_n_actors () const
	Gets the number of actors this behaviour is applied too. More...
Glib::RefPtr< Actor >	get_nth_actor (int index)
	Gets an actor the behaviour was applied to referenced by index num. More...
Glib::RefPtr< const Actor >	get_nth_actor (int index) const
	Gets an actor the behaviour was applied to referenced by index num. More...
Glib::RefPtr< Alpha >	get_alpha ()
	Retrieves the Clutter::Alpha object bound to behave. More...
Glib::RefPtr< const Alpha >	get_alpha () const
	Retrieves the Clutter::Alpha object bound to behave. More...
void	set_alpha (const Glib::RefPtr< Alpha >& alpha)
	Binds alpha to a Clutter::Behaviour. More...
void	actors_foreach (const SlotForEach& slot)
Glib::SignalProxy1< void, const Glib::RefPtr< Actor >& >	signal_applied ()
Glib::SignalProxy1< void, const Glib::RefPtr< Actor >& >	signal_removed ()
Glib::PropertyProxy < Glib::RefPtr< Alpha > >	property_alpha ()
	Alpha Object to drive the behaviour. More...
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Alpha > >	property_alpha () const
	Alpha Object to drive the behaviour. 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 < BehaviourEllipse >	create (const Glib::RefPtr< Alpha >& alpha, int x, int y, int width, int height, RotateDirection direction, double begin, double end)
Static Public Member Functions inherited from Clutter::Behaviour
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Member Functions
	BehaviourEllipse (const Glib::RefPtr< Alpha >& alpha, int x, int y, int width, int height, RotateDirection direction, double angle_start, double angle_end)
Protected Member Functions inherited from Clutter::Behaviour
	Behaviour ()
virtual void	alpha_notify_vfunc (double alpha_value)
virtual void	on_applied (const Glib::RefPtr< Actor >& actor)
	This is a default handler for the signal signal_applied(). More...
virtual void	on_removed (const Glib::RefPtr< Actor >& actor)
	This is a default handler for the signal signal_removed(). More...

Related Functions
(Note that these are not member functions.)
Glib::RefPtr < Clutter::BehaviourEllipse >	wrap (ClutterBehaviourEllipse* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...
Related Functions inherited from Clutter::Behaviour
Glib::RefPtr< Clutter::Behaviour >	wrap (ClutterBehaviour* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Additional Inherited Members
Public Types inherited from Clutter::Behaviour
typedef sigc::slot< void, const Glib::RefPtr< Behaviour > &, const Glib::RefPtr< Actor >& >	SlotForEach
	For instance, void on_foreach(const Glib::RefPtr<Behaviour>& behaviour, const Glib::RefPtr<Actor>& actor) More...

Detailed Description

Deprecated:

Behaviour and its sub-classes have been deprecated since Clutter 1.6, in favour of the animation framework API.

Constructor & Destructor Documentation

virtual Clutter::BehaviourEllipse::~BehaviourEllipse ( )

virtual

Clutter::BehaviourEllipse::BehaviourEllipse ( const Glib::RefPtr< Alpha >&  alpha, int  x, int  y, int  width, int  height, RotateDirection  direction, double  angle_start, double  angle_end  )

protected

Member Function Documentation

static Glib::RefPtr<BehaviourEllipse> Clutter::BehaviourEllipse::create ( const Glib::RefPtr< Alpha >&  alpha, int  x, int  y, int  width, int  height, RotateDirection  direction, double  begin, double  end  )

static

double Clutter::BehaviourEllipse::get_angle_end

(

)

const

Gets the at which movements ends.

Since cluttermm 0.4:

Returns

Angle in degrees.

double Clutter::BehaviourEllipse::get_angle_start

(

)

const

Gets the angle at which movements starts.

Since cluttermm 0.6:

Returns

Angle in degrees.

double Clutter::BehaviourEllipse::get_angle_tilt

(

RotateAxis

axis)

const

Gets the tilt of the ellipse around the center in the given axis.

Since cluttermm 0.4:

Parameters

axis	A Clutter::RotateAxis.

Returns

Angle in degrees.

void Clutter::BehaviourEllipse::get_center	(	int &	x,
		int &	y
	)		const

Gets the center of the elliptical path path.

Since cluttermm 0.4:

Parameters

x	Return location for the X coordinate of the center, or 0.
y	Return location for the Y coordinate of the center, or 0.

RotateDirection Clutter::BehaviourEllipse::get_direction

(

)

const

Retrieves the Clutter::RotateDirection used by the ellipse behaviour.

Since cluttermm 0.4:

Returns

The rotation direction.

int Clutter::BehaviourEllipse::get_height

(

)

const

Gets the height of the elliptical path.

Since cluttermm 0.4:

Returns

The height of the path.

void Clutter::BehaviourEllipse::get_tilt	(	double &	angle_tilt_x,
		double &	angle_tilt_y,
		double &	angle_tilt_z
	)		const

Gets the tilt of the ellipse around the center in Y axis.

Since cluttermm 0.4:

Parameters

angle_tilt_x	Return location for tilt angle on the X axis, or 0.
angle_tilt_y	Return location for tilt angle on the Y axis, or 0.
angle_tilt_z	Return location for tilt angle on the Z axis, or 0.

static GType Clutter::BehaviourEllipse::get_type ( )

static

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

int Clutter::BehaviourEllipse::get_width

(

)

const

Gets the width of the elliptical path.

Since cluttermm 0.4:

Returns

The width of the path.

ClutterBehaviourEllipse* Clutter::BehaviourEllipse::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterBehaviourEllipse* Clutter::BehaviourEllipse::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterBehaviourEllipse* Clutter::BehaviourEllipse::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::BehaviourEllipse::property_angle_end

(

)

Final angle.

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::BehaviourEllipse::property_angle_end

(

)

const

Final angle.

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::BehaviourEllipse::property_angle_start

(

)

Initial angle.

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::BehaviourEllipse::property_angle_start

(

)

const

Initial angle.

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::BehaviourEllipse::property_angle_tilt_x

(

)

Tilt of the ellipse around x axis.

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::BehaviourEllipse::property_angle_tilt_x

(

)

const

Tilt of the ellipse around x axis.

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::BehaviourEllipse::property_angle_tilt_y

(

)

Tilt of the ellipse around y axis.

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::BehaviourEllipse::property_angle_tilt_y

(

)

const

Tilt of the ellipse around y axis.

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::BehaviourEllipse::property_angle_tilt_z

(

)

Tilt of the ellipse around z axis.

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::BehaviourEllipse::property_angle_tilt_z

(

)

const

Tilt of the ellipse around z axis.

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< Knot > Clutter::BehaviourEllipse::property_center

(

)

Center of ellipse.

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< Knot > Clutter::BehaviourEllipse::property_center

(

)

const

Center of ellipse.

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< RotateDirection > Clutter::BehaviourEllipse::property_direction

(

)

Direction of rotation.

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< RotateDirection > Clutter::BehaviourEllipse::property_direction

(

)

const

Direction of rotation.

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< int > Clutter::BehaviourEllipse::property_height

(

)

Height of ellipse.

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< int > Clutter::BehaviourEllipse::property_height

(

)

const

Height of ellipse.

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< int > Clutter::BehaviourEllipse::property_width

(

)

Width of the ellipse.

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< int > Clutter::BehaviourEllipse::property_width

(

)

const

Width of the ellipse.

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::BehaviourEllipse::set_angle_end

(

double

angle_end)

Sets the angle at which movement ends; angles >= 360 degress get clamped to the canonical interval <0, 360).

Since cluttermm 0.4:

Parameters

angle_end

Angle at which movement ends in degrees, between 0 and 360.

void Clutter::BehaviourEllipse::set_angle_start

(

double

angle_start)

Sets the angle at which movement starts; angles >= 360 degress get clamped to the canonical interval <0, 360).

Since cluttermm 0.6:

Parameters

angle_start

Angle at which movement starts in degrees, between 0 and 360.

void Clutter::BehaviourEllipse::set_angle_tilt	(	RotateAxis	axis,
		double	angle_tilt
	)

Sets the angle at which the ellipse should be tilted around it's center.

Since cluttermm 0.4:

Parameters

axis	A Clutter::RotateAxis.
angle_tilt	Tilt of the elipse around the center in the given axis in degrees.

void Clutter::BehaviourEllipse::set_center	(	int	x,
		int	y
	)

Sets the center of the elliptical path to the point represented by knot.

Since cluttermm 0.4:

Parameters

x	X coordinace of centre.
y	Y coordinace of centre.

void Clutter::BehaviourEllipse::set_direction

(

RotateDirection

direction)

Sets the rotation direction used by the ellipse behaviour.

Since cluttermm 0.4:

Parameters

direction

The rotation direction.

void Clutter::BehaviourEllipse::set_height

(

int

height)

Sets the height of the elliptical path.

Since cluttermm 0.4:

Parameters

height

Height of the ellipse.

void Clutter::BehaviourEllipse::set_tilt	(	double	angle_tilt_x,
		double	angle_tilt_y,
		double	angle_tilt_z
	)

Sets the angles at which the ellipse should be tilted around it's center.

Since cluttermm 0.4:

Parameters

angle_tilt_x	Tilt of the elipse around the center in X axis in degrees.
angle_tilt_y	Tilt of the elipse around the center in Y axis in degrees.
angle_tilt_z	Tilt of the elipse around the center in Z axis in degrees.

void Clutter::BehaviourEllipse::set_width

(

int

width)

Sets the width of the elliptical path.

Since cluttermm 0.4:

Parameters

width

Width of the ellipse.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::BehaviourEllipse > wrap ( ClutterBehaviourEllipse *  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:

• cluttermm/behaviour-ellipse.h