Actor
Object Hierarchy:
Description:
[ CCode ( type_id = "clutter_actor_get_type ()" ) ]
public class Actor : InitiallyUnowned, Implementor, Animatable, Container, Scriptable
public class Actor : InitiallyUnowned, Implementor, Animatable, Container, Scriptable
Base class for actors.
All known sub-classes:
Namespace: Clutter
Package: clutter-1.0
Content:
Properties:
- public Action actions { set; }
Adds a Action to the actor
- public ActorBox allocation { owned get; }
The allocation for the actor, in pixels
- public Gravity anchor_gravity { get; set; }
The anchor point expressed as a Gravity
- public float anchor_x { get; set; }
The X coordinate of an actor's anchor point, relative to the actor coordinate space, in pixels.
- public float anchor_y { get; set; }
The Y coordinate of an actor's anchor point, relative to the actor coordinate space, in pixels
- public Color background_color { get; set; }
Paints a solid fill of the actor's allocation using the specified color.
- public bool background_color_set { get; }
Whether the background_color property has been set.
- public Matrix child_transform { get; set; }
Applies a transformation matrix on each child of an actor.
- public bool child_transform_set { get; }
Whether the child_transform property is set.
- public Geometry clip { owned get; set; }
The visible region of the actor, in actor-relative coordinates
- public Rect clip_rect { owned get; set; }
The visible region of the actor, in actor-relative coordinates, expressed as a Rect.
- public bool clip_to_allocation { get; set; }
Whether the clip region should track the allocated area of the actor.
- public Constraint constraints { set; }
Adds a Constraint to the actor
- public Content content { get; set; }
The Content implementation that controls the content of the actor.
- public ActorBox content_box { get; }
The bounding box for the Content used by the actor.
- public ContentGravity content_gravity { get; set; }
- public ContentRepeat content_repeat { get; set; }
The repeat policy for the actor's content.
- public float depth { get; set; }
The position of the actor on the Z axis.
- public Effect effect { set; }
Adds Effect to the list of effects be applied on a Actor
- public Actor first_child { get; }
The actor's first child.
- public bool fixed_position_set { get; set; }
- public float fixed_x { get; set; }
The fixed X position of the actor in pixels.
- public float fixed_y { get; set; }
The fixed Y position of the actor in pixels.
- public bool has_clip { get; }
Whether the actor has the clip property set or not
- public bool has_pointer { get; }
Whether the actor contains the pointer of a InputDevice or not.
- public float height { get; set; }
Height of the actor (in pixels).
- public Actor last_child { get; }
The actor's last child.
- public LayoutManager layout_manager { get; set; }
A delegate object for controlling the layout of the children of an actor.
- public ScalingFilter magnification_filter { get; set; }
- public bool mapped { get; }
Whether the actor is mapped (will be painted when the stage to which it belongs is mapped)
- public float margin_bottom { get; set; }
The margin (in pixels) from the bottom of the actor.
- public float margin_left { get; set; }
The margin (in pixels) from the left of the actor.
- public float margin_right { get; set; }
The margin (in pixels) from the right of the actor.
- public float margin_top { get; set; }
The margin (in pixels) from the top of the actor.
- public float min_height { get; set; }
A forced minimum height request for the actor, in pixels
- public bool min_height_set { get; set; }
This flag controls whether the min_height property is used
- public float min_width { get; set; }
A forced minimum width request for the actor, in pixels
- public bool min_width_set { get; set; }
This flag controls whether the min_width property is used
- public ScalingFilter minification_filter { get; set; }
- public string name { get; set; }
The name of the actor
- public float natural_height { get; set; }
A forced natural height request for the actor, in pixels
- public bool natural_height_set { get; set; }
This flag controls whether the natural_height property is used
- public float natural_width { get; set; }
A forced natural width request for the actor, in pixels
- public bool natural_width_set { get; set; }
This flag controls whether the natural_width property is used
- public OffscreenRedirect offscreen_redirect { get; set; }
Determines the conditions in which the actor will be redirected to an offscreen framebuffer while being painted.
- public uint opacity { get; set; }
Opacity of an actor, between 0 (fully transparent) and 255 (fully opaque)
- public Point pivot_point { owned get; set; }
The point around which the scaling and rotation transformations occur.
- public float pivot_point_z { get; set; }
The Z component of the pivot_point, expressed as a value along the Z axis.
- public Point position { owned get; set; }
The position of the origin of the actor.
- public bool reactive { get; set; }
Whether the actor is reactive to events or not
- public bool realized { get; }
Whether the actor has been realized
- public RequestMode request_mode { get; set; }
Request mode for the Actor.
- public double rotation_angle_x { get; set; }
The rotation angle on the X axis.
- public double rotation_angle_y { get; set; }
The rotation angle on the Y axis
- public double rotation_angle_z { get; set; }
The rotation angle on the Z axis
- public Vertex rotation_center_x { owned get; set; }
The rotation center on the X axis.
- public Vertex rotation_center_y { owned get; set; }
The rotation center on the Y axis.
- public Vertex rotation_center_z { owned get; set; }
The rotation center on the Z axis.
- public Gravity rotation_center_z_gravity { get; set; }
The rotation center on the Z axis expressed as a Gravity.
- public float scale_center_x { get; set; }
The horizontal center point for scaling
- public float scale_center_y { get; set; }
The vertical center point for scaling
- public Gravity scale_gravity { get; set; }
The center point for scaling expressed as a Gravity
- public double scale_x { get; set; }
The horizontal scale of the actor.
- public double scale_y { get; set; }
The vertical scale of the actor.
- public double scale_z { get; set; }
The scale factor of the actor along the Z axis.
- public bool show_on_set_parent { get; set; }
If
true
, the actor is automatically shown when parented. - public Size size { owned get; set; }
The size of the actor.
- public TextDirection text_direction { get; set; }
The direction of the text inside a Actor.
- public Matrix transform { get; set; }
Overrides the transformations of a Actor with a custom matrix.
- public bool transform_set { get; }
Whether the transform property is set.
- public float translation_x { get; set; }
An additional translation applied along the X axis, relative to the actor's pivot_point.
- public float translation_y { get; set; }
An additional translation applied along the Y axis, relative to the actor's pivot_point.
- public float translation_z { get; set; }
An additional translation applied along the Z axis, relative to the actor's pivot_point.
- public bool visible { get; set; }
Whether the actor is set to be visible or not
- public float width { get; set; }
Width of the actor (in pixels).
- public float x { get; set; }
X coordinate of the actor in pixels.
- public ActorAlign x_align { get; set; }
The alignment of an actor on the X axis, if the actor has been given extra space for its allocation.
- public bool x_expand { get; set; }
Whether a layout manager should assign more space to the actor on the X axis.
- public float y { get; set; }
Y coordinate of the actor in pixels.
- public ActorAlign y_align { get; set; }
The alignment of an actor on the Y axis, if the actor has been given extra space for its allocation.
- public bool y_expand { get; set; }
Whether a layout manager should assign more space to the actor on the Y axis.
- public float z_position { get; set; }
The actor's position on the Z axis, relative to the parent's transformations.
Static methods:
- public static unowned Actor get_by_gid (uint32 id_)
Retrieves the Actor with
id_
.
Creation methods:
- public Actor ()
Creates a new Actor.
Methods:
- public void add_action (Action action)
Adds
action
to the list of actions applied to this - public void add_action_with_name (string name, Action action)
A convenience function for setting the name of a Action while adding it to the list of actions applied to this
- public void add_child (Actor child)
Adds
child
to the children of this . - public void add_constraint (Constraint constraint)
Adds
constraint
to the list of Constraints applied to this - public void add_constraint_with_name (string name, Constraint constraint)
A convenience function for setting the name of a Constraint while adding it to the list of constraints applied to this
- public void add_effect (Effect effect)
Adds
effect
to the list of Effects applied to this - public void add_effect_with_name (string name, Effect effect)
A convenience function for setting the name of a Effect while adding it to the list of effects applied to this.
- public void add_transition (string name, Transition transition)
Adds a
transition
to the Actor's list of animations. - public virtual void allocate (ActorBox box, AllocationFlags flags)
Assigns the size of a Actor from the given
box
. - public void allocate_align_fill (ActorBox box, double x_align, double y_align, bool x_fill, bool y_fill, AllocationFlags flags)
Allocates this 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.
- public void allocate_available_size (float x, float y, float available_width, float available_height, AllocationFlags flags)
Allocates this taking into account the Actor's preferred size, but limiting it to the maximum available width and height provided.
- public void allocate_preferred_size (AllocationFlags flags)
Allocates the natural size of this.
- public unowned Animation animate (ulong mode, uint duration, ...)
Animates the given list of properties of this between the current value for each property and a new final value.
- public unowned Animation animate_with_alpha (Alpha alpha, ...)
Animates the given list of properties of this between the current value for each property and a new final value.
- public unowned Animation animate_with_alphav (Alpha alpha, string[] properties, Value[] values)
Animates the given list of properties of this between the current value for each property and a new final value.
- public unowned Animation animate_with_timeline (ulong mode, Timeline timeline, ...)
Animates the given list of properties of this between the current value for each property and a new final value.
- public unowned Animation animate_with_timelinev (ulong mode, Timeline timeline, string[] properties, Value[] values)
Animates the given list of properties of this between the current value for each property and a new final value.
- public unowned Animation animatev (ulong mode, uint duration, string[] properties, Value[] values)
Animates the given list of properties of this between the current value for each property and a new final value.
- public Vertex apply_relative_transform_to_point (Actor? ancestor, Vertex point)
Transforms
point
in coordinates relative to the actor into ancestor-relative coordinates using the relevant transform stack (i.e. scale, rotation, etc). - public virtual void apply_transform (ref Matrix matrix)
- public Vertex apply_transform_to_point (Vertex point)
Transforms
point
in coordinates relative to the actor into screen-relative coordinates with the current actor transformation (i.e. scale, rotation, etc) - public void bind_model (ListModel? model, owned ActorCreateChildFunc create_child_func)
Binds a ListModel to a Actor.
- public void clear_actions ()
Clears the list of actions applied to this
- public void clear_constraints ()
Clears the list of constraints applied to this
- public void clear_effects ()
Clears the list of effects applied to this
- public bool contains (Actor descendant)
Determines if
descendant
is contained inside this (either as an immediate child, or as a deeper descendant). - public void continue_paint ()
Run the next stage of the paint sequence.
- public Context create_pango_context ()
Creates a Context for the given actor.
- public Layout create_pango_layout (string? text)
- public void destroy_all_children ()
Destroys all children of this.
- public void detach_animation ()
- public bool emit_event (Event event, bool capture)
- public void get_abs_allocation_vertices (Vertex[] verts)
Calculates the transformed screen coordinates of the four corners of the actor; the returned vertices relate to the ActorBox coordinates as follows:
- public virtual unowned Object get_accessible ()
Returns the accessible object that describes the actor to an assistive technology.
- public unowned Action get_action (string name)
Retrieves the Action with the given name in the list of actions applied to this
- public List<unowned Action> get_actions ()
Retrieves the list of actions applied to this
- public ActorBox get_allocation_box ()
Gets the layout box an actor has been assigned.
- public Geometry get_allocation_geometry ()
Gets the layout box an actor has been assigned.
- public void get_allocation_vertices (Actor? ancestor, Vertex[] verts)
Calculates the transformed coordinates of the four corners of the actor in the plane of
ancestor
. - public void get_anchor_point (out float anchor_x, out float anchor_y)
Gets the current anchor point of the
actor
in pixels. - public Gravity get_anchor_point_gravity ()
Retrieves the anchor position expressed as a Gravity.
- public unowned Animation get_animation ()
- public Color get_background_color ()
Retrieves the color set using set_background_color.
- public unowned Actor get_child_at_index (int index_)
Retrieves the actor at the given
index_
inside the list of children of this. - public Matrix get_child_transform ()
Retrieves the child transformation matrix set using set_child_transform; if none is currently set, the
transform
matrix will be initialized to the identity matrix. - public List<unowned Actor> get_children ()
Retrieves the list of children of this.
- public void get_clip (out float xoff, out float yoff, out float width, out float height)
Gets the clip area for this, if any is set.
- public bool get_clip_to_allocation ()
Retrieves the value set using set_clip_to_allocation
- public unowned Constraint get_constraint (string name)
Retrieves the Constraint with the given name in the list of constraints applied to this
- public List<unowned Constraint> get_constraints ()
Retrieves the list of constraints applied to this
- public unowned Content get_content ()
Retrieves the contents of this.
- public ActorBox get_content_box ()
Retrieves the bounding box for the Content of this.
- public ContentGravity get_content_gravity ()
Retrieves the content gravity as set using set_content_gravity.
- public ContentRepeat get_content_repeat ()
Retrieves the repeat policy for a Actor set by set_content_repeat.
- public void get_content_scaling_filters (out ScalingFilter min_filter, out ScalingFilter mag_filter)
Retrieves the values set using set_content_scaling_filters.
- public unowned PaintVolume? get_default_paint_volume ()
Retrieves the default paint volume for this .
- public float get_depth ()
Retrieves the depth of this.
- public uint get_easing_delay ()
Retrieves the delay that should be applied when tweening animatable properties.
- public uint get_easing_duration ()
Retrieves the duration of the tweening for animatable properties of this for the current easing state.
- public AnimationMode get_easing_mode ()
Retrieves the easing mode for the tweening of animatable properties of this for the current easing state.
- public unowned Effect get_effect (string name)
Retrieves the Effect with the given name in the list of effects applied to this
- public List<unowned Effect> get_effects ()
Retrieves the Effects applied on this, if any
- public unowned Actor get_first_child ()
Retrieves the first child of this.
- public bool get_fixed_position_set ()
Checks whether an actor has a fixed position set (and will thus be unaffected by any layout manager).
- public ActorFlags get_flags ()
Retrieves the flags set on this
- public Geometry get_geometry ()
Gets the size and position of an actor relative to its parent actor.
- public uint32 get_gid ()
Retrieves the unique id for this.
- public bool get_has_pointer ()
Checks whether an actor contains the pointer of a InputDevice
- public float get_height ()
Retrieves the height of a Actor.
- public unowned Actor get_last_child ()
Retrieves the last child of this.
- public unowned LayoutManager get_layout_manager ()
Retrieves the LayoutManager used by this.
- public Margin get_margin ()
Retrieves all the components of the margin of a Actor .
- public float get_margin_bottom ()
Retrieves the bottom margin of a Actor.
- public float get_margin_left ()
Retrieves the left margin of a Actor.
- public float get_margin_right ()
Retrieves the right margin of a Actor.
- public float get_margin_top ()
Retrieves the top margin of a Actor.
- public int get_n_children ()
Retrieves the number of children of this.
- public unowned string get_name ()
Retrieves the name of this.
- public unowned Actor get_next_sibling ()
Retrieves the sibling of this that comes after it in the list of children of this's parent.
- public OffscreenRedirect get_offscreen_redirect ()
Retrieves whether to redirect the actor to an offscreen buffer, as set by set_offscreen_redirect.
- public uint8 get_opacity ()
Retrieves the opacity value of an actor, as set by set_opacity.
- public bool get_paint_box (out ActorBox box)
Retrieves the paint volume of the passed Actor, and transforms it into a 2D bounding box in stage coordinates.
- public uint8 get_paint_opacity ()
Retrieves the absolute opacity of the actor, as it appears on the stage.
- public bool get_paint_visibility ()
Retrieves the 'paint' visibility of an actor recursively checking for non visible parents.
- public unowned PaintVolume? get_paint_volume ()
Retrieves the paint volume of the passed Actor, or
null
when a paint volume can't be determined. - public virtual bool get_paint_volume_vfunc (out PaintVolume volume)
- public unowned Context get_pango_context ()
Retrieves the Context for this.
- public unowned Actor? get_parent ()
Retrieves the parent of this.
- public void get_pivot_point (out float pivot_x, out float pivot_y)
Retrieves the coordinates of the pivot_point.
- public float get_pivot_point_z ()
Retrieves the Z component of the pivot_point.
- public void get_position (out float x, out float y)
This function tries to "do what you mean" and tell you where the actor is, prior to any transformations.
- public virtual void get_preferred_height (float for_width, out float min_height_p, out float natural_height_p)
Computes the requested minimum and natural heights for an actor, or if they are already computed, returns the cached values.
- public void get_preferred_size (out float min_width_p, out float min_height_p, out float natural_width_p, out float natural_height_p)
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).
- public virtual void get_preferred_width (float for_height, out float min_width_p, out float natural_width_p)
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.
- public unowned Actor get_previous_sibling ()
Retrieves the sibling of this that comes before it in the list of children of this's parent.
- public bool get_reactive ()
Checks whether this is marked as reactive.
- public RequestMode get_request_mode ()
Retrieves the geometry request mode of this
- public double get_rotation (RotateAxis axis, out float x, out float y, out float z)
Retrieves the angle and center of rotation on the given axis, set using set_rotation.
- public double get_rotation_angle (RotateAxis axis)
Retrieves the angle of rotation set by set_rotation_angle.
- public void get_scale (out double scale_x, out double scale_y)
Retrieves an actors scale factors.
- public void get_scale_center (out float center_x, out float center_y)
Retrieves the scale center coordinate in pixels relative to the top left corner of the actor.
- public Gravity get_scale_gravity ()
Retrieves the scale center as a compass direction.
- public double get_scale_z ()
Retrieves the scaling factor along the Z axis, as set using set_scale_z.
- public unowned Shader get_shader ()
Queries the currently set Shader on this.
- public void get_size (out float width, out float height)
This function tries to "do what you mean" and return the size an actor will have.
- public unowned Stage get_stage ()
Retrieves the Stage where this is contained.
- public TextDirection get_text_direction ()
Retrieves the value set using set_text_direction
- public Matrix get_transform ()
Retrieves the current transformation matrix of a Actor .
- public Matrix get_transformation_matrix ()
Retrieves the transformations applied to this relative to its parent.
- public unowned PaintVolume? get_transformed_paint_volume (Actor relative_to_ancestor)
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.
- public void get_transformed_position (out float x, out float y)
Gets the absolute position of an actor, in pixels relative to the stage.
- public void get_transformed_size (out float width, out float height)
Gets the absolute size of an actor in pixels, taking into account the scaling factors.
- public unowned Transition get_transition (string name)
Retrieves the Transition of a Actor by using the transition
name
. - public void get_translation (out float translate_x, out float translate_y, out float translate_z)
Retrieves the translation set using set_translation.
- public float get_width ()
Retrieves the width of a Actor.
- public float get_x ()
Retrieves the X coordinate of a Actor.
- public ActorAlign get_x_align ()
Retrieves the horizontal alignment policy set using set_x_align.
- public bool get_x_expand ()
Retrieves the value set with set_x_expand.
- public float get_y ()
Retrieves the Y coordinate of a Actor.
- public ActorAlign get_y_align ()
Retrieves the vertical alignment policy set using set_y_align.
- public bool get_y_expand ()
Retrieves the value set with set_y_expand.
- public float get_z_position ()
Retrieves the actor's position on the Z axis.
- public Gravity get_z_rotation_gravity ()
Retrieves the center for the rotation around the Z axis as a compass direction.
- public void grab_key_focus ()
Sets the key focus of the Stage including this to this Actor.
- public bool has_actions ()
Returns whether the actor has any actions applied.
- public bool has_allocation ()
Checks if the actor has an up-to-date allocation assigned to it.
- public bool has_constraints ()
Returns whether the actor has any constraints applied.
- public bool has_effects ()
Returns whether the actor has any effects applied.
- public bool has_key_focus ()
Checks whether this is the Actor that has key focus
- public virtual bool has_overlaps ()
Asks the actor's implementation whether it may contain overlapping primitives.
- public virtual void hide_all ()
Calls hide on all child actors (if any).
- public void insert_child_above (Actor child, Actor? sibling)
Inserts
child
into the list of children of this, above another child of this or, ifsibling
isnull
, above all the children of this. - public void insert_child_at_index (Actor child, int index_)
Inserts
child
into the list of children of this, using the givenindex_
. - public void insert_child_below (Actor child, Actor? sibling)
Inserts
child
into the list of children of this, below another child of this or, ifsibling
isnull
, below all the children of this. - public bool is_in_clone_paint ()
Checks whether this is being currently painted by a Clone
- public bool is_mapped ()
Checks whether a Actor has been set as mapped.
- public bool is_realized ()
Checks whether a Actor is realized.
- public bool is_rotated ()
Checks whether any rotation is applied to the actor.
- public bool is_scaled ()
Checks whether the actor is scaled in either dimension.
- public bool is_visible ()
Checks whether an actor is marked as visible.
- public void lower (Actor? above)
Puts this below
above
. - public void lower_bottom ()
Lowers this to the bottom.
- public virtual void map ()
Sets the MAPPED flag on the actor and possibly maps and realizes its children if they are visible.
- public 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.
- public 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.
- public void move_by (float dx, float dy)
Moves an actor by the specified distance relative to its current position in pixels.
- public bool needs_expand (Orientation orientation)
Checks whether an actor, or any of its children, is set to expand horizontally or vertically.
- public virtual void paint_node (PaintNode root)
- public void pop_internal ()
Disables the effects of push_internal.
- public void push_internal ()
Should be used by actors implementing the Container and with internal children added through set_parent, for instance:
- public void queue_redraw ()
Queues up a redraw of an actor and any children.
- public void queue_redraw_with_clip (RectangleInt? clip)
Queues a redraw on this limited to a specific, actor-relative rectangular area.
- public void raise (Actor? below)
Puts this above
below
. - public void raise_top ()
Raises this to the top.
- public void remove_action (Action action)
Removes
action
from the list of actions applied to this - public void remove_action_by_name (string name)
Removes the Action with the given name from the list of actions applied to this
- public void remove_all_children ()
Removes all children of this.
- public void remove_all_transitions ()
Removes all transitions associated to this .
- public void remove_child (Actor child)
Removes
child
from the children of this. - public void remove_clip ()
Removes clip area from this.
- public void remove_constraint (Constraint constraint)
Removes
constraint
from the list of constraints applied to this - public void remove_constraint_by_name (string name)
Removes the Constraint with the given name from the list of constraints applied to this
- public void remove_effect (Effect effect)
Removes
effect
from the list of effects applied to this - public void remove_effect_by_name (string name)
Removes the Effect with the given name from the list of effects applied to this
- public void remove_transition (string name)
Removes the transition stored inside a Actor using
name
identifier. - public void reparent (Actor new_parent)
Resets the parent actor of this.
- public void replace_child (Actor old_child, Actor new_child)
Replaces
old_child
withnew_child
in the list of children of this. - public void restore_easing_state ()
Restores the easing state as it was prior to a call to save_easing_state.
- public 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.
- public void set_allocation (ActorBox box, AllocationFlags flags)
Stores the allocation of this as defined by
box
. - public void set_anchor_point (float anchor_x, float anchor_y)
Sets an anchor point for this.
- public void set_anchor_point_from_gravity (Gravity gravity)
Sets an anchor point on the actor, based on the given gravity (this is a convenience function wrapping set_anchor_point).
- public void set_background_color (Color? color)
Sets the background color of a Actor.
- public void set_child_above_sibling (Actor child, Actor? sibling)
Sets
child
to be abovesibling
in the list of children of this. - public void set_child_at_index (Actor child, int index_)
Changes the index of
child
in the list of children of this. - public void set_child_below_sibling (Actor child, Actor? sibling)
Sets
child
to be belowsibling
in the list of children of this. - public void set_child_transform (Matrix? transform)
Sets the transformation matrix to be applied to all the children of this prior to their own transformations.
- public void set_clip (float xoff, float yoff, float width, float height)
Sets clip area for this.
- public void set_clip_to_allocation (bool clip_set)
Sets whether this should be clipped to the same size as its allocation
- public void set_content (Content? content)
Sets the contents of a Actor.
- public void set_content_gravity (ContentGravity gravity)
Sets the gravity of the Content used by this.
- public void set_content_repeat (ContentRepeat repeat)
Sets the policy for repeating the content of a Actor.
- public void set_content_scaling_filters (ScalingFilter min_filter, ScalingFilter mag_filter)
Sets the minification and magnification filter to be applied when scaling the content of a Actor.
- public void set_depth (float depth)
Sets the Z coordinate of this to
depth
. - public void set_easing_delay (uint msecs)
Sets the delay that should be applied before tweening animatable properties.
- public void set_easing_duration (uint msecs)
Sets the duration of the tweening for animatable properties of this for the current easing state.
- public void set_easing_mode (AnimationMode mode)
Sets the easing mode for the tweening of animatable properties of this.
- public 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).
- public void set_flags (ActorFlags flags)
Sets
flags
on this - public void set_geometry (Geometry geometry)
Sets the actor's fixed position and forces its minimum and natural size, in pixels.
- public void set_height (float height)
Forces a height on an actor, causing the actor's preferred width and height (if any) to be ignored.
- public void set_layout_manager (LayoutManager? manager)
Sets the LayoutManager delegate object that will be used to lay out the children of this.
- public void set_margin (Margin margin)
Sets all the components of the margin of a Actor.
- public void set_margin_bottom (float margin)
Sets the margin from the bottom of a Actor.
- public void set_margin_left (float margin)
Sets the margin from the left of a Actor.
- public void set_margin_right (float margin)
Sets the margin from the right of a Actor.
- public void set_margin_top (float margin)
Sets the margin from the top of a Actor.
- public void set_name (string name)
Sets the given name to this.
- public void set_offscreen_redirect (OffscreenRedirect redirect)
Defines the circumstances where the actor should be redirected into an offscreen image.
- public void set_opacity (uint8 opacity)
Sets the actor's opacity, with zero being completely transparent and 255 (0xff) being fully opaque.
- public void set_parent (Actor parent)
Sets the parent of this to
parent
. - public void set_pivot_point (float pivot_x, float pivot_y)
Sets the position of the pivot_point around which the scaling and rotation transformations occur.
- public void set_pivot_point_z (float pivot_z)
Sets the component on the Z axis of the pivot_point around which the scaling and rotation transformations occur.
- public void set_position (float x, float y)
Sets the actor's fixed position in pixels relative to any parent actor.
- public void set_reactive (bool reactive)
Sets this as reactive.
- public void set_request_mode (RequestMode mode)
Sets the geometry request mode of this.
- public void set_rotation (RotateAxis axis, double angle, float x, float y, float z)
Sets the rotation angle of this around the given axis.
- public void set_rotation_angle (RotateAxis axis, double angle)
Sets the
angle
of rotation of a Actor on the givenaxis
. - public void set_scale (double scale_x, double scale_y)
Scales an actor with the given factors.
- public 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.
- public 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.
- public void set_scale_z (double scale_z)
Scales an actor on the Z axis by the given
scale_z
factor. - public bool set_shader (Shader? shader)
Sets the Shader to be used when rendering this.
- public void set_shader_param (string param, Value value)
Sets the value for a named parameter of the shader applied to
actor
. - public void set_shader_param_float (string param, float value)
Sets the value for a named float parameter of the shader applied to
actor
. - public void set_shader_param_int (string param, int value)
Sets the value for a named int parameter of the shader applied to
actor
. - public void set_size (float width, float height)
Sets the actor's size request in pixels.
- public void set_text_direction (TextDirection text_dir)
Sets the TextDirection for an actor
- public void set_transform (Matrix? transform)
Overrides the transformations of a 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.
- public void set_translation (float translate_x, float translate_y, float translate_z)
Sets an additional translation transformation on a Actor , relative to the pivot_point.
- public void set_width (float width)
Forces a width on an actor, causing the actor's preferred width and height (if any) to be ignored.
- public void set_x (float x)
Sets the actor's X coordinate, relative to its parent, in pixels.
- public void set_x_align (ActorAlign x_align)
Sets the horizontal alignment policy of a Actor, in case the actor received extra horizontal space.
- public void set_x_expand (bool expand)
Sets whether a Actor should expand horizontally; this means that layout manager should allocate extra space for the actor, if possible.
- public void set_y (float y)
Sets the actor's Y coordinate, relative to its parent, in pixels.
- public void set_y_align (ActorAlign y_align)
Sets the vertical alignment policy of a Actor, in case the actor received extra vertical space.
- public void set_y_expand (bool expand)
Sets whether a Actor should expand horizontally; this means that layout manager should allocate extra space for the actor, if possible.
- public void set_z_position (float z_position)
Sets the actor's position on the Z axis.
- public void set_z_rotation_from_gravity (double angle, Gravity gravity)
Sets the rotation angle of this around the Z axis using the center point specified as a compass point.
- public bool should_pick_paint ()
Should be called inside the implementation of the pick virtual function in order to check whether the actor should paint itself in pick mode or not.
- public virtual void show_all ()
Calls show on all children of an actor (if any).
- public bool transform_stage_point (float x, float y, out float x_out, out float y_out)
This function translates screen coordinates (
x
,y
) to coordinates relative to the actor. - public virtual void unmap ()
Unsets the MAPPED flag on the actor and possibly unmaps its children if they were mapped.
- public void unparent ()
Removes the parent of this.
- public void unset_flags (ActorFlags flags)
Unsets
flags
on this
Signals:
- public signal void allocation_changed (ActorBox box, AllocationFlags flags)
The allocation_changed signal is emitted when the allocation property changes.
- public virtual signal bool button_press_event (ButtonEvent event)
The button_press_event signal is emitted each time a mouse button is pressed on
actor
. - public virtual signal bool button_release_event (ButtonEvent event)
The button_release_event signal is emitted each time a mouse button is released on
actor
. - public virtual signal bool captured_event (Event event)
The captured_event signal is emitted when an event is captured by Clutter.
- public virtual signal void destroy ()
The destroy signal notifies that all references held on the actor which emitted it should be released.
- public virtual signal bool enter_event (CrossingEvent event)
The enter_event signal is emitted when the pointer enters the
actor
- public virtual signal bool event (Event event)
The event signal is emitted each time an event is received by the
actor
. - public virtual signal void hide ()
The hide signal is emitted when an actor is no longer rendered on the stage.
- public virtual signal void key_focus_in ()
The key_focus_in signal is emitted when
actor
receives key focus. - public virtual signal void key_focus_out ()
The key_focus_out signal is emitted when
actor
loses key focus. - public virtual signal bool key_press_event (KeyEvent event)
The key_press_event signal is emitted each time a keyboard button is pressed while
actor
has key focus (see set_key_focus). - public virtual signal bool key_release_event (KeyEvent event)
The key_release_event signal is emitted each time a keyboard button is released while
actor
has key focus (see set_key_focus). - public virtual signal bool leave_event (CrossingEvent event)
The leave_event signal is emitted when the pointer leaves the
actor
. - public virtual signal bool motion_event (MotionEvent event)
The motion_event signal is emitted each time the mouse pointer is moved over
actor
. - public virtual signal void paint ()
The paint signal is emitted each time an actor is being painted.
- public virtual signal void parent_set (Actor? old_parent)
This signal is emitted when the parent of the actor changes.
- public virtual signal void pick (Color color)
The pick signal is emitted each time an actor is being painted in "pick mode".
- public virtual signal void queue_relayout ()
The
::queue_layout
signal is emitted when queue_relayout is called on an actor. - public virtual signal void realize ()
The realize signal is emitted each time an actor is being realized.
- public virtual signal bool scroll_event (ScrollEvent event)
The scroll_event signal is emitted each time the mouse is scrolled on
actor
- public virtual signal void show ()
The show signal is emitted when an actor is visible and rendered on the stage.
- public virtual signal bool touch_event (Event event)
The touch_event signal is emitted each time a touch begin/end/update/cancel event.
- public signal void transition_stopped (string name, bool is_finished)
The 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 stop, or it has been removed from the transitions applied on
actor
, using remove_transition. - public signal void transitions_completed ()
The transitions_completed signal is emitted once all transitions involving
actor
are complete. - public virtual signal void unrealize ()
The unrealize signal is emitted each time an actor is being unrealized.
Fields:
Inherited Members:
All known members inherited from class GLib.Object
All known members inherited from interface Atk.Implementor
All known members inherited from interface Clutter.Animatable
All known members inherited from interface Clutter.Container
All known members inherited from interface Clutter.Scriptable