cluttermm: Clutter::Actor Class Reference
Public Member Functions | |
virtual | ~Actor () |
ClutterActor* | gobj () |
Provides access to the underlying C GObject. More... | |
const ClutterActor* | gobj () const |
Provides access to the underlying C GObject. More... | |
ClutterActor* | 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_flags (ActorFlags flags) |
Sets flags on self. More... | |
void | unset_flags (ActorFlags flags) |
Unsets flags on self. More... | |
ActorFlags | get_flags () const |
Retrieves the flags set on self. More... | |
bool | is_mapped () const |
bool | is_realized () const |
bool | is_visible () const |
bool | is_reactive () const |
void | show () |
Flags an actor to be displayed. More... | |
void | show_all () |
Calls show() on all children of an actor (if any). More... | |
void | hide () |
Flags an actor to be hidden. More... | |
void | hide_all () |
Calls hide() on all child actors (if any). More... | |
void | realize () |
Realization informs the actor that it is attached to a stage. More... | |
void | unrealize () |
Unrealization informs the actor that it may be being destroyed or moved to another stage. More... | |
void | map () |
Sets the Clutter::ACTOR_MAPPED flag on the actor and possibly maps and realizes its children if they are visible. More... | |
void | unmap () |
Unsets the Clutter::ACTOR_MAPPED flag on the actor and possibly unmaps its children if they were mapped. More... | |
void | paint () |
Renders the actor to display. More... | |
void | continue_paint () |
Run the next stage of the paint sequence. More... | |
void | queue_redraw () |
Queues up a redraw of an actor and any children. More... | |
void | queue_relayout () |
Indicates that the actor's size request or other layout-affecting properties may have changed. More... | |
bool | has_overlaps () |
Asks the actor's implementation whether it may contain overlapping primitives. More... | |
void | set_content (const Glib::RefPtr< Content >& content) |
Sets the contents of a Clutter::Actor. More... | |
Glib::RefPtr< Content > | get_content () |
Retrieves the contents of self. More... | |
Glib::RefPtr< const Content > | get_content () const |
Retrieves the contents of self. More... | |
void | set_content_gravity (ContentGravity gravity) |
Sets the gravity of the Clutter::Content used by self. More... | |
ContentGravity | get_content_gravity () const |
Retrieves the content gravity as set using set_content_gravity(). More... | |
void | set_content_scaling_filters (ScalingFilter min_filter, ScalingFilter mag_filter) |
Sets the minification and magnification filter to be applied when scaling the Clutter::Actor::property_content() of a Clutter::Actor. More... | |
void | get_content_scaling_filters (ScalingFilter& min_filter, ScalingFilter& mag_filter) |
Retrieves the values set using set_content_scaling_filters(). More... | |
void | set_content_repeat (ContentRepeat repeat) |
Sets the policy for repeating the Clutter::Actor::property_content() of a Clutter::Actor. More... | |
ContentRepeat | get_content_repeat () const |
Retrieves the repeat policy for a Clutter::Actor set by set_content_repeat(). More... | |
ActorBox | get_content_box () const |
void | destroy () |
Destroys an actor. More... | |
Glib::RefPtr< Pango::Context > | get_pango_context () |
Retrieves the Pango::Context for self. More... | |
Glib::RefPtr< const Pango::Context > | get_pango_context () const |
Retrieves the Pango::Context for self. More... | |
Glib::RefPtr< Pango::Context > | create_pango_context () |
Creates a Pango::Context for the given actor. More... | |
Glib::RefPtr< Pango::Layout > | create_pango_layout (const Glib::ustring& text) |
Creates a new Pango::Layout from the same Pango::Context used by the Clutter::Actor. More... | |
Matrix | get_transform () const |
Returns the transformation matrix being used by the actor. More... | |
void | get_transformation_matrix (ClutterMatrix* matrix) |
Retrieves the transformations applied to self relative to its parent. More... | |
void | set_transform (const Matrix&transform) |
Overrides the transformations of a Clutter::Actor with a custom matrix, which will be applied relative to the origin of the actor's allocation and to the actor's pivot point. More... | |
void | set_child_transform (const Matrix&transform) |
Sets the transformation matrix to be applied to all the children of self prior to their own transformations. More... | |
bool | is_in_clone_paint () const |
Checks whether self is being currently painted by a Clutter::Clone. More... | |
bool | get_paint_box (ActorBox& box) |
Retrieves the paint volume of the passed Clutter::Actor, and transforms it into a 2D bounding box in stage coordinates. More... | |
bool | has_pointer () const |
Checks whether an actor contains the pointer of a Clutter::InputDevice. More... | |
void | set_text_direction (TextDirection text_dir) |
Sets the Clutter::TextDirection for an actor. More... | |
TextDirection | get_text_direction () const |
Retrieves the value set using set_text_direction() More... | |
Glib::RefPtr< Actor > | get_stage () |
Retrieves the Clutter::Stage where actor is contained. More... | |
Glib::RefPtr< const Actor > | get_stage () const |
Retrieves the Clutter::Stage where actor is contained. More... | |
void | set_child_below_sibling (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling) |
Sets child to be below sibling in the list of children of self. More... | |
void | set_child_above_sibling (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling) |
Sets child to be above sibling in the list of children of self. More... | |
void | set_child_at_index (const Glib::RefPtr< Actor >& child, int index) |
Changes the index of child in the list of children of self. More... | |
void | set_geometry (const Geometry& geometry) |
Sets the actor's fixed position and forces its minimum and natural size, in pixels. More... | |
Geometry | get_geometry () const |
Gets the size and position of an actor relative to its parent actor. More... | |
void | set_size (float width, float height) |
Sets the actor's size request in pixels. More... | |
void | get_position (float& x, float& y) |
This function tries to "do what you mean" and tell you where the actor is, prior to any transformations. More... | |
void | set_position (float x, float y) |
Sets the actor's fixed position in pixels relative to any parent actor. More... | |
float | get_width () const |
Retrieves the width of a Clutter::Actor. More... | |
float | get_height () const |
Retrieves the height of a Clutter::Actor. More... | |
void | set_width (float width) |
Forces a width on an actor, causing the actor's preferred width and height (if any) to be ignored. More... | |
void | set_height (float height) |
Forces a height on an actor, causing the actor's preferred width and height (if any) to be ignored. More... | |
void | set_x (float x) |
Sets the actor's X coordinate, relative to its parent, in pixels. More... | |
float | get_x () const |
Retrieves the X coordinate of a Clutter::Actor. More... | |
void | set_y (float y) |
Sets the actor's Y coordinate, relative to its parent, in pixels. More... | |
float | get_y () const |
Retrieves the Y coordinate of a Clutter::Actor. More... | |
void | set_z_position (float z_position) |
Sets the actor's position on the Z axis. More... | |
float | get_z_position () const |
Retrieves the actor's position on the Z axis. More... | |
void | set_x_align (ActorAlign x_align) |
Sets the horizontal alignment policy of a Clutter::Actor, in case the actor received extra horizontal space. More... | |
ActorAlign | get_x_align () const |
Retrieves the horizontal alignment policy set using set_x_align(). More... | |
void | set_y_align (ActorAlign y_align) |
Sets the vertical alignment policy of a Clutter::Actor, in case the actor received extra vertical space. More... | |
ActorAlign | get_y_align () const |
Retrieves the vertical alignment policy set using set_y_align(). More... | |
bool | get_x_expand () const |
Retrieves the value set with set_x_expand(). More... | |
void | set_x_expand (bool expand=true) |
Sets whether a Clutter::Actor should expand horizontally; this means that layout manager should allocate extra space for the actor, if possible. More... | |
bool | get_y_expand () const |
Retrieves the value set with set_y_expand(). More... | |
void | set_y_expand (bool expand=true) |
Sets whether a Clutter::Actor should expand horizontally; this means that layout manager should allocate extra space for the actor, if possible. More... | |
bool | needs_expand (Orientation orientation) const |
Checks whether an actor, or any of its children, is set to expand horizontally or vertically. More... | |
void | set_layout_manager (const Glib::RefPtr< LayoutManager >& manager) |
Sets the Clutter::LayoutManager delegate object that will be used to lay out the children of self. More... | |
void | unset_layout_manager () |
Unset the layout manager. More... | |
Glib::RefPtr< LayoutManager > | get_layout_manager () |
Retrieves the Clutter::LayoutManager used by self. More... | |
Glib::RefPtr< const LayoutManager > | get_layout_manager () const |
Retrieves the Clutter::LayoutManager used by self. More... | |
void | set_reactive (bool reactive=true) |
Sets actor as reactive. More... | |
bool | get_reactive () const |
Checks whether actor is marked as reactive. More... | |
bool | has_key_focus () const |
Checks whether self is the Clutter::Actor that has key focus. More... | |
void | set_rotation (RotateAxis axis, double angle, float x, float y, float z) |
Sets the rotation angle of self around the given axis. More... | |
void | set_z_rotation_from_gravity (double angle, Gravity gravity) |
Sets the rotation angle of self around the Z axis using the center point specified as a compass point. More... | |
double | get_rotation (RotateAxis axis, float& x, float& y, float& z) const |
Retrieves the angle and center of rotation on the given axis, set using set_rotation(). More... | |
Gravity | get_z_rotation_gravity () const |
Retrieves the center for the rotation around the Z axis as a compass direction. More... | |
void | set_opacity (guint8 opacity) |
Sets the actor's opacity, with zero being completely transparent and 255 (0xff) being fully opaque. More... | |
guint8 | get_opacity () const |
Retrieves the opacity value of an actor, as set by set_opacity(). More... | |
void | set_offscreen_redirect (OffscreenRedirect redirect) const |
Defines the circumstances where the actor should be redirected into an offscreen image. More... | |
OffscreenRedirect | get_offscreen_redirect () |
Retrieves whether to redirect the actor to an offscreen buffer, as set by set_offscreen_redirect(). More... | |
void | set_background_color (const Color& color) |
Sets the background color of a Clutter::Actor. More... | |
Color | get_background_color () const |
Retrieves the color set using set_background_color(). More... | |
const PaintVolume* | get_paint_volume () const |
Retrieves the paint volume of the passed Clutter::Actor, or 0 when a paint volume can't be determined. More... | |
const PaintVolume* | get_transformed_paint_volume (const Glib::RefPtr< Actor >& relative_to_ancestor) const |
Retrieves the 3D paint volume of an actor like get_paint_volume() does (Please refer to the documentation of get_paint_volume() for more details.) and it additionally transforms the paint volume into the coordinate space of relative_to_ancestor. More... | |
const PaintVolume* | get_transformed_paint_volume () const |
A get_transformed_paint_volume() convenience overload. More... | |
const PaintVolume* | get_default_paint_volume () const |
Retrieves the default paint volume for self. More... | |
void | set_name (const gchar* name) |
Sets the given name to self. More... | |
Glib::ustring | get_name () const |
Retrieves the name of self. More... | |
guint32 | get_gid () const |
Retrieves the unique id for self. More... | |
void | set_clip (float xoff, float yoff, float width, float height) |
Sets clip area for self. More... | |
void | get_clip (float& xoff, float& yoff, float& width, float& height) |
Gets the clip area for self, if any is set. More... | |
void | set_clip_to_allocation (bool clip_set=true) |
Sets whether self should be clipped to the same size as its allocation. More... | |
bool | get_clip_to_allocation () const |
Retrieves the value set using set_clip_to_allocation() More... | |
void | remove_clip () |
Removes clip area from self. More... | |
bool | has_clip () const |
Determines whether the actor has a clip area set or not. More... | |
std::vector< Glib::RefPtr < Actor > > | get_children () |
Retrieves the list of children of self. More... | |
std::vector< Glib::RefPtr < const Actor > > | get_children () const |
Retrieves the list of children of self. More... | |
int | get_n_children () const |
Retrieves the number of children of self. More... | |
Glib::RefPtr< Actor > | get_child_at_index (int index) |
Retrieves the actor at the given index inside the list of children of self. More... | |
Glib::RefPtr< const Actor > | get_child_at_index (int index) const |
Retrieves the actor at the given index inside the list of children of self. More... | |
Glib::RefPtr< Actor > | get_previous_sibling () |
Retrieves the sibling of self that comes before it in the list of children of self's parent. More... | |
Glib::RefPtr< const Actor > | get_previous_sibling () const |
Retrieves the sibling of self that comes before it in the list of children of self's parent. More... | |
Glib::RefPtr< Actor > | get_next_sibling () |
Retrieves the sibling of self that comes after it in the list of children of self's parent. More... | |
Glib::RefPtr< const Actor > | get_next_sibling () const |
Retrieves the sibling of self that comes after it in the list of children of self's parent. More... | |
Glib::RefPtr< Actor > | get_first_child () |
Retrieves the first child of self. More... | |
Glib::RefPtr< const Actor > | get_first_child () const |
Retrieves the first child of self. More... | |
Glib::RefPtr< Actor > | get_last_child () |
Retrieves the last child of self. More... | |
Glib::RefPtr< const Actor > | get_last_child () const |
Retrieves the last child of self. More... | |
void | set_parent (const Glib::RefPtr< Actor >& parent) |
Sets the parent of self to parent. More... | |
Glib::RefPtr< Actor > | get_parent () |
Retrieves the parent of self. More... | |
Glib::RefPtr< const Actor > | get_parent () const |
Retrieves the parent of self. More... | |
void | reparent (const Glib::RefPtr< Actor >& new_parent) |
Resets the parent actor of self. More... | |
void | unparent () |
Removes the parent of self. More... | |
bool | contains (const Glib::RefPtr< const Actor >& descendant) const |
Determines if descendant is contained inside self (either as an immediate child, or as a deeper descendant). More... | |
void | raise (const Glib::RefPtr< Actor >& below) |
Puts self above below. More... | |
void | lower (const Glib::RefPtr< Actor >& above) |
Puts self below above. More... | |
void | raise_top () |
Raises self to the top. More... | |
void | lower_bottom () |
Lowers self to the bottom. More... | |
Glib::RefPtr< Shader > | get_shader () |
Queries the currently set Clutter::Shader on self. More... | |
Glib::RefPtr< const Shader > | get_shader () const |
Queries the currently set Clutter::Shader on self. More... | |
void | set_shader (const Glib::RefPtr< Shader >& shader) |
Sets the Clutter::Shader to be used when rendering self. More... | |
template<class ParamType > | |
void | set_shader_param (const Glib::ustring& param, const ParamType& value) |
Sets the value for a named parameter of the shader applied to actor. More... | |
bool | is_rotated () const |
Checks whether any rotation is applied to the actor. More... | |
bool | is_scaled () const |
Checks whether the actor is scaled in either dimension. More... | |
void | set_pivot_point (float x, float y) |
Sets the position of the Clutter::Actor::property_pivot_point() around which the scaling and rotation transformations occur. More... | |
void | get_pivot_point (float& pivot_x, float& pivot_y) const |
Retrieves the coordinates of the Clutter::Actor::property_pivot_point(). More... | |
void | set_pivot_point_z (float pivot_z) |
Sets the component on the Z axis of the Clutter::Actor::property_pivot_point() around which the scaling and rotation transformations occur. More... | |
float | get_pivot_point_z () const |
Retrieves the Z component of the Clutter::Actor::property_pivot_point(). More... | |
void | set_rotation_angle (RotateAxis axis, double angle) |
Sets the angle of rotation of a Clutter::Actor on the given axis. More... | |
double | get_rotation_angle (RotateAxis axis) const |
Retrieves the angle of rotation set by set_rotation_angle(). More... | |
void | set_translation (float translate_x, float translate_y, float translate_z) |
Sets an additional translation transformation on a Clutter::Actor, relative to the Clutter::Actor::property_pivot_point(). More... | |
void | get_translation (float& translate_x, float& translate_y, float& translate_z) const |
Retrieves the translation set using set_translation(). More... | |
bool | should_pick_paint () const |
Should be called inside the implementation of the Clutter::Actor::signal_pick() virtual function in order to check whether the actor should paint itself in pick mode or not. More... | |
void | get_allocation_vertices (Vertex vertices[4]) const |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor. More... | |
void | get_allocation_vertices (const Glib::RefPtr< Actor >& ancestor, Vertex vertices[4]) const |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor. More... | |
void | get_abs_allocation_vertices (Vertex vertices[4]) const |
Calculates the transformed screen coordinates of the four corners of the actor; the returned vertices relate to the Clutter::ActorBox coordinates as follows: More... | |
void | allocate_align_fill (const ActorBox& box, gdouble x_align, double y_align, bool x_fill, bool y_fill, AllocationFlags flags) |
Allocates self by taking into consideration the available allocation area; an alignment factor on either axis; and whether the actor should fill the allocation on either axis. More... | |
void | set_allocation (const ActorBox& box, AllocationFlags flags) |
Stores the allocation of self as defined by box. More... | |
ActorBox | get_allocation_box () const |
Gets the layout box an actor has been assigned. More... | |
void | allocate (const ActorBox& box, AllocationFlags absolute_origin_changed=ALLOCATION_NONE) |
Assigns the size of a Clutter::Actor from the given box. More... | |
void | allocate_preferred_size (AllocationFlags absolute_origin_changed=ALLOCATION_NONE) |
Allocates the natural size of self. More... | |
void | allocate_available_size (float x, float y, float available_width, float available_height, AllocationFlags flags=ALLOCATION_NONE) |
Allocates self taking into account the Clutter::Actor's preferred size, but limiting it to the maximum available width and height provided. More... | |
void | apply_transform_to_point (const Vertex& point, Vertex& vertex) const |
Transforms point in coordinates relative to the actor into screen-relative coordinates with the current actor transformation (i.e. scale, rotation, etc) More... | |
void | transform_stage_point (float x, float y, float& x_out, float& y_out) const |
This function translates screen coordinates ( x, y) to coordinates relative to the actor. More... | |
void | apply_relative_transform_to_point (const Glib::RefPtr< Actor >& ancestor, const Vertex& point, Vertex& vertex) const |
Transforms point in coordinates relative to the actor into ancestor-relative coordinates using the relevant transform stack (i.e. scale, rotation, etc). More... | |
void | apply_relative_transform_to_point (const Vertex& point, Vertex& vertex) const |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor. More... | |
void | get_transformed_position (float& x, float& y) const |
Gets the absolute position of an actor, in pixels relative to the stage. More... | |
Matrix | get_child_transform () const |
void | get_transformed_size (float& width, float& height) const |
Gets the absolute size of an actor in pixels, taking into account the scaling factors. More... | |
void | set_request_mode (RequestMode mode) |
Sets the geometry request mode of self. More... | |
RequestMode | get_request_mode () const |
Retrieves the geometry request mode of self. More... | |
void | get_preferred_size (float& min_width_p, float& min_height_p, float& natural_width_p, float& natural_height_p) const |
Computes the preferred minimum and natural size of an actor, taking into account the actor's geometry management (either height-for-width or width-for-height). More... | |
void | get_preferred_width (float for_height, float& min_width_p, float& natural_width_p) const |
Computes the requested minimum and natural widths for an actor, optionally depending on the specified height, or if they are already computed, returns the cached values. More... | |
void | get_preferred_height (float for_width, float& min_height_p, float& natural_height_p) const |
Computes the requested minimum and natural heights for an actor, or if they are already computed, returns the cached values. More... | |
guint8 | get_paint_opacity () const |
Retrieves the absolute opacity of the actor, as it appears on the stage. More... | |
bool | get_paint_visibility () const |
Retrieves the 'paint' visibility of an actor recursively checking for non visible parents. More... | |
void | move_anchor_point_from_gravity (Gravity gravity) |
Sets an anchor point on the actor based on the given gravity, adjusting the actor postion so that its relative position within its parent remains unchanged. More... | |
void | move_anchor_point (float anchor_x, float anchor_y) |
Sets an anchor point for the actor, and adjusts the actor postion so that the relative position of the actor toward its parent remains the same. More... | |
void | set_margin_top (float margin) |
Sets the margin from the top of a Clutter::Actor. More... | |
float | get_margin_top () const |
Retrieves the top margin of a Clutter::Actor. More... | |
void | set_margin_bottom (float margin) |
Sets the margin from the bottom of a Clutter::Actor. More... | |
float | get_margin_bottom () const |
Retrieves the bottom margin of a Clutter::Actor. More... | |
void | set_margin_left (float margin) |
Sets the margin from the left of a Clutter::Actor. More... | |
float | get_margin_left () const |
Retrieves the left margin of a Clutter::Actor. More... | |
void | set_margin_right (float margin) |
Sets the margin from the right of a Clutter::Actor. More... | |
float | get_margin_right () const |
Retrieves the right margin of a Clutter::Actor. More... | |
void | set_margins (float top, float left, float bottom, float right) |
Convenience method for setting all margins at once. More... | |
bool | get_fixed_position_set () const |
Checks whether an actor has a fixed position set (and will thus be unaffected by any layout manager). More... | |
void | set_fixed_position_set (bool is_set) |
Sets whether an actor has a fixed position set (and will thus be unaffected by any layout manager). More... | |
Geometry | get_allocation_geometry () const |
Gets the layout box an actor has been assigned. More... | |
void | set_depth (float depth) |
Sets the Z coordinate of self to depth. More... | |
float | get_depth () const |
Retrieves the depth of self. More... | |
void | set_scale (double scale_x, double scale_y) |
Scales an actor with the given factors. More... | |
void | set_scale_z (double scale_z) |
Scales an actor on the Z axis by the given scale_z factor. More... | |
void | set_scale_full (double scale_x, double scale_y, float center_x, float center_y) |
Scales an actor with the given factors around the given center point. More... | |
void | set_scale_with_gravity (double scale_x, double scale_y, Gravity gravity) |
Scales an actor with the given factors around the given center point. More... | |
void | get_scale (double& scale_x, double& scale_y) const |
Retrieves an actors scale factors. More... | |
double | get_scale_z () const |
Retrieves the scaling factor along the Z axis, as set using set_scale_z(). More... | |
void | get_scale_center (float& center_x, float& center_y) const |
Retrieves the scale center coordinate in pixels relative to the top left corner of the actor. More... | |
Gravity | get_scale_gravity () const |
Retrieves the scale center as a compass direction. More... | |
void | get_size (float& width, float& height) const |
This function tries to "do what you mean" and return the size an actor will have. More... | |
void | move_by (float dx, float dy) |
Moves an actor by the specified distance relative to its current position in pixels. More... | |
bool | event (const ClutterEvent* event, bool capture) |
This function is used to emit an event on the main stage. More... | |
void | set_anchor_point (float anchor_x, float anchor_y) |
Sets an anchor point for self. More... | |
void | get_anchor_point (float& anchor_x, float& anchor_y) const |
Gets the current anchor point of the actor in pixels. More... | |
void | set_anchor_point_from_gravity (ClutterGravity gravity) |
Sets an anchor point on the actor, based on the given gravity (this is a convenience function wrapping set_anchor_point()). More... | |
Gravity | get_anchor_point_gravity () |
Retrieves the anchor position expressed as a Clutter::Gravity. More... | |
void | grab_key_focus () |
Sets the key focus of the Clutter::Stage including self to this Clutter::Actor. More... | |
void | add_child (const Glib::RefPtr< Actor >& child) |
Adds child to the children of self. More... | |
void | insert_child_above (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling) |
Inserts child into the list of children of self, above another child of self or, if sibling is 0 , above all the children of self. More... | |
void | insert_child_at_index (const Glib::RefPtr< Actor >& child, int index) |
Inserts child into the list of children of self, using the given index. More... | |
void | insert_child_at_index (const Glib::RefPtr< Actor >& child) |
A insert_child_at_index() convenience overload. More... | |
void | insert_child_below (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling) |
Inserts child into the list of children of self, below another child of self or, if sibling is 0 , below all the children of self. More... | |
void | replace_child (const Glib::RefPtr< Actor >& old_child, const Glib::RefPtr< Actor >& new_child) |
Replaces old_child with new_child in the list of children of self. More... | |
void | remove_child (const Glib::RefPtr< Actor >& child) |
Removes child from the children of self. More... | |
void | remove_all_children () |
Removes all children of self. More... | |
Glib::RefPtr< Animation > | get_animation () |
Retrieves the Clutter::Animation used by actor, if animate() has been called on actor. More... | |
Glib::RefPtr< const Animation > | get_animation () const |
Retrieves the Clutter::Animation used by actor, if animate() has been called on actor. More... | |
void | detach_animation () |
Detaches the Clutter::Animation used by actor, if animate() has been called on actor. More... | |
void | push_internal () |
Should be used by actors implementing the Clutter::Container and with internal children added through set_parent(), for instance: More... | |
void | pop_internal () |
Disables the effects of push_internal(). More... | |
bool | has_allocation () const |
Checks if the actor has an up-to-date allocation assigned to it. More... | |
Glib::RefPtr< Atk::Object > | get_accessible () |
Returns the accessible object that describes the actor to an assistive technology. More... | |
Glib::RefPtr< const Atk::Object > | get_accessible () const |
Returns the accessible object that describes the actor to an assistive technology. More... | |
void | add_action (const Glib::RefPtr< Action >& action) |
Adds action to the list of actions applied to self. More... | |
void | add_action (const Glib::ustring& name, const Glib::RefPtr< Action >& action) |
A convenience function for setting the name of a Clutter::Action while adding it to the list of actions applied to self. More... | |
void | remove_action (const Glib::RefPtr< Action >& action) |
Removes action from the list of actions applied to self. More... | |
void | remove_action (const Glib::ustring& name) |
Removes the Clutter::Action with the given name from the list of actions applied to self. More... | |
Glib::RefPtr< Action > | get_action (const Glib::ustring& name) |
Retrieves the Clutter::Action with the given name in the list of actions applied to self. More... | |
Glib::RefPtr< const Action > | get_action (const Glib::ustring& name) const |
Retrieves the Clutter::Action with the given name in the list of actions applied to self. More... | |
void | clear_actions () |
Clears the list of actions applied to self. More... | |
std::vector< Glib::RefPtr < Action > > | get_actions () |
Retrieves the list of actions applied to self. More... | |
std::vector< Glib::RefPtr < const Action > > | get_actions () const |
Retrieves the list of actions applied to self. More... | |
bool | has_actions () const |
Returns whether the actor has any actions applied. More... | |
void | add_effect (const Glib::RefPtr< Effect >& effect) |
Adds effect to the list of Clutter::Effects applied to self. More... | |
void | add_effect_with_name (const Glib::ustring& name, const Glib::RefPtr< Effect >& effect) |
A convenience function for setting the name of a Clutter::Effect while adding it to the list of effectss applied to self. More... | |
void | remove_effect (const Glib::RefPtr< Effect >& effect) |
Removes effect from the list of effects applied to self. More... | |
void | remove_effect (const Glib::ustring& name) |
Removes the Clutter::Effect with the given name from the list of effects applied to self. More... | |
std::vector< Glib::RefPtr < Effect > > | get_effects () |
Retrieves the Clutter::Effects applied on self, if any. More... | |
std::vector< Glib::RefPtr < const Effect > > | get_effects () const |
Retrieves the Clutter::Effects applied on self, if any. More... | |
Glib::RefPtr< Effect > | get_effect (const Glib::ustring& name) |
Retrieves the Clutter::Effect with the given name in the list of effects applied to self. More... | |
Glib::RefPtr< const Effect > | get_effect (const Glib::ustring& name) const |
Retrieves the Clutter::Effect with the given name in the list of effects applied to self. More... | |
void | clear_effects () |
Clears the list of effects applied to self. More... | |
bool | has_effects () const |
Returns whether the actor has any effects applied. More... | |
void | save_easing_state () |
Saves the current easing state for animatable properties, and creates a new state with the default values for easing mode and duration. More... | |
void | restore_easing_state () |
Restores the easing state as it was prior to a call to save_easing_state(). More... | |
void | set_easing_duration (guint msecs) |
Sets the duration of the tweening for animatable properties of self for the current easing state. More... | |
guint | get_easing_duration () const |
Retrieves the duration of the tweening for animatable properties of self for the current easing state. More... | |
AnimationMode | get_easing_mode () const |
Retrieves the easing mode for the tweening of animatable properties of self for the current easing state. More... | |
void | set_easing_mode (AnimationMode mode) |
Sets the easing mode for the tweening of animatable properties of self. More... | |
guint | get_easing_delay () const |
Retrieves the delay that should be applied when tweening animatable properties. More... | |
void | set_easing_delay (guint msecs) |
Sets the delay that should be applied before tweening animatable properties. More... | |
Glib::RefPtr< Transition > | get_transition (const Glib::ustring& name) |
Retrieves the Clutter::Transition of a Clutter::Actor by using the transition name. More... | |
Glib::RefPtr< const Transition > | get_transition (const Glib::ustring& name) const |
Retrieves the Clutter::Transition of a Clutter::Actor by using the transition name. More... | |
void | add_transition (const Glib::ustring& name, const Glib::RefPtr< Transition >& transition) |
Adds a transition to the Clutter::Actor's list of animations. More... | |
void | remove_transition (const Glib::ustring& name) |
Removes the transition stored inside a Clutter::Actor using name identifier. More... | |
void | remove_all_transitions () |
Removes all transitions associated to self. More... | |
void | add_constraint (const Glib::RefPtr< Constraint >& constraint) |
Adds constraint to the list of Clutter::Constraints applied to self. More... | |
void | add_constraint (const Glib::ustring& name, const Glib::RefPtr< Constraint >& constraint) |
A convenience function for setting the name of a Clutter::Constraint while adding it to the list of constraints applied to self. More... | |
void | remove_constraint (const Glib::RefPtr< Constraint >& constraint) |
Removes constraint from the list of constraints applied to self. More... | |
void | remove_constraint (const Glib::ustring& name) |
Removes the Clutter::Constraint with the given name from the list of constraints applied to self. More... | |
bool | has_constraints () const |
Returns whether the actor has any constraints applied. More... | |
std::vector< Glib::RefPtr < Clutter::Constraint > > | get_constraints () |
Retrieves the list of constraints applied to self. More... | |
std::vector< Glib::RefPtr < const Clutter::Constraint > > | get_constraints () const |
Retrieves the list of constraints applied to self. More... | |
Glib::RefPtr< const Constraint > | get_constraint (const Glib::ustring& name) const |
Retrieves the Clutter::Constraint with the given name in the list of constraints applied to self. More... | |
Glib::RefPtr< Constraint > | get_constraint (const Glib::ustring& name) |
Retrieves the Clutter::Constraint with the given name in the list of constraints applied to self. More... | |
void | clear_constraints () |
Clears the list of constraints applied to self. More... | |
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_key_focus_out () |
Glib::SignalProxy0< void > | signal_key_focus_in () |
Glib::SignalProxy1< void, const Glib::RefPtr< Actor >& > | signal_parent_set () |
Glib::SignalProxy1< bool, ScrollEvent* > | signal_scroll_event () |
Glib::SignalProxy1< bool, KeyEvent* > | signal_key_press_event () |
Glib::SignalProxy1< bool, Event* > | signal_captured_event () |
Glib::SignalProxy0< void > | signal_paint () |
Glib::SignalProxy1< void, const Glib::RefPtr< Actor >& > | signal_queue_redaw () |
Glib::SignalProxy0< void > | signal_queue_relayout () |
Glib::SignalProxy0< void > | signal_realize () |
Glib::SignalProxy0< void > | signal_unrealize () |
Glib::SignalProxy1< void, const Color& > | signal_pick () |
Glib::SignalProxy2< void, const ActorBox &, AllocationFlags > | signal_allocation_changed () |
Glib::SignalProxy1< bool, ClutterTouchEvent* > | signal_touch_event () |
Glib::SignalProxy0< void > | signal_transitions_completed () |
Glib::SignalProxy2< void, const Glib::ustring&, bool > | signal_transition_stopped () |
Glib::PropertyProxy_ReadOnly < ActorBox > | property_allocation () const |
The actor's allocation. More... | |
Glib::PropertyProxy< float > | property_anchor_x () |
X coordinate of the anchor point. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_anchor_x () const |
X coordinate of the anchor point. More... | |
Glib::PropertyProxy< float > | property_anchor_y () |
Y coordinate of the anchor point. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_anchor_y () const |
Y coordinate of the anchor point. More... | |
Glib::PropertyProxy< Gravity > | property_anchor_gravity () |
The anchor point as a ClutterGravity. More... | |
Glib::PropertyProxy_ReadOnly < Gravity > | property_anchor_gravity () const |
The anchor point as a ClutterGravity. More... | |
Glib::PropertyProxy< Color > | property_background_color () |
The actor's background color. More... | |
Glib::PropertyProxy_ReadOnly < Color > | property_background_color () const |
The actor's background color. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_background_color_set () const |
Whether the background color is set. More... | |
Glib::PropertyProxy< Matrix > | property_child_transform () |
Children transformation matrix. More... | |
Glib::PropertyProxy_ReadOnly < Matrix > | property_child_transform () const |
Children transformation matrix. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_child_transform_set () const |
Whether the child-transform property is set. More... | |
Glib::PropertyProxy< Geometry > | property_clip () |
The clip region for the actor. More... | |
Glib::PropertyProxy_ReadOnly < Geometry > | property_clip () const |
The clip region for the actor. More... | |
Glib::PropertyProxy< Rect > | property_clip_rect () |
The visible region of the actor. More... | |
Glib::PropertyProxy_ReadOnly < Rect > | property_clip_rect () const |
The visible region of the actor. More... | |
Glib::PropertyProxy< bool > | property_clip_to_allocation () |
Sets the clip region to track the actor's allocation. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_clip_to_allocation () const |
Sets the clip region to track the actor's allocation. More... | |
Glib::PropertyProxy< Content > | property_content () |
Delegate object for painting the actor's content. More... | |
Glib::PropertyProxy_ReadOnly < Content > | property_content () const |
Delegate object for painting the actor's content. More... | |
Glib::PropertyProxy_ReadOnly < ActorBox > | property_content_box () const |
The bounding box of the actor's content. More... | |
Glib::PropertyProxy < ContentGravity > | property_content_gravity () |
Alignment of the actor's content. More... | |
Glib::PropertyProxy_ReadOnly < ContentGravity > | property_content_gravity () const |
Alignment of the actor's content. More... | |
Glib::PropertyProxy < ContentRepeat > | property_content_repeat () |
The repeat policy for the actor's content. More... | |
Glib::PropertyProxy_ReadOnly < ContentRepeat > | property_content_repeat () const |
The repeat policy for the actor's content. More... | |
Glib::PropertyProxy< float > | property_depth () |
Position on the Z axis. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_depth () const |
Position on the Z axis. More... | |
Glib::PropertyProxy_WriteOnly < Glib::RefPtr< Effect > > | property_effect () |
Add an effect to be applied on the actor. More... | |
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Actor > > | property_first_child () const |
The actor's first child. More... | |
Glib::PropertyProxy< bool > | property_fixed_position_set () |
Whether to use fixed positioning for the actor. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_fixed_position_set () const |
Whether to use fixed positioning for the actor. More... | |
Glib::PropertyProxy< float > | property_fixed_x () |
Forced X position of the actor. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_fixed_x () const |
Forced X position of the actor. More... | |
Glib::PropertyProxy< float > | property_fixed_y () |
Forced Y position of the actor. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_fixed_y () const |
Forced Y position of the actor. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_has_clip () const |
Whether the actor has a clip set. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_has_pointer () const |
Whether the actor contains the pointer of an input device. More... | |
Glib::PropertyProxy< float > | property_height () |
Height of the actor. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_height () const |
Height of the actor. More... | |
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Actor > > | property_last_child () const |
The actor's last child. More... | |
Glib::PropertyProxy < Glib::RefPtr< LayoutManager > > | property_layout_manager () |
The object controlling the layout of an actor's children. More... | |
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< LayoutManager > > | property_layout_manager () const |
The object controlling the layout of an actor's children. More... | |
Glib::PropertyProxy < ScalingFilter > | property_magnification_filter () |
The filter used when increasing the size of the content. More... | |
Glib::PropertyProxy_ReadOnly < ScalingFilter > | property_magnification_filter () const |
The filter used when increasing the size of the content. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_mapped () const |
Whether the actor will be painted. More... | |
Glib::PropertyProxy< float > | property_margin_bottom () |
Extra space at the bottom. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_margin_bottom () const |
Extra space at the bottom. More... | |
Glib::PropertyProxy< float > | property_margin_left () |
Extra space at the left. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_margin_left () const |
Extra space at the left. More... | |
Glib::PropertyProxy< float > | property_margin_right () |
Extra space at the right. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_margin_right () const |
Extra space at the right. More... | |
Glib::PropertyProxy< float > | property_margin_top () |
Extra space at the top. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_margin_top () const |
Extra space at the top. More... | |
Glib::PropertyProxy < ScalingFilter > | property_minification_filter () |
The filter used when reducing the size of the content. More... | |
Glib::PropertyProxy_ReadOnly < ScalingFilter > | property_minification_filter () const |
The filter used when reducing the size of the content. More... | |
Glib::PropertyProxy< float > | property_min_height () |
Forced minimum height request for the actor. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_min_height () const |
Forced minimum height request for the actor. More... | |
Glib::PropertyProxy< bool > | property_min_height_set () |
Whether to use the min-height property. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_min_height_set () const |
Whether to use the min-height property. More... | |
Glib::PropertyProxy< float > | property_min_width () |
Forced minimum width request for the actor. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_min_width () const |
Forced minimum width request for the actor. More... | |
Glib::PropertyProxy< bool > | property_min_width_set () |
Whether to use the min-width property. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_min_width_set () const |
Whether to use the min-width property. More... | |
Glib::PropertyProxy < Glib::ustring > | property_name () |
Name of the actor. More... | |
Glib::PropertyProxy_ReadOnly < Glib::ustring > | property_name () const |
Name of the actor. More... | |
Glib::PropertyProxy< float > | property_natural_height () |
Forced natural height request for the actor. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_natural_height () const |
Forced natural height request for the actor. More... | |
Glib::PropertyProxy< bool > | property_natural_height_set () |
Whether to use the natural-height property. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_natural_height_set () const |
Whether to use the natural-height property. More... | |
Glib::PropertyProxy< float > | property_natural_width () |
Forced natural width request for the actor. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_natural_width () const |
Forced natural width request for the actor. More... | |
Glib::PropertyProxy< bool > | property_natural_width_set () |
Whether to use the natural-width property. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_natural_width_set () const |
Whether to use the natural-width property. More... | |
Glib::PropertyProxy< guint8 > | property_opacity () |
Opacity of an actor. More... | |
Glib::PropertyProxy_ReadOnly < guint8 > | property_opacity () const |
Opacity of an actor. More... | |
Glib::PropertyProxy < OffscreenRedirect > | property_offscreen_redirect () |
Flags controlling when to flatten the actor into a single image. More... | |
Glib::PropertyProxy_ReadOnly < OffscreenRedirect > | property_offscreen_redirect () const |
Flags controlling when to flatten the actor into a single image. More... | |
Glib::PropertyProxy< Point > | property_pivot_point () |
The point around which the scaling and rotation occur. More... | |
Glib::PropertyProxy_ReadOnly < Point > | property_pivot_point () const |
The point around which the scaling and rotation occur. More... | |
Glib::PropertyProxy< float > | property_pivot_point_z () |
Z component of the pivot point. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_pivot_point_z () const |
Z component of the pivot point. More... | |
Glib::PropertyProxy< Point > | property_position () |
The position of the origin of the actor. More... | |
Glib::PropertyProxy_ReadOnly < Point > | property_position () const |
The position of the origin of the actor. More... | |
Glib::PropertyProxy< bool > | property_reactive () |
Whether the actor is reactive to events. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_reactive () const |
Whether the actor is reactive to events. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_realized () const |
Whether the actor has been realized. More... | |
Glib::PropertyProxy< RequestMode > | property_request_mode () |
The actor's request mode. More... | |
Glib::PropertyProxy_ReadOnly < RequestMode > | property_request_mode () const |
The actor's request mode. More... | |
Glib::PropertyProxy< double > | property_rotation_angle_x () |
The rotation angle on the X axis. More... | |
Glib::PropertyProxy_ReadOnly < double > | property_rotation_angle_x () const |
The rotation angle on the X axis. More... | |
Glib::PropertyProxy< double > | property_rotation_angle_y () |
The rotation angle on the Y axis. More... | |
Glib::PropertyProxy_ReadOnly < double > | property_rotation_angle_y () const |
The rotation angle on the Y axis. More... | |
Glib::PropertyProxy< double > | property_rotation_angle_z () |
The rotation angle on the Z axis. More... | |
Glib::PropertyProxy_ReadOnly < double > | property_rotation_angle_z () const |
The rotation angle on the Z axis. More... | |
Glib::PropertyProxy< Vertex > | property_rotation_center_x () |
The rotation center on the X axis. More... | |
Glib::PropertyProxy_ReadOnly < Vertex > | property_rotation_center_x () const |
The rotation center on the X axis. More... | |
Glib::PropertyProxy< Vertex > | property_rotation_center_y () |
The rotation center on the Y axis. More... | |
Glib::PropertyProxy_ReadOnly < Vertex > | property_rotation_center_y () const |
The rotation center on the Y axis. More... | |
Glib::PropertyProxy< Vertex > | property_rotation_center_z () |
The rotation center on the Z axis. More... | |
Glib::PropertyProxy_ReadOnly < Vertex > | property_rotation_center_z () const |
The rotation center on the Z axis. More... | |
Glib::PropertyProxy< Gravity > | property_rotation_center_z_gravity () |
Center point for rotation around the Z axis. More... | |
Glib::PropertyProxy_ReadOnly < Gravity > | property_rotation_center_z_gravity () const |
Center point for rotation around the Z axis. More... | |
Glib::PropertyProxy< double > | property_scale_x () |
Scale factor on the X axis. More... | |
Glib::PropertyProxy_ReadOnly < double > | property_scale_x () const |
Scale factor on the X axis. More... | |
Glib::PropertyProxy< double > | property_scale_y () |
Scale factor on the Y axis. More... | |
Glib::PropertyProxy_ReadOnly < double > | property_scale_y () const |
Scale factor on the Y axis. More... | |
Glib::PropertyProxy< double > | property_scale_z () |
Scale factor on the Z axis. More... | |
Glib::PropertyProxy_ReadOnly < double > | property_scale_z () const |
Scale factor on the Z axis. More... | |
Glib::PropertyProxy< double > | property_scale_center_x () |
Horizontal scale center. More... | |
Glib::PropertyProxy_ReadOnly < double > | property_scale_center_x () const |
Horizontal scale center. More... | |
Glib::PropertyProxy< double > | property_scale_center_y () |
Vertical scale center. More... | |
Glib::PropertyProxy_ReadOnly < double > | property_scale_center_y () const |
Vertical scale center. More... | |
Glib::PropertyProxy< Gravity > | property_scale_gravity () |
The center of scaling. More... | |
Glib::PropertyProxy_ReadOnly < Gravity > | property_scale_gravity () const |
The center of scaling. More... | |
Glib::PropertyProxy< bool > | property_show_on_set_parent () |
Whether the actor is shown when parented. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_show_on_set_parent () const |
Whether the actor is shown when parented. More... | |
Glib::PropertyProxy < TextDirection > | property_text_direction () |
Direction of the text. More... | |
Glib::PropertyProxy_ReadOnly < TextDirection > | property_text_direction () const |
Direction of the text. More... | |
Glib::PropertyProxy< float > | property_translation_x () |
Translation along the X axis. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_translation_x () const |
Translation along the X axis. More... | |
Glib::PropertyProxy< float > | property_translation_y () |
Translation along the Y axis. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_translation_y () const |
Translation along the Y axis. More... | |
Glib::PropertyProxy< float > | property_translation_z () |
Translation along the Z axis. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_translation_z () const |
Translation along the Z axis. More... | |
Glib::PropertyProxy< Matrix > | property_transform () |
Transformation matrix. More... | |
Glib::PropertyProxy_ReadOnly < Matrix > | property_transform () const |
Transformation matrix. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_transform_set () const |
Whether the transform property is set. More... | |
Glib::PropertyProxy< bool > | property_visible () |
Whether the actor is visible or not. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_visible () const |
Whether the actor is visible or not. More... | |
Glib::PropertyProxy< float > | property_width () |
Width of the actor. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_width () const |
Width of the actor. More... | |
Glib::PropertyProxy< float > | property_x () |
X coordinate of the actor. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_x () const |
X coordinate of the actor. More... | |
Glib::PropertyProxy< ActorAlign > | property_x_align () |
The alignment of the actor on the X axis within its allocation. More... | |
Glib::PropertyProxy_ReadOnly < ActorAlign > | property_x_align () const |
The alignment of the actor on the X axis within its allocation. More... | |
Glib::PropertyProxy< bool > | property_x_expand () |
Whether extra horizontal space should be assigned to the actor. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_x_expand () const |
Whether extra horizontal space should be assigned to the actor. More... | |
Glib::PropertyProxy< float > | property_y () |
Y coordinate of the actor. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_y () const |
Y coordinate of the actor. More... | |
Glib::PropertyProxy< ActorAlign > | property_y_align () |
The alignment of the actor on the Y axis within its allocation. More... | |
Glib::PropertyProxy_ReadOnly < ActorAlign > | property_y_align () const |
The alignment of the actor on the Y axis within its allocation. More... | |
Glib::PropertyProxy< bool > | property_y_expand () |
Whether extra vertical space should be assigned to the actor. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_y_expand () const |
Whether extra vertical space should be assigned to the actor. More... | |
Glib::PropertyProxy< float > | property_z_position () |
The actor's position on the Z axis. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_z_position () const |
The actor's position on the Z axis. More... | |
Public Member Functions inherited from Clutter::Scriptable | |
virtual | ~Scriptable () |
ClutterScriptable* | gobj () |
Provides access to the underlying C GObject. More... | |
const ClutterScriptable* | gobj () const |
Provides access to the underlying C GObject. More... | |
void | set_id (const std::string& id) |
Sets id as the unique Clutter script it for this instance of Clutter::ScriptableIface. More... | |
std::string | get_id () const |
Retrieves the id of scriptable set using set_id(). More... | |
bool | parse_custom_node (const Glib::RefPtr< Script >& script, Glib::ValueBase& value, const Glib::ustring& name, JsonNode* node) |
Parses the passed JSON node. More... | |
void | set_custom_property (const Glib::RefPtr< Script >& script, const Glib::ustring& name, const Glib::ValueBase& value) |
Overrides the common properties setting. More... | |
Public Member Functions inherited from Clutter::Animatable | |
virtual | ~Animatable () |
ClutterAnimatable* | gobj () |
Provides access to the underlying C GObject. More... | |
const ClutterAnimatable* | gobj () const |
Provides access to the underlying C GObject. More... | |
GParamSpec* | find_property (const Glib::ustring& property_name) |
Finds the ParamSpec for property_name. More... | |
void | get_initial_state_value (const Glib::ustring& property_name, Glib::ValueBase& value) const |
Retrieves the current state of property_name and sets value with it. More... | |
void | set_final_state_value (const Glib::ustring& property_name, const Glib::ValueBase& value) |
Sets the current state of property_name to value. More... | |
void | interpolate_value_value (const Glib::ustring& property_name, const Glib::RefPtr< const Interval >& interval, double progress, Glib::ValueBase& value) |
Asks a Clutter::Animatable implementation to interpolate a a named property between the initial and final values of a Clutter::Interval, using progress as the interpolation value, and store the result inside value. More... | |
template<class ValueType > | |
void | get_initial_state (const Glib::ustring& property_name, ValueType& value) const |
Gets the initial state of an animation. More... | |
template<class ValueType > | |
void | set_final_state (const Glib::ustring& property_name, const ValueType& value) |
Sets the final state for an animation. More... | |
template<class ValueType > | |
bool | interpolate (const Glib::ustring& property_name, const Glib::RefPtr< const Interval >& interval, double progress, ValueType& value) |
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< Actor > | create () |
static Glib::RefPtr< Actor > | get_actor_by_gid (guint32 id) |
Retrieves the Clutter::Actor with id. More... | |
Static Public Member Functions inherited from Clutter::Scriptable | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
Static Public Member Functions inherited from Clutter::Animatable | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
Protected Member Functions | |
Actor () | |
void | set_shader_param_value (const Glib::ustring& param, const Glib::ValueBase& value) |
Sets the value for a named parameter of the shader applied to actor. More... | |
virtual void | show_all_vfunc () |
virtual void | hide_all_vfunc () |
virtual void | map_vfunc () |
virtual void | unmap_vfunc () |
virtual void | paint_vfunc () |
virtual void | get_preferred_width_vfunc (float for_height, float& min_width_p, float& natural_width_p) const |
virtual void | get_preferred_height_vfunc (float for_width, float& min_height_p, float& natural_height_p) const |
virtual void | allocate_vfunc (const ActorBox& box, AllocationFlags absolute_origin_changed) |
virtual void | pick_vfunc (const Color& color) |
virtual bool | get_paint_volume_vfunc (ClutterPaintVolume* volume) |
virtual bool | has_overlaps_vfunc () const |
virtual void | paint_node_vfunc (ClutterPaintNode* root) |
virtual bool | on_button_press_event (ButtonEvent*event) |
This is a default handler for the signal signal_button_press_event(). More... | |
virtual bool | on_button_release_event (ButtonEvent*event) |
This is a default handler for the signal signal_button_release_event(). More... | |
virtual bool | on_motion_event (MotionEvent*event) |
This is a default handler for the signal signal_motion_event(). More... | |
virtual bool | on_leave_event (CrossingEvent*event) |
This is a default handler for the signal signal_leave_event(). More... | |
virtual void | on_show () |
This is a default handler for the signal signal_show(). More... | |
virtual void | on_hide () |
This is a default handler for the signal signal_hide(). More... | |
virtual void | on_destroy () |
This is a default handler for the signal signal_destroy(). More... | |
virtual bool | on_key_release_event (KeyEvent*event) |
This is a default handler for the signal signal_key_release_event(). More... | |
virtual bool | on_enter_event (CrossingEvent*event) |
This is a default handler for the signal signal_enter_event(). More... | |
virtual bool | on_event (Event*event) |
This is a default handler for the signal signal_event(). More... | |
virtual void | on_key_focus_out () |
This is a default handler for the signal signal_key_focus_out(). More... | |
virtual void | on_key_focus_in () |
This is a default handler for the signal signal_key_focus_in(). More... | |
virtual void | on_parent_set (const Glib::RefPtr< Actor >& old_parent) |
This is a default handler for the signal signal_parent_set(). More... | |
virtual bool | on_scroll_event (ScrollEvent*event) |
This is a default handler for the signal signal_scroll_event(). More... | |
virtual bool | on_key_press_event (KeyEvent*event) |
This is a default handler for the signal signal_key_press_event(). More... | |
virtual bool | on_captured_event (Event*event) |
This is a default handler for the signal signal_captured_event(). More... | |
virtual void | on_paint () |
This is a default handler for the signal signal_paint(). More... | |
virtual void | on_queue_redaw (const Glib::RefPtr< Actor >& origin) |
This is a default handler for the signal signal_queue_redaw(). More... | |
virtual void | on_queue_relayout () |
This is a default handler for the signal signal_queue_relayout(). More... | |
virtual void | on_realize () |
This is a default handler for the signal signal_realize(). More... | |
virtual void | on_unrealize () |
This is a default handler for the signal signal_unrealize(). More... | |
virtual void | on_pick (const Color& color) |
This is a default handler for the signal signal_pick(). More... | |
virtual bool | on_touch_event (ClutterTouchEvent*event) |
This is a default handler for the signal signal_touch_event(). More... | |
Protected Member Functions inherited from Clutter::Scriptable | |
Scriptable () | |
You should derive from this class to use it. More... | |
virtual void | set_id_vfunc (const std::string& id) |
virtual const char* | get_id_vfunc () const |
virtual void | set_custom_property_vfunc (const Glib::RefPtr< Script >& script, const Glib::ustring& name, const Glib::ValueBase& value) |
Protected Member Functions inherited from Clutter::Animatable | |
Animatable () | |
You should derive from this class to use it. More... | |
virtual GParamSpec* | find_property_vfunc (const Glib::ustring& property_name) |
virtual void | get_initial_state_vfunc (const Glib::ustring& property_name, Glib::ValueBase& value) |
virtual void | set_final_state_vfunc (const Glib::ustring& property_name, const Glib::ValueBase& value) |
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. More... | |
Related Functions inherited from Clutter::Scriptable | |
Glib::RefPtr< Clutter::Scriptable > | wrap (ClutterScriptable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Clutter::Animatable | |
Glib::RefPtr< Clutter::Animatable > | wrap (ClutterAnimatable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Constructor & Destructor Documentation
|
virtual |
|
protected |
Member Function Documentation
void Clutter::Actor::add_action | ( | const Glib::RefPtr< Action >& | action) |
Adds action to the list of actions applied to self.
A Clutter::Action can only belong to one actor at a time
The Clutter::Actor will hold a reference on action until either remove_action() or clear_actions() is called
- Parameters
-
action A Clutter::Action.
void Clutter::Actor::add_action | ( | const Glib::ustring & | name, |
const Glib::RefPtr< Action >& | action | ||
) |
A convenience function for setting the name of a Clutter::Action while adding it to the list of actions applied to self.
This function is the logical equivalent of:
[C example ellipted]
- Parameters
-
name The name to set on the action. action A Clutter::Action.
void Clutter::Actor::add_child | ( | const Glib::RefPtr< Actor >& | child) |
Adds child to the children of self.
This function will acquire a reference on child that will only be released when calling remove_child().
This function will take into consideration the Clutter::Actor::property_depth() of child, and will keep the list of children sorted.
This function will emit the Clutter::Container::signal_actor_added() signal on self.
- Parameters
-
child A Clutter::Actor.
void Clutter::Actor::add_constraint | ( | const Glib::RefPtr< Constraint >& | constraint) |
Adds constraint to the list of Clutter::Constraints applied to self.
The Clutter::Actor will hold a reference on the constraint until either remove_constraint() or clear_constraints() is called.
- Parameters
-
constraint A Clutter::Constraint.
void Clutter::Actor::add_constraint | ( | const Glib::ustring & | name, |
const Glib::RefPtr< Constraint >& | constraint | ||
) |
A convenience function for setting the name of a Clutter::Constraint while adding it to the list of constraints applied to self.
This function is the logical equivalent of:
[C example ellipted]
- Parameters
-
name The name to set on the constraint. constraint A Clutter::Constraint.
void Clutter::Actor::add_effect | ( | const Glib::RefPtr< Effect >& | effect) |
Adds effect to the list of Clutter::Effects applied to self.
The Clutter::Actor will hold a reference on the effect until either remove_effect() or clear_effects() is called.
- Parameters
-
effect A Clutter::Effect.
void Clutter::Actor::add_effect_with_name | ( | const Glib::ustring & | name, |
const Glib::RefPtr< Effect >& | effect | ||
) |
A convenience function for setting the name of a Clutter::Effect while adding it to the list of effectss applied to self.
This function is the logical equivalent of:
[C example ellipted]
- Parameters
-
name The name to set on the effect. effect A Clutter::Effect.
void Clutter::Actor::add_transition | ( | const Glib::ustring & | name, |
const Glib::RefPtr< Transition >& | transition | ||
) |
Adds a transition to the Clutter::Actor's list of animations.
The name string is a per-actor unique identifier of the transition: only one Clutter::Transition can be associated to the specified name.
The transition will be started once added.
This function will take a reference on the transition.
This function is usually called implicitly when modifying an animatable property.
- Parameters
-
name The name of the transition to add. transition The Clutter::Transition to add.
void Clutter::Actor::allocate | ( | const ActorBox& | box, |
AllocationFlags | absolute_origin_changed = ALLOCATION_NONE |
||
) |
Assigns the size of a Clutter::Actor from the given box.
This function should only be called on the children of an actor when overriding the Clutter::ActorClass.allocate() virtual function.
This function will adjust the stored allocation to take into account the alignment flags set in the Clutter::Actor::property_x_align() and Clutter::Actor::property_y_align() properties, as well as the margin values set in the Clutter::Actor::property_margin_top(), Clutter::Actor::property_margin_right(), Clutter::Actor::property_margin_bottom(), and Clutter::Actor::property_margin_left() properties.
This function will respect the easing state of the Clutter::Actor and interpolate between the current allocation and the new one if the easing state duration is a positive value.
Actors can know from their allocation box whether they have moved with respect to their parent actor. The flags parameter describes additional information about the allocation, for instance whether the parent has moved with respect to the stage, for example because a grandparent's origin has moved.
- Parameters
-
box New allocation of the actor, in parent-relative coordinates. flags Flags that control the allocation.
void Clutter::Actor::allocate_align_fill | ( | const ActorBox& | box, |
gdouble | x_align, | ||
double | y_align, | ||
bool | x_fill, | ||
bool | y_fill, | ||
AllocationFlags | flags | ||
) |
Allocates self by taking into consideration the available allocation area; an alignment factor on either axis; and whether the actor should fill the allocation on either axis.
The box should contain the available allocation width and height; if the x1 and y1 members of Clutter::ActorBox are not set to 0, the allocation will be offset by their value.
This function takes into consideration the geometry request specified by the Clutter::Actor::property_request_mode() property, and the text direction.
This function is useful for fluid layout managers using legacy alignment flags. Newly written layout managers should use the Clutter::Actor::property_x_align() and Clutter::Actor::property_y_align() properties, instead, and just call allocate() inside their Clutter::ActorClass.allocate() implementation.
- Parameters
-
box A Clutter::ActorBox, containing the available width and height. x_align The horizontal alignment, between 0 and 1. y_align The vertical alignment, between 0 and 1. x_fill Whether the actor should fill horizontally. y_fill Whether the actor should fill vertically. flags Allocation flags to be passed to allocate().
void Clutter::Actor::allocate_available_size | ( | float | x, |
float | y, | ||
float | available_width, | ||
float | available_height, | ||
AllocationFlags | flags = ALLOCATION_NONE |
||
) |
Allocates self taking into account the Clutter::Actor's preferred size, but limiting it to the maximum available width and height provided.
This function will do the right thing when dealing with the actor's request mode.
The implementation of this function is equivalent to:
[C example ellipted]
This function can be used by fluid layout managers to allocate an actor's preferred size without making it bigger than the area available for the container.
- Parameters
-
x The actor's X coordinate. y The actor's Y coordinate. available_width The maximum available width, or -1 to use the actor's natural width. available_height The maximum available height, or -1 to use the actor's natural height. flags Flags controlling the allocation.
void Clutter::Actor::allocate_preferred_size | ( | AllocationFlags | absolute_origin_changed = ALLOCATION_NONE ) |
Allocates the natural size of self.
This function is a utility call for Clutter::Actor implementations that allocates the actor's preferred natural size. It can be used by fixed layout managers (like Clutter::Group or so called 'composite actors') inside the ClutterActor::allocate implementation to give each child exactly how much space it requires, regardless of the size of the parent.
This function is not meant to be used by applications. It is also not meant to be used outside the implementation of the Clutter::ActorClass.allocate virtual function.
- Parameters
-
flags Flags controlling the allocation.
|
protectedvirtual |
void Clutter::Actor::apply_relative_transform_to_point | ( | const Glib::RefPtr< Actor >& | ancestor, |
const Vertex& | point, | ||
Vertex& | vertex | ||
) | const |
Transforms point in coordinates relative to the actor into ancestor-relative coordinates using the relevant transform stack (i.e. scale, rotation, etc).
If ancestor is 0
the ancestor will be the Clutter::Stage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of apply_transform_to_point().
- Parameters
-
ancestor A Clutter::Actor ancestor, or 0
to use the default Clutter::Stage.point A point as Clutter::Vertex. vertex The translated Clutter::Vertex.
void Clutter::Actor::apply_relative_transform_to_point | ( | const Vertex& | point, |
Vertex& | vertex | ||
) | const |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor.
The returned vertices relate to the Clutter::ActorBox coordinates as follows:
- verts[0] contains (x1, y1)
- verts[1] contains (x2, y1)
- verts[2] contains (x1, y2)
- verts[3] contains (x2, y2)
If ancestor is 0
the ancestor will be the Clutter::Stage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of get_abs_allocation_vertices().
- Parameters
-
ancestor A Clutter::Actor to calculate the vertices against, or 0
to use the Clutter::Stage.verts Return location for an array of 4 Clutter::Vertex in which to store the result.
Transforms point in coordinates relative to the actor into screen-relative coordinates with the current actor transformation (i.e. scale, rotation, etc)
- Parameters
-
point A point as Clutter::Vertex. vertex The translated Clutter::Vertex.
void Clutter::Actor::clear_actions | ( | ) |
Clears the list of actions applied to self.
void Clutter::Actor::clear_constraints | ( | ) |
Clears the list of constraints applied to self.
void Clutter::Actor::clear_effects | ( | ) |
Clears the list of effects applied to self.
bool Clutter::Actor::contains | ( | const Glib::RefPtr< const Actor >& | descendant) | const |
Determines if descendant is contained inside self (either as an immediate child, or as a deeper descendant).
If self and descendant point to the same actor then it will also return true
.
- Parameters
-
descendant A Clutter::Actor, possibly contained in self.
- Returns
- Whether descendent is contained within self.
void Clutter::Actor::continue_paint | ( | ) |
Run the next stage of the paint sequence.
This function should only be called within the implementation of the ‘run’ virtual of a Clutter::Effect. It will cause the run method of the next effect to be applied, or it will paint the actual actor if the current effect is the last effect in the chain.
|
static |
Glib::RefPtr<Pango::Context> Clutter::Actor::create_pango_context | ( | ) |
Creates a Pango::Context for the given actor.
The Pango::Context is already configured using the appropriate font map, resolution and font options.
See also get_pango_context().
- Returns
- The newly created Pango::Context. Use Glib::object_unref() on the returned value to deallocate its resources.
Glib::RefPtr<Pango::Layout> Clutter::Actor::create_pango_layout | ( | const Glib::ustring & | text) |
Creates a new Pango::Layout from the same Pango::Context used by the Clutter::Actor.
The Pango::Layout is already configured with the font map, resolution and font options, and the given text.
If you want to keep around a Pango::Layout created by this function you will have to connect to the Clutter::Backend::signal_font_changed() and Clutter::Backend::signal_resolution_changed() signals, and call pango_layout_context_changed() in response to them.
- Parameters
-
text The text to set on the Pango::Layout, or 0
.
- Returns
- The newly created Pango::Layout. Use Glib::object_unref() when done.
void Clutter::Actor::destroy | ( | ) |
Destroys an actor.
When an actor is destroyed, it will break any references it holds to other objects. If the actor is inside a container, the actor will be removed.
When you destroy a container, its children will be destroyed as well.
- Note
- you cannot destroy the Clutter::Stage returned by Clutter::Stage::get_default().
void Clutter::Actor::detach_animation | ( | ) |
Detaches the Clutter::Animation used by actor, if animate() has been called on actor.
Once the animation has been detached, it loses a reference. If it was the only reference then the Clutter::Animation becomes invalid.
The Clutter::Animation::signal_completed() signal will not be emitted.
- Since cluttermm 1.4:
- Deprecated: 1.12: Use the implicit transition for animatable properties in Clutter::Actor instead, and remove_transition() to remove the transition.
bool Clutter::Actor::event | ( | const 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.
- Parameters
-
event A Clutter::Event. capture true
if event in in capture phase,false
otherwise.
- Returns
- The return value from the signal emission:
true
if the actor handled the event, orfalse
if the event was not handled.
void Clutter::Actor::get_abs_allocation_vertices | ( | Vertex | vertices[4]) | const |
Calculates the transformed screen coordinates of the four corners of the actor; the returned vertices relate to the Clutter::ActorBox coordinates as follows:
- v[0] contains (x1, y1)
- v[1] contains (x2, y1)
- v[2] contains (x1, y2)
- v[3] contains (x2, y2)
- Parameters
-
verts Pointer to a location of an array of 4 Clutter::Vertex where to store the result.
Glib::RefPtr<Atk::Object> Clutter::Actor::get_accessible | ( | ) |
Returns the accessible object that describes the actor to an assistive technology.
If no class-specific Atk::Object implementation is available for the actor instance in question, it will inherit an Atk::Object implementation from the first ancestor class for which such an implementation is defined.
The documentation of the ATK library contains more information about accessible objects and their uses.
- Returns
- The Atk::Object associated with actor.
Glib::RefPtr<const Atk::Object> Clutter::Actor::get_accessible | ( | ) | const |
Returns the accessible object that describes the actor to an assistive technology.
If no class-specific Atk::Object implementation is available for the actor instance in question, it will inherit an Atk::Object implementation from the first ancestor class for which such an implementation is defined.
The documentation of the ATK library contains more information about accessible objects and their uses.
- Returns
- The Atk::Object associated with actor.
Glib::RefPtr<Action> Clutter::Actor::get_action | ( | const Glib::ustring & | name) |
Retrieves the Clutter::Action with the given name in the list of actions applied to self.
- Parameters
-
name The name of the action to retrieve.
- Returns
- A Clutter::Action for the given name, or
0
. The returned Clutter::Action is owned by the actor and it should not be unreferenced directly.
Glib::RefPtr<const Action> Clutter::Actor::get_action | ( | const Glib::ustring & | name) | const |
Retrieves the Clutter::Action with the given name in the list of actions applied to self.
- Parameters
-
name The name of the action to retrieve.
- Returns
- A Clutter::Action for the given name, or
0
. The returned Clutter::Action is owned by the actor and it should not be unreferenced directly.
std::vector< Glib::RefPtr<Action> > Clutter::Actor::get_actions | ( | ) |
Retrieves the list of actions applied to self.
- Returns
- A copy of the list of Clutter::Actions. The contents of the list are owned by the Clutter::Actor. Use Glib::list_free() to free the resources allocated by the returned List.
std::vector< Glib::RefPtr<const Action> > Clutter::Actor::get_actions | ( | ) | const |
Retrieves the list of actions applied to self.
- Returns
- A copy of the list of Clutter::Actions. The contents of the list are owned by the Clutter::Actor. Use Glib::list_free() to free the resources allocated by the returned List.
|
static |
Retrieves the Clutter::Actor with id.
Deprecated: 1.8: The id is not used any longer.
- Deprecated:
- The ID is no longer used.
- Parameters
-
id A Clutter::Actor unique id.
- Returns
- The actor with the passed id or
0
. The returned actor does not have its reference count increased.
ActorBox Clutter::Actor::get_allocation_box | ( | ) | const |
Gets the layout box an actor has been assigned.
The allocation can only be assumed valid inside a paint() method; anywhere else, it may be out-of-date.
An allocation does not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.
<note>Do not call any of the clutter_actor_get_allocation_*() family of functions inside the implementation of the get_preferred_width() or get_preferred_height() virtual functions.</note>
- Parameters
-
box The function fills this in with the actor's allocation.
Geometry Clutter::Actor::get_allocation_geometry | ( | ) | const |
Gets the layout box an actor has been assigned.
The allocation can only be assumed valid inside a paint() method; anywhere else, it may be out-of-date.
An allocation does not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.
The returned rectangle is in pixels.
Deprecated: 1.12: Use get_allocation_box() instead.
- Parameters
-
geom Allocation geometry in pixels.
- Deprecated:
- Use get_allocation_box() instead.
void Clutter::Actor::get_allocation_vertices | ( | Vertex | vertices[4]) | const |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor.
The returned vertices relate to the Clutter::ActorBox coordinates as follows:
- verts[0] contains (x1, y1)
- verts[1] contains (x2, y1)
- verts[2] contains (x1, y2)
- verts[3] contains (x2, y2)
If ancestor is 0
the ancestor will be the Clutter::Stage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of get_abs_allocation_vertices().
- Parameters
-
ancestor A Clutter::Actor to calculate the vertices against, or 0
to use the Clutter::Stage.verts Return location for an array of 4 Clutter::Vertex in which to store the result.
void Clutter::Actor::get_allocation_vertices | ( | const Glib::RefPtr< Actor >& | ancestor, |
Vertex | vertices[4] | ||
) | const |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor.
The returned vertices relate to the Clutter::ActorBox coordinates as follows:
- verts[0] contains (x1, y1)
- verts[1] contains (x2, y1)
- verts[2] contains (x1, y2)
- verts[3] contains (x2, y2)
If ancestor is 0
the ancestor will be the Clutter::Stage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of get_abs_allocation_vertices().
- Parameters
-
ancestor A Clutter::Actor to calculate the vertices against, or 0
to use the Clutter::Stage.verts Return location for an array of 4 Clutter::Vertex in which to store the result.
void Clutter::Actor::get_anchor_point | ( | float & | anchor_x, |
float & | anchor_y | ||
) | const |
Gets the current anchor point of the actor in pixels.
Deprecated: 1.12: Use Clutter::Actor::property_pivot_point() instead
- Deprecated:
- Use “pivot-point” instead.
- Parameters
-
anchor_x Return location for the X coordinate of the anchor point. anchor_y Return location for the Y coordinate of the anchor point.
Gravity Clutter::Actor::get_anchor_point_gravity | ( | ) |
Retrieves the anchor position expressed as a Clutter::Gravity.
If the anchor point was specified using pixels or units this will return Clutter::GRAVITY_NONE.
Deprecated: 1.12: Use Clutter::Actor::property_pivot_point() instead.
- Deprecated:
- Use “pivot-point” instead.
- Returns
- The Clutter::Gravity used by the anchor point.
Glib::RefPtr<Animation> Clutter::Actor::get_animation | ( | ) |
Retrieves the Clutter::Animation used by actor, if animate() has been called on actor.
- Since cluttermm 1.0:
- Deprecated: 1.12: Use the implicit transition for animatable properties in Clutter::Actor instead, and get_transition() to retrieve the transition.
- Deprecated:
- Use the implicit transition for animatable properties in ClutterActor instead
- Returns
- A Clutter::Animation, or
0
.
Glib::RefPtr<const Animation> Clutter::Actor::get_animation | ( | ) | const |
Retrieves the Clutter::Animation used by actor, if animate() has been called on actor.
- Since cluttermm 1.0:
- Deprecated: 1.12: Use the implicit transition for animatable properties in Clutter::Actor instead, and get_transition() to retrieve the transition.
- Deprecated:
- Use the implicit transition for animatable properties in ClutterActor instead
- Returns
- A Clutter::Animation, or
0
.
Color Clutter::Actor::get_background_color | ( | ) | const |
Retrieves the color set using set_background_color().
Glib::RefPtr<Actor> Clutter::Actor::get_child_at_index | ( | int | index) |
Retrieves the actor at the given index inside the list of children of self.
- Parameters
-
index The position in the list of children.
- Returns
- A pointer to a Clutter::Actor, or
0
.
Glib::RefPtr<const Actor> Clutter::Actor::get_child_at_index | ( | int | index) | const |
Retrieves the actor at the given index inside the list of children of self.
- Parameters
-
index The position in the list of children.
- Returns
- A pointer to a Clutter::Actor, or
0
.
Matrix Clutter::Actor::get_child_transform | ( | ) | const |
std::vector< Glib::RefPtr<Actor> > Clutter::Actor::get_children | ( | ) |
Retrieves the list of children of self.
- Returns
- A newly allocated List of Clutter::Actors. Use Glib::list_free() when done.
std::vector< Glib::RefPtr<const Actor> > Clutter::Actor::get_children | ( | ) | const |
Retrieves the list of children of self.
- Returns
- A newly allocated List of Clutter::Actors. Use Glib::list_free() when done.
void Clutter::Actor::get_clip | ( | float & | xoff, |
float & | yoff, | ||
float & | width, | ||
float & | height | ||
) |
Gets the clip area for self, if any is set.
- Parameters
-
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
.
bool Clutter::Actor::get_clip_to_allocation | ( | ) | const |
Retrieves the value set using set_clip_to_allocation()
- Returns
true
if the Clutter::Actor is clipped to its allocation.
Glib::RefPtr<const Constraint> Clutter::Actor::get_constraint | ( | const Glib::ustring & | name) | const |
Retrieves the Clutter::Constraint with the given name in the list of constraints applied to self.
- Parameters
-
name The name of the constraint to retrieve.
- Returns
- A Clutter::Constraint for the given name, or
0
. The returned Clutter::Constraint is owned by the actor and it should not be unreferenced directly.
Glib::RefPtr<Constraint> Clutter::Actor::get_constraint | ( | const Glib::ustring & | name) |
Retrieves the Clutter::Constraint with the given name in the list of constraints applied to self.
- Parameters
-
name The name of the constraint to retrieve.
- Returns
- A Clutter::Constraint for the given name, or
0
. The returned Clutter::Constraint is owned by the actor and it should not be unreferenced directly.
std::vector< Glib::RefPtr<Clutter::Constraint> > Clutter::Actor::get_constraints | ( | ) |
Retrieves the list of constraints applied to self.
- Returns
- A copy of the list of Clutter::Constraints. The contents of the list are owned by the Clutter::Actor. Use Glib::list_free() to free the resources allocated by the returned List.
std::vector< Glib::RefPtr<const Clutter::Constraint> > Clutter::Actor::get_constraints | ( | ) | const |
Retrieves the list of constraints applied to self.
- Returns
- A copy of the list of Clutter::Constraints. The contents of the list are owned by the Clutter::Actor. Use Glib::list_free() to free the resources allocated by the returned List.
Glib::RefPtr<Content> Clutter::Actor::get_content | ( | ) |
Retrieves the contents of self.
- Returns
- A pointer to the Clutter::Content instance, or
0
if none was set.
Glib::RefPtr<const Content> Clutter::Actor::get_content | ( | ) | const |
Retrieves the contents of self.
- Returns
- A pointer to the Clutter::Content instance, or
0
if none was set.
ActorBox Clutter::Actor::get_content_box | ( | ) | const |
ContentGravity Clutter::Actor::get_content_gravity | ( | ) | const |
Retrieves the content gravity as set using set_content_gravity().
- Returns
- The content gravity.
ContentRepeat Clutter::Actor::get_content_repeat | ( | ) | const |
Retrieves the repeat policy for a Clutter::Actor set by set_content_repeat().
- Returns
- The content repeat policy.
void Clutter::Actor::get_content_scaling_filters | ( | ScalingFilter& | min_filter, |
ScalingFilter& | mag_filter | ||
) |
Retrieves the values set using set_content_scaling_filters().
- Parameters
-
min_filter Return location for the minification filter, or 0
.mag_filter Return location for the magnification filter, or 0
.
const PaintVolume* Clutter::Actor::get_default_paint_volume | ( | ) | const |
Retrieves the default paint volume for self.
This function provides the same Clutter::PaintVolume that would be computed by the default implementation inside Clutter::Actor of the Clutter::ActorClass.get_paint_volume() virtual function.
This function should only be used by Clutter::Actor subclasses that cannot chain up to the parent implementation when computing their paint volume.
- Returns
- A pointer to the default Clutter::PaintVolume, relative to the Clutter::Actor, or
0
if the actor could not compute a valid paint volume. The returned value is not guaranteed to be stable across multiple frames, so if you want to retain it, you will need to copy it using clutter_paint_volume_copy().
float Clutter::Actor::get_depth | ( | ) | const |
Retrieves the depth of self.
Deprecated: 1.12: Use get_z_position() instead.
- Deprecated:
- Use get_z_position() instead.
- Returns
- The depth of the actor.
guint Clutter::Actor::get_easing_delay | ( | ) | const |
Retrieves the delay that should be applied when tweening animatable properties.
- Returns
- A delay, in milliseconds.
guint Clutter::Actor::get_easing_duration | ( | ) | const |
Retrieves the duration of the tweening for animatable properties of self for the current easing state.
- Returns
- The duration of the tweening, in milliseconds.
AnimationMode Clutter::Actor::get_easing_mode | ( | ) | const |
Retrieves the easing mode for the tweening of animatable properties of self for the current easing state.
- Returns
- An easing mode.
Glib::RefPtr<Effect> Clutter::Actor::get_effect | ( | const Glib::ustring & | name) |
Retrieves the Clutter::Effect with the given name in the list of effects applied to self.
- Parameters
-
name The name of the effect to retrieve.
- Returns
- A Clutter::Effect for the given name, or
0
. The returned Clutter::Effect is owned by the actor and it should not be unreferenced directly.
Glib::RefPtr<const Effect> Clutter::Actor::get_effect | ( | const Glib::ustring & | name) | const |
Retrieves the Clutter::Effect with the given name in the list of effects applied to self.
- Parameters
-
name The name of the effect to retrieve.
- Returns
- A Clutter::Effect for the given name, or
0
. The returned Clutter::Effect is owned by the actor and it should not be unreferenced directly.
std::vector< Glib::RefPtr<Effect> > Clutter::Actor::get_effects | ( | ) |
Retrieves the Clutter::Effects applied on self, if any.
- Returns
- A list of Clutter::Effects, or
0
. The elements of the returned list are owned by Clutter and they should not be freed. You should free the returned list using Glib::list_free() when done.
std::vector< Glib::RefPtr<const Effect> > Clutter::Actor::get_effects | ( | ) | const |
Retrieves the Clutter::Effects applied on self, if any.
- Returns
- A list of Clutter::Effects, or
0
. The elements of the returned list are owned by Clutter and they should not be freed. You should free the returned list using Glib::list_free() when done.
Glib::RefPtr<Actor> Clutter::Actor::get_first_child | ( | ) |
Retrieves the first child of self.
The returned pointer is only valid until the scene graph changes; it is not safe to modify the list of children of self while iterating it.
- Returns
- A pointer to a Clutter::Actor, or
0
.
Glib::RefPtr<const Actor> Clutter::Actor::get_first_child | ( | ) | const |
Retrieves the first child of self.
The returned pointer is only valid until the scene graph changes; it is not safe to modify the list of children of self while iterating it.
- Returns
- A pointer to a Clutter::Actor, or
0
.
bool Clutter::Actor::get_fixed_position_set | ( | ) | const |
Checks whether an actor has a fixed position set (and will thus be unaffected by any layout manager).
- Returns
true
if the fixed position is set on the actor.
ActorFlags Clutter::Actor::get_flags | ( | ) | const |
Retrieves the flags set on self.
- Returns
- A bitwise or of Clutter::ActorFlags or 0.
Geometry Clutter::Actor::get_geometry | ( | ) | const |
Gets the size and position of an actor relative to its parent actor.
This is the same as calling get_position() and get_size(). It tries to "do what you mean" and get the requested size and position if the actor's allocation is invalid.
Deprecated: 1.10: Use get_position() and get_size(), or get_allocation_geometry() instead.
- Parameters
-
geometry A location to store actors Clutter::Geometry.
- Deprecated:
- Use get_position() and get_size(), or get_allocation_geometry() instead.
guint32 Clutter::Actor::get_gid | ( | ) | const |
Retrieves the unique id for self.
Deprecated: 1.8: The id is not used any longer.
- Returns
- Globally unique value for this object instance.
float Clutter::Actor::get_height | ( | ) | const |
Retrieves the height of a Clutter::Actor.
If the actor has a valid allocation, this function will return the height of the allocated area given to the actor.
If the actor does not have a valid allocation, this function will return the actor's natural height, that is the preferred height of the actor.
If you care whether you get the preferred height or the height that has been assigned to the actor, you should probably call a different function like get_allocation_box() to retrieve the allocated size or get_preferred_height() to retrieve the preferred height.
If an actor has a fixed height, for instance a height that has been assigned using set_height(), the height returned will be the same value.
- Returns
- The height of the actor, in pixels.
Glib::RefPtr<Actor> Clutter::Actor::get_last_child | ( | ) |
Retrieves the last child of self.
The returned pointer is only valid until the scene graph changes; it is not safe to modify the list of children of self while iterating it.
- Returns
- A pointer to a Clutter::Actor, or
0
.
Glib::RefPtr<const Actor> Clutter::Actor::get_last_child | ( | ) | const |
Retrieves the last child of self.
The returned pointer is only valid until the scene graph changes; it is not safe to modify the list of children of self while iterating it.
- Returns
- A pointer to a Clutter::Actor, or
0
.
Glib::RefPtr<LayoutManager> Clutter::Actor::get_layout_manager | ( | ) |
Retrieves the Clutter::LayoutManager used by self.
- Returns
- A pointer to the Clutter::LayoutManager, or
0
.
Glib::RefPtr<const LayoutManager> Clutter::Actor::get_layout_manager | ( | ) | const |
Retrieves the Clutter::LayoutManager used by self.
- Returns
- A pointer to the Clutter::LayoutManager, or
0
.
float Clutter::Actor::get_margin_bottom | ( | ) | const |
float Clutter::Actor::get_margin_left | ( | ) | const |
float Clutter::Actor::get_margin_right | ( | ) | const |
float Clutter::Actor::get_margin_top | ( | ) | const |
int Clutter::Actor::get_n_children | ( | ) | const |
Retrieves the number of children of self.
- Returns
- The number of children of an actor.
Glib::ustring Clutter::Actor::get_name | ( | ) | const |
Retrieves the name of self.
- Returns
- The name of the actor, or
0
. The returned string is owned by the actor and should not be modified or freed.
Glib::RefPtr<Actor> Clutter::Actor::get_next_sibling | ( | ) |
Retrieves the sibling of self that comes after it in the list of children of self's parent.
The returned pointer is only valid until the scene graph changes; it is not safe to modify the list of children of self while iterating it.
- Returns
- A pointer to a Clutter::Actor, or
0
.
Glib::RefPtr<const Actor> Clutter::Actor::get_next_sibling | ( | ) | const |
Retrieves the sibling of self that comes after it in the list of children of self's parent.
The returned pointer is only valid until the scene graph changes; it is not safe to modify the list of children of self while iterating it.
- Returns
- A pointer to a Clutter::Actor, or
0
.
OffscreenRedirect Clutter::Actor::get_offscreen_redirect | ( | ) |
Retrieves whether to redirect the actor to an offscreen buffer, as set by set_offscreen_redirect().
- Returns
- The value of the offscreen-redirect property of the actor.
guint8 Clutter::Actor::get_opacity | ( | ) | const |
Retrieves the opacity value of an actor, as set by set_opacity().
For retrieving the absolute opacity of the actor inside a paint virtual function, see get_paint_opacity().
- Returns
- The opacity of the actor.
bool Clutter::Actor::get_paint_box | ( | ActorBox& | box) |
Retrieves the paint volume of the passed Clutter::Actor, and transforms it into a 2D bounding box in stage coordinates.
This function is useful to determine the on screen area occupied by the actor. The box is only an approximation and may often be considerably larger due to the optimizations used to calculate the box. The box is never smaller though, so it can reliably be used for culling.
There are times when a 2D paint box can't be determined, e.g. because the actor isn't yet parented under a stage or because the actor is unable to determine a paint volume.
- Parameters
-
box Return location for a Clutter::ActorBox.
- Returns
true
if a 2D paint box could be determined, elsefalse
.
guint8 Clutter::Actor::get_paint_opacity | ( | ) | const |
Retrieves the absolute opacity of the actor, as it appears on the stage.
This function traverses the hierarchy chain and composites the opacity of the actor with that of its parents.
This function is intended for subclasses to use in the paint virtual function, to paint themselves with the correct opacity.
- Returns
- The actor opacity value.
bool Clutter::Actor::get_paint_visibility | ( | ) | const |
Retrieves the 'paint' visibility of an actor recursively checking for non visible parents.
This is by definition the same as Clutter::ACTOR_IS_MAPPED.
{0,8,4}
- Returns
true
if the actor is visibile and will be painted.
const PaintVolume* Clutter::Actor::get_paint_volume | ( | ) | const |
Retrieves the paint volume of the passed Clutter::Actor, or 0
when a paint volume can't be determined.
The paint volume is defined as the 3D space occupied by an actor when being painted.
This function will call the get_paint_volume()
virtual function of the Clutter::Actor class. Sub-classes of Clutter::Actor should not usually care about overriding the default implementation, unless they are, for instance: painting outside their allocation, or actors with a depth factor (not in terms of Clutter::Actor::property_depth() but real 3D depth).
<note>2D actors overriding get_paint_volume()
ensure their volume has a depth of 0. (This will be true so long as you don't call clutter_paint_volume_set_depth().)</note>
- Returns
- A pointer to a Clutter::PaintVolume, or
0
if no volume could be determined. The returned pointer is not guaranteed to be valid across multiple frames; if you want to keep it, you will need to copy it using clutter_paint_volume_copy().
|
protectedvirtual |
Glib::RefPtr<Pango::Context> Clutter::Actor::get_pango_context | ( | ) |
Retrieves the Pango::Context for self.
The actor's Pango::Context is already configured using the appropriate font map, resolution and font options.
Unlike create_pango_context(), this context is owend by the Clutter::Actor and it will be updated each time the options stored by the Clutter::Backend change.
You can use the returned Pango::Context to create a Pango::Layout and render text using cogl_pango_render_layout() to reuse the glyphs cache also used by Clutter.
- Returns
- The Pango::Context for a Clutter::Actor. The returned Pango::Context is owned by the actor and should not be unreferenced by the application code.
Glib::RefPtr<const Pango::Context> Clutter::Actor::get_pango_context | ( | ) | const |
Retrieves the Pango::Context for self.
The actor's Pango::Context is already configured using the appropriate font map, resolution and font options.
Unlike create_pango_context(), this context is owend by the Clutter::Actor and it will be updated each time the options stored by the Clutter::Backend change.
You can use the returned Pango::Context to create a Pango::Layout and render text using cogl_pango_render_layout() to reuse the glyphs cache also used by Clutter.
- Returns
- The Pango::Context for a Clutter::Actor. The returned Pango::Context is owned by the actor and should not be unreferenced by the application code.
Glib::RefPtr<Actor> Clutter::Actor::get_parent | ( | ) |
Retrieves the parent of self.
- Returns
- The Clutter::Actor parent, or
0
if no parent is set.
Glib::RefPtr<const Actor> Clutter::Actor::get_parent | ( | ) | const |
Retrieves the parent of self.
- Returns
- The Clutter::Actor parent, or
0
if no parent is set.
void Clutter::Actor::get_pivot_point | ( | float & | pivot_x, |
float & | pivot_y | ||
) | const |
Retrieves the coordinates of the Clutter::Actor::property_pivot_point().
- Parameters
-
pivot_x Return location for the normalized X coordinate of the pivot point, or 0
.pivot_y Return location for the normalized Y coordinate of the pivot point, or 0
.
float Clutter::Actor::get_pivot_point_z | ( | ) | const |
Retrieves the Z component of the Clutter::Actor::property_pivot_point().
void Clutter::Actor::get_position | ( | float & | x, |
float & | y | ||
) |
This function tries to "do what you mean" and tell you where the actor is, prior to any transformations.
Retrieves the fixed position of an actor in pixels, if one has been set; otherwise, if the allocation is valid, returns the actor's allocated position; otherwise, returns 0,0.
The returned position is in pixels.
- Parameters
-
x Return location for the X coordinate, or 0
.y Return location for the Y coordinate, or 0
.
void Clutter::Actor::get_preferred_height | ( | float | for_width, |
float & | min_height_p, | ||
float & | natural_height_p | ||
) | const |
Computes the requested minimum and natural heights for an actor, or if they are already computed, returns the cached values.
An actor may not get its request - depending on the layout manager that's in effect.
A request should not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.
- Parameters
-
for_width Available width to assume in computing desired height, or a negative value to indicate that no width is defined. min_height_p Return location for minimum height, or 0
.natural_height_p Return location for natural height, or 0
.
|
protectedvirtual |
void Clutter::Actor::get_preferred_size | ( | float & | min_width_p, |
float & | min_height_p, | ||
float & | natural_width_p, | ||
float & | natural_height_p | ||
) | const |
Computes the preferred minimum and natural size of an actor, taking into account the actor's geometry management (either height-for-width or width-for-height).
The width and height used to compute the preferred height and preferred width are the actor's natural ones.
If you need to control the height for the preferred width, or the width for the preferred height, you should use get_preferred_width() and get_preferred_height(), and check the actor's preferred geometry management using the Clutter::Actor::property_request_mode() property.
- Parameters
-
min_width_p Return location for the minimum width, or 0
.min_height_p Return location for the minimum height, or 0
.natural_width_p Return location for the natural width, or 0
.natural_height_p Return location for the natural height, or 0
.
void Clutter::Actor::get_preferred_width | ( | float | for_height, |
float & | min_width_p, | ||
float & | natural_width_p | ||
) | const |
Computes the requested minimum and natural widths for an actor, optionally depending on the specified height, or if they are already computed, returns the cached values.
An actor may not get its request - depending on the layout manager that's in effect.
A request should not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.
- Parameters
-
for_height Available height when computing the preferred width, or a negative value to indicate that no height is defined. min_width_p Return location for minimum width, or 0
.natural_width_p Return location for the natural width, or 0
.
|
protectedvirtual |
Glib::RefPtr<Actor> Clutter::Actor::get_previous_sibling | ( | ) |
Retrieves the sibling of self that comes before it in the list of children of self's parent.
The returned pointer is only valid until the scene graph changes; it is not safe to modify the list of children of self while iterating it.
- Returns
- A pointer to a Clutter::Actor, or
0
.
Glib::RefPtr<const Actor> Clutter::Actor::get_previous_sibling | ( | ) | const |
Retrieves the sibling of self that comes before it in the list of children of self's parent.
The returned pointer is only valid until the scene graph changes; it is not safe to modify the list of children of self while iterating it.
- Returns
- A pointer to a Clutter::Actor, or
0
.
bool Clutter::Actor::get_reactive | ( | ) | const |
Checks whether actor is marked as reactive.
- Returns
true
if the actor is reactive.
RequestMode Clutter::Actor::get_request_mode | ( | ) | const |
Retrieves the geometry request mode of self.
- Returns
- The request mode for the actor.
double Clutter::Actor::get_rotation | ( | RotateAxis | axis, |
float & | x, | ||
float & | y, | ||
float & | z | ||
) | const |
Retrieves the angle and center of rotation on the given axis, set using set_rotation().
Deprecated: 1.12: Use get_rotation_angle() and get_pivot_point() instead.
- Deprecated:
- Use get_rotation_angle() and get_pivot_point() instead.
- Parameters
-
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.
- Returns
- The angle of rotation.
double Clutter::Actor::get_rotation_angle | ( | RotateAxis | axis) | const |
Retrieves the angle of rotation set by set_rotation_angle().
- Parameters
-
axis The axis of the rotation.
- Returns
- The angle of rotation, in degrees.
void Clutter::Actor::get_scale | ( | double & | scale_x, |
double & | scale_y | ||
) | const |
Retrieves an actors scale factors.
- Parameters
-
scale_x Location to store horizonal scale factor, or 0
.scale_y Location to store vertical scale factor, or 0
.
void Clutter::Actor::get_scale_center | ( | float & | center_x, |
float & | center_y | ||
) | const |
Retrieves the scale center coordinate in pixels relative to the top left corner of the actor.
If the scale center was specified using a Clutter::Gravity this will calculate the pixel offset using the current size of the actor.
Deprecated: 1.12: Use get_pivot_point() instead.
- Deprecated:
- Use get_pivot_point() instead.
- Parameters
-
center_x Location to store the X position of the scale center, or 0
.center_y Location to store the Y position of the scale center, or 0
.
Gravity Clutter::Actor::get_scale_gravity | ( | ) | const |
Retrieves the scale center as a compass direction.
If the scale center was specified in pixels or units this will return Clutter::GRAVITY_NONE.
Deprecated: 1.12: Use get_pivot_point() instead.
- Deprecated:
- Use get_pivot_point() instead.
- Returns
- The scale gravity.
double Clutter::Actor::get_scale_z | ( | ) | const |
Retrieves the scaling factor along the Z axis, as set using set_scale_z().
- Returns
- The scaling factor along the Z axis.
Glib::RefPtr<Shader> Clutter::Actor::get_shader | ( | ) |
Queries the currently set Clutter::Shader on self.
Deprecated: 1.8: Use get_effect() instead.
- Deprecated:
- Use get_effect() instead.
- Returns
- The currently set Clutter::Shader or
0
if no shader is set.
Glib::RefPtr<const Shader> Clutter::Actor::get_shader | ( | ) | const |
Queries the currently set Clutter::Shader on self.
Deprecated: 1.8: Use get_effect() instead.
- Deprecated:
- Use get_effect() instead.
- Returns
- The currently set Clutter::Shader or
0
if no shader is set.
void Clutter::Actor::get_size | ( | float & | width, |
float & | height | ||
) | const |
This function tries to "do what you mean" and return the size an actor will have.
If the actor has a valid allocation, the allocation will be returned; otherwise, the actors natural size request will be returned.
If you care whether you get the request vs. the allocation, you should probably call a different function like get_allocation_box() or get_preferred_width().
- Parameters
-
width Return location for the width, or 0
.height Return location for the height, or 0
.
Glib::RefPtr<Actor> Clutter::Actor::get_stage | ( | ) |
Retrieves the Clutter::Stage where actor is contained.
- Returns
- The stage containing the actor, or
0
.
Glib::RefPtr<const Actor> Clutter::Actor::get_stage | ( | ) | const |
Retrieves the Clutter::Stage where actor is contained.
- Returns
- The stage containing the actor, or
0
.
TextDirection Clutter::Actor::get_text_direction | ( | ) | const |
Retrieves the value set using set_text_direction()
If no text direction has been previously set, the default text direction, as returned by clutter_get_default_text_direction(), will be returned instead
- Returns
- The Clutter::TextDirection for the actor.
Matrix Clutter::Actor::get_transform | ( | ) | const |
Returns the transformation matrix being used by the actor.
void Clutter::Actor::get_transformation_matrix | ( | ClutterMatrix * | matrix) |
Retrieves the transformations applied to self relative to its parent.
Deprecated: 1.12: Use get_transform() instead
- Deprecated:
- Use get_transform() instead
- Parameters
-
matrix The return location for a Clutter::Matrix.
const PaintVolume* Clutter::Actor::get_transformed_paint_volume | ( | const Glib::RefPtr< Actor >& | relative_to_ancestor) | const |
Retrieves the 3D paint volume of an actor like get_paint_volume() does (Please refer to the documentation of get_paint_volume() for more details.) and it additionally transforms the paint volume into the coordinate space of relative_to_ancestor.
(Or the stage if 0
is passed for relative_to_ancestor)
This can be used by containers that base their paint volume on the volume of their children. Such containers can query the transformed paint volume of all of its children and union them together using clutter_paint_volume_union().
- Parameters
-
relative_to_ancestor A Clutter::Actor that is an ancestor of self (or 0
for the stage).
- Returns
- A pointer to a Clutter::PaintVolume, or
0
if no volume could be determined. The returned pointer is not guaranteed to be valid across multiple frames; if you wish to keep it, you will have to copy it using clutter_paint_volume_copy().
const PaintVolume* Clutter::Actor::get_transformed_paint_volume | ( | ) | const |
A get_transformed_paint_volume() convenience overload.
void Clutter::Actor::get_transformed_position | ( | float & | x, |
float & | y | ||
) | const |
Gets the absolute position of an actor, in pixels relative to the stage.
- Parameters
-
x Return location for the X coordinate, or 0
.y Return location for the Y coordinate, or 0
.
void Clutter::Actor::get_transformed_size | ( | float & | width, |
float & | height | ||
) | const |
Gets the absolute size of an actor in pixels, taking into account the scaling factors.
If the actor has a valid allocation, the allocated size will be used. If the actor has not a valid allocation then the preferred size will be transformed and returned.
If you want the transformed allocation, see get_abs_allocation_vertices() instead.
<note>When the actor (or one of its ancestors) is rotated around the X or Y axis, it no longer appears as on the stage as a rectangle, but as a generic quadrangle; in that case this function returns the size of the smallest rectangle that encapsulates the entire quad. Please note that in this case no assumptions can be made about the relative position of this envelope to the absolute position of the actor, as returned by get_transformed_position(); if you need this information, you need to use get_abs_allocation_vertices() to get the coords of the actual quadrangle.</note>
- Parameters
-
width Return location for the width, or 0
.height Return location for the height, or 0
.
Glib::RefPtr<Transition> Clutter::Actor::get_transition | ( | const Glib::ustring & | name) |
Retrieves the Clutter::Transition of a Clutter::Actor by using the transition name.
Transitions created for animatable properties use the name of the property itself, for instance the code below:
[C example ellipted]
will call the on_transition_stopped
callback when the transition is finished.
If you just want to get notifications of the completion of a transition, you should use the Clutter::Actor::signal_transition_stopped() signal, using the transition name as the signal detail.
- Parameters
-
name The name of the transition.
- Returns
- A Clutter::Transition, or
0
is none was found to match the passed name; the returned instance is owned by Clutter and it should not be freed.
Glib::RefPtr<const Transition> Clutter::Actor::get_transition | ( | const Glib::ustring & | name) | const |
Retrieves the Clutter::Transition of a Clutter::Actor by using the transition name.
Transitions created for animatable properties use the name of the property itself, for instance the code below:
[C example ellipted]
will call the on_transition_stopped
callback when the transition is finished.
If you just want to get notifications of the completion of a transition, you should use the Clutter::Actor::signal_transition_stopped() signal, using the transition name as the signal detail.
- Parameters
-
name The name of the transition.
- Returns
- A Clutter::Transition, or
0
is none was found to match the passed name; the returned instance is owned by Clutter and it should not be freed.
void Clutter::Actor::get_translation | ( | float & | translate_x, |
float & | translate_y, | ||
float & | translate_z | ||
) | const |
Retrieves the translation set using set_translation().
- Parameters
-
translate_x Return location for the X component of the translation, or 0
.translate_y Return location for the Y component of the translation, or 0
.translate_z Return location for the Z component of the translation, or 0
.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
float Clutter::Actor::get_width | ( | ) | const |
Retrieves the width of a Clutter::Actor.
If the actor has a valid allocation, this function will return the width of the allocated area given to the actor.
If the actor does not have a valid allocation, this function will return the actor's natural width, that is the preferred width of the actor.
If you care whether you get the preferred width or the width that has been assigned to the actor, you should probably call a different function like get_allocation_box() to retrieve the allocated size or get_preferred_width() to retrieve the preferred width.
If an actor has a fixed width, for instance a width that has been assigned using set_width(), the width returned will be the same value.
- Returns
- The width of the actor, in pixels.
float Clutter::Actor::get_x | ( | ) | const |
Retrieves the X coordinate of a Clutter::Actor.
This function tries to "do what you mean", by returning the correct value depending on the actor's state.
If the actor has a valid allocation, this function will return the X coordinate of the origin of the allocation box.
If the actor has any fixed coordinate set using set_x(), set_position() or set_geometry(), this function will return that coordinate.
If both the allocation and a fixed position are missing, this function will return 0.
- Returns
- The X coordinate, in pixels, ignoring any transformation (i.e. scaling, rotation).
ActorAlign Clutter::Actor::get_x_align | ( | ) | const |
Retrieves the horizontal alignment policy set using set_x_align().
- Returns
- The horizontal alignment policy.
bool Clutter::Actor::get_x_expand | ( | ) | const |
Retrieves the value set with set_x_expand().
See also: needs_expand()
- Returns
true
if the actor has been set to expand.
float Clutter::Actor::get_y | ( | ) | const |
Retrieves the Y coordinate of a Clutter::Actor.
This function tries to "do what you mean", by returning the correct value depending on the actor's state.
If the actor has a valid allocation, this function will return the Y coordinate of the origin of the allocation box.
If the actor has any fixed coordinate set using set_y(), set_position() or set_geometry(), this function will return that coordinate.
If both the allocation and a fixed position are missing, this function will return 0.
- Returns
- The Y coordinate, in pixels, ignoring any transformation (i.e. scaling, rotation).
ActorAlign Clutter::Actor::get_y_align | ( | ) | const |
Retrieves the vertical alignment policy set using set_y_align().
- Returns
- The vertical alignment policy.
bool Clutter::Actor::get_y_expand | ( | ) | const |
Retrieves the value set with set_y_expand().
See also: needs_expand()
- Returns
true
if the actor has been set to expand.
float Clutter::Actor::get_z_position | ( | ) | const |
Retrieves the actor's position on the Z axis.
- Returns
- The position on the Z axis.
Gravity Clutter::Actor::get_z_rotation_gravity | ( | ) | const |
Retrieves the center for the rotation around the Z axis as a compass direction.
If the center was specified in pixels or units this will return Clutter::GRAVITY_NONE.
Deprecated: 1.12: Use the Clutter::Actor::property_pivot_point() instead of a Clutter::Gravity
- Deprecated:
- Use the “pivot-point” instead of a Gravity.
- Returns
- The Z rotation center.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
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.
void Clutter::Actor::grab_key_focus | ( | ) |
Sets the key focus of the Clutter::Stage including self to this Clutter::Actor.
bool Clutter::Actor::has_actions | ( | ) | const |
Returns whether the actor has any actions applied.
- Returns
true
if the actor has any actions,false
otherwise.
bool Clutter::Actor::has_allocation | ( | ) | const |
Checks if the actor has an up-to-date allocation assigned to it.
This means that the actor should have an allocation: it's visible and has a parent. It also means that there is no outstanding relayout request in progress for the actor or its children (There might be other outstanding layout requests in progress that will cause the actor to get a new allocation when the stage is laid out, however).
If this function returns false
, then the actor will normally be allocated before it is next drawn on the screen.
- Returns
true
if the actor has an up-to-date allocation.
bool Clutter::Actor::has_clip | ( | ) | const |
Determines whether the actor has a clip area set or not.
{0,1,1}
- Returns
true
if the actor has a clip area set.
bool Clutter::Actor::has_constraints | ( | ) | const |
Returns whether the actor has any constraints applied.
- Returns
true
if the actor has any constraints,false
otherwise.
bool Clutter::Actor::has_effects | ( | ) | const |
Returns whether the actor has any effects applied.
- Returns
true
if the actor has any effects,false
otherwise.
bool Clutter::Actor::has_key_focus | ( | ) | const |
Checks whether self is the Clutter::Actor that has key focus.
- Returns
true
if the actor has key focus, andfalse
otherwise.
bool Clutter::Actor::has_overlaps | ( | ) |
Asks the actor's implementation whether it may contain overlapping primitives.
For example; Clutter may use this to determine whether the painting should be redirected to an offscreen buffer to correctly implement the opacity property.
Custom actors can override the default response by implementing the Clutter::Actor has_overlaps
virtual function. See set_offscreen_redirect() for more information.
- Returns
true
if the actor may have overlapping primitives, andfalse
otherwise.
|
protectedvirtual |
bool Clutter::Actor::has_pointer | ( | ) | const |
Checks whether an actor contains the pointer of a Clutter::InputDevice.
- Returns
true
if the actor contains the pointer, andfalse
otherwise.
void Clutter::Actor::hide | ( | ) |
Flags an actor to be hidden.
A hidden actor will not be rendered on the stage.
Actors are visible by default.
If this function is called on an actor without a parent, the Clutter::Actor::property_show_on_set_parent() property will be set to false
as a side-effect.
void Clutter::Actor::hide_all | ( | ) |
Calls hide() on all child actors (if any).
Deprecated: 1.10: Using hide() on the actor will prevent its children from being painted as well.
- Deprecated:
- Using hide() on the actor will now prevent its children from being painted as well.
|
protectedvirtual |
void Clutter::Actor::insert_child_above | ( | const Glib::RefPtr< Actor >& | child, |
const Glib::RefPtr< Actor >& | sibling | ||
) |
Inserts child into the list of children of self, above another child of self or, if sibling is 0
, above all the children of self.
This function will acquire a reference on child that will only be released when calling remove_child().
This function will not take into consideration the Clutter::Actor::property_depth() of child.
This function will emit the Clutter::Container::signal_actor_added() signal on self.
- Parameters
-
child A Clutter::Actor. sibling A child of self, or 0
.
void Clutter::Actor::insert_child_at_index | ( | const Glib::RefPtr< Actor >& | child, |
int | index | ||
) |
Inserts child into the list of children of self, using the given index.
If index is greater than the number of children in self, or is less than 0, then the new child is added at the end.
This function will acquire a reference on child that will only be released when calling remove_child().
This function will not take into consideration the Clutter::Actor::property_depth() of child.
This function will emit the Clutter::Container::signal_actor_added() signal on self.
- Parameters
-
child A Clutter::Actor. index The index.
void Clutter::Actor::insert_child_at_index | ( | const Glib::RefPtr< Actor >& | child) |
A insert_child_at_index() convenience overload.
void Clutter::Actor::insert_child_below | ( | const Glib::RefPtr< Actor >& | child, |
const Glib::RefPtr< Actor >& | sibling | ||
) |
Inserts child into the list of children of self, below another child of self or, if sibling is 0
, below all the children of self.
This function will acquire a reference on child that will only be released when calling remove_child().
This function will not take into consideration the Clutter::Actor::property_depth() of child.
This function will emit the Clutter::Container::signal_actor_added() signal on self.
- Parameters
-
child A Clutter::Actor. sibling A child of self, or 0
.
bool Clutter::Actor::is_in_clone_paint | ( | ) | const |
Checks whether self is being currently painted by a Clutter::Clone.
This function is useful only inside the signal_paint() virtual function implementations or within handlers for the Clutter::Actor::signal_paint() signal
This function should not be used by applications
- Returns
true
if the Clutter::Actor is currently being painted by a Clutter::Clone, andfalse
otherwise.
bool Clutter::Actor::is_mapped | ( | ) | const |
bool Clutter::Actor::is_reactive | ( | ) | const |
bool Clutter::Actor::is_realized | ( | ) | const |
bool Clutter::Actor::is_rotated | ( | ) | const |
Checks whether any rotation is applied to the actor.
- Returns
true
if the actor is rotated.
bool Clutter::Actor::is_scaled | ( | ) | const |
Checks whether the actor is scaled in either dimension.
- Returns
true
if the actor is scaled.
bool Clutter::Actor::is_visible | ( | ) | const |
void Clutter::Actor::lower | ( | const Glib::RefPtr< Actor >& | above) |
Puts self below above.
Both actors must have the same parent, and the parent must implement the Clutter::Container interface.
This function calls Clutter::Container::lower_child() internally.
Deprecated: 1.10: Use set_child_below_sibling() instead.
- Deprecated:
- Use set_child_below_sibling() instead
- Parameters
-
above A Clutter::Actor to lower below.
void Clutter::Actor::lower_bottom | ( | ) |
Lowers self to the bottom.
This function calls lower() internally.
Deprecated: 1.10: Use set_child_below_sibling() with a 0
sibling, instead.
void Clutter::Actor::map | ( | ) |
Sets the Clutter::ACTOR_MAPPED flag on the actor and possibly maps and realizes its children if they are visible.
Does nothing if the actor is not visible.
Calling this function is strongly disencouraged: the default implementation of Clutter::ActorClass.map() will map all the children of an actor when mapping its parent.
When overriding map, it is mandatory to chain up to the parent implementation.
|
protectedvirtual |
void Clutter::Actor::move_anchor_point | ( | float | anchor_x, |
float | anchor_y | ||
) |
Sets an anchor point for the actor, and adjusts the actor postion so that the relative position of the actor toward its parent remains the same.
Deprecated: 1.12: Use Clutter::Actor::property_pivot_point() instead.
- Deprecated:
- Use “pivot-point” instead.
- Parameters
-
anchor_x X coordinate of the anchor point. anchor_y Y coordinate of the anchor point.
void Clutter::Actor::move_anchor_point_from_gravity | ( | Gravity | gravity) |
Sets an anchor point on the actor based on the given gravity, adjusting the actor postion so that its relative position within its parent remains unchanged.
Since version 1.0 the anchor point will be stored as a gravity so that if the actor changes size then the anchor point will move. For example, if you set the anchor point to Clutter::GRAVITY_SOUTH_EAST and later double the size of the actor, the anchor point will move to the bottom right.
Deprecated: 1.12: Use Clutter::Actor::property_pivot_point() instead.
- Deprecated:
- Use “pivot-point” instead.
- Parameters
-
gravity Clutter::Gravity.
void Clutter::Actor::move_by | ( | float | dx, |
float | dy | ||
) |
Moves an actor by the specified distance relative to its current position in pixels.
This function modifies the fixed position of an actor and thus removes it from any layout management. Another way to move an actor is with an anchor point, see set_anchor_point(), or with an additional translation, using set_translation().
bool Clutter::Actor::needs_expand | ( | Orientation | orientation) | const |
Checks whether an actor, or any of its children, is set to expand horizontally or vertically.
This function should only be called by layout managers that can assign extra space to their children.
If you want to know whether the actor was explicitly set to expand, use get_x_expand() or get_y_expand().
- Parameters
-
orientation The direction of expansion.
- Returns
true
if the actor should expand.
|
protectedvirtual |
This is a default handler for the signal signal_button_press_event().
|
protectedvirtual |
This is a default handler for the signal signal_button_release_event().
|
protectedvirtual |
This is a default handler for the signal signal_captured_event().
|
protectedvirtual |
This is a default handler for the signal signal_destroy().
|
protectedvirtual |
This is a default handler for the signal signal_enter_event().
|
protectedvirtual |
This is a default handler for the signal signal_event().
|
protectedvirtual |
This is a default handler for the signal signal_hide().
|
protectedvirtual |
This is a default handler for the signal signal_key_focus_in().
|
protectedvirtual |
This is a default handler for the signal signal_key_focus_out().
|
protectedvirtual |
This is a default handler for the signal signal_key_press_event().
|
protectedvirtual |
This is a default handler for the signal signal_key_release_event().
|
protectedvirtual |
This is a default handler for the signal signal_leave_event().
|
protectedvirtual |
This is a default handler for the signal signal_motion_event().
|
protectedvirtual |
This is a default handler for the signal signal_paint().
|
protectedvirtual |
This is a default handler for the signal signal_parent_set().
|
protectedvirtual |
This is a default handler for the signal signal_pick().
|
protectedvirtual |
This is a default handler for the signal signal_queue_redaw().
|
protectedvirtual |
This is a default handler for the signal signal_queue_relayout().
|
protectedvirtual |
This is a default handler for the signal signal_realize().
|
protectedvirtual |
This is a default handler for the signal signal_scroll_event().
|
protectedvirtual |
This is a default handler for the signal signal_show().
|
protectedvirtual |
This is a default handler for the signal signal_touch_event().
|
protectedvirtual |
This is a default handler for the signal signal_unrealize().
void Clutter::Actor::paint | ( | ) |
Renders the actor to display.
This function should not be called directly by applications. Call queue_redraw() to queue paints, instead.
This function is context-aware, and will either cause a regular paint or a pick paint.
This function will emit the Clutter::Actor::signal_paint() signal or the Clutter::Actor::signal_pick() signal, depending on the context.
This function does not paint the actor if the actor is set to 0, unless it is performing a pick paint.
|
protectedvirtual |
|
protectedvirtual |
|
protectedvirtual |
void Clutter::Actor::pop_internal | ( | ) |
Disables the effects of push_internal().
Deprecated: 1.10: All children of an actor are accessible through the Clutter::Actor API. This function is only useful for legacy containers overriding the default implementation of the Clutter::Container interface.
- Deprecated:
- All children of an actor are accessible through the ClutterActor API. This function is only useful for legacy containers overriding the default implementation of the ClutterContainer interface.
Glib::PropertyProxy_ReadOnly< ActorBox > Clutter::Actor::property_allocation | ( | ) | const |
The actor's allocation.
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< Gravity > Clutter::Actor::property_anchor_gravity | ( | ) |
The anchor point as a ClutterGravity.
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< Gravity > Clutter::Actor::property_anchor_gravity | ( | ) | const |
The anchor point as a ClutterGravity.
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< float > Clutter::Actor::property_anchor_x | ( | ) |
X coordinate of the anchor point.
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< float > Clutter::Actor::property_anchor_x | ( | ) | const |
X coordinate of the anchor point.
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< float > Clutter::Actor::property_anchor_y | ( | ) |
Y coordinate of the anchor point.
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< float > Clutter::Actor::property_anchor_y | ( | ) | const |
Y coordinate of the anchor point.
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< Color > Clutter::Actor::property_background_color | ( | ) |
The actor's background color.
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< Color > Clutter::Actor::property_background_color | ( | ) | const |
The actor's background color.
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_ReadOnly< bool > Clutter::Actor::property_background_color_set | ( | ) | const |
Whether the background color is set.
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< Matrix > Clutter::Actor::property_child_transform | ( | ) |
Children transformation matrix.
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< Matrix > Clutter::Actor::property_child_transform | ( | ) | const |
Children transformation matrix.
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_ReadOnly< bool > Clutter::Actor::property_child_transform_set | ( | ) | const |
Whether the child-transform property is set.
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< Geometry > Clutter::Actor::property_clip | ( | ) |
The clip region for the actor.
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< Geometry > Clutter::Actor::property_clip | ( | ) | const |
The clip region for the actor.
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< Rect > Clutter::Actor::property_clip_rect | ( | ) |
The visible region of the actor.
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< Rect > Clutter::Actor::property_clip_rect | ( | ) | const |
The visible region of the actor.
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< bool > Clutter::Actor::property_clip_to_allocation | ( | ) |
Sets the clip region to track the actor's allocation.
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< bool > Clutter::Actor::property_clip_to_allocation | ( | ) | const |
Sets the clip region to track the actor's allocation.
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< Content > Clutter::Actor::property_content | ( | ) |
Delegate object for painting the actor's content.
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< Content > Clutter::Actor::property_content | ( | ) | const |
Delegate object for painting the actor's content.
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_ReadOnly< ActorBox > Clutter::Actor::property_content_box | ( | ) | const |
The bounding box of the actor's content.
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< ContentGravity > Clutter::Actor::property_content_gravity | ( | ) |
Alignment of the actor's content.
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< ContentGravity > Clutter::Actor::property_content_gravity | ( | ) | const |
Alignment of the actor's content.
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< ContentRepeat > Clutter::Actor::property_content_repeat | ( | ) |
The repeat policy for the actor's content.
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< ContentRepeat > Clutter::Actor::property_content_repeat | ( | ) | const |
The repeat policy for the actor's content.
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< float > Clutter::Actor::property_depth | ( | ) |
Position on the 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< float > Clutter::Actor::property_depth | ( | ) | const |
Position on the 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_WriteOnly< Glib::RefPtr<Effect> > Clutter::Actor::property_effect | ( | ) |
Add an effect to be applied on the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
- Returns
- A PropertyProxy_WriteOnly that allows you to set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<Actor> > Clutter::Actor::property_first_child | ( | ) | const |
The actor's first child.
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< bool > Clutter::Actor::property_fixed_position_set | ( | ) |
Whether to use fixed positioning for the actor.
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< bool > Clutter::Actor::property_fixed_position_set | ( | ) | const |
Whether to use fixed positioning for the actor.
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< float > Clutter::Actor::property_fixed_x | ( | ) |
Forced X position of the actor.
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< float > Clutter::Actor::property_fixed_x | ( | ) | const |
Forced X position of the actor.
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< float > Clutter::Actor::property_fixed_y | ( | ) |
Forced Y position of the actor.
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< float > Clutter::Actor::property_fixed_y | ( | ) | const |
Forced Y position of the actor.
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_ReadOnly< bool > Clutter::Actor::property_has_clip | ( | ) | const |
Whether the actor has a clip set.
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_ReadOnly< bool > Clutter::Actor::property_has_pointer | ( | ) | const |
Whether the actor contains the pointer of an input device.
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< float > Clutter::Actor::property_height | ( | ) |
Height of the actor.
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< float > Clutter::Actor::property_height | ( | ) | const |
Height of the actor.
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_ReadOnly< Glib::RefPtr<Actor> > Clutter::Actor::property_last_child | ( | ) | const |
The actor's last child.
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< Glib::RefPtr<LayoutManager> > Clutter::Actor::property_layout_manager | ( | ) |
The object controlling the layout of an actor's children.
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< Glib::RefPtr<LayoutManager> > Clutter::Actor::property_layout_manager | ( | ) | const |
The object controlling the layout of an actor's children.
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< ScalingFilter > Clutter::Actor::property_magnification_filter | ( | ) |
The filter used when increasing the size of the content.
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< ScalingFilter > Clutter::Actor::property_magnification_filter | ( | ) | const |
The filter used when increasing the size of the content.
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_ReadOnly< bool > Clutter::Actor::property_mapped | ( | ) | const |
Whether the actor will be painted.
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< float > Clutter::Actor::property_margin_bottom | ( | ) |
Extra space at the bottom.
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< float > Clutter::Actor::property_margin_bottom | ( | ) | const |
Extra space at the bottom.
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< float > Clutter::Actor::property_margin_left | ( | ) |
Extra space at the left.
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< float > Clutter::Actor::property_margin_left | ( | ) | const |
Extra space at the left.
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< float > Clutter::Actor::property_margin_right | ( | ) |
Extra space at the right.
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< float > Clutter::Actor::property_margin_right | ( | ) | const |
Extra space at the right.
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< float > Clutter::Actor::property_margin_top | ( | ) |
Extra space at the top.
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< float > Clutter::Actor::property_margin_top | ( | ) | const |
Extra space at the top.
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< float > Clutter::Actor::property_min_height | ( | ) |
Forced minimum height request for the actor.
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< float > Clutter::Actor::property_min_height | ( | ) | const |
Forced minimum height request for the actor.
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< bool > Clutter::Actor::property_min_height_set | ( | ) |
Whether to use the min-height property.
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< bool > Clutter::Actor::property_min_height_set | ( | ) | const |
Whether to use the min-height property.
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< float > Clutter::Actor::property_min_width | ( | ) |
Forced minimum width request for the actor.
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< float > Clutter::Actor::property_min_width | ( | ) | const |
Forced minimum width request for the actor.
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< bool > Clutter::Actor::property_min_width_set | ( | ) |
Whether to use the min-width property.
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< bool > Clutter::Actor::property_min_width_set | ( | ) | const |
Whether to use the min-width property.
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< ScalingFilter > Clutter::Actor::property_minification_filter | ( | ) |
The filter used when reducing the size of the content.
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< ScalingFilter > Clutter::Actor::property_minification_filter | ( | ) | const |
The filter used when reducing the size of the content.
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< Glib::ustring > Clutter::Actor::property_name | ( | ) |
Name of the actor.
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< Glib::ustring > Clutter::Actor::property_name | ( | ) | const |
Name of the actor.
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< float > Clutter::Actor::property_natural_height | ( | ) |
Forced natural height request for the actor.
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< float > Clutter::Actor::property_natural_height | ( | ) | const |
Forced natural height request for the actor.
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< bool > Clutter::Actor::property_natural_height_set | ( | ) |
Whether to use the natural-height property.
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< bool > Clutter::Actor::property_natural_height_set | ( | ) | const |
Whether to use the natural-height property.
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< float > Clutter::Actor::property_natural_width | ( | ) |
Forced natural width request for the actor.
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< float > Clutter::Actor::property_natural_width | ( | ) | const |
Forced natural width request for the actor.
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< bool > Clutter::Actor::property_natural_width_set | ( | ) |
Whether to use the natural-width property.
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< bool > Clutter::Actor::property_natural_width_set | ( | ) | const |
Whether to use the natural-width property.
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< OffscreenRedirect > Clutter::Actor::property_offscreen_redirect | ( | ) |
Flags controlling when to flatten the actor into a single image.
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< OffscreenRedirect > Clutter::Actor::property_offscreen_redirect | ( | ) | const |
Flags controlling when to flatten the actor into a single image.
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< guint8 > Clutter::Actor::property_opacity | ( | ) |
Opacity of an actor.
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< guint8 > Clutter::Actor::property_opacity | ( | ) | const |
Opacity of an actor.
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< Point > Clutter::Actor::property_pivot_point | ( | ) |
The point around which the scaling and rotation occur.
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< Point > Clutter::Actor::property_pivot_point | ( | ) | const |
The point around which the scaling and rotation occur.
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< float > Clutter::Actor::property_pivot_point_z | ( | ) |
Z component of the pivot point.
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< float > Clutter::Actor::property_pivot_point_z | ( | ) | const |
Z component of the pivot point.
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< Point > Clutter::Actor::property_position | ( | ) |
The position of the origin of the actor.
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< Point > Clutter::Actor::property_position | ( | ) | const |
The position of the origin of the actor.
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< bool > Clutter::Actor::property_reactive | ( | ) |
Whether the actor is reactive to events.
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< bool > Clutter::Actor::property_reactive | ( | ) | const |
Whether the actor is reactive to events.
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_ReadOnly< bool > Clutter::Actor::property_realized | ( | ) | const |
Whether the actor has been realized.
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< RequestMode > Clutter::Actor::property_request_mode | ( | ) |
The actor's request mode.
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< RequestMode > Clutter::Actor::property_request_mode | ( | ) | const |
The actor's request mode.
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::Actor::property_rotation_angle_x | ( | ) |
The rotation angle on the 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::Actor::property_rotation_angle_x | ( | ) | const |
The rotation angle on the 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::Actor::property_rotation_angle_y | ( | ) |
The rotation angle on the 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::Actor::property_rotation_angle_y | ( | ) | const |
The rotation angle on the 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::Actor::property_rotation_angle_z | ( | ) |
The rotation angle on the 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::Actor::property_rotation_angle_z | ( | ) | const |
The rotation angle on the 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< Vertex > Clutter::Actor::property_rotation_center_x | ( | ) |
The rotation center on the 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< Vertex > Clutter::Actor::property_rotation_center_x | ( | ) | const |
The rotation center on the 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< Vertex > Clutter::Actor::property_rotation_center_y | ( | ) |
The rotation center on the 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< Vertex > Clutter::Actor::property_rotation_center_y | ( | ) | const |
The rotation center on the 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< Vertex > Clutter::Actor::property_rotation_center_z | ( | ) |
The rotation center on the 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< Vertex > Clutter::Actor::property_rotation_center_z | ( | ) | const |
The rotation center on the 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< Gravity > Clutter::Actor::property_rotation_center_z_gravity | ( | ) |
Center point for rotation around the 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< Gravity > Clutter::Actor::property_rotation_center_z_gravity | ( | ) | const |
Center point for rotation around the 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< double > Clutter::Actor::property_scale_center_x | ( | ) |
Horizontal scale center.
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::Actor::property_scale_center_x | ( | ) | const |
Horizontal scale center.
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::Actor::property_scale_center_y | ( | ) |
Vertical scale center.
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::Actor::property_scale_center_y | ( | ) | const |
Vertical scale center.
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< Gravity > Clutter::Actor::property_scale_gravity | ( | ) |
The center of scaling.
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< Gravity > Clutter::Actor::property_scale_gravity | ( | ) | const |
The center of scaling.
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::Actor::property_scale_x | ( | ) |
Scale factor on the 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::Actor::property_scale_x | ( | ) | const |
Scale factor on the 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::Actor::property_scale_y | ( | ) |
Scale factor on the 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::Actor::property_scale_y | ( | ) | const |
Scale factor on the 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::Actor::property_scale_z | ( | ) |
Scale factor on the 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::Actor::property_scale_z | ( | ) | const |
Scale factor on the 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< bool > Clutter::Actor::property_show_on_set_parent | ( | ) |
Whether the actor is shown when parented.
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< bool > Clutter::Actor::property_show_on_set_parent | ( | ) | const |
Whether the actor is shown when parented.
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< TextDirection > Clutter::Actor::property_text_direction | ( | ) |
Direction of the text.
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< TextDirection > Clutter::Actor::property_text_direction | ( | ) | const |
Direction of the text.
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< Matrix > Clutter::Actor::property_transform | ( | ) |
Transformation matrix.
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< Matrix > Clutter::Actor::property_transform | ( | ) | const |
Transformation matrix.
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_ReadOnly< bool > Clutter::Actor::property_transform_set | ( | ) | const |
Whether the transform property is set.
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< float > Clutter::Actor::property_translation_x | ( | ) |
Translation along the 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< float > Clutter::Actor::property_translation_x | ( | ) | const |
Translation along the 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< float > Clutter::Actor::property_translation_y | ( | ) |
Translation along the 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< float > Clutter::Actor::property_translation_y | ( | ) | const |
Translation along the 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< float > Clutter::Actor::property_translation_z | ( | ) |
Translation along the 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< float > Clutter::Actor::property_translation_z | ( | ) | const |
Translation along the 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< bool > Clutter::Actor::property_visible | ( | ) |
Whether the actor is visible or not.
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< bool > Clutter::Actor::property_visible | ( | ) | const |
Whether the actor is visible or not.
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< float > Clutter::Actor::property_width | ( | ) |
Width of the actor.
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< float > Clutter::Actor::property_width | ( | ) | const |
Width of the actor.
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< float > Clutter::Actor::property_x | ( | ) |
X coordinate of the actor.
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< float > Clutter::Actor::property_x | ( | ) | const |
X coordinate of the actor.
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< ActorAlign > Clutter::Actor::property_x_align | ( | ) |
The alignment of the actor on the X axis within its allocation.
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< ActorAlign > Clutter::Actor::property_x_align | ( | ) | const |
The alignment of the actor on the X axis within its allocation.
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< bool > Clutter::Actor::property_x_expand | ( | ) |
Whether extra horizontal space should be assigned to the actor.
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< bool > Clutter::Actor::property_x_expand | ( | ) | const |
Whether extra horizontal space should be assigned to the actor.
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< float > Clutter::Actor::property_y | ( | ) |
Y coordinate of the actor.
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< float > Clutter::Actor::property_y | ( | ) | const |
Y coordinate of the actor.
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< ActorAlign > Clutter::Actor::property_y_align | ( | ) |
The alignment of the actor on the Y axis within its allocation.
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< ActorAlign > Clutter::Actor::property_y_align | ( | ) | const |
The alignment of the actor on the Y axis within its allocation.
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< bool > Clutter::Actor::property_y_expand | ( | ) |
Whether extra vertical space should be assigned to the actor.
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< bool > Clutter::Actor::property_y_expand | ( | ) | const |
Whether extra vertical space should be assigned to the actor.
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< float > Clutter::Actor::property_z_position | ( | ) |
The actor's position on the 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< float > Clutter::Actor::property_z_position | ( | ) | const |
The actor's position on the 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.
void Clutter::Actor::push_internal | ( | ) |
Should be used by actors implementing the Clutter::Container and with internal children added through set_parent(), for instance:
[C example ellipted]
This function will be used by Clutter to toggle an "internal child" flag whenever set_parent() is called; internal children are handled differently by Clutter, specifically when destroying their parent.
Call pop_internal() when you finished adding internal children.
Nested calls to push_internal() are allowed, but each one must by followed by a pop_internal() call.
Deprecated: 1.10: All children of an actor are accessible through the Clutter::Actor API, and Clutter::Actor implements the Clutter::Container interface, so this function is only useful for legacy containers overriding the default implementation.
- Deprecated:
- All children of an actor are accessible through the ClutterActor API
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.
This function will not do anything if self is not visible, or if the actor is inside an invisible part of the scenegraph.
Also be aware that painting is a NOP for actors with an opacity of 0
When you are implementing a custom actor you must queue a redraw whenever some private state changes that will affect painting or picking of your actor.
void Clutter::Actor::queue_relayout | ( | ) |
Indicates that the actor's size request or other layout-affecting properties may have changed.
This function is used inside Clutter::Actor subclass implementations, not by applications directly.
Queueing a new layout automatically queues a redraw as well.
void Clutter::Actor::raise | ( | const Glib::RefPtr< Actor >& | below) |
Puts self above below.
Both actors must have the same parent, and the parent must implement the Clutter::Container interface
This function calls Clutter::Container::raise_child() internally.
Deprecated: 1.10: Use set_child_above_sibling() instead.
- Deprecated:
- Use set_child_above_sibling() instead.
- Parameters
-
below A Clutter::Actor to raise above.
void Clutter::Actor::raise_top | ( | ) |
Raises self to the top.
This function calls raise() internally.
Deprecated: 1.10: Use set_child_above_sibling() with a 0
sibling, instead.
void Clutter::Actor::realize | ( | ) |
Realization informs the actor that it is attached to a stage.
It can use this to allocate resources if it wanted to delay allocation until it would be rendered. However it is perfectly acceptable for an actor to create resources before being realized because Clutter only ever has a single rendering context so that actor is free to be moved from one stage to another.
This function does nothing if the actor is already realized.
Because a realized actor must have realized parent actors, calling realize() will also realize all parents of the actor.
This function does not realize child actors, except in the special case that realizing the stage, when the stage is visible, will suddenly map (and thus realize) the children of the stage.
Deprecated: 1.16: Actors are automatically realized, and nothing requires explicit realization.
void Clutter::Actor::remove_action | ( | const Glib::RefPtr< Action >& | action) |
Removes action from the list of actions applied to self.
The reference held by self on the Clutter::Action will be released
- Parameters
-
action A Clutter::Action.
void Clutter::Actor::remove_action | ( | const Glib::ustring & | name) |
Removes the Clutter::Action with the given name from the list of actions applied to self.
- Parameters
-
name The name of the action to remove.
void Clutter::Actor::remove_all_children | ( | ) |
Removes all children of self.
This function releases the reference added by inserting a child actor in the list of children of self.
If the reference count of a child drops to zero, the child will be destroyed. If you want to ensure the destruction of all the children of self, use destroy_all_children().
void Clutter::Actor::remove_all_transitions | ( | ) |
Removes all transitions associated to self.
void Clutter::Actor::remove_child | ( | const Glib::RefPtr< Actor >& | child) |
Removes child from the children of self.
This function will release the reference added by add_child(), so if you want to keep using child you will have to acquire a referenced on it before calling this function.
This function will emit the Clutter::Container::signal_actor_removed() signal on self.
- Parameters
-
child A Clutter::Actor.
void Clutter::Actor::remove_clip | ( | ) |
Removes clip area from self.
void Clutter::Actor::remove_constraint | ( | const Glib::RefPtr< Constraint >& | constraint) |
Removes constraint from the list of constraints applied to self.
The reference held by self on the Clutter::Constraint will be released
- Parameters
-
constraint A Clutter::Constraint.
void Clutter::Actor::remove_constraint | ( | const Glib::ustring & | name) |
Removes the Clutter::Constraint with the given name from the list of constraints applied to self.
- Parameters
-
name The name of the constraint to remove.
void Clutter::Actor::remove_effect | ( | const Glib::RefPtr< Effect >& | effect) |
Removes effect from the list of effects applied to self.
The reference held by self on the Clutter::Effect will be released
- Parameters
-
effect A Clutter::Effect.
void Clutter::Actor::remove_effect | ( | const Glib::ustring & | name) |
Removes the Clutter::Effect with the given name from the list of effects applied to self.
- Parameters
-
name The name of the effect to remove.
void Clutter::Actor::remove_transition | ( | const Glib::ustring & | name) |
Removes the transition stored inside a Clutter::Actor using name identifier.
If the transition is currently in progress, it will be stopped.
This function releases the reference acquired when the transition was added to the Clutter::Actor.
- Parameters
-
name The name of the transition to remove.
void Clutter::Actor::reparent | ( | const Glib::RefPtr< Actor >& | new_parent) |
Resets the parent actor of self.
This function is logically equivalent to calling unparent() and set_parent(), but more efficiently implemented, as it ensures the child is not finalized when unparented, and emits the Clutter::Actor::signal_parent_set() signal only once.
In reality, calling this function is less useful than it sounds, as some application code may rely on changes in the intermediate state between removal and addition of the actor from its old parent to the new_parent. Thus, it is strongly encouraged to avoid using this function in application code.
Deprecated: 1.10: Use remove_child() and add_child() instead; remember to take a reference on the actor being removed before calling remove_child() to avoid the reference count dropping to zero and the actor being destroyed.
- Deprecated:
- Use remove_child() and add_child() instead.
- Parameters
-
new_parent The new Clutter::Actor parent.
void Clutter::Actor::replace_child | ( | const Glib::RefPtr< Actor >& | old_child, |
const Glib::RefPtr< Actor >& | new_child | ||
) |
Replaces old_child with new_child in the list of children of self.
- Parameters
-
old_child The child of self to replace. new_child The Clutter::Actor to replace old_child.
void Clutter::Actor::restore_easing_state | ( | ) |
Restores the easing state as it was prior to a call to save_easing_state().
void Clutter::Actor::save_easing_state | ( | ) |
Saves the current easing state for animatable properties, and creates a new state with the default values for easing mode and duration.
New transitions created after calling this function will inherit the duration, easing mode, and delay of the new easing state; this also applies to transitions modified in flight.
void Clutter::Actor::set_allocation | ( | const ActorBox& | box, |
AllocationFlags | flags | ||
) |
Stores the allocation of self as defined by box.
This function can only be called from within the implementation of the Clutter::ActorClass.allocate() virtual function.
The allocation should have been adjusted to take into account constraints, alignment, and margin properties. If you are implementing a Clutter::Actor subclass that provides its own layout management policy for its children instead of using a Clutter::LayoutManager delegate, you should not call this function on the children of self; instead, you should call allocate(), which will adjust the allocation box for you.
This function should only be used by subclasses of Clutter::Actor that wish to store their allocation but cannot chain up to the parent's implementation; the default implementation of the Clutter::ActorClass.allocate() virtual function will call this function.
It is important to note that, while chaining up was the recommended behaviour for Clutter::Actor subclasses prior to the introduction of this function, it is recommended to call set_allocation() instead.
If the Clutter::Actor is using a Clutter::LayoutManager delegate object to handle the allocation of its children, this function will call the Clutter::LayoutManager::allocate() function only if the Clutter::DELEGATE_LAYOUT flag is set on flags, otherwise it is expected that the subclass will call Clutter::LayoutManager::allocate() by itself. For instance, the following code:
[C example ellipted]
is equivalent to this:
[C example ellipted]
- Parameters
-
box A Clutter::ActorBox. flags Allocation flags.
void Clutter::Actor::set_anchor_point | ( | float | anchor_x, |
float | anchor_y | ||
) |
Sets an anchor point for 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.
Deprecated: 1.12: Use Clutter::Actor::property_pivot_point() instead.
- Deprecated:
- Use “pivot-point” instead.
- Parameters
-
anchor_x X coordinate of the anchor point. anchor_y Y coordinate of the anchor point.
void Clutter::Actor::set_anchor_point_from_gravity | ( | ClutterGravity | gravity) |
Sets an anchor point on the actor, based on the given gravity (this is a convenience function wrapping set_anchor_point()).
Since version 1.0 the anchor point will be stored as a gravity so that if the actor changes size then the anchor point will move. For example, if you set the anchor point to Clutter::GRAVITY_SOUTH_EAST and later double the size of the actor, the anchor point will move to the bottom right.
Deprecated: 1.12: Use Clutter::Actor::property_pivot_point() instead.
- Deprecated:
- Use “pivot-point” instead.
- Parameters
-
gravity Clutter::Gravity.
void Clutter::Actor::set_background_color | ( | const Color& | color) |
Sets the background color of a Clutter::Actor.
The background color will be used to cover the whole allocation of the actor. The default background color of an actor is transparent.
To check whether an actor has a background color, you can use the Clutter::Actor::property_background_color_set() actor property.
The Clutter::Actor::property_background_color() property is animatable.
- Parameters
-
color A Clutter::Color, or 0
to unset a previously set color.
void Clutter::Actor::set_child_above_sibling | ( | const Glib::RefPtr< Actor >& | child, |
const Glib::RefPtr< Actor >& | sibling | ||
) |
Sets child to be above sibling in the list of children of self.
If sibling is 0
, child will be the new last child of self.
This function is logically equivalent to removing child and using insert_child_above(), but it will not emit signals or change state on child.
- Parameters
-
child A Clutter::Actor child of self. sibling A Clutter::Actor child of self, or 0
.
void Clutter::Actor::set_child_at_index | ( | const Glib::RefPtr< Actor >& | child, |
int | index | ||
) |
Changes the index of child in the list of children of self.
This function is logically equivalent to removing child and calling insert_child_at_index(), but it will not emit signals or change state on child.
- Parameters
-
child A Clutter::Actor child of self. index The new index for child.
void Clutter::Actor::set_child_below_sibling | ( | const Glib::RefPtr< Actor >& | child, |
const Glib::RefPtr< Actor >& | sibling | ||
) |
Sets child to be below sibling in the list of children of self.
If sibling is 0
, child will be the new first child of self.
This function is logically equivalent to removing self and using insert_child_below(), but it will not emit signals or change state on child.
- Parameters
-
child A Clutter::Actor child of self. sibling A Clutter::Actor child of self, or 0
.
void Clutter::Actor::set_child_transform | ( | const Matrix& | transform) |
Sets the transformation matrix to be applied to all the children of self prior to their own transformations.
The default child transformation is the identity matrix.
If transform is 0
, the child transform will be unset.
The Clutter::Actor::property_child_transform() property is animatable.
- Parameters
-
transform A Clutter::Matrix, or 0
.
void Clutter::Actor::set_clip | ( | float | xoff, |
float | yoff, | ||
float | width, | ||
float | height | ||
) |
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.
- Parameters
-
xoff X offset of the clip rectangle. yoff Y offset of the clip rectangle. width Width of the clip rectangle. height Height of the clip rectangle.
void Clutter::Actor::set_clip_to_allocation | ( | bool | clip_set = true ) |
Sets whether self should be clipped to the same size as its allocation.
- Parameters
-
clip_set true
to apply a clip tracking the allocation.
void Clutter::Actor::set_content | ( | const Glib::RefPtr< Content >& | content) |
Sets the contents of a Clutter::Actor.
- Parameters
-
content A Clutter::Content, or 0
.
void Clutter::Actor::set_content_gravity | ( | ContentGravity | gravity) |
Sets the gravity of the Clutter::Content used by self.
See the description of the Clutter::Actor::property_content_gravity() property for more information.
The Clutter::Actor::property_content_gravity() property is animatable.
- Parameters
-
gravity The Clutter::ContentGravity.
void Clutter::Actor::set_content_repeat | ( | ContentRepeat | repeat) |
Sets the policy for repeating the Clutter::Actor::property_content() of a Clutter::Actor.
The behaviour is deferred to the Clutter::Content implementation.
- Parameters
-
repeat The repeat policy.
void Clutter::Actor::set_content_scaling_filters | ( | ScalingFilter | min_filter, |
ScalingFilter | mag_filter | ||
) |
Sets the minification and magnification filter to be applied when scaling the Clutter::Actor::property_content() of a Clutter::Actor.
The Clutter::Actor::property_minification_filter() will be used when reducing the size of the content; the Clutter::Actor::property_magnification_filter() will be used when increasing the size of the content.
- Parameters
-
min_filter The minification filter for the content. mag_filter The magnification filter for the content.
void Clutter::Actor::set_depth | ( | float | depth) |
Sets the Z coordinate of self to depth.
The unit used by depth is dependant on the perspective setup. See also Clutter::Stage::set_perspective().
Deprecated: 1.12: Use set_z_position() instead.
- Deprecated:
- Use set_z_position() instead.
- Parameters
-
depth Z co-ord.
void Clutter::Actor::set_easing_delay | ( | guint | msecs) |
Sets the delay that should be applied before tweening animatable properties.
- Parameters
-
msecs The delay before the start of the tweening, in milliseconds.
void Clutter::Actor::set_easing_duration | ( | guint | msecs) |
Sets the duration of the tweening for animatable properties of self for the current easing state.
- Parameters
-
msecs The duration of the easing, or 0
.
void Clutter::Actor::set_easing_mode | ( | AnimationMode | mode) |
Sets the easing mode for the tweening of animatable properties of self.
- Parameters
-
mode An easing mode, excluding Clutter::CUSTOM_MODE.
void Clutter::Actor::set_fixed_position_set | ( | bool | is_set) |
Sets whether an actor has a fixed position set (and will thus be unaffected by any layout manager).
- Parameters
-
is_set Whether to use fixed position.
void Clutter::Actor::set_flags | ( | ActorFlags | flags) |
Sets flags on self.
This function will emit notifications for the changed properties
- Parameters
-
flags The flags to set.
void Clutter::Actor::set_geometry | ( | const Geometry& | geometry) |
Sets the actor's fixed position and forces its minimum and natural size, in pixels.
This means the untransformed actor will have the given geometry. This is the same as calling set_position() and set_size().
Deprecated: 1.10: Use set_position() and set_size() instead.
- Deprecated:
- Use set_position() and set_size() instead.
- Parameters
-
geometry A Clutter::Geometry.
void Clutter::Actor::set_height | ( | float | height) |
Forces a height on an actor, causing the actor's preferred width and height (if any) to be ignored.
If height is -1 the actor will use its preferred height instead of overriding it, i.e. you can "unset" the height with -1.
This function sets both the minimum and natural size of the actor.
since: 0.2
- Parameters
-
height Requested new height for the actor, in pixels, or -1.
void Clutter::Actor::set_layout_manager | ( | const Glib::RefPtr< LayoutManager >& | manager) |
Sets the Clutter::LayoutManager delegate object that will be used to lay out the children of self.
The Clutter::Actor will take a reference on the passed manager which will be released either when the layout manager is removed, or when the actor is destroyed.
- Parameters
-
manager A Clutter::LayoutManager, or 0
to unset it.
void Clutter::Actor::set_margin_bottom | ( | float | margin) |
Sets the margin from the bottom of a Clutter::Actor.
The Clutter::Actor::property_margin_bottom() property is animatable.
- Parameters
-
margin The bottom margin.
void Clutter::Actor::set_margin_left | ( | float | margin) |
Sets the margin from the left of a Clutter::Actor.
The Clutter::Actor::property_margin_left() property is animatable.
- Parameters
-
margin The left margin.
void Clutter::Actor::set_margin_right | ( | float | margin) |
Sets the margin from the right of a Clutter::Actor.
The Clutter::Actor::property_margin_right() property is animatable.
- Parameters
-
margin The right margin.
void Clutter::Actor::set_margin_top | ( | float | margin) |
Sets the margin from the top of a Clutter::Actor.
The Clutter::Actor::property_margin_top() property is animatable.
- Parameters
-
margin The top margin.
void Clutter::Actor::set_margins | ( | float | top, |
float | left, | ||
float | bottom, | ||
float | right | ||
) |
Convenience method for setting all margins at once.
- Parameters
-
top The top margin left the left margin bottom The bottom margin right The right margin.
void Clutter::Actor::set_name | ( | const gchar * | name) |
Sets the given name to self.
The name can be used to identify a Clutter::Actor.
- Parameters
-
name Textual tag to apply to actor.
void Clutter::Actor::set_offscreen_redirect | ( | OffscreenRedirect | redirect) | const |
Defines the circumstances where the actor should be redirected into an offscreen image.
The offscreen image is used to flatten the actor into a single image while painting for two main reasons. Firstly, when the actor is painted a second time without any of its contents changing it can simply repaint the cached image without descending further down the actor hierarchy. Secondly, it will make the opacity look correct even if there are overlapping primitives in the actor.
Caching the actor could in some cases be a performance win and in some cases be a performance lose so it is important to determine which value is right for an actor before modifying this value. For example, there is never any reason to flatten an actor that is just a single texture (such as a Clutter::Texture) because it is effectively already cached in an image so the offscreen would be redundant. Also if the actor contains primitives that are far apart with a large transparent area in the middle (such as a large CluterGroup with a small actor in the top left and a small actor in the bottom right) then the cached image will contain the entire image of the large area and the paint will waste time blending all of the transparent pixels in the middle.
The default method of implementing opacity on a container simply forwards on the opacity to all of the children. If the children are overlapping then it will appear as if they are two separate glassy objects and there will be a break in the color where they overlap. By redirecting to an offscreen buffer it will be as if the two opaque objects are combined into one and then made transparent which is usually what is expected.
The image below demonstrates the difference between redirecting and not. The image shows two Clutter groups, each containing a red and a green rectangle which overlap. The opacity on the group is set to 128 (which is 50%). When the offscreen redirect is not used, the red rectangle can be seen through the blue rectangle as if the two rectangles were separately transparent. When the redirect is used the group as a whole is transparent instead so the red rectangle is not visible where they overlap.
<figure id="offscreen-redirect"> <title>Sample of using an offscreen redirect for transparency</title> <graphic fileref="offscreen-redirect.png" format="PNG"> </figure>
The default value for this property is 0, so we effectively will never redirect an actor offscreen by default. This means that there are times that transparent actors may look glassy as described above. The reason this is the default is because there is a performance trade off between quality and performance here. In many cases the default form of glassy opacity looks good enough, but if it's not you will need to set the Clutter::OFFSCREEN_REDIRECT_AUTOMATIC_FOR_OPACITY flag to enable redirection for opacity.
Custom actors that don't contain any overlapping primitives are recommended to override the has_overlaps() virtual to return false
for maximum efficiency.
- Parameters
-
redirect New offscreen redirect flags for the actor.
void Clutter::Actor::set_opacity | ( | guint8 | opacity) |
Sets the actor's opacity, with zero being completely transparent and 255 (0xff) being fully opaque.
The Clutter::Actor::property_opacity() property is animatable.
- Parameters
-
opacity New opacity value for the actor.
void Clutter::Actor::set_parent | ( | const Glib::RefPtr< Actor >& | parent) |
Sets the parent of self to parent.
This function will result in parent acquiring a reference on self, eventually by sinking its floating reference first. The reference will be released by unparent().
This function should only be called by legacy Clutter::Actors implementing the Clutter::Container interface.
Deprecated: 1.10: Use add_child() instead.
- Deprecated:
- Use add_child() instead.
- Parameters
-
parent A new Clutter::Actor parent.
void Clutter::Actor::set_pivot_point | ( | float | x, |
float | y | ||
) |
Sets the position of the Clutter::Actor::property_pivot_point() around which the scaling and rotation transformations occur.
The pivot point's coordinates are in normalized space, with the (0, 0) point being the top left corner of the actor, and the (1, 1) point being the bottom right corner.
- Parameters
-
pivot_x The normalized X coordinate of the pivot point. pivot_y The normalized Y coordinate of the pivot point.
void Clutter::Actor::set_pivot_point_z | ( | float | pivot_z) |
Sets the component on the Z axis of the Clutter::Actor::property_pivot_point() around which the scaling and rotation transformations occur.
The pivot_z value is expressed as a distance along the Z axis.
- Parameters
-
pivot_z The Z coordinate of the actor's pivot point.
void Clutter::Actor::set_position | ( | float | x, |
float | y | ||
) |
Sets the actor's fixed position in pixels relative to any parent actor.
If a layout manager is in use, this position will override the layout manager and force a fixed position.
- Parameters
-
x New left position of actor in pixels. y New top position of actor in pixels.
void Clutter::Actor::set_reactive | ( | bool | reactive = true ) |
Sets actor as reactive.
Reactive actors will receive events.
- Parameters
-
reactive Whether the actor should be reactive to events.
void Clutter::Actor::set_request_mode | ( | RequestMode | mode) |
Sets the geometry request mode of self.
The mode determines the order for invoking get_preferred_width() and get_preferred_height()
- Parameters
-
mode The request mode.
void Clutter::Actor::set_rotation | ( | RotateAxis | axis, |
double | angle, | ||
float | x, | ||
float | y, | ||
float | z | ||
) |
Sets the rotation angle of self around the given axis.
The rotation center coordinates used depend on the value of axis:
- Clutter::X_AXIS requires y and z
- Clutter::Y_AXIS requires x and z
- Clutter::Z_AXIS requires x and y
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.
Deprecated: 1.12: Use set_rotation_angle() and set_pivot_point() instead.
- Deprecated:
- Use set_rotation_angle() and set_pivot_point() instead.
- Parameters
-
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_rotation_angle | ( | RotateAxis | axis, |
double | angle | ||
) |
Sets the angle of rotation of a Clutter::Actor on the given axis.
This function is a convenience for setting the rotation properties Clutter::Actor::property_rotation_angle_x(), Clutter::Actor::property_rotation_angle_y(), and Clutter::Actor::property_rotation_angle_z().
The center of rotation is established by the Clutter::Actor::property_pivot_point() property.
- Parameters
-
axis The axis to set the angle one. angle The angle of rotation, in degrees.
void Clutter::Actor::set_scale | ( | double | scale_x, |
double | scale_y | ||
) |
Scales an actor with the given factors.
The scale transformation is relative the the Clutter::Actor::property_pivot_point().
The Clutter::Actor::property_scale_x() and Clutter::Actor::property_scale_y() properties are animatable.
- Parameters
-
scale_x Double factor to scale actor by horizontally. scale_y Double factor to scale actor by vertically.
void Clutter::Actor::set_scale_full | ( | double | scale_x, |
double | scale_y, | ||
float | center_x, | ||
float | center_y | ||
) |
Scales an actor with the given factors around the given center point.
The center point is specified in pixels relative to the anchor point (usually the top left corner of the actor).
The Clutter::Actor::property_scale_x() and Clutter::Actor::property_scale_y() properties are animatable.
Deprecated: 1.12: Use set_pivot_point() to control the scale center
- Deprecated:
- Use set_pivot_point() to control the scale center.
- Parameters
-
scale_x Double factor to scale actor by horizontally. scale_y Double factor to scale actor by vertically. center_x X coordinate of the center of the scaling. center_y Y coordinate of the center of the scaling.
void Clutter::Actor::set_scale_with_gravity | ( | double | scale_x, |
double | scale_y, | ||
Gravity | gravity | ||
) |
Scales an actor with the given factors around the given center point.
The center point is specified as one of the compass directions in Clutter::Gravity. For example, setting it to north will cause the top of the actor to remain unchanged and the rest of the actor to expand left, right and downwards.
The Clutter::Actor::property_scale_x() and Clutter::Actor::property_scale_y() properties are animatable.
Deprecated: 1.12: Use set_pivot_point() to set the scale center using normalized coordinates instead.
- Deprecated:
- Use set_pivot_point() to set the scale center using normalized coordinates instead.
- Parameters
-
scale_x Double factor to scale actor by horizontally. scale_y Double factor to scale actor by vertically. gravity The location of the scale center expressed as a compass direction.
void Clutter::Actor::set_scale_z | ( | double | scale_z) |
Scales an actor on the Z axis by the given scale_z factor.
The scale transformation is relative the the Clutter::Actor::property_pivot_point().
The Clutter::Actor::property_scale_z() property is animatable.
- Parameters
-
scale_z The scaling factor along the Z axis.
void Clutter::Actor::set_shader | ( | const Glib::RefPtr< Shader >& | shader) |
Sets the Clutter::Shader to be used when rendering self.
If shader is 0
this function will unset any currently set shader for the actor.
<note>Any Clutter::Effect applied to self will take the precedence over the Clutter::Shader set using this function.</note>
Deprecated: 1.8: Use Clutter::ShaderEffect and add_effect() instead.
- Deprecated:
- Use add_effect() instead.
- Parameters
-
shader A Clutter::Shader or 0
to unset the shader.
- Returns
true
if the shader was successfully applied or removed.
void Clutter::Actor::set_shader_param | ( | const Glib::ustring & | param, |
const ParamType & | value | ||
) |
Sets the value for a named parameter of the shader applied to actor.
Deprecated: 1.8: Use Clutter::ShaderEffect::set_uniform_value() instead
- Parameters
-
param The name of the parameter. value The value of the parameter.
- Deprecated:
- Use ShaderEffect::set_uniform_value() instead."
|
protected |
Sets the value for a named parameter of the shader applied to actor.
Deprecated: 1.8: Use Clutter::ShaderEffect::set_uniform_value() instead
- Deprecated:
- Use ShaderEffect::set_uniform_value() instead.
- Parameters
-
param The name of the parameter. value The value of the parameter.
void Clutter::Actor::set_size | ( | float | width, |
float | height | ||
) |
Sets the actor's size request in pixels.
This overrides any "normal" size request the actor would have. For example a text actor might normally request the size of the text; this function would force a specific size instead.
If width and/or height are -1 the actor will use its "normal" size request instead of overriding it, i.e. you can "unset" the size with -1.
This function sets or unsets both the minimum and natural size.
- Parameters
-
width New width of actor in pixels, or -1. height New height of actor in pixels, or -1.
void Clutter::Actor::set_text_direction | ( | TextDirection | text_dir) |
Sets the Clutter::TextDirection for an actor.
The passed text direction must not be Clutter::TEXT_DIRECTION_DEFAULT
If self implements Clutter::Container then this function will recurse inside all the children of self (including the internal ones).
Composite actors not implementing Clutter::Container, or actors requiring special handling when the text direction changes, should connect to the Object::signal_notify() signal for the Clutter::Actor::property_text_direction() property
- Parameters
-
text_dir The text direction for self.
void Clutter::Actor::set_transform | ( | const Matrix& | transform) |
Overrides the transformations of a Clutter::Actor with a custom matrix, which will be applied relative to the origin of the actor's allocation and to the actor's pivot point.
The Clutter::Actor::property_transform() property is animatable.
- Parameters
-
transform A Clutter::Matrix, or 0
to unset a custom transformation.
void Clutter::Actor::set_translation | ( | float | translate_x, |
float | translate_y, | ||
float | translate_z | ||
) |
Sets an additional translation transformation on a Clutter::Actor, relative to the Clutter::Actor::property_pivot_point().
- Parameters
-
translate_x The translation along the X axis. translate_y The translation along the Y axis. translate_z The translation along the Z axis.
void Clutter::Actor::set_width | ( | float | width) |
Forces a width on an actor, causing the actor's preferred width and height (if any) to be ignored.
If width is -1 the actor will use its preferred width request instead of overriding it, i.e. you can "unset" the width with -1.
This function sets both the minimum and natural size of the actor.
since: 0.2
- Parameters
-
width Requested new width for the actor, in pixels, or -1.
void Clutter::Actor::set_x | ( | float | x) |
Sets the actor's X coordinate, relative to its parent, in pixels.
Overrides any layout manager and forces a fixed position for the actor.
The Clutter::Actor::property_x() property is animatable.
- Parameters
-
x The actor's position on the X axis.
void Clutter::Actor::set_x_align | ( | ActorAlign | x_align) |
Sets the horizontal alignment policy of a Clutter::Actor, in case the actor received extra horizontal space.
See also the Clutter::Actor::property_x_align() property.
- Parameters
-
x_align The horizontal alignment policy.
void Clutter::Actor::set_x_expand | ( | bool | expand = true ) |
Sets whether a Clutter::Actor should expand horizontally; this means that layout manager should allocate extra space for the actor, if possible.
Setting an actor to expand will also make all its parent expand, so that it's possible to build an actor tree and only set this flag on its leaves and not on every single actor.
- Parameters
-
expand Whether the actor should expand horizontally.
void Clutter::Actor::set_y | ( | float | y) |
Sets the actor's Y coordinate, relative to its parent, in pixels.
#
Overrides any layout manager and forces a fixed position for the actor.
The Clutter::Actor::property_y() property is animatable.
- Parameters
-
y The actor's position on the Y axis.
void Clutter::Actor::set_y_align | ( | ActorAlign | y_align) |
Sets the vertical alignment policy of a Clutter::Actor, in case the actor received extra vertical space.
See also the Clutter::Actor::property_y_align() property.
- Parameters
-
y_align The vertical alignment policy.
void Clutter::Actor::set_y_expand | ( | bool | expand = true ) |
Sets whether a Clutter::Actor should expand horizontally; this means that layout manager should allocate extra space for the actor, if possible.
Setting an actor to expand will also make all its parent expand, so that it's possible to build an actor tree and only set this flag on its leaves and not on every single actor.
- Parameters
-
expand Whether the actor should expand vertically.
void Clutter::Actor::set_z_position | ( | float | z_position) |
Sets the actor's position on the Z axis.
See Clutter::Actor::property_z_position().
- Parameters
-
z_position The position on the Z axis.
void Clutter::Actor::set_z_rotation_from_gravity | ( | double | angle, |
Gravity | gravity | ||
) |
Sets the rotation angle of self around the Z axis using the center point specified as a compass point.
For example to rotate such that the center of the actor remains static you can use Clutter::GRAVITY_CENTER. If the actor changes size the center point will move accordingly.
Deprecated: 1.12: Use set_rotation_angle() and set_pivot_point() instead.
- Deprecated:
- Use set_rotation_angle() and set_pivot_point() instead.
- Parameters
-
angle The angle of rotation. gravity The center point of the rotation.
bool Clutter::Actor::should_pick_paint | ( | ) | const |
Should be called inside the implementation of the Clutter::Actor::signal_pick() virtual function in order to check whether the actor should paint itself in pick mode or not.
This function should never be called directly by applications.
- Returns
true
if the actor should paint its silhouette,false
otherwise.
void Clutter::Actor::show | ( | ) |
Flags an actor to be displayed.
An actor that isn't shown will not be rendered on the stage.
Actors are visible by default.
If this function is called on an actor without a parent, the Clutter::Actor::property_show_on_set_parent() will be set to true
as a side effect.
void Clutter::Actor::show_all | ( | ) |
Calls show() on all children of an actor (if any).
Deprecated: 1.10: Actors are visible by default
- Deprecated:
- Actors are visible by default.
|
protectedvirtual |
Glib::SignalProxy2< void,const ActorBox&,AllocationFlags > Clutter::Actor::signal_allocation_changed | ( | ) |
- Slot Prototype:
void on_my_allocation_changed(const ActorBox& box, AllocationFlags flags)
The signal_allocation_changed() signal is emitted when the Clutter::Actor::property_allocation() property changes. Usually, application code should just use the notifications for the :allocation property but if you want to track the allocation flags as well, for instance to know whether the absolute origin of actor changed, then you might want use this signal instead.
- Parameters
-
box A Clutter::ActorBox with the new allocation. flags Clutter::AllocationFlags for the allocation.
Glib::SignalProxy1< bool,ButtonEvent* > Clutter::Actor::signal_button_press_event | ( | ) |
- Slot Prototype:
bool on_my_button_press_event(ButtonEvent* event)
The signal_button_press_event() signal is emitted each time a mouse button is pressed on actor.
- Parameters
-
event A Clutter::ButtonEvent.
- Returns
true
if the event has been handled by the actor, orfalse
to continue the emission.
Glib::SignalProxy1< bool,ButtonEvent* > Clutter::Actor::signal_button_release_event | ( | ) |
- Slot Prototype:
bool on_my_button_release_event(ButtonEvent* event)
The signal_button_release_event() signal is emitted each time a mouse button is released on actor.
- Parameters
-
event A Clutter::ButtonEvent.
- Returns
true
if the event has been handled by the actor, orfalse
to continue the emission.
Glib::SignalProxy1< bool,Event* > Clutter::Actor::signal_captured_event | ( | ) |
- Slot Prototype:
bool on_my_captured_event(Event* event)
The signal_captured_event() signal is emitted when an event is captured by Clutter. This signal will be emitted starting from the top-level container (the Clutter::Stage) to the actor which received the event going down the hierarchy. This signal can be used to intercept every event before the specialized events (like ClutterActor::button-press-event or signal_key_released_event()) are emitted.
- Parameters
-
event A Clutter::Event.
- Returns
true
if the event has been handled by the actor, orfalse
to continue the emission.
Glib::SignalProxy0< void > Clutter::Actor::signal_destroy | ( | ) |
- Slot Prototype:
void on_my_destroy()
The signal_destroy() signal notifies that all references held on the actor which emitted it should be released.
The signal_destroy() signal should be used by all holders of a reference on actor.
This signal might result in the finalization of the Clutter::Actor if all references are released.
Composite actors and actors implementing the Clutter::Container interface should override the default implementation of the class handler of this signal and call Clutter::Actor::destroy() on their children. When overriding the default class handler, it is required to chain up to the parent's implementation.
Glib::SignalProxy1< bool,CrossingEvent* > Clutter::Actor::signal_enter_event | ( | ) |
- Slot Prototype:
bool on_my_enter_event(CrossingEvent* event)
The signal_enter_event() signal is emitted when the pointer enters the actor
- Parameters
-
event A Clutter::CrossingEvent.
- Returns
true
if the event has been handled by the actor, orfalse
to continue the emission.
Glib::SignalProxy1< bool,Event* > Clutter::Actor::signal_event | ( | ) |
- Slot Prototype:
bool on_my_event(Event* event)
The signal_event() signal is emitted each time an event is received by the actor. This signal will be emitted on every actor, following the hierarchy chain, until it reaches the top-level container (the Clutter::Stage).
- Parameters
-
event A Clutter::Event.
- Returns
true
if the event has been handled by the actor, orfalse
to continue the emission.
Glib::SignalProxy0< void > Clutter::Actor::signal_hide | ( | ) |
- Slot Prototype:
void on_my_hide()
The signal_hide() signal is emitted when an actor is no longer rendered on the stage.
Glib::SignalProxy0< void > Clutter::Actor::signal_key_focus_in | ( | ) |
- Slot Prototype:
void on_my_key_focus_in()
The signal_key_focus_in() signal is emitted when actor receives key focus.
Glib::SignalProxy0< void > Clutter::Actor::signal_key_focus_out | ( | ) |
- Slot Prototype:
void on_my_key_focus_out()
The signal_key_focus_out() signal is emitted when actor loses key focus.
Glib::SignalProxy1< bool,KeyEvent* > Clutter::Actor::signal_key_press_event | ( | ) |
- Slot Prototype:
bool on_my_key_press_event(KeyEvent* event)
The signal_key_press_event() signal is emitted each time a keyboard button is pressed while actor has key focus (see Clutter::Stage::set_key_focus()).
- Parameters
-
event A Clutter::KeyEvent.
- Returns
true
if the event has been handled by the actor, orfalse
to continue the emission.
Glib::SignalProxy1< bool,KeyEvent* > Clutter::Actor::signal_key_release_event | ( | ) |
- Slot Prototype:
bool on_my_key_release_event(KeyEvent* event)
The signal_key_release_event() signal is emitted each time a keyboard button is released while actor has key focus (see Clutter::Stage::set_key_focus()).
- Parameters
-
event A Clutter::KeyEvent.
- Returns
true
if the event has been handled by the actor, orfalse
to continue the emission.
Glib::SignalProxy1< bool,CrossingEvent* > Clutter::Actor::signal_leave_event | ( | ) |
- Slot Prototype:
bool on_my_leave_event(CrossingEvent* event)
The signal_leave_event() signal is emitted when the pointer leaves the actor.
- Parameters
-
event A Clutter::CrossingEvent.
- Returns
true
if the event has been handled by the actor, orfalse
to continue the emission.
Glib::SignalProxy1< bool,MotionEvent* > Clutter::Actor::signal_motion_event | ( | ) |
- Slot Prototype:
bool on_my_motion_event(MotionEvent* event)
The signal_motion_event() signal is emitted each time the mouse pointer is moved over actor.
- Parameters
-
event A Clutter::MotionEvent.
- Returns
true
if the event has been handled by the actor, orfalse
to continue the emission.
Glib::SignalProxy0< void > Clutter::Actor::signal_paint | ( | ) |
- Slot Prototype:
void on_my_paint()
The signal_paint() signal is emitted each time an actor is being painted.
Subclasses of Clutter::Actor should override the Clutter::ActorClass.paint virtual function paint themselves in that function.
<warning>It is strongly discouraged to connect a signal handler to the Clutter::Actor::signal_paint() signal; if you want to change the paint sequence of an existing Clutter::Actor instance, either create a new Clutter::Actor class and override the Clutter::ActorClass.paint virtual function, or use a Clutter::Effect. The Clutter::Actor::signal_paint() signal will be removed in a future version of Clutter.</warning>
Deprecated: 1.12: Override the Clutter::ActorClass.paint virtual function, use a Clutter::Content implementation, or a Clutter::Effect instead of connecting to this signal.
Glib::SignalProxy1< void,const Glib::RefPtr<Actor>& > Clutter::Actor::signal_parent_set | ( | ) |
- Slot Prototype:
void on_my_parent_set(const Glib::RefPtr<Actor>& old_parent)
This signal is emitted when the parent of the actor changes.
- Parameters
-
old_parent The previous parent of the actor, or 0
.
Glib::SignalProxy1< void,const Color& > Clutter::Actor::signal_pick | ( | ) |
- Slot Prototype:
void on_my_pick(const Color& color)
The signal_pick() signal is emitted each time an actor is being painted in "pick mode". The pick mode is used to identify the actor during the event handling phase, or by Clutter::Stage::get_actor_at_pos(). The actor should paint its shape using the passed pick_color.
Subclasses of Clutter::Actor should override the class signal handler and paint themselves in that function.
It is possible to connect a handler to the signal_pick() signal in order to set up some custom aspect of a paint in pick mode.
- Since cluttermm 1.0:
- Deprecated: 1.12: Override the Clutter::ActorClass.pick virtual function instead.
- Parameters
-
color The Clutter::Color to be used when picking.
Glib::SignalProxy1< void,const Glib::RefPtr<Actor>& > Clutter::Actor::signal_queue_redaw | ( | ) |
- Slot Prototype:
void on_my_queue_redaw(const Glib::RefPtr<Actor>& origin)
The ::queue_redraw signal is emitted when Clutter::Actor::queue_redraw() is called on origin.
The default implementation for Clutter::Actor chains up to the parent actor and queues a redraw on the parent, thus "bubbling" the redraw queue up through the actor graph. The default implementation for Clutter::Stage queues a Clutter::Stage::ensure_redraw() in a main loop idle handler.
Note that the origin actor may be the stage, or a container; it does not have to be a leaf node in the actor graph.
Toolkits embedding a Clutter::Stage which require a redraw and relayout cycle can stop the emission of this signal using the GSignal API, redraw the UI and then call Clutter::Stage::ensure_redraw() themselves, like:
[C example ellipted]
<note>This signal is emitted before the Clutter paint pipeline is executed. If you want to know when the pipeline has been completed you should connect to the signal_paint() signal on the Stage with Glib::signal_connect_after().</note>
- Parameters
-
origin The actor which initiated the redraw request.
Glib::SignalProxy0< void > Clutter::Actor::signal_queue_relayout | ( | ) |
- Slot Prototype:
void on_my_queue_relayout()
The ::queue_layout signal is emitted when Clutter::Actor::queue_relayout() is called on an actor.
The default implementation for Clutter::Actor chains up to the parent actor and queues a relayout on the parent, thus "bubbling" the relayout queue up through the actor graph.
The main purpose of this signal is to allow relayout to be propagated properly in the procense of Clutter::Clone actors. Applications will not normally need to connect to this signal.
Glib::SignalProxy0< void > Clutter::Actor::signal_realize | ( | ) |
- Slot Prototype:
void on_my_realize()
The signal_realize() signal is emitted each time an actor is being realized.
Deprecated: 1.16: The signal should not be used in newly written code
Glib::SignalProxy1< bool,ScrollEvent* > Clutter::Actor::signal_scroll_event | ( | ) |
- Slot Prototype:
bool on_my_scroll_event(ScrollEvent* event)
The signal_scroll_event() signal is emitted each time the mouse is scrolled on actor
- Parameters
-
event A Clutter::ScrollEvent.
- Returns
true
if the event has been handled by the actor, orfalse
to continue the emission.
Glib::SignalProxy0< void > Clutter::Actor::signal_show | ( | ) |
- Slot Prototype:
void on_my_show()
The signal_show() signal is emitted when an actor is visible and rendered on the stage.
Glib::SignalProxy1< bool,ClutterTouchEvent* > Clutter::Actor::signal_touch_event | ( | ) |
- Slot Prototype:
bool on_my_touch_event(ClutterTouchEvent* event)
The signal_touch_event() signal is emitted each time a touch begin/end/update/cancel event.
- Parameters
-
event A Clutter::Event.
- Returns
- Clutter::EVENT_STOP if the event has been handled by the actor, or Clutter::EVENT_PROPAGATE to continue the emission.
Glib::SignalProxy2< void,const Glib::ustring&,bool > Clutter::Actor::signal_transition_stopped | ( | ) |
- Slot Prototype:
void on_my_transition_stopped(const Glib::ustring& name, bool is_finished)
The signal_transition_stopped() signal is emitted once a transition is stopped; a transition is stopped once it reached its total duration (including eventual repeats), it has been stopped using Clutter::Timeline::stop(), or it has been removed from the transitions applied on actor, using Clutter::Actor::remove_transition().
- Parameters
-
name The name of the transition. is_finished Whether the transition was finished, or stopped.
Glib::SignalProxy0< void > Clutter::Actor::signal_transitions_completed | ( | ) |
- Slot Prototype:
void on_my_transitions_completed()
The signal_transitions_completed() signal is emitted once all transitions involving actor are complete.
Glib::SignalProxy0< void > Clutter::Actor::signal_unrealize | ( | ) |
- Slot Prototype:
void on_my_unrealize()
The signal_unrealize() signal is emitted each time an actor is being unrealized.
Deprecated: 1.16: The signal should not be used in newly written code
void Clutter::Actor::transform_stage_point | ( | float | x, |
float | y, | ||
float & | x_out, | ||
float & | y_out | ||
) | const |
This function translates screen coordinates ( x, y) to coordinates relative to the actor.
For example, it can be used to translate screen events from global screen coordinates into actor-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.
<note>This function can be computationally intensive.</note>
<note>This function only works when the allocation is up-to-date, i.e. inside of paint().</note>
- Parameters
-
x X screen coordinate of the point to unproject. y Y screen coordinate of the point to unproject. x_out Return location for the unprojected x coordinance. y_out Return location for the unprojected y coordinance.
- Returns
true
if conversion was successful.
void Clutter::Actor::unmap | ( | ) |
Unsets the Clutter::ACTOR_MAPPED flag on the actor and possibly unmaps its children if they were mapped.
Calling this function is not encouraged: the default Clutter::Actor implementation of Clutter::ActorClass.unmap() will also unmap any eventual children by default when their parent is unmapped.
When overriding Clutter::ActorClass.unmap(), it is mandatory to chain up to the parent implementation.
<note>It is important to note that the implementation of the Clutter::ActorClass.unmap() virtual function may be called after the Clutter::ActorClass.destroy() or the ObjectClass.dispose() implementation, but it is guaranteed to be called before the ObjectClass.finalize() implementation.</note>
|
protectedvirtual |
void Clutter::Actor::unparent | ( | ) |
Removes the parent of self.
This will cause the parent of self to release the reference acquired when calling set_parent(), so if you want to keep self you will have to acquire a reference of your own, through Glib::object_ref().
This function should only be called by legacy Clutter::Actors implementing the Clutter::Container interface.
{0,1,1}
Deprecated: 1.10: Use remove_child() instead.
- Deprecated:
- Use remove_child() instead.
void Clutter::Actor::unrealize | ( | ) |
Unrealization informs the actor that it may be being destroyed or moved to another stage.
The actor may want to destroy any underlying graphics resources at this point. However it is perfectly acceptable for it to retain the resources until the actor is destroyed because Clutter only ever uses a single rendering context and all of the graphics resources are valid on any stage.
Because mapped actors must be realized, actors may not be unrealized if they are mapped. This function hides the actor to be sure it isn't mapped, an application-visible side effect that you may not be expecting.
This function should not be called by application code.
This function should not really be in the public API, because there isn't a good reason to call it. ClutterActor will already unrealize things for you when it's important to do so.
If you were using unrealize() in a dispose implementation, then don't, just chain up to ClutterActor's dispose.
If you were using unrealize() to implement unrealizing children of your container, then don't, ClutterActor will already take care of that.
Deprecated: 1.16: Actors are automatically unrealized, and nothing requires explicit realization.
void Clutter::Actor::unset_flags | ( | ActorFlags | flags) |
Unsets flags on self.
This function will emit notifications for the changed properties
- Parameters
-
flags The flags to unset.
void Clutter::Actor::unset_layout_manager | ( | ) |
Unset the layout manager.
Friends And Related Function Documentation
|
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/actor.h