brl/mutter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ddda4aec18
mutter/clutter/clutter-actor-private.h

317 lines
14 KiB
C
Raw Normal View History

Add copyright notices
2010-10-21 12:13:00 +00:00
/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Copyright (C) 2010 Intel Corporation.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
Clean up clutter-private.h/6 Move all Actor private API to a separate file.
2010-10-21 11:16:05 +00:00
#ifndef __CLUTTER_ACTOR_PRIVATE_H__
#define __CLUTTER_ACTOR_PRIVATE_H__
#include <clutter/clutter-actor.h>
G_BEGIN_DECLS
docs: Documentation fixes
2010-12-09 15:06:12 +00:00
/*< private >
Clean up clutter-private.h/6 Move all Actor private API to a separate file.
2010-10-21 11:16:05 +00:00
* ClutterRedrawFlags:
* @CLUTTER_REDRAW_CLIPPED_TO_ALLOCATION: Tells clutter the maximum
* extents of what needs to be redrawn lies within the actors
* current allocation. (Only use this for 2D actors though because
* any actor with depth may be projected outside of its allocation)
*
* Flags passed to the clutter_actor_queue_redraw_with_clip ()
* function
*
2.0: Remove all Since: annotations We're starting from scratch.
2012-08-27 08:48:36 +00:00
*
Clean up clutter-private.h/6 Move all Actor private API to a separate file.
2010-10-21 11:16:05 +00:00
*/
typedef enum
{
CLUTTER_REDRAW_CLIPPED_TO_ALLOCATION = 1 << 0
} ClutterRedrawFlags;
docs: Documentation fixes
2010-12-09 15:06:12 +00:00
/*< private >
* ClutterActorTraverseFlags:
actor: make _clutter_actor_traverse more flexible This makes it possible to choose the traversal order; either depth first or breadth first and when visiting actors in a depth first order there is now a callback called before children are traversed and one called after. Some tasks such as unrealizing actors need to explicitly control the traversal order to maintain the invariable that all children of an actor are unrealized before we actually mark the parent as unrealized. The callbacks are now passed the relative depth in the graph of the actor being visited and instead of only being able to return a boolean to bail out of further traversal it can now do one of: continue, skip_children or break. To implement something like unrealize it's desirable to skip children that you find have already been unrealized.
2010-10-20 14:40:30 +00:00
* CLUTTER_ACTOR_TRAVERSE_DEPTH_FIRST: Traverse the graph in
* a depth first order.
* CLUTTER_ACTOR_TRAVERSE_BREADTH_FIRST: Traverse the graph in a
* breadth first order.
Clean up clutter-private.h/6 Move all Actor private API to a separate file.
2010-10-21 11:16:05 +00:00
*
* Controls some options for how clutter_actor_traverse() iterates
* through the graph.
*/
Remove unnecessary duplicate name for private enumerations
2010-12-10 16:03:10 +00:00
typedef enum {
actor: make _clutter_actor_traverse more flexible This makes it possible to choose the traversal order; either depth first or breadth first and when visiting actors in a depth first order there is now a callback called before children are traversed and one called after. Some tasks such as unrealizing actors need to explicitly control the traversal order to maintain the invariable that all children of an actor are unrealized before we actually mark the parent as unrealized. The callbacks are now passed the relative depth in the graph of the actor being visited and instead of only being able to return a boolean to bail out of further traversal it can now do one of: continue, skip_children or break. To implement something like unrealize it's desirable to skip children that you find have already been unrealized.
2010-10-20 14:40:30 +00:00
CLUTTER_ACTOR_TRAVERSE_DEPTH_FIRST = 1L<<0,
CLUTTER_ACTOR_TRAVERSE_BREADTH_FIRST = 1L<<1
Clean up clutter-private.h/6 Move all Actor private API to a separate file.
2010-10-21 11:16:05 +00:00
} ClutterActorTraverseFlags;
docs: Documentation fixes
2010-12-09 15:06:12 +00:00
/*< private >
actor: make _clutter_actor_traverse more flexible This makes it possible to choose the traversal order; either depth first or breadth first and when visiting actors in a depth first order there is now a callback called before children are traversed and one called after. Some tasks such as unrealizing actors need to explicitly control the traversal order to maintain the invariable that all children of an actor are unrealized before we actually mark the parent as unrealized. The callbacks are now passed the relative depth in the graph of the actor being visited and instead of only being able to return a boolean to bail out of further traversal it can now do one of: continue, skip_children or break. To implement something like unrealize it's desirable to skip children that you find have already been unrealized.
2010-10-20 14:40:30 +00:00
* ClutterActorTraverseVisitFlags:
* CLUTTER_ACTOR_TRAVERSE_VISIT_CONTINUE: Continue traversing as
* normal
* CLUTTER_ACTOR_TRAVERSE_VISIT_SKIP_CHILDREN: Don't traverse the
* children of the last visited actor. (Not applicable when using
docs: Documentation fixes
2010-12-09 15:06:12 +00:00
* %CLUTTER_ACTOR_TRAVERSE_DEPTH_FIRST_POST_ORDER since the children
actor: make _clutter_actor_traverse more flexible This makes it possible to choose the traversal order; either depth first or breadth first and when visiting actors in a depth first order there is now a callback called before children are traversed and one called after. Some tasks such as unrealizing actors need to explicitly control the traversal order to maintain the invariable that all children of an actor are unrealized before we actually mark the parent as unrealized. The callbacks are now passed the relative depth in the graph of the actor being visited and instead of only being able to return a boolean to bail out of further traversal it can now do one of: continue, skip_children or break. To implement something like unrealize it's desirable to skip children that you find have already been unrealized.
2010-10-20 14:40:30 +00:00
* are visited before having an opportunity to bail out)
* CLUTTER_ACTOR_TRAVERSE_VISIT_BREAK: Immediately bail out without
* visiting any more actors.
*
* Each time an actor is visited during a scenegraph traversal the
* ClutterTraverseCallback can return a set of flags that may affect
* the continuing traversal. It may stop traversal completely, just
* skip over children for the current actor or continue as normal.
*/
Remove unnecessary duplicate name for private enumerations
2010-12-10 16:03:10 +00:00
typedef enum {
actor: make _clutter_actor_traverse more flexible This makes it possible to choose the traversal order; either depth first or breadth first and when visiting actors in a depth first order there is now a callback called before children are traversed and one called after. Some tasks such as unrealizing actors need to explicitly control the traversal order to maintain the invariable that all children of an actor are unrealized before we actually mark the parent as unrealized. The callbacks are now passed the relative depth in the graph of the actor being visited and instead of only being able to return a boolean to bail out of further traversal it can now do one of: continue, skip_children or break. To implement something like unrealize it's desirable to skip children that you find have already been unrealized.
2010-10-20 14:40:30 +00:00
CLUTTER_ACTOR_TRAVERSE_VISIT_CONTINUE = 1L<<0,
CLUTTER_ACTOR_TRAVERSE_VISIT_SKIP_CHILDREN = 1L<<1,
CLUTTER_ACTOR_TRAVERSE_VISIT_BREAK = 1L<<2
} ClutterActorTraverseVisitFlags;
docs: Documentation fixes
2010-12-09 15:06:12 +00:00
/*< private >
actor: make _clutter_actor_traverse more flexible This makes it possible to choose the traversal order; either depth first or breadth first and when visiting actors in a depth first order there is now a callback called before children are traversed and one called after. Some tasks such as unrealizing actors need to explicitly control the traversal order to maintain the invariable that all children of an actor are unrealized before we actually mark the parent as unrealized. The callbacks are now passed the relative depth in the graph of the actor being visited and instead of only being able to return a boolean to bail out of further traversal it can now do one of: continue, skip_children or break. To implement something like unrealize it's desirable to skip children that you find have already been unrealized.
2010-10-20 14:40:30 +00:00
* ClutterTraverseCallback:
*
* The callback prototype used with clutter_actor_traverse. The
* returned flags can be used to affect the continuing traversal
* either by continuing as normal, skipping over children of an
* actor or bailing out completely.
*/
typedef ClutterActorTraverseVisitFlags (*ClutterTraverseCallback) (ClutterActor *actor,
docs: Documentation fixes
2010-12-09 15:06:12 +00:00
gint depth,
gpointer user_data);
actor: make _clutter_actor_traverse more flexible This makes it possible to choose the traversal order; either depth first or breadth first and when visiting actors in a depth first order there is now a callback called before children are traversed and one called after. Some tasks such as unrealizing actors need to explicitly control the traversal order to maintain the invariable that all children of an actor are unrealized before we actually mark the parent as unrealized. The callbacks are now passed the relative depth in the graph of the actor being visited and instead of only being able to return a boolean to bail out of further traversal it can now do one of: continue, skip_children or break. To implement something like unrealize it's desirable to skip children that you find have already been unrealized.
2010-10-20 14:40:30 +00:00
docs: Documentation fixes
2010-12-09 15:06:12 +00:00
/*< private >
* ClutterForeachCallback:
Clean up clutter-private.h/6 Move all Actor private API to a separate file.
2010-10-21 11:16:05 +00:00
* @actor: The actor being iterated
* @user_data: The private data specified when starting the iteration
*
* A generic callback for iterating over actor, such as with
* _clutter_actor_foreach_child. The difference when compared to
* #ClutterCallback is that it returns a boolean so it is possible to break
* out of an iteration early.
*
* Return value: %TRUE to continue iterating or %FALSE to break iteration
* early.
*/
typedef gboolean (*ClutterForeachCallback) (ClutterActor *actor,
docs: Documentation fixes
2010-12-09 15:06:12 +00:00
gpointer user_data);
Clean up clutter-private.h/6 Move all Actor private API to a separate file.
2010-10-21 11:16:05 +00:00
actor: Add TransformInfo ClutterTransformInfo is a (private) ancillary data structure that contains all the decomposed transformation data, i.e. rotation angles and centers, scale factors and centers, and anchor point. This data structure is stored in the GData of the actor instance instead of the actor's private data. This change gives us: • a smaller, cleaner private data structure; • no size penalty for untransformed actors; • static constant storage for the defaults, shared across all instances; • cache locality for all the decomposed transformation data, given that the structure size is smaller. At the end of the day, the only authoritative piece of information for actor transformation is the CoglMatrix that we initialize in apply_transform() from all the decomposed parameters, and that can stay inside the private data structure of ClutterActor.
2011-12-09 14:38:25 +00:00
typedef struct _AnchorCoord AnchorCoord;
typedef struct _SizeRequest SizeRequest;
actor: Adjust the allocation prior to call allocate() ClutterActor has various properties controlling the allocation: - x-align, y-align - margin-top, margin-bottom, margin-left, margin-right These properties should adjust the ClutterActorBox passed from the parent actor to its children when calling clutter_actor_allocate(), so that the child can just allocate its children at the right origin with the right available size.
2011-11-23 18:16:29 +00:00
typedef struct _ClutterLayoutInfo ClutterLayoutInfo;
actor: Add TransformInfo ClutterTransformInfo is a (private) ancillary data structure that contains all the decomposed transformation data, i.e. rotation angles and centers, scale factors and centers, and anchor point. This data structure is stored in the GData of the actor instance instead of the actor's private data. This change gives us: • a smaller, cleaner private data structure; • no size penalty for untransformed actors; • static constant storage for the defaults, shared across all instances; • cache locality for all the decomposed transformation data, given that the structure size is smaller. At the end of the day, the only authoritative piece of information for actor transformation is the CoglMatrix that we initialize in apply_transform() from all the decomposed parameters, and that can stay inside the private data structure of ClutterActor.
2011-12-09 14:38:25 +00:00
typedef struct _ClutterTransformInfo ClutterTransformInfo;
actor: Implement implicit animatable properties Clutter is meant to be, and I quote from the README, a toolkit: for creating fast, compelling, portable, and dynamic graphical user interfaces and yet the default mode of operation for setting an actor's state on the scene graph (position, size, opacity, rotation, scaling, depth, etc.) is *not* dynamic. We assume a static UI, and then animate it. This is the wrong way to design an API for a toolkit meant to be used to create animated user interfaces. The default mode of operation should be to implicitly animate every state transition, and only allow skipping the animation if the user consciously decides to do so — i.e. the design tenet of the API should be to make The Right Thing™ by default, and make it really hard (or even impossible) to do The Wrong Thing™. So we should identify "animatable" properties, i.e. those properties that should be implicitly animated by ClutterActor, and use the animation framework we provide to tween the transitions between the current state and the desired state; the implicit animation should happen when setting these properties using the public accessors, and not through some added functionality. For instance, the following: clutter_actor_set_position (actor, newX, newY); should not make the actor jump to the (newX, newY) point; it should tween the actor's position between the current point and the desired point. Since we have to maintain backward compatibility with existing applications, we still need to mark the transitions explicitly, but we can be smart about it, and treat transition states as a stack that can be pushed and popped, e.g.: clutter_actor_save_easing_state (actor); clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_position (actor, newX, newY); clutter_actor_set_opacity (actor, newOpacity); clutter_actor_restore_easing_state (actor); And we can even start stacking animations, e.g.: clutter_actor_save_easing_state (actor); clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_position (actor, newX, newY); clutter_actor_save_easing_state (actor); clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_easing_mode (actor, CLUTTER_LINEAR); clutter_actor_set_opacity (actor, newOpacity); clutter_actor_set_depth (actor, newDepth); clutter_actor_restore_easing_state (actor); clutter_actor_restore_easing_state (actor); And so on, and so forth. The implementation takes advantage of the newly added Transition API, which uses only ClutterTimeline sub-classes and ClutterInterval, to cut down the amount of signal emissions and memory management of object instances; as well of using the ClutterAnimatable interface for custom properties and interpolation of values.
2012-03-15 11:09:11 +00:00
typedef struct _ClutterAnimationInfo ClutterAnimationInfo;
actor: Add TransformInfo ClutterTransformInfo is a (private) ancillary data structure that contains all the decomposed transformation data, i.e. rotation angles and centers, scale factors and centers, and anchor point. This data structure is stored in the GData of the actor instance instead of the actor's private data. This change gives us: • a smaller, cleaner private data structure; • no size penalty for untransformed actors; • static constant storage for the defaults, shared across all instances; • cache locality for all the decomposed transformation data, given that the structure size is smaller. At the end of the day, the only authoritative piece of information for actor transformation is the CoglMatrix that we initialize in apply_transform() from all the decomposed parameters, and that can stay inside the private data structure of ClutterActor.
2011-12-09 14:38:25 +00:00
/* Internal helper struct to represent a point that can be stored in
either direct pixel coordinates or as a fraction of the actor's
size. It is used for the anchor point, scale center and rotation
centers. */
struct _AnchorCoord
{
gboolean is_fractional;
union
{
/* Used when is_fractional == TRUE */
struct
{
gdouble x;
gdouble y;
} fraction;
/* Use when is_fractional == FALSE */
ClutterVertex units;
} v;
};
struct _SizeRequest
{
guint age;
gfloat for_size;
gfloat min_size;
gfloat natural_size;
};
actor: Adjust the allocation prior to call allocate() ClutterActor has various properties controlling the allocation: - x-align, y-align - margin-top, margin-bottom, margin-left, margin-right These properties should adjust the ClutterActorBox passed from the parent actor to its children when calling clutter_actor_allocate(), so that the child can just allocate its children at the right origin with the right available size.
2011-11-23 18:16:29 +00:00
/*< private >
* ClutterLayoutInfo:
actor: Add basic automatic expand flags The :x-expand and :y-expand flags on ClutterActor are used to signal that an actor should expand horizontally and/or vertically - i.e. that its parent's layout management policy should try to assign extra space to the actor when allocating it. The expand flags are automatic: when set on a leaf node in the actor tree, they will bubble up through the parent and grandparents up to the top level actor; during allocation, the actors with children will lazily compute whether their children needs to expand.
2012-03-27 13:53:27 +00:00
* @fixed_pos: the fixed position of the actor
actor: Adjust the allocation prior to call allocate() ClutterActor has various properties controlling the allocation: - x-align, y-align - margin-top, margin-bottom, margin-left, margin-right These properties should adjust the ClutterActorBox passed from the parent actor to its children when calling clutter_actor_allocate(), so that the child can just allocate its children at the right origin with the right available size.
2011-11-23 18:16:29 +00:00
* @margin: the composed margin of the actor
* @x_align: the horizontal alignment, if the actor expands horizontally
* @y_align: the vertical alignment, if the actor expands vertically
actor: Add basic automatic expand flags The :x-expand and :y-expand flags on ClutterActor are used to signal that an actor should expand horizontally and/or vertically - i.e. that its parent's layout management policy should try to assign extra space to the actor when allocating it. The expand flags are automatic: when set on a leaf node in the actor tree, they will bubble up through the parent and grandparents up to the top level actor; during allocation, the actors with children will lazily compute whether their children needs to expand.
2012-03-27 13:53:27 +00:00
* @x_expand: whether the actor should expand horizontally
* @y_expand: whether the actor should expand vertically
* @minimum: the fixed minimum size
* @natural: the fixed natural size
actor: Adjust the allocation prior to call allocate() ClutterActor has various properties controlling the allocation: - x-align, y-align - margin-top, margin-bottom, margin-left, margin-right These properties should adjust the ClutterActorBox passed from the parent actor to its children when calling clutter_actor_allocate(), so that the child can just allocate its children at the right origin with the right available size.
2011-11-23 18:16:29 +00:00
*
* Ancillary layout information for an actor.
*/
struct _ClutterLayoutInfo
{
/* fixed position coordinates */
actor: Use ClutterPoint for the fixed position
2012-03-30 17:43:59 +00:00
ClutterPoint fixed_pos;
actor: Adjust the allocation prior to call allocate() ClutterActor has various properties controlling the allocation: - x-align, y-align - margin-top, margin-bottom, margin-left, margin-right These properties should adjust the ClutterActorBox passed from the parent actor to its children when calling clutter_actor_allocate(), so that the child can just allocate its children at the right origin with the right available size.
2011-11-23 18:16:29 +00:00
ClutterMargin margin;
guint x_align : 4;
guint y_align : 4;
actor: Store the fixed sizes into LayoutInfo Remove four more floats from ClutterActorPrivate. The fixed minimum and natural sizes should be stored inside the ClutterLayoutInfo structure, along with the fixed position.
2011-11-24 14:13:29 +00:00
actor: Add basic automatic expand flags The :x-expand and :y-expand flags on ClutterActor are used to signal that an actor should expand horizontally and/or vertically - i.e. that its parent's layout management policy should try to assign extra space to the actor when allocating it. The expand flags are automatic: when set on a leaf node in the actor tree, they will bubble up through the parent and grandparents up to the top level actor; during allocation, the actors with children will lazily compute whether their children needs to expand.
2012-03-27 13:53:27 +00:00
guint x_expand : 1;
guint y_expand : 1;
actor: Use ClutterSize for minimum and natural fixed sizes
2012-03-30 17:53:22 +00:00
ClutterSize minimum;
ClutterSize natural;
actor: Adjust the allocation prior to call allocate() ClutterActor has various properties controlling the allocation: - x-align, y-align - margin-top, margin-bottom, margin-left, margin-right These properties should adjust the ClutterActorBox passed from the parent actor to its children when calling clutter_actor_allocate(), so that the child can just allocate its children at the right origin with the right available size.
2011-11-23 18:16:29 +00:00
};
const ClutterLayoutInfo * _clutter_actor_get_layout_info_or_defaults (ClutterActor *self);
ClutterLayoutInfo * _clutter_actor_get_layout_info (ClutterActor *self);
Add _clutter_actor_peek_layout_info This will be needed later to get a layout_info without creating one if there is none already.
2012-06-07 14:31:22 +00:00
ClutterLayoutInfo * _clutter_actor_peek_layout_info (ClutterActor *self);
actor: Adjust the allocation prior to call allocate() ClutterActor has various properties controlling the allocation: - x-align, y-align - margin-top, margin-bottom, margin-left, margin-right These properties should adjust the ClutterActorBox passed from the parent actor to its children when calling clutter_actor_allocate(), so that the child can just allocate its children at the right origin with the right available size.
2011-11-23 18:16:29 +00:00
actor: Add TransformInfo ClutterTransformInfo is a (private) ancillary data structure that contains all the decomposed transformation data, i.e. rotation angles and centers, scale factors and centers, and anchor point. This data structure is stored in the GData of the actor instance instead of the actor's private data. This change gives us: • a smaller, cleaner private data structure; • no size penalty for untransformed actors; • static constant storage for the defaults, shared across all instances; • cache locality for all the decomposed transformation data, given that the structure size is smaller. At the end of the day, the only authoritative piece of information for actor transformation is the CoglMatrix that we initialize in apply_transform() from all the decomposed parameters, and that can stay inside the private data structure of ClutterActor.
2011-12-09 14:38:25 +00:00
struct _ClutterTransformInfo
{
/* rotation (angle and center) */
gdouble rx_angle;
gdouble ry_angle;
gdouble rz_angle;
/* scaling */
gdouble scale_x;
gdouble scale_y;
actor: Add scaling factor in the Z axis Having a scaling factor on the Z axis helps with projects that use fully 3D elements, like Mash. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-09 09:59:13 +00:00
gdouble scale_z;
actor: Implement implicit animatable properties Clutter is meant to be, and I quote from the README, a toolkit: for creating fast, compelling, portable, and dynamic graphical user interfaces and yet the default mode of operation for setting an actor's state on the scene graph (position, size, opacity, rotation, scaling, depth, etc.) is *not* dynamic. We assume a static UI, and then animate it. This is the wrong way to design an API for a toolkit meant to be used to create animated user interfaces. The default mode of operation should be to implicitly animate every state transition, and only allow skipping the animation if the user consciously decides to do so — i.e. the design tenet of the API should be to make The Right Thing™ by default, and make it really hard (or even impossible) to do The Wrong Thing™. So we should identify "animatable" properties, i.e. those properties that should be implicitly animated by ClutterActor, and use the animation framework we provide to tween the transitions between the current state and the desired state; the implicit animation should happen when setting these properties using the public accessors, and not through some added functionality. For instance, the following: clutter_actor_set_position (actor, newX, newY); should not make the actor jump to the (newX, newY) point; it should tween the actor's position between the current point and the desired point. Since we have to maintain backward compatibility with existing applications, we still need to mark the transitions explicitly, but we can be smart about it, and treat transition states as a stack that can be pushed and popped, e.g.: clutter_actor_save_easing_state (actor); clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_position (actor, newX, newY); clutter_actor_set_opacity (actor, newOpacity); clutter_actor_restore_easing_state (actor); And we can even start stacking animations, e.g.: clutter_actor_save_easing_state (actor); clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_position (actor, newX, newY); clutter_actor_save_easing_state (actor); clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_easing_mode (actor, CLUTTER_LINEAR); clutter_actor_set_opacity (actor, newOpacity); clutter_actor_set_depth (actor, newDepth); clutter_actor_restore_easing_state (actor); clutter_actor_restore_easing_state (actor); And so on, and so forth. The implementation takes advantage of the newly added Transition API, which uses only ClutterTimeline sub-classes and ClutterInterval, to cut down the amount of signal emissions and memory management of object instances; as well of using the ClutterAnimatable interface for custom properties and interpolation of values.
2012-03-15 11:09:11 +00:00
actor: Add translation transformation We need an alternative to the translation performed by the anchor point, one that possibly applies to all three axes and is relative to the pivot-point. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 16:31:52 +00:00
/* translation */
ClutterVertex translation;
actor: Add :z-position and deprecate :depth The ClutterActor:depth property has always been a bit of a misnomer: actors are 2D flat surfaces, so they cannot have "depth"; the property defines the position on the Z axis. Another side effect of the :depth property is that it decides the default paint and allocation order on insertion, and that setting it will call the ClutterContainer.sort_depth_order() method. This has proven to be a fairly bad design decision that we strung along from the 0.x days, as it gives a false impression of being able to change the paint and allocation order simply by changing the position on the Z axis — something that, in reality, requires depth testing to be enabled during the paint sequence of an actor's parent. For 2.0 we need a clean break from the side effects, and a better defined interface. ClutterActor:z-position is essentially what ClutterActor:depth is, but doesn't call into ClutterContainer, and has a more apt name. https://bugzilla.gnome.org/show_bug.cgi?id=679465
2012-07-05 17:57:38 +00:00
/* z_position */
gfloat z_position;
actor: Add pivot point The pivot point is a point in normalized coordinates space around which all transformations revolve. It supercedes the anchor point and the per-transformation center points as well as the gravity settings, and tries to sort out the mess that is the modelview matrix set up in ClutterActor. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 09:35:13 +00:00
/* transformation center */
ClutterPoint pivot;
actor: Add :pivot-point-z For some transformations we need to be able to set the Z component of the pivot point. Unlike :pivot-point, the Z coordinate is not normalized because actors are 2D surfaces. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 13:28:48 +00:00
gfloat pivot_z;
Add ClutterActor.transform The :transform property controls the modelview matrix of an actor; it can be used to set a custom modelview matrix on the actor, as opposed to the decomposed transformations (rotation, scaling, translation) provided by the ClutterActor class.
2012-07-20 20:56:43 +00:00
CoglMatrix transform;
guint transform_set : 1;
actor: Add the :child-transform property An additional transformation that is applied to the children of an actor before their own transformations, but not to the actor itself.
2012-08-16 16:10:50 +00:00
CoglMatrix child_transform;
guint child_transform_set : 1;
actor: Add TransformInfo ClutterTransformInfo is a (private) ancillary data structure that contains all the decomposed transformation data, i.e. rotation angles and centers, scale factors and centers, and anchor point. This data structure is stored in the GData of the actor instance instead of the actor's private data. This change gives us: • a smaller, cleaner private data structure; • no size penalty for untransformed actors; • static constant storage for the defaults, shared across all instances; • cache locality for all the decomposed transformation data, given that the structure size is smaller. At the end of the day, the only authoritative piece of information for actor transformation is the CoglMatrix that we initialize in apply_transform() from all the decomposed parameters, and that can stay inside the private data structure of ClutterActor.
2011-12-09 14:38:25 +00:00
};
const ClutterTransformInfo * _clutter_actor_get_transform_info_or_defaults (ClutterActor *self);
ClutterTransformInfo * _clutter_actor_get_transform_info (ClutterActor *self);
actor: Implement implicit animatable properties Clutter is meant to be, and I quote from the README, a toolkit: for creating fast, compelling, portable, and dynamic graphical user interfaces and yet the default mode of operation for setting an actor's state on the scene graph (position, size, opacity, rotation, scaling, depth, etc.) is *not* dynamic. We assume a static UI, and then animate it. This is the wrong way to design an API for a toolkit meant to be used to create animated user interfaces. The default mode of operation should be to implicitly animate every state transition, and only allow skipping the animation if the user consciously decides to do so — i.e. the design tenet of the API should be to make The Right Thing™ by default, and make it really hard (or even impossible) to do The Wrong Thing™. So we should identify "animatable" properties, i.e. those properties that should be implicitly animated by ClutterActor, and use the animation framework we provide to tween the transitions between the current state and the desired state; the implicit animation should happen when setting these properties using the public accessors, and not through some added functionality. For instance, the following: clutter_actor_set_position (actor, newX, newY); should not make the actor jump to the (newX, newY) point; it should tween the actor's position between the current point and the desired point. Since we have to maintain backward compatibility with existing applications, we still need to mark the transitions explicitly, but we can be smart about it, and treat transition states as a stack that can be pushed and popped, e.g.: clutter_actor_save_easing_state (actor); clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_position (actor, newX, newY); clutter_actor_set_opacity (actor, newOpacity); clutter_actor_restore_easing_state (actor); And we can even start stacking animations, e.g.: clutter_actor_save_easing_state (actor); clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_position (actor, newX, newY); clutter_actor_save_easing_state (actor); clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_easing_mode (actor, CLUTTER_LINEAR); clutter_actor_set_opacity (actor, newOpacity); clutter_actor_set_depth (actor, newDepth); clutter_actor_restore_easing_state (actor); clutter_actor_restore_easing_state (actor); And so on, and so forth. The implementation takes advantage of the newly added Transition API, which uses only ClutterTimeline sub-classes and ClutterInterval, to cut down the amount of signal emissions and memory management of object instances; as well of using the ClutterAnimatable interface for custom properties and interpolation of values.
2012-03-15 11:09:11 +00:00
typedef struct _AState {
guint easing_duration;
actor: Add delay to the easing state It should be possible to set up the delay of a transition, but since we start the Transition instance before returning control to the caller, we cannot use clutter_actor_get_transition() to do it without something extra-awkward, like: transition = clutter_actor_get_transition (actor, "width"); clutter_timeline_stop (transition); clutter_timeline_set_delay (transition, 1000); clutter_timeline_start (transition); for each property involved. It's much easier to add a delay to the easing state of an actor.
2012-03-15 12:24:02 +00:00
guint easing_delay;
actor: Implement implicit animatable properties Clutter is meant to be, and I quote from the README, a toolkit: for creating fast, compelling, portable, and dynamic graphical user interfaces and yet the default mode of operation for setting an actor's state on the scene graph (position, size, opacity, rotation, scaling, depth, etc.) is *not* dynamic. We assume a static UI, and then animate it. This is the wrong way to design an API for a toolkit meant to be used to create animated user interfaces. The default mode of operation should be to implicitly animate every state transition, and only allow skipping the animation if the user consciously decides to do so — i.e. the design tenet of the API should be to make The Right Thing™ by default, and make it really hard (or even impossible) to do The Wrong Thing™. So we should identify "animatable" properties, i.e. those properties that should be implicitly animated by ClutterActor, and use the animation framework we provide to tween the transitions between the current state and the desired state; the implicit animation should happen when setting these properties using the public accessors, and not through some added functionality. For instance, the following: clutter_actor_set_position (actor, newX, newY); should not make the actor jump to the (newX, newY) point; it should tween the actor's position between the current point and the desired point. Since we have to maintain backward compatibility with existing applications, we still need to mark the transitions explicitly, but we can be smart about it, and treat transition states as a stack that can be pushed and popped, e.g.: clutter_actor_save_easing_state (actor); clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_position (actor, newX, newY); clutter_actor_set_opacity (actor, newOpacity); clutter_actor_restore_easing_state (actor); And we can even start stacking animations, e.g.: clutter_actor_save_easing_state (actor); clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_position (actor, newX, newY); clutter_actor_save_easing_state (actor); clutter_actor_set_easing_duration (actor, 500); clutter_actor_set_easing_mode (actor, CLUTTER_LINEAR); clutter_actor_set_opacity (actor, newOpacity); clutter_actor_set_depth (actor, newDepth); clutter_actor_restore_easing_state (actor); clutter_actor_restore_easing_state (actor); And so on, and so forth. The implementation takes advantage of the newly added Transition API, which uses only ClutterTimeline sub-classes and ClutterInterval, to cut down the amount of signal emissions and memory management of object instances; as well of using the ClutterAnimatable interface for custom properties and interpolation of values.
2012-03-15 11:09:11 +00:00
ClutterAnimationMode easing_mode;
} AState;
struct _ClutterAnimationInfo
{
GArray *states;
AState *cur_state;
GHashTable *transitions;
};
Clean up the Actor private header Reading it is getting painful.
2013-03-07 11:23:39 +00:00
const ClutterAnimationInfo * _clutter_actor_get_animation_info_or_defaults (ClutterActor *self);
ClutterAnimationInfo * _clutter_actor_get_animation_info (ClutterActor *self);
ClutterTransition * _clutter_actor_create_transition (ClutterActor *self,
GParamSpec *pspec,
...);
ClutterTransition * _clutter_actor_get_transition (ClutterActor *self,
GParamSpec *pspec);
gboolean _clutter_actor_foreach_child (ClutterActor *self,
ClutterForeachCallback callback,
gpointer user_data);
void _clutter_actor_traverse (ClutterActor *actor,
ClutterActorTraverseFlags flags,
ClutterTraverseCallback before_children_callback,
ClutterTraverseCallback after_children_callback,
gpointer user_data);
ClutterActor * _clutter_actor_get_stage_internal (ClutterActor *actor);
void _clutter_actor_apply_modelview_transform (ClutterActor *self,
CoglMatrix *matrix);
void _clutter_actor_apply_relative_transformation_matrix (ClutterActor *self,
ClutterActor *ancestor,
CoglMatrix *matrix);
void _clutter_actor_rerealize (ClutterActor *self,
ClutterCallback callback,
gpointer data);
void _clutter_actor_set_opacity_override (ClutterActor *self,
gint opacity);
gint _clutter_actor_get_opacity_override (ClutterActor *self);
void _clutter_actor_set_in_clone_paint (ClutterActor *self,
gboolean is_in_clone_paint);
void _clutter_actor_set_enable_model_view_transform (ClutterActor *self,
gboolean enable);
void _clutter_actor_set_enable_paint_unmapped (ClutterActor *self,
gboolean enable);
void _clutter_actor_set_has_pointer (ClutterActor *self,
gboolean has_pointer);
void _clutter_actor_queue_redraw_with_clip (ClutterActor *self,
ClutterRedrawFlags flags,
ClutterPaintVolume *clip_volume);
void _clutter_actor_queue_redraw_full (ClutterActor *self,
ClutterRedrawFlags flags,
ClutterPaintVolume *volume,
ClutterEffect *effect);
ClutterPaintVolume * _clutter_actor_get_queue_redraw_clip (ClutterActor *self);
void _clutter_actor_set_queue_redraw_clip (ClutterActor *self,
ClutterPaintVolume *clip_volume);
void _clutter_actor_finish_queue_redraw (ClutterActor *self,
ClutterPaintVolume *clip);
gboolean _clutter_actor_set_default_paint_volume (ClutterActor *self,
GType check_gtype,
ClutterPaintVolume *volume);
const gchar * _clutter_actor_get_debug_name (ClutterActor *self);
void _clutter_actor_push_clone_paint (void);
void _clutter_actor_pop_clone_paint (void);
guint32 _clutter_actor_get_pick_id (ClutterActor *self);
void _clutter_actor_shader_pre_paint (ClutterActor *actor,
gboolean repeat);
void _clutter_actor_shader_post_paint (ClutterActor *actor);
ClutterActorAlign _clutter_actor_get_effective_x_align (ClutterActor *self);
void _clutter_actor_handle_event (ClutterActor *actor,
const ClutterEvent *event);
actor: Move event chain emission into ClutterActor By moving the function that builds the event emission chain we can avoid a bunch of checks and function calls.
2012-06-24 08:58:12 +00:00
actor: Keep track of clones Instead of using signal notifications, we should be able to keep track of the clones of an actor from within ClutterActor itself, using private API. There's no point in pretending that people can actually create a Clone class out of tree, given the amount of invariants we have to punch through in order to implement a proper replicator node of the scene graph, so we can just skip the signal emissions and just do the right thing at the right time.
2013-03-07 18:09:33 +00:00
void _clutter_actor_attach_clone (ClutterActor *actor,
ClutterActor *clone);
void _clutter_actor_detach_clone (ClutterActor *actor,
ClutterActor *clone);
void _clutter_actor_queue_redraw_on_clones (ClutterActor *actor);
void _clutter_actor_queue_relayout_on_clones (ClutterActor *actor);
Bind constraints: Don't force redraws on source relayout When the source actor potentially changes size, that shouldn't necessarily result in the target actor being redrawn - it should be like when a child of a container is reallocated due to changes in its siblings or parent - it should redraw only to the extent that it is moved and resized. Privately export an internal function from clutter-actor.c to allow getting this right. https://bugzilla.gnome.org/show_bug.cgi?id=719367 Conflicts: clutter/clutter-actor.c
2013-11-22 15:30:21 +00:00
void _clutter_actor_queue_only_relayout (ClutterActor *actor);
actor: Keep track of clones Instead of using signal notifications, we should be able to keep track of the clones of an actor from within ClutterActor itself, using private API. There's no point in pretending that people can actually create a Clone class out of tree, given the amount of invariants we have to punch through in order to implement a proper replicator node of the scene graph, so we can just skip the signal emissions and just do the right thing at the right time.
2013-03-07 18:09:33 +00:00
Clean up clutter-private.h/6 Move all Actor private API to a separate file.
2010-10-21 11:16:05 +00:00
G_END_DECLS
#endif /* __CLUTTER_ACTOR_PRIVATE_H__ */
Reference in New Issue Copy Permalink