isa/mutter
1
0
Fork 0
mirror of https://github.com/brl/mutter.git synced 2024-12-12 06:10:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
e3259435f2
mutter/clutter/deprecated/clutter-actor.h

162 lines
9.4 KiB
C
Raw Normal View History

build: Add inclusion guards and license notices
2011-12-28 18:32:00 +00:00
/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Authored By Matthew Allum <mallum@openedhand.com>
*
* Copyright (C) 2006, 2007, 2008 OpenedHand Ltd
* Copyright (C) 2009, 2010 Intel Corp
*
* 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/>.
*/
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif
actor: Move deprecated symbols into separate headers The clutter-actor.h header is already pretty big, so let's try to keep the deprecated symbols out of it.
2011-11-02 12:47:46 +00:00
#ifndef __CLUTTER_ACTOR_DEPRECATED_H__
#define __CLUTTER_ACTOR_DEPRECATED_H__
#include <clutter/clutter-types.h>
G_BEGIN_DECLS
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_set_geometry (ClutterActor *self,
const ClutterGeometry *geometry);
actor: Move deprecated symbols into separate headers The clutter-actor.h header is already pretty big, so let's try to keep the deprecated symbols out of it.
2011-11-02 12:47:46 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10_FOR(clutter_actor_get_allocation_geometry)
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_get_geometry (ClutterActor *self,
ClutterGeometry *geometry);
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_8
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
guint32 clutter_actor_get_gid (ClutterActor *self);
actor: Deprecate [sg]et_geometry() These methods are short-hands for accessing the position and size, which are already shorthands for accessing the various dimensional and positional attributes. Plus, they use ClutterGeometry, which is a fairly bad data type for a rectangle.
2011-11-08 14:46:55 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_8
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
ClutterActor * clutter_get_actor_by_gid (guint32 id_);
actor: Move deprecated symbols into separate headers The clutter-actor.h header is already pretty big, so let's try to keep the deprecated symbols out of it.
2011-11-02 12:47:46 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10_FOR(clutter_actor_remove_child() and clutter_actor_add_child())
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_reparent (ClutterActor *self,
ClutterActor *new_parent);
actor: Deprecate the old parent modifiers The old API should not be used in newly written code; we have better methods for setting up and modifying the scene graph, now.
2011-12-18 21:18:27 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10_FOR(clutter_actor_add_child)
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_set_parent (ClutterActor *self,
ClutterActor *parent);
actor: Deprecate the old parent modifiers The old API should not be used in newly written code; we have better methods for setting up and modifying the scene graph, now.
2011-12-18 21:18:27 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10_FOR(clutter_actor_remove_child)
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_unparent (ClutterActor *self);
actor: Deprecate the old parent modifiers The old API should not be used in newly written code; we have better methods for setting up and modifying the scene graph, now.
2011-12-18 21:18:27 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10_FOR(clutter_actor_set_child_above_sibling)
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_raise (ClutterActor *self,
ClutterActor *below);
Deprecate the old raise/lower API We have a replacement in ClutterActor, now. The old ClutterContainer API needs to be deprecated, and the raise() and lower() virtual functions need a default implementation, so we can check for implementations overriding them, by using the diagnostic mode like we do for add(), remove(), and foreach(). The sort_depth_order() virtual function just doesn't do anything, as it should have been made ages ago. The Actor wrappers for the Container methods also need to be deprecated.
2011-12-27 18:57:32 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10_FOR(clutter_actor_set_child_below_sibling)
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_lower (ClutterActor *self,
ClutterActor *above);
Deprecate the old raise/lower API We have a replacement in ClutterActor, now. The old ClutterContainer API needs to be deprecated, and the raise() and lower() virtual functions need a default implementation, so we can check for implementations overriding them, by using the diagnostic mode like we do for add(), remove(), and foreach(). The sort_depth_order() virtual function just doesn't do anything, as it should have been made ages ago. The Actor wrappers for the Container methods also need to be deprecated.
2011-12-27 18:57:32 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10_FOR(clutter_actor_set_child_above_sibling() with NULL sibling)
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_raise_top (ClutterActor *self);
Deprecate the old raise/lower API We have a replacement in ClutterActor, now. The old ClutterContainer API needs to be deprecated, and the raise() and lower() virtual functions need a default implementation, so we can check for implementations overriding them, by using the diagnostic mode like we do for add(), remove(), and foreach(). The sort_depth_order() virtual function just doesn't do anything, as it should have been made ages ago. The Actor wrappers for the Container methods also need to be deprecated.
2011-12-27 18:57:32 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10_FOR(clutter_actor_set_child_below_sibling() with NULL sibling)
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_lower_bottom (ClutterActor *self);
Deprecate the old raise/lower API We have a replacement in ClutterActor, now. The old ClutterContainer API needs to be deprecated, and the raise() and lower() virtual functions need a default implementation, so we can check for implementations overriding them, by using the diagnostic mode like we do for add(), remove(), and foreach(). The sort_depth_order() virtual function just doesn't do anything, as it should have been made ages ago. The Actor wrappers for the Container methods also need to be deprecated.
2011-12-27 18:57:32 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_push_internal (ClutterActor *self);
actor: Deprecated push/pop internal methods The concept of "internal child" only meant anything when we had a separate API for containers and actors. Now that we plugged that particular hole, we can drop all the hacks we used to have in place to work around its design limitations.
2012-01-03 14:36:32 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_pop_internal (ClutterActor *self);
actor: Deprecated push/pop internal methods The concept of "internal child" only meant anything when we had a separate API for containers and actors. Now that we plugged that particular hole, we can drop all the hacks we used to have in place to work around its design limitations.
2012-01-03 14:36:32 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_show_all (ClutterActor *self);
actor: Deprecate show_all()/hide_all() The hide_all() method is pretty much pointless, as hiding an actor will automatically prevent its children from being painted. The show_all() method would only be marginally useful, if actors weren't set to be visible by default when added to another actor - which was the case when we introduced show_all() and hide_all().
2012-01-17 16:11:29 +00:00
Update the deprecation macros Use the new versioned macros instead of the generic ones.
2012-02-27 15:10:13 +00:00
CLUTTER_DEPRECATED_IN_1_10
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_hide_all (ClutterActor *self);
actor: Deprecate show_all()/hide_all() The hide_all() method is pretty much pointless, as hiding an actor will automatically prevent its children from being painted. The show_all() method would only be marginally useful, if actors weren't set to be visible by default when added to another actor - which was the case when we introduced show_all() and hide_all().
2012-01-17 16:11:29 +00:00
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
CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_actor_set_z_position)
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
void clutter_actor_set_depth (ClutterActor *self,
gfloat depth);
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
CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_actor_get_z_position)
actor: Deprecate rotation center properties The pivot point supercedes the per-axis center of rotation, including the one based on the gravity enumeration. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 10:58:19 +00:00
gfloat clutter_actor_get_depth (ClutterActor *self);
CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_actor_set_rotation_angle)
void clutter_actor_set_rotation (ClutterActor *self,
ClutterRotateAxis axis,
gdouble angle,
gfloat x,
gfloat y,
gfloat z);
CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_actor_set_rotation_angle and clutter_actor_set_pivot_point)
void clutter_actor_set_z_rotation_from_gravity (ClutterActor *self,
gdouble angle,
ClutterGravity gravity);
CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_actor_get_rotation_angle)
gdouble clutter_actor_get_rotation (ClutterActor *self,
ClutterRotateAxis axis,
gfloat *x,
gfloat *y,
gfloat *z);
CLUTTER_DEPRECATED_IN_1_12
ClutterGravity clutter_actor_get_z_rotation_gravity (ClutterActor *self);
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
actor: Deprecate scale center and gravity accessors The ClutterActor:pivot-point supercedes the scale center and gravity properties. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 11:14:44 +00:00
CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_actor_set_scale and clutter_actor_set_pivot_point)
void clutter_actor_set_scale_full (ClutterActor *self,
gdouble scale_x,
gdouble scale_y,
gfloat center_x,
gfloat center_y);
CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_actor_set_scale and clutter_actor_set_pivot_point)
void clutter_actor_set_scale_with_gravity (ClutterActor *self,
gdouble scale_x,
gdouble scale_y,
ClutterGravity gravity);
CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_actor_get_pivot_point)
void clutter_actor_get_scale_center (ClutterActor *self,
gfloat *center_x,
gfloat *center_y);
CLUTTER_DEPRECATED_IN_1_12_FOR(clutter_actor_get_pivot_point)
ClutterGravity clutter_actor_get_scale_gravity (ClutterActor *self);
actor: Deprecate anchor-point The pivot point and the translation transformation replace it completely. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 17:06:48 +00:00
CLUTTER_DEPRECATED_IN_1_12
void clutter_actor_set_anchor_point (ClutterActor *self,
gfloat anchor_x,
gfloat anchor_y);
CLUTTER_DEPRECATED_IN_1_12
void clutter_actor_move_anchor_point (ClutterActor *self,
gfloat anchor_x,
gfloat anchor_y);
CLUTTER_DEPRECATED_IN_1_12
void clutter_actor_get_anchor_point (ClutterActor *self,
gfloat *anchor_x,
gfloat *anchor_y);
CLUTTER_DEPRECATED_IN_1_12
ClutterGravity clutter_actor_get_anchor_point_gravity (ClutterActor *self);
CLUTTER_DEPRECATED_IN_1_12
void clutter_actor_set_anchor_point_from_gravity (ClutterActor *self,
ClutterGravity gravity);
CLUTTER_DEPRECATED_IN_1_12
void clutter_actor_move_anchor_point_from_gravity (ClutterActor *self,
ClutterGravity gravity);
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
CLUTTER_DEPRECATED_IN_1_12
void clutter_actor_get_transformation_matrix (ClutterActor *self,
ClutterMatrix *matrix);
actor: Deprecate anchor-point The pivot point and the translation transformation replace it completely. https://bugzilla.gnome.org/show_bug.cgi?id=677853
2012-07-06 17:06:48 +00:00
actor: Deprecate Geometry-related API We cannot fully deprecate Geometry, because ClutterActor and ClutterText are actually using the type in signals and properties; but we can deprecate the API that uses this type, so that 2.0 will be able to avoid it entirely.
2012-08-10 13:17:56 +00:00
CLUTTER_DEPRECATED_IN_1_12_FOR (clutter_actor_get_allocation_box)
void clutter_actor_get_allocation_geometry (ClutterActor *self,
ClutterGeometry *geom);
actor: Move deprecated symbols into separate headers The clutter-actor.h header is already pretty big, so let's try to keep the deprecated symbols out of it.
2011-11-02 12:47:46 +00:00
G_END_DECLS
#endif /* __CLUTTER_ACTOR_DEPRECATED_H__ */
Reference in New Issue Copy Permalink