Class

ClutterPanGesture

Description [src]

final class Clutter.PanGesture : Clutter.Gesture
{
  /* No available fields */
}

A ClutterGesture subclass for recognizing pan gestures.

Hierarchy

hierarchy this ClutterPanGesture ancestor_0 ClutterGesture ancestor_0--this ancestor_1 ClutterAction ancestor_1--ancestor_0 ancestor_2 ClutterActorMeta ancestor_2--ancestor_1 ancestor_3 GInitiallyUnowned ancestor_3--ancestor_2 ancestor_4 GObject ancestor_4--ancestor_3

Constructors

clutter_pan_gesture_new

Creates a new ClutterPanGesture instance.

Instance methods

clutter_pan_gesture_get_accumulated_delta

Retrieves the accumulated delta from all events (ie. the total delta that the pan has been moved) as accumulated_delta_out.

clutter_pan_gesture_get_begin_centroid

Retrieves the begin centroid of self.

clutter_pan_gesture_get_begin_centroid_abs

Retrieves the begin centroid of self in absolute coordinates.

clutter_pan_gesture_get_begin_threshold

Gets the movement threshold in pixels that begins the pan gesture.

clutter_pan_gesture_get_centroid

Retrieves the current centroid of the points active on self.

clutter_pan_gesture_get_centroid_abs

Retrieves the current centroid of the points active on self in absolute coordinates.

clutter_pan_gesture_get_delta

Retrieves the delta between the current ::pan-update signal emission and the one before as delta_out.

clutter_pan_gesture_get_delta_abs
No description available.

clutter_pan_gesture_get_max_n_points

Gets the maximum number of points set by clutter_pan_gesture_set_max_n_points().

clutter_pan_gesture_get_min_n_points

Gets the minimum number of points set by clutter_pan_gesture_set_min_n_points().

clutter_pan_gesture_get_pan_axis

Retrieves the axis constraint set by clutter_pan_gesture_set_pan_axis().

clutter_pan_gesture_get_velocity

Retrieves the current velocity of the pan.

clutter_pan_gesture_get_velocity_abs
No description available.

clutter_pan_gesture_set_begin_threshold

Sets the movement threshold in pixels to begin the pan gesture.

clutter_pan_gesture_set_max_n_points

Sets the maximum number of points to use for the pan. Set to 0 to allow an unlimited number.

clutter_pan_gesture_set_min_n_points

Sets the minimum number of points for the gesture to start.

clutter_pan_gesture_set_pan_axis

Restricts the pan gesture to a specific axis.

Methods inherited from ClutterGesture (14)
clutter_gesture_can_not_cancel

In case self and other_gesture are operating on the same points, calling this function will make sure that self does not cancel other_gesture when self moves to state RECOGNIZING.

clutter_gesture_cancel

Cancels the gesture by setting its state to CANCELLED.

clutter_gesture_get_n_points

Retrieves the number of active points the gesture currently has.

clutter_gesture_get_point_begin_coords

Retrieves the begin coordinates of the point with index point_index.

clutter_gesture_get_point_begin_coords_abs
No description available.

clutter_gesture_get_point_coords

Retrieves the latest coordinates of the point with index point_index.

clutter_gesture_get_point_coords_abs
No description available.

clutter_gesture_get_point_event

Retrieves the the latest event of the point with index point_index.

clutter_gesture_get_point_previous_coords

Retrieves the previous coordinates of the point with index point_index.

clutter_gesture_get_point_previous_coords_abs
No description available.

clutter_gesture_get_points

Retrieves an array of the currently active points of the gesture, the array is ordered in the order the points were added in (newest to oldest).

clutter_gesture_get_state

Gets the current state of the gesture.

clutter_gesture_reset_state_machine
No description available.

clutter_gesture_set_state

Sets the state of the gesture. This method is private to gesture implementations.

Methods inherited from ClutterAction (1)
clutter_action_get_phase
No description available.

Methods inherited from ClutterActorMeta (5)
clutter_actor_meta_get_actor

Retrieves a pointer to the ClutterActor that owns meta.

clutter_actor_meta_get_enabled

Retrieves whether meta is enabled.

clutter_actor_meta_get_name

Retrieves the name set using clutter_actor_meta_set_name().

clutter_actor_meta_set_enabled

Sets whether meta should be enabled or not.

clutter_actor_meta_set_name

Sets the name of meta.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

Clutter.PanGesture:begin-threshold

The threshold in pixels that has to be panned for the gesture to start.

Clutter.PanGesture:max-n-points

The maximum number of points to use for the pan. Set to 0 to allow an unlimited number. Defaults to 0.

Clutter.PanGesture:min-n-points

The minimum number of points for the gesture to start, defaults to 1.

Clutter.PanGesture:pan-axis

Constraints the pan gesture to the specified axis.

Properties inherited from ClutterGesture (1)
Clutter.Gesture:state

The current state of the gesture.

Properties inherited from ClutterActorMeta (3)
Clutter.ActorMeta:actor

The ClutterActor attached to the ClutterActorMeta instance.

Clutter.ActorMeta:enabled

Whether or not the ClutterActorMeta is enabled.

Clutter.ActorMeta:name

The unique name to access the ClutterActorMeta.

Signals

Clutter.PanGesture::pan-update

The ::pan-update signal is emitted when one or multiple points of the pan have changed.

Signals inherited from ClutterGesture (5)
ClutterGesture::cancel

The ::cancel signal is emitted when a continuous gesture got cancelled.

ClutterGesture::end

The ::end signal is emitted when a continuous gesture ends.

ClutterGesture::may-recognize

The ::may-recognize signal is emitted if the gesture might become active and move to RECOGNIZING. Its purpose is to allow the implementation or a user of a gesture to prohibit the gesture from starting when needed.

ClutterGesture::recognize

The ::recognize signal is emitted when the gesture recognizes.

ClutterGesture::should-handle-sequence

The ::should-handle-sequence signal is emitted when a sequence gets added to the gesture. Return FALSE to make the gesture ignore the sequence of events.

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct ClutterPanGestureClass {
  ClutterGestureClass parent_class;
  
}

No description available.

Class members
parent_class: ClutterGestureClass

No description available.