cluttermm: Clutter::BehaviourRotate Class Reference

Inheritance diagram for Clutter::BehaviourRotate:
Collaboration diagram for Clutter::BehaviourRotate:

Public Member Functions

virtual ~BehaviourRotate ()
 
ClutterBehaviourRotate* gobj ()
 Provides access to the underlying C GObject. More...

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

 
ClutterBehaviourRotate* 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_axis (RotateAxis axis)
 Sets the axis used by the rotate behaviour. More...

 
RotateAxis get_axis () const
 Retrieves the Clutter::RotateAxis used by the rotate behaviour. More...

 
void set_direction (RotateDirection direction)
 Sets the rotation direction used by the rotate behaviour. More...

 
RotateDirection get_direction () const
 Retrieves the Clutter::RotateDirection used by the rotate behaviour. More...

 
void set_center (int x, int y, int z)
 Sets the center of rotation. More...

 
void get_center (int& x, int& y, int& z) const
 Retrieves the center of rotation set using set_center(). More...

 
void set_bounds (double angle_begin, double angle_end)
 Sets the initial and final angles of a rotation behaviour; angles >= 360 degrees get clamped to the canonical interval <0, 360). More...

 
void get_bounds (double& angle_begin, double& angle_end) const
 Retrieves the rotation boundaries of the rotate 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< RotateAxisproperty_axis ()
 Axis of rotation. More...

 
Glib::PropertyProxy_ReadOnly

< RotateAxis
property_axis () const
 Axis of rotation. More...

 
Glib::PropertyProxy< int > property_center_x ()
 X coordinate of the center of rotation. More...

 
Glib::PropertyProxy_ReadOnly< int > property_center_x () const
 X coordinate of the center of rotation. More...

 
Glib::PropertyProxy< int > property_center_y ()
 Y coordinate of the center of rotation. More...

 
Glib::PropertyProxy_ReadOnly< int > property_center_y () const
 Y coordinate of the center of rotation. More...

 
Glib::PropertyProxy< int > property_center_z ()
 Z coordinate of the center of rotation. More...

 
Glib::PropertyProxy_ReadOnly< int > property_center_z () const
 Z coordinate of the center of rotation. More...

 
Glib::PropertyProxy

< RotateDirection
property_direction ()
 Direction of rotation. More...

 
Glib::PropertyProxy_ReadOnly

< RotateDirection
property_direction () const
 Direction of rotation. 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< Actorget_nth_actor (int index)
 Gets an actor the behaviour was applied to referenced by index num. More...

 
Glib::RefPtr< const Actorget_nth_actor (int index) const
 Gets an actor the behaviour was applied to referenced by index num. More...

 
Glib::RefPtr< Alphaget_alpha ()
 Retrieves the Clutter::Alpha object bound to behave. More...

 
Glib::RefPtr< const Alphaget_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

< BehaviourRotate
create (const Glib::RefPtr< Alpha >& alpha, RotateAxis axis, RotateDirection direction, double angle_begin, double angle_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

 BehaviourRotate (const Glib::RefPtr< Alpha >& alpha, RotateAxis axis, RotateDirection direction, double angle_begin, 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::BehaviourRotate
wrap (ClutterBehaviourRotate* 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:
Use the Actor rotation properties and Actor::animate(), or Animator, or State instead.

Constructor & Destructor Documentation

virtual Clutter::BehaviourRotate::~BehaviourRotate ( )
virtual
Clutter::BehaviourRotate::BehaviourRotate ( const Glib::RefPtr< Alpha >&  alpha,
RotateAxis  axis,
RotateDirection  direction,
double  angle_begin,
double  angle_end 
)
explicitprotected

Member Function Documentation

static Glib::RefPtr<BehaviourRotate> Clutter::BehaviourRotate::create ( const Glib::RefPtr< Alpha >&  alpha,
RotateAxis  axis,
RotateDirection  direction,
double  angle_begin,
double  angle_end 
)
static
RotateAxis Clutter::BehaviourRotate::get_axis ( ) const

Retrieves the Clutter::RotateAxis used by the rotate behaviour.

Since cluttermm 0.4:
Returns
The rotation axis.
void Clutter::BehaviourRotate::get_bounds ( double &  angle_begin,
double &  angle_end 
) const

Retrieves the rotation boundaries of the rotate behaviour.

Since cluttermm 0.4:
Parameters
angle_startReturn value for the initial angle.
angle_endReturn value for the final angle.
void Clutter::BehaviourRotate::get_center ( int &  x,
int &  y,
int &  z 
) const

Retrieves the center of rotation set using set_center().

Since cluttermm 0.4:
Parameters
xReturn location for the X center of rotation.
yReturn location for the Y center of rotation.
zReturn location for the Z center of rotation.
RotateDirection Clutter::BehaviourRotate::get_direction ( ) const

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

Since cluttermm 0.4:
Returns
The rotation direction.
static GType Clutter::BehaviourRotate::get_type ( )
static

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

ClutterBehaviourRotate* Clutter::BehaviourRotate::gobj ( )
inline

Provides access to the underlying C GObject.

const ClutterBehaviourRotate* Clutter::BehaviourRotate::gobj ( ) const
inline

Provides access to the underlying C GObject.

ClutterBehaviourRotate* Clutter::BehaviourRotate::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::BehaviourRotate::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::BehaviourRotate::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::BehaviourRotate::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::BehaviourRotate::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< RotateAxis > Clutter::BehaviourRotate::property_axis ( )

Axis 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< RotateAxis > Clutter::BehaviourRotate::property_axis ( ) const

Axis 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::BehaviourRotate::property_center_x ( )

X coordinate of the center 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< int > Clutter::BehaviourRotate::property_center_x ( ) const

X coordinate of the center 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::BehaviourRotate::property_center_y ( )

Y coordinate of the center 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< int > Clutter::BehaviourRotate::property_center_y ( ) const

Y coordinate of the center 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::BehaviourRotate::property_center_z ( )

Z coordinate of the center 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< int > Clutter::BehaviourRotate::property_center_z ( ) const

Z coordinate of the center 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< RotateDirection > Clutter::BehaviourRotate::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::BehaviourRotate::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.
void Clutter::BehaviourRotate::set_axis ( RotateAxis  axis)

Sets the axis used by the rotate behaviour.

Since cluttermm 0.4:
Parameters
axisA Clutter::RotateAxis.
void Clutter::BehaviourRotate::set_bounds ( double  angle_begin,
double  angle_end 
)

Sets the initial and final angles of a rotation behaviour; angles >= 360 degrees get clamped to the canonical interval <0, 360).

Since cluttermm 0.4:
Parameters
angle_startInitial angle in degrees, between 0 and 360.
angle_endFinal angle in degrees, between 0 and 360.
void Clutter::BehaviourRotate::set_center ( int  x,
int  y,
int  z 
)

Sets the center of rotation.

The coordinates are relative to the plane normal to the rotation axis set with set_axis().

Since cluttermm 0.4:
Parameters
xX axis center of rotation.
yY axis center of rotation.
zZ axis center of rotation.
void Clutter::BehaviourRotate::set_direction ( RotateDirection  direction)

Sets the rotation direction used by the rotate behaviour.

Since cluttermm 0.4:
Parameters
directionThe rotation direction.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::BehaviourRotate > wrap ( ClutterBehaviourRotate *  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/behaviour-rotate.h