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
8453807ce9
mutter/clutter/clutter-pan-action.h

148 lines
6.2 KiB
C
Raw Normal View History

pan-action: add PanAction, to handle panning in scrollable actors PanAction is a GestureAction-subclass that implements the panning concept for scrollable actors, with the ability to emit interpolated signals to emulate the kinetic inertia of the panning. PanAction provides: • pan signal, notifying users of the panning gesture status; • pan-stopped signal, emitted at the end of the interpolated phase of the panning gesture, if enabled; • pan-axis property, to allow constraining the dragging to a specific axis; • interpolated property, to enable or disable the inertial behaviour; • deceleration property, to customize the rate at which the momentum of the panning will be slowed down; • acceleration-factor property, applied to the inertial momentum when starting the interpolated sequence. An interactive test is also provided. https://bugzilla.gnome.org/show_bug.cgi?id=681648
2012-08-25 14:23:23 +00:00
/*
* Clutter.
*
* An OpenGL based 'interactive canvas' library.
*
* Copyright (C) 2010 Intel Corporation.
* Copyright (C) 2011 Robert Bosch Car Multimedia GmbH.
* Copyright (C) 2012 Collabora Ltd.
*
* 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/>.
*
* Author:
* Emanuele Aina <emanuele.aina@collabora.com>
*
* Based on ClutterDragAction, ClutterSwipeAction, and MxKineticScrollView,
* written by:
* Emmanuele Bassi <ebassi@linux.intel.com>
* Tomeu Vizoso <tomeu.vizoso@collabora.co.uk>
* Chris Lord <chris@linux.intel.com>
*/
#if !defined(__CLUTTER_H_INSIDE__) && !defined(CLUTTER_COMPILATION)
#error "Only <clutter/clutter.h> can be included directly."
#endif
#ifndef __CLUTTER_PAN_ACTION_H__
#define __CLUTTER_PAN_ACTION_H__
#include <clutter/clutter-gesture-action.h>
G_BEGIN_DECLS
#define CLUTTER_TYPE_PAN_ACTION (clutter_pan_action_get_type ())
#define CLUTTER_PAN_ACTION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CLUTTER_TYPE_PAN_ACTION, ClutterPanAction))
#define CLUTTER_IS_PAN_ACTION(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), CLUTTER_TYPE_PAN_ACTION))
#define CLUTTER_PAN_ACTION_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), CLUTTER_TYPE_PAN_ACTION, ClutterPanActionClass))
#define CLUTTER_IS_PAN_ACTION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), CLUTTER_TYPE_PAN_ACTION))
action: fix CLUTTER_GESTURE_ACTION_GET_CLASS() Fix the same cut'n'paste error fixed for GestureAction in 609766fa, this time in ClickAction, PanAction, RotateAction and SwipeAction. https://bugzilla.gnome.org/show_bug.cgi?id=683430
2012-09-11 17:20:19 +00:00
#define CLUTTER_PAN_ACTION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), CLUTTER_TYPE_PAN_ACTION, ClutterPanActionClass))
pan-action: add PanAction, to handle panning in scrollable actors PanAction is a GestureAction-subclass that implements the panning concept for scrollable actors, with the ability to emit interpolated signals to emulate the kinetic inertia of the panning. PanAction provides: • pan signal, notifying users of the panning gesture status; • pan-stopped signal, emitted at the end of the interpolated phase of the panning gesture, if enabled; • pan-axis property, to allow constraining the dragging to a specific axis; • interpolated property, to enable or disable the inertial behaviour; • deceleration property, to customize the rate at which the momentum of the panning will be slowed down; • acceleration-factor property, applied to the inertial momentum when starting the interpolated sequence. An interactive test is also provided. https://bugzilla.gnome.org/show_bug.cgi?id=681648
2012-08-25 14:23:23 +00:00
typedef struct _ClutterPanAction ClutterPanAction;
typedef struct _ClutterPanActionPrivate ClutterPanActionPrivate;
typedef struct _ClutterPanActionClass ClutterPanActionClass;
/**
* ClutterPanAction:
*
docs: Remove last stray DocBook tags
2014-03-18 14:14:22 +00:00
* The #ClutterPanAction structure contains
pan-action: add PanAction, to handle panning in scrollable actors PanAction is a GestureAction-subclass that implements the panning concept for scrollable actors, with the ability to emit interpolated signals to emulate the kinetic inertia of the panning. PanAction provides: • pan signal, notifying users of the panning gesture status; • pan-stopped signal, emitted at the end of the interpolated phase of the panning gesture, if enabled; • pan-axis property, to allow constraining the dragging to a specific axis; • interpolated property, to enable or disable the inertial behaviour; • deceleration property, to customize the rate at which the momentum of the panning will be slowed down; • acceleration-factor property, applied to the inertial momentum when starting the interpolated sequence. An interactive test is also provided. https://bugzilla.gnome.org/show_bug.cgi?id=681648
2012-08-25 14:23:23 +00:00
* only private data and should be accessed using the provided API
*
* Since: 1.12
*/
struct _ClutterPanAction
{
/*< private >*/
ClutterGestureAction parent_instance;
ClutterPanActionPrivate *priv;
};
/**
* ClutterPanActionClass:
* @pan: class handler for the #ClutterPanAction::pan signal
* @pan_stopped: class handler for the #ClutterPanAction::pan-stopped signal
*
docs: Remove last stray DocBook tags
2014-03-18 14:14:22 +00:00
* The #ClutterPanActionClass structure contains
pan-action: add PanAction, to handle panning in scrollable actors PanAction is a GestureAction-subclass that implements the panning concept for scrollable actors, with the ability to emit interpolated signals to emulate the kinetic inertia of the panning. PanAction provides: • pan signal, notifying users of the panning gesture status; • pan-stopped signal, emitted at the end of the interpolated phase of the panning gesture, if enabled; • pan-axis property, to allow constraining the dragging to a specific axis; • interpolated property, to enable or disable the inertial behaviour; • deceleration property, to customize the rate at which the momentum of the panning will be slowed down; • acceleration-factor property, applied to the inertial momentum when starting the interpolated sequence. An interactive test is also provided. https://bugzilla.gnome.org/show_bug.cgi?id=681648
2012-08-25 14:23:23 +00:00
* only private data.
*
* Since: 1.12
*/
struct _ClutterPanActionClass
{
/*< private >*/
ClutterGestureActionClass parent_class;
/*< public >*/
gboolean (* pan) (ClutterPanAction *action,
ClutterActor *actor,
gboolean is_interpolated);
void (* pan_stopped) (ClutterPanAction *action,
ClutterActor *actor);
/*< private >*/
void (* _clutter_pan_action1) (void);
void (* _clutter_pan_action2) (void);
void (* _clutter_pan_action3) (void);
void (* _clutter_pan_action4) (void);
void (* _clutter_pan_action5) (void);
void (* _clutter_pan_action6) (void);
};
CLUTTER_AVAILABLE_IN_1_12
GType clutter_pan_action_get_type (void) G_GNUC_CONST;
CLUTTER_AVAILABLE_IN_1_12
ClutterAction * clutter_pan_action_new (void);
CLUTTER_AVAILABLE_IN_1_12
void clutter_pan_action_set_pan_axis (ClutterPanAction *self,
ClutterPanAxis axis);
CLUTTER_AVAILABLE_IN_1_12
ClutterPanAxis clutter_pan_action_get_pan_axis (ClutterPanAction *self);
CLUTTER_AVAILABLE_IN_1_12
void clutter_pan_action_set_interpolate (ClutterPanAction *self,
gboolean should_interpolate);
CLUTTER_AVAILABLE_IN_1_12
gboolean clutter_pan_action_get_interpolate (ClutterPanAction *self);
CLUTTER_AVAILABLE_IN_1_12
void clutter_pan_action_set_deceleration (ClutterPanAction *self,
gdouble rate);
CLUTTER_AVAILABLE_IN_1_12
gdouble clutter_pan_action_get_deceleration (ClutterPanAction *self);
CLUTTER_AVAILABLE_IN_1_12
void clutter_pan_action_set_acceleration_factor (ClutterPanAction *self,
gdouble factor);
CLUTTER_AVAILABLE_IN_1_12
gdouble clutter_pan_action_get_acceleration_factor (ClutterPanAction *self);
CLUTTER_AVAILABLE_IN_1_12
void clutter_pan_action_get_interpolated_coords (ClutterPanAction *self,
gfloat *interpolated_x,
gfloat *interpolated_y);
CLUTTER_AVAILABLE_IN_1_12
pan-action: Add a simple convenience function to retrieve delta/coords This is a simple helper designed to ease the implementation of alternate implementations of the "pan" signal handler. https://bugzilla.gnome.org/show_bug.cgi?id=689061
2012-11-26 04:11:45 +00:00
gfloat clutter_pan_action_get_interpolated_delta (ClutterPanAction *self,
pan-action: add PanAction, to handle panning in scrollable actors PanAction is a GestureAction-subclass that implements the panning concept for scrollable actors, with the ability to emit interpolated signals to emulate the kinetic inertia of the panning. PanAction provides: • pan signal, notifying users of the panning gesture status; • pan-stopped signal, emitted at the end of the interpolated phase of the panning gesture, if enabled; • pan-axis property, to allow constraining the dragging to a specific axis; • interpolated property, to enable or disable the inertial behaviour; • deceleration property, to customize the rate at which the momentum of the panning will be slowed down; • acceleration-factor property, applied to the inertial momentum when starting the interpolated sequence. An interactive test is also provided. https://bugzilla.gnome.org/show_bug.cgi?id=681648
2012-08-25 14:23:23 +00:00
gfloat *delta_x,
gfloat *delta_y);
pan-action: Add a simple convenience function to retrieve delta/coords This is a simple helper designed to ease the implementation of alternate implementations of the "pan" signal handler. https://bugzilla.gnome.org/show_bug.cgi?id=689061
2012-11-26 04:11:45 +00:00
CLUTTER_AVAILABLE_IN_1_14
gfloat clutter_pan_action_get_motion_delta (ClutterPanAction *self,
guint point,
gfloat *delta_x,
gfloat *delta_y);
CLUTTER_AVAILABLE_IN_1_14
void clutter_pan_action_get_motion_coords (ClutterPanAction *self,
guint point,
gfloat *motion_x,
gfloat *motion_y);
pan-action: add PanAction, to handle panning in scrollable actors PanAction is a GestureAction-subclass that implements the panning concept for scrollable actors, with the ability to emit interpolated signals to emulate the kinetic inertia of the panning. PanAction provides: • pan signal, notifying users of the panning gesture status; • pan-stopped signal, emitted at the end of the interpolated phase of the panning gesture, if enabled; • pan-axis property, to allow constraining the dragging to a specific axis; • interpolated property, to enable or disable the inertial behaviour; • deceleration property, to customize the rate at which the momentum of the panning will be slowed down; • acceleration-factor property, applied to the inertial momentum when starting the interpolated sequence. An interactive test is also provided. https://bugzilla.gnome.org/show_bug.cgi?id=681648
2012-08-25 14:23:23 +00:00
G_END_DECLS
#endif /* __CLUTTER_PAN_ACTION_H__ */
Reference in New Issue Copy Permalink