#include <actor.h>
Public Member Functions | |
virtual | ~Actor () |
ClutterActor * | gobj () |
Provides access to the underlying C GObject. | |
const ClutterActor * | gobj () const |
Provides access to the underlying C GObject. | |
ClutterActor * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
void | show () |
Flags a clutter actor to be displayed. | |
void | show_all () |
Call show() on all children of a actor (if any). | |
void | hide () |
Flags a clutter actor to be hidden. | |
void | hide_all () |
Call hide() on all child actors (if any). | |
void | realize () |
Creates any underlying graphics resources needed by the actor to be displayed. | |
void | unrealize () |
Frees up any underlying graphics resources needed by the actor to be displayed. | |
void | paint () |
Renders the actor to display. | |
void | queue_redraw () |
Queues up a redraw of an actor and any children. | |
void | set_geometry (const ClutterGeometry *geometry) |
Sets the actors untransformed geometry in pixels relative to any parent actor. | |
void | get_geometry (ClutterGeometry *geometry) |
Gets the actors untransformed geometry in pixels relative to any parent actor. | |
void | get_coords (int *x_1, int *y_1, int *x_2, int *y_2) const |
Gets the actors untransformed bounding rectangle co-ordinates in pixels relative to any parent actor. | |
void | set_size (int width, int height) |
Sets the actors size in pixels. | |
void | set_sizeu (Unit width, Unit height) |
Sets the actors size in Clutter::Unit. | |
void | get_position (int &x, int &y) |
Retrieves the position of an actor. | |
void | get_positionu (Unit &x, Unit &y) |
Retrieves the position of an actor in Clutter::Unit<!-- -->s. | |
void | set_position (int x, int y) |
Sets the actors position in pixels relative to any parent actor. | |
void | set_positionu (Unit x, Unit y) |
Sets the actors position in Clutter::Unit relative to any parent actor. | |
void | get_abs_position (int &x, int &y) const |
Gets the absolute position of an actor in pixels relative to the stage. | |
guint | get_width () const |
Retrieves the actors width ignoring any scaling factors. | |
Unit | get_widthu () const |
Retrieves the actors width ignoring any scaling factors. | |
guint | get_height () const |
Retrieves the actors height ignoring any scaling factors. | |
Unit | get_heightu () const |
Retrieves the actors height ignoring any scaling factors. | |
void | set_width (guint width) |
Requests a new width for actor. | |
void | set_widthu (Unit width) |
Requests a new width for actor. | |
void | set_height (guint height) |
Requests a new height for actor. | |
void | set_heightu (Unit height) |
Requests a new height for actor. | |
void | set_x (int x) |
Sets the actor's x position relative to its parent. | |
void | set_xu (Unit x) |
Sets the actor's x position relative to its parent. | |
int | get_x () const |
Retrieves the actors x position relative to any parent. | |
Unit | get_xu () const |
Retrieves the actors x position relative to any parent, in Clutter::Unit. | |
void | set_y (int y) |
Sets the actor's y position relative to its parent. | |
void | set_yu (Unit y) |
Sets the actor's y position relative to its parent. | |
int | get_y () const |
Retrieves the actors y position relative to any parent. | |
Unit | get_yu () const |
Retrieves the actors y position relative to any parent, in Clutter::Unit. | |
void | set_reactive (bool reactive=true) |
Sets actor as reactive. | |
bool | get_reactive () const |
Checks whether actor is marked as reactive. | |
void | set_rotation (RotateAxis axis, double angle, int x, int y, int z) |
Sets the rotation angle of self around the given axis. | |
void | set_rotationx (RotateAxis axis, Fixed angle, int x, int y, int z) |
Sets the rotation angle of self around the given axis. | |
double | get_rotation (RotateAxis axis, int &x, int &y, int &z) const |
Retrieves the angle and center of rotation on the given axis, set using clutter_actor_set_angle(). | |
Fixed | get_rotationx (RotateAxis axis, int &x, int &y, int &z) const |
Retrieves the angle and center of rotation on the given axis, set using set_rotation(). | |
void | set_opacity (guint8 opacity) |
Sets the actors opacity, with zero being completely transparent and 255 (0xff) as fully opaque. | |
guint8 | get_opacity () const |
Retrieves the actors opacity. | |
void | set_name (const gchar *name) |
Sets a textual tag to the actor. | |
Glib::ustring | get_name () const |
Retrieves the name of self. | |
guint32 | get_gid () const |
Retrieves the unique id for self. | |
void | set_clip (int xoff, int yoff, int width, int height) |
Sets clip area in pixels for self. | |
void | get_clip (int &xoff, int &yoff, int &width, int &height) |
Gets the clip area for self, in pixels. | |
void | set_clipu (Unit xoff, Unit yoff, Unit width, Unit height) |
Unit-based variant of set_clip(). | |
void | get_clipu (Unit &xoff, Unit &yoff, Unit &width, Unit &height) |
Unit-based variant of get_clip(). | |
void | remove_clip () |
Removes clip area in pixels from self. | |
bool | has_clip () const |
Gets whether the actor has a clip set or not. | |
void | set_parent (const Glib::RefPtr< Actor > &parent) |
Sets the parent of self to parent. | |
Glib::RefPtr< Actor > | get_parent () |
Retrieves the parent of self. | |
Glib::RefPtr< const Actor > | get_parent () const |
Retrieves the parent of self. | |
void | reparent (const Glib::RefPtr< Actor > &new_parent) |
This function resets the parent actor of self. | |
void | unparent () |
This function should not be used in applications. | |
void | raise (const Glib::RefPtr< Actor > &below) |
Puts self above below. | |
void | lower (const Glib::RefPtr< Actor > &above) |
Puts self below above. | |
void | raise_top () |
Raises self to the top. | |
void | lower_bottom () |
Lowers self to the bottom. | |
void | set_depth (int depth) |
Sets the Z co-ordinate of self to depth. | |
void | set_depthu (Unit depth) |
Sets the Z co-ordinate of self to depth in Clutter::Unit, the Units of which are dependant on the perspective setup. | |
int | get_depth () const |
Retrieves the depth of self. | |
Unit | get_depthu () const |
Retrieves the depth of self. | |
void | set_scalex (Fixed scale_x, Fixed scale_y) |
Scales an actor with fixed point parameters. | |
void | set_scale (double scale_x, double scale_y) |
Scales an actor with floating point parameters. | |
void | get_scalex (Fixed &scale_x, Fixed &scale_y) const |
Retrieves an actors scale in fixed point. | |
void | get_scale (double &scale_x, double &scale_y) const |
Retrieves an actors scale in floating point. | |
void | get_abs_size (guint &width, guint &height) const |
Gets the absolute size of an actor taking into account an scaling factors. | |
void | get_size (guint &width, guint &height) const |
Gets the size of an actor in pixels ignoring any scaling factors. | |
void | get_sizeu (Unit &width, Unit &height) const |
Gets the size of an actor in Clutter::Unit<!-- -->s ignoring any scaling factors. | |
void | move_by (int dx, int dy) |
Moves an actor by specified distance relative to current position in pixels. | |
void | move_byu (Unit dx, Unit dy) |
Moves an actor by specified distance relative to the current position. | |
void | apply_transform_to_point (const ClutterVertex &point, ClutterVertex &vertex) |
Transforms point in coordinates relative to the actor into screen coordiances with the current actor tranform (i.e. scale, rotation etc). | |
void | transform_stage_point (Unit x, Unit y, Unit &x_out, Unit &y_out) |
The function translates point with screen coordinates ( x, y) to coordinates relative to the actor, i.e. it can be used to translate screen events from global screen coordinates into local coordinates. | |
bool | event (ClutterEvent *event, bool capture) |
This function is used to emit an event on the main stage. | |
void | set_anchor_point (int anchor_x, int anchor_y) |
Sets an anchor point for the actor. | |
void | get_anchor_point (int &anchor_x, int &anchor_y) const |
Gets the current anchor point of the actor in pixels. | |
void | set_anchor_pointu (Unit anchor_x, Unit anchor_y) |
Sets an anchor point for the self. | |
void | get_anchor_pointu (Unit &anchor_x, Unit &anchor_y) |
Gets the current anchor point of the actor in Clutter::Unit<!-- -->s. | |
void | set_anchor_point_from_gravity (ClutterGravity gravity) |
Sets an anchor point the actor based on the given gravity (this is a convenience function wrapping set_anchor_point()). | |
Glib::SignalProxy1< bool, ButtonEvent * > | signal_button_press_event () |
Glib::SignalProxy1< bool, ButtonEvent * > | signal_button_release_event () |
Glib::SignalProxy1< bool, MotionEvent * > | signal_motion_event () |
Glib::SignalProxy1< bool, CrossingEvent * > | signal_leave_event () |
Glib::SignalProxy0< void > | signal_show () |
Glib::SignalProxy0< void > | signal_hide () |
Glib::SignalProxy0< void > | signal_destroy () |
Glib::SignalProxy1< bool, KeyEvent * > | signal_key_release_event () |
Glib::SignalProxy1< bool, CrossingEvent * > | signal_enter_event () |
Glib::SignalProxy1< bool, Event * > | signal_event () |
Glib::SignalProxy0< void > | signal_focus_out () |
Glib::SignalProxy0< void > | signal_focus_in () |
Glib::SignalProxy1< bool, ScrollEvent * > | signal_scroll_event () |
Glib::SignalProxy1< bool, KeyEvent * > | signal_key_press_event () |
Glib::SignalProxy1< bool, Event * > | signal_captured_event () |
Protected Member Functions | |
Actor () | |
void | pick (const Color &color) |
Renders a silhouette of the actor in supplied color. | |
bool | should_pick_paint () const |
Utility call for subclasses overiding the pick method. | |
virtual bool | on_button_press_event (ButtonEvent *event) |
virtual bool | on_button_release_event (ButtonEvent *event) |
virtual bool | on_motion_event (MotionEvent *event) |
virtual bool | on_leave_event (CrossingEvent *event) |
virtual void | on_show () |
virtual void | on_hide () |
virtual void | on_destroy () |
virtual bool | on_key_release_event (KeyEvent *event) |
virtual bool | on_enter_event (CrossingEvent *event) |
virtual bool | on_event (Event *event) |
virtual void | on_focus_out () |
virtual void | on_focus_in () |
virtual bool | on_scroll_event (ScrollEvent *event) |
virtual bool | on_key_press_event (KeyEvent *event) |
virtual bool | on_captured_event (Event *event) |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Clutter::Actor > | wrap (ClutterActor *object, bool take_copy=false) |
A Glib::wrap() method for this object. |
virtual Clutter::Actor::~Actor | ( | ) | [virtual] |
Clutter::Actor::Actor | ( | ) | [protected] |
ClutterActor* Clutter::Actor::gobj | ( | ) | [inline] |
Provides access to the underlying C GObject.
Reimplemented from Clutter::Scriptable.
Reimplemented in Clutter::CloneTexture, Clutter::Entry, Clutter::Group, Clutter::Label, Clutter::Rectangle, Clutter::Stage, Clutter::Texture, and Clutter::Cairo::CairoTexture.
const ClutterActor* Clutter::Actor::gobj | ( | ) | const [inline] |
Provides access to the underlying C GObject.
Reimplemented from Clutter::Scriptable.
Reimplemented in Clutter::CloneTexture, Clutter::Entry, Clutter::Group, Clutter::Label, Clutter::Rectangle, Clutter::Stage, Clutter::Texture, and Clutter::Cairo::CairoTexture.
ClutterActor* Clutter::Actor::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Reimplemented in Clutter::CloneTexture, Clutter::Entry, Clutter::Group, Clutter::Label, Clutter::Rectangle, Clutter::Stage, Clutter::Texture, and Clutter::Cairo::CairoTexture.
void Clutter::Actor::show | ( | ) |
Flags a clutter actor to be displayed.
An actor not shown will not appear on the display.
void Clutter::Actor::show_all | ( | ) |
Call show() on all children of a actor (if any).
Since: 0.2
void Clutter::Actor::hide | ( | ) |
Flags a clutter actor to be hidden.
An actor not shown will not appear on the display.
void Clutter::Actor::hide_all | ( | ) |
Call hide() on all child actors (if any).
Since: 0.2
void Clutter::Actor::realize | ( | ) |
Creates any underlying graphics resources needed by the actor to be displayed.
void Clutter::Actor::unrealize | ( | ) |
Frees up any underlying graphics resources needed by the actor to be displayed.
void Clutter::Actor::paint | ( | ) |
Renders the actor to display.
This function should not be called directly by applications instead clutter_actor_queue_redraw should be used to queue paints.
void Clutter::Actor::queue_redraw | ( | ) |
Queues up a redraw of an actor and any children.
The redraw occurs once the main loop becomes idle (after the current batch of events has been processed, roughly).
Applications rarely need to call this as redraws are handled automatically by modification functions.
void Clutter::Actor::set_geometry | ( | const ClutterGeometry * | geometry | ) |
Sets the actors untransformed geometry in pixels relative to any parent actor.
geometry | A Clutter::Geometry. |
void Clutter::Actor::get_geometry | ( | ClutterGeometry * | geometry | ) |
Gets the actors untransformed geometry in pixels relative to any parent actor.
geometry | A location to store actors Clutter::Geometry. |
void Clutter::Actor::get_coords | ( | int * | x_1, | |
int * | y_1, | |||
int * | x_2, | |||
int * | y_2 | |||
) | const |
Gets the actors untransformed bounding rectangle co-ordinates in pixels relative to any parent actor.
x_1 | A location to store actors left position, or 0 . | |
y_1 | A location to store actors top position, or 0 . | |
x_2 | A location to store actors right position, or 0 . | |
y_2 | A location to store actors bottom position, or 0 . |
void Clutter::Actor::set_size | ( | int | width, | |
int | height | |||
) |
Sets the actors size in pixels.
If width and/or height are -1 the actor will assume the same size of its bounding box.
width | New width of actor in pixels, or -1. | |
height | New height of actor in pixels, or -1. |
Sets the actors size in Clutter::Unit.
If width and/or height are -1 the actor will assume the same size of its bounding box.
Since: 0.6
width | New width of actor in Clutter::Unit, or -1. | |
height | New height of actor in Clutter::Unit, or -1. |
void Clutter::Actor::get_position | ( | int & | x, | |
int & | y | |||
) |
Retrieves the position of an actor.
Since: 0.6
x | Return location for the X coordinate, or 0 . | |
y | Return location for the Y coordinate, or 0 . |
Retrieves the position of an actor in Clutter::Unit<!-- -->s.
Since: 0.6
x | Return location for the X coordinate, or 0 . | |
y | Return location for the Y coordinate, or 0 . |
void Clutter::Actor::set_position | ( | int | x, | |
int | y | |||
) |
Sets the actors position in pixels relative to any parent actor.
x | New left position of actor in pixels. | |
y | New top position of actor in pixels. |
Sets the actors position in Clutter::Unit relative to any parent actor.
Since: 0.6
x | New left position of actor in Clutter::Unit. | |
y | New top position of actor in Clutter::Unit. |
void Clutter::Actor::get_abs_position | ( | int & | x, | |
int & | y | |||
) | const |
Gets the absolute position of an actor in pixels relative to the stage.
x | Location to store x position if non 0 . | |
y | Location to store y position if non 0 . |
guint Clutter::Actor::get_width | ( | ) | const |
Retrieves the actors width ignoring any scaling factors.
Unit Clutter::Actor::get_widthu | ( | ) | const |
Retrieves the actors width ignoring any scaling factors.
guint Clutter::Actor::get_height | ( | ) | const |
Retrieves the actors height ignoring any scaling factors.
Unit Clutter::Actor::get_heightu | ( | ) | const |
Retrieves the actors height ignoring any scaling factors.
void Clutter::Actor::set_width | ( | guint | width | ) |
Requests a new width for actor.
since: 0.2
width | Requested new width for actor. |
void Clutter::Actor::set_widthu | ( | Unit | width | ) |
Requests a new width for actor.
since: 0.6
width | Requested new width for actor in Clutter::Unit. |
void Clutter::Actor::set_height | ( | guint | height | ) |
Requests a new height for actor.
since: 0.2
height | Requested new height for actor. |
void Clutter::Actor::set_heightu | ( | Unit | height | ) |
Requests a new height for actor.
since: 0.6
height | Requested new height for actor in Clutter::Unit. |
void Clutter::Actor::set_x | ( | int | x | ) |
Sets the actor's x position relative to its parent.
Since: 0.6
x | The actors position on the X axis. |
void Clutter::Actor::set_xu | ( | Unit | x | ) |
Sets the actor's x position relative to its parent.
Since: 0.6
x | The actors position on the X axis in Clutter::Unit. |
int Clutter::Actor::get_x | ( | ) | const |
Retrieves the actors x position relative to any parent.
Unit Clutter::Actor::get_xu | ( | ) | const |
Retrieves the actors x position relative to any parent, in Clutter::Unit.
void Clutter::Actor::set_y | ( | int | y | ) |
Sets the actor's y position relative to its parent.
Since: 0.6
y | The actors position on the Y axis. |
void Clutter::Actor::set_yu | ( | Unit | y | ) |
Sets the actor's y position relative to its parent.
Since: 0.6
y | The actors position on the Y axis in Clutter::Unit. |
int Clutter::Actor::get_y | ( | ) | const |
Retrieves the actors y position relative to any parent.
Unit Clutter::Actor::get_yu | ( | ) | const |
Retrieves the actors y position relative to any parent, in Clutter::Unit.
void Clutter::Actor::set_reactive | ( | bool | reactive = true |
) |
Sets actor as reactive.
Reactive actors will receive events.
Since: 0.6
reactive | Whether the actor should be reactive to events. |
bool Clutter::Actor::get_reactive | ( | ) | const |
Checks whether actor is marked as reactive.
true
if the actor is reactivevoid Clutter::Actor::set_rotation | ( | RotateAxis | axis, | |
double | angle, | |||
int | x, | |||
int | y, | |||
int | z | |||
) |
Sets the rotation angle of self around the given axis.
The rotation center coordinates used depend on the value of axis: <itemizedlist> <listitem>Clutter::X_AXIS requires y and z</listitem> <listitem>Clutter::Y_AXIS requires x and z</listitem> <listitem>Clutter::Z_AXIS requires x and y</listitem> </itemizedlist>
The rotation coordinates are relative to the anchor point of the actor, set using set_anchor_point(). If no anchor point is set, the upper left corner is assumed as the origin.
Since: 0.6
axis | The axis of rotation. | |
angle | The angle of rotation. | |
x | X coordinate of the rotation center. | |
y | Y coordinate of the rotation center. | |
z | Z coordinate of the rotation center. |
void Clutter::Actor::set_rotationx | ( | RotateAxis | axis, | |
Fixed | angle, | |||
int | x, | |||
int | y, | |||
int | z | |||
) |
Sets the rotation angle of self around the given axis.
This function is the fixed point variant of set_rotation().
Since: 0.6
axis | The axis of rotation. | |
angle | The angle of rotation. | |
x | X coordinate of the rotation center. | |
y | Y coordinate of the rotation center. | |
z | Z coordinate of the rotation center. |
double Clutter::Actor::get_rotation | ( | RotateAxis | axis, | |
int & | x, | |||
int & | y, | |||
int & | z | |||
) | const |
Retrieves the angle and center of rotation on the given axis, set using clutter_actor_set_angle().
The coordinates of the center returned by this function depend on the axis passed.
axis | The axis of rotation. | |
x | Return value for the X coordinate of the center of rotation. | |
y | Return value for the Y coordinate of the center of rotation. | |
z | Return value for the Z coordinate of the center of rotation. |
Fixed Clutter::Actor::get_rotationx | ( | RotateAxis | axis, | |
int & | x, | |||
int & | y, | |||
int & | z | |||
) | const |
Retrieves the angle and center of rotation on the given axis, set using set_rotation().
This function is the fixed point variant of get_rotation().
axis | The axis of rotation. | |
x | Return value for the X coordinate of the center of rotation. | |
y | Return value for the Y coordinate of the center of rotation. | |
z | Return value for the Z coordinate of the center of rotation. |
void Clutter::Actor::set_opacity | ( | guint8 | opacity | ) |
Sets the actors opacity, with zero being completely transparent and 255 (0xff) as fully opaque.
opacity | New opacity value for actor. |
guint8 Clutter::Actor::get_opacity | ( | ) | const |
Retrieves the actors opacity.
void Clutter::Actor::set_name | ( | const gchar * | name | ) |
Sets a textual tag to the actor.
name | Textual tag to apply to actor. |
Glib::ustring Clutter::Actor::get_name | ( | ) | const |
Retrieves the name of self.
guint32 Clutter::Actor::get_gid | ( | ) | const |
Retrieves the unique id for self.
void Clutter::Actor::set_clip | ( | int | xoff, | |
int | yoff, | |||
int | width, | |||
int | height | |||
) |
Sets clip area in pixels for self.
The clip area is always computed from the upper left corner of the actor, even if the anchor point is set otherwise.
xoff | X offset of the clip rectangle, in pixels. | |
yoff | Y offset of the clip rectangle, in pixels. | |
width | Width of the clip rectangle, in pixels. | |
height | Height of the clip rectangle, in pixels. |
void Clutter::Actor::get_clip | ( | int & | xoff, | |
int & | yoff, | |||
int & | width, | |||
int & | height | |||
) |
Gets the clip area for self, in pixels.
Since: 0.6
xoff | Return location for the X offset of the clip rectangle, or 0 . | |
yoff | Return location for the Y offset of the clip rectangle, or 0 . | |
width | Return location for the width of the clip rectangle, or 0 . | |
height | Return location for the height of the clip rectangle, or 0 . |
Unit-based variant of set_clip().
Sets clip area for self. The clip area is always computed from the upper left corner of the actor, even if the anchor point is set otherwise.
Since: 0.6
xoff | X offset of the clip rectangle, in Clutter::Unit<!-- -->s. | |
yoff | Y offset of the clip rectangle, in Clutter::Unit<!-- -->s. | |
width | Width of the clip rectangle, in Clutter::Unit<!-- -->s. | |
height | Height of the clip rectangle, in Clutter::Unit<!-- -->s. |
Unit-based variant of get_clip().
Gets the clip area for self, in Clutter::Unit<!-- -->s.
Since: 0.6
xoff | Return location for the X offset of the clip rectangle, or 0 . | |
yoff | Return location for the Y offset of the clip rectangle, or 0 . | |
width | Return location for the width of the clip rectangle, or 0 . | |
height | Return location for the height of the clip rectangle, or 0 . |
void Clutter::Actor::remove_clip | ( | ) |
Removes clip area in pixels from self.
bool Clutter::Actor::has_clip | ( | ) | const |
Gets whether the actor has a clip set or not.
true
if the actor has a clip set.void Clutter::Actor::set_parent | ( | const Glib::RefPtr< Actor > & | parent | ) |
Sets the parent of self to parent.
The opposite function is unparent().
This function should not be used by applications but by custom 'composite' actor sub classes.
parent | A new Clutter::Actor parent. |
Glib::RefPtr<Actor> Clutter::Actor::get_parent | ( | ) |
Glib::RefPtr<const Actor> Clutter::Actor::get_parent | ( | ) | const |
void Clutter::Actor::reparent | ( | const Glib::RefPtr< Actor > & | new_parent | ) |
This function resets the parent actor of self.
It is logically equivalent to calling clutter_actory_unparent() and set_parent().
Since: 0.2
new_parent | The new Clutter::Actor parent. |
void Clutter::Actor::unparent | ( | ) |
This function should not be used in applications.
It should be called by implementations of container actors, to dissociate a child from the container.
Since: 0.1.1
void Clutter::Actor::raise | ( | const Glib::RefPtr< Actor > & | below | ) |
Puts self above below.
Both actors must have the same parent.
below | A Clutter::Actor to raise above. |
void Clutter::Actor::lower | ( | const Glib::RefPtr< Actor > & | above | ) |
Puts self below above.
Both actors must have the same parent.
above | A Clutter::Actor to lower below. |
void Clutter::Actor::raise_top | ( | ) |
Raises self to the top.
void Clutter::Actor::lower_bottom | ( | ) |
Lowers self to the bottom.
void Clutter::Actor::set_depth | ( | int | depth | ) |
Sets the Z co-ordinate of self to depth.
The Units of which are dependant on the perspective setup.
depth | Z co-ord. |
void Clutter::Actor::set_depthu | ( | Unit | depth | ) |
Sets the Z co-ordinate of self to depth in Clutter::Unit, the Units of which are dependant on the perspective setup.
depth | Z co-ord in Clutter::Unit. |
int Clutter::Actor::get_depth | ( | ) | const |
Unit Clutter::Actor::get_depthu | ( | ) | const |
Scales an actor with fixed point parameters.
scale_x | Clutter::Fixed factor to scale actor by horizontally. | |
scale_y | Clutter::Fixed factor to scale actor by vertically. |
void Clutter::Actor::set_scale | ( | double | scale_x, | |
double | scale_y | |||
) |
Scales an actor with floating point parameters.
Since: 0.2
scale_x | Double factor to scale actor by horizontally. | |
scale_y | Double factor to scale actor by vertically. |
Retrieves an actors scale in fixed point.
Since: 0.2
scale_x | Location to store horizonal fixed scale factor if non 0 . | |
scale_y | Location to store vertical fixed scale factor if non 0 . |
void Clutter::Actor::get_scale | ( | double & | scale_x, | |
double & | scale_y | |||
) | const |
Retrieves an actors scale in floating point.
Since: 0.2
scale_x | Location to store horizonal float scale factor if non 0 . | |
scale_y | Location to store vertical float scale factor if non 0 . |
void Clutter::Actor::get_abs_size | ( | guint & | width, | |
guint & | height | |||
) | const |
Gets the absolute size of an actor taking into account an scaling factors.
width | Location to store width if non 0 . | |
height | Location to store height if non 0 . |
void Clutter::Actor::get_size | ( | guint & | width, | |
guint & | height | |||
) | const |
Gets the size of an actor in pixels ignoring any scaling factors.
Since: 0.2
width | Location to store width if non 0 . | |
height | Location to store height if non 0 . |
Gets the size of an actor in Clutter::Unit<!-- -->s ignoring any scaling factors.
Since: 0.6
width | Location to store width if non 0 . | |
height | Location to store height if non 0 . |
void Clutter::Actor::move_by | ( | int | dx, | |
int | dy | |||
) |
Moves an actor by specified distance relative to the current position.
Since: 0.6
dx | Distance to move Actor on X axis, in Clutter::Unit<!-- -->s. | |
dy | Distance to move Actor on Y axis, in Clutter::Unit<!-- -->s. |
void Clutter::Actor::apply_transform_to_point | ( | const ClutterVertex & | point, | |
ClutterVertex & | vertex | |||
) |
Transforms point in coordinates relative to the actor into screen coordiances with the current actor tranform (i.e. scale, rotation etc).
Since: 0.4
point | A point as Clutter::Vertex. | |
vertex | The translated Clutter::Vertex. |
The function translates point with screen coordinates ( x, y) to coordinates relative to the actor, i.e. it can be used to translate screen events from global screen coordinates into local coordinates.
The conversion can fail, notably if the transform stack results in the actor being projected on the screen as a mere line.
The conversion should not be expected to be pixel-perfect due to the nature of the operation. In general the error grows when the skewing of the actor rectangle on screen increases.
x | X screen coordinate of the point to unproject, in Clutter::Unit<!-- -->s. | |
y | Y screen coordinate of the point to unproject, in Clutter::Unit<!-- -->s. | |
x_out | Return location for the unprojected x coordinance, in Clutter::Unit<!-- -->s. | |
y_out | Return location for the unprojected y coordinance, in Clutter::Unit<!-- -->s. |
true
if conversion was successful.bool Clutter::Actor::event | ( | ClutterEvent * | event, | |
bool | capture | |||
) |
This function is used to emit an event on the main stage.
You should rarely need to use this function, except for synthetising events.
event | A Clutter::Event. | |
capture | true if event in in capture phase, false otherwise. |
true
if the actor handled the event, or false
if the event was not handledvoid Clutter::Actor::set_anchor_point | ( | int | anchor_x, | |
int | anchor_y | |||
) |
Sets an anchor point for the actor.
The anchor point is a point in the coordinate space of an actor to which the actor position within its parent is relative; the default is (0, 0), i.e. the top-left corner of the actor.
Since: 0.6
anchor_x | X coordinate of the anchor point. | |
anchor_y | Y coordinate of the anchor point. |
void Clutter::Actor::get_anchor_point | ( | int & | anchor_x, | |
int & | anchor_y | |||
) | const |
Gets the current anchor point of the actor in pixels.
Since: 0.6
anchor_x | Return location for the X coordinate of the anchor point. | |
anchor_y | Return location for the y coordinate of the anchor point. |
Sets an anchor point for the self.
The anchor point is a point in the coordinate space of an actor to which the actor position within its parent is relative; the default is (0, 0), i.e. the top-left corner of the actor.
Since: 0.6
anchor_x | X coordinate of the anchor point, in Clutter::Unit<!-- -->s. | |
anchor_y | Y coordinate of the anchor point, in Clutter::Unit<!-- -->s. |
Gets the current anchor point of the actor in Clutter::Unit<!-- -->s.
Since: 0.6
anchor_x | Return location for the X coordinace of the anchor point. | |
anchor_y | Return location for the X coordinace of the anchor point. |
void Clutter::Actor::set_anchor_point_from_gravity | ( | ClutterGravity | gravity | ) |
Sets an anchor point the actor based on the given gravity (this is a convenience function wrapping set_anchor_point()).
Since: 0.6
gravity | Clutter::Gravity. |
Glib::SignalProxy1< bool,ButtonEvent* > Clutter::Actor::signal_button_press_event | ( | ) |
bool on_my_button_press_event(ButtonEvent* event)
Glib::SignalProxy1< bool,ButtonEvent* > Clutter::Actor::signal_button_release_event | ( | ) |
bool on_my_button_release_event(ButtonEvent* event)
Glib::SignalProxy1< bool,MotionEvent* > Clutter::Actor::signal_motion_event | ( | ) |
bool on_my_motion_event(MotionEvent* event)
Glib::SignalProxy1< bool,CrossingEvent* > Clutter::Actor::signal_leave_event | ( | ) |
bool on_my_leave_event(CrossingEvent* event)
Glib::SignalProxy0< void > Clutter::Actor::signal_show | ( | ) |
void on_my_show()
Glib::SignalProxy0< void > Clutter::Actor::signal_hide | ( | ) |
void on_my_hide()
Glib::SignalProxy0< void > Clutter::Actor::signal_destroy | ( | ) |
void on_my_destroy()
Glib::SignalProxy1< bool,KeyEvent* > Clutter::Actor::signal_key_release_event | ( | ) |
bool on_my_key_release_event(KeyEvent* event)
Glib::SignalProxy1< bool,CrossingEvent* > Clutter::Actor::signal_enter_event | ( | ) |
bool on_my_enter_event(CrossingEvent* event)
Glib::SignalProxy1< bool,Event* > Clutter::Actor::signal_event | ( | ) |
bool on_my_event(Event* event)
Glib::SignalProxy0< void > Clutter::Actor::signal_focus_out | ( | ) |
void on_my_focus_out()
Glib::SignalProxy0< void > Clutter::Actor::signal_focus_in | ( | ) |
void on_my_focus_in()
Glib::SignalProxy1< bool,ScrollEvent* > Clutter::Actor::signal_scroll_event | ( | ) |
bool on_my_scroll_event(ScrollEvent* event)
Glib::SignalProxy1< bool,KeyEvent* > Clutter::Actor::signal_key_press_event | ( | ) |
bool on_my_key_press_event(KeyEvent* event)
Glib::SignalProxy1< bool,Event* > Clutter::Actor::signal_captured_event | ( | ) |
bool on_my_captured_event(Event* event)
void Clutter::Actor::pick | ( | const Color & | color | ) | [protected] |
Renders a silhouette of the actor in supplied color.
Used internally for mapping pointer events to actors.
This function should not never be called directly by applications.
Subclasses overiding this method should call should_pick_paint() to decide if to render there silhouette but in any case should still recursively call pick for any children.
Since 0.4
color | A Clutter::Color. |
bool Clutter::Actor::should_pick_paint | ( | ) | const [protected] |
Utility call for subclasses overiding the pick method.
This function should not never be called directly by applications.
true
if the actor should paint its silhouette, false
otherwise. virtual bool Clutter::Actor::on_button_press_event | ( | ButtonEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_button_release_event | ( | ButtonEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_motion_event | ( | MotionEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_leave_event | ( | CrossingEvent * | event | ) | [protected, virtual] |
virtual void Clutter::Actor::on_show | ( | ) | [protected, virtual] |
virtual void Clutter::Actor::on_hide | ( | ) | [protected, virtual] |
virtual void Clutter::Actor::on_destroy | ( | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_key_release_event | ( | KeyEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_enter_event | ( | CrossingEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_event | ( | Event * | event | ) | [protected, virtual] |
virtual void Clutter::Actor::on_focus_out | ( | ) | [protected, virtual] |
virtual void Clutter::Actor::on_focus_in | ( | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_scroll_event | ( | ScrollEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_key_press_event | ( | KeyEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_captured_event | ( | Event * | event | ) | [protected, virtual] |
Glib::RefPtr< Clutter::Actor > wrap | ( | ClutterActor * | object, | |
bool | take_copy = false | |||
) | [related] |
A Glib::wrap() method for this object.
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. |