Class

ClutterTapAction

Description [src]

class Clutter.TapAction : Clutter.GestureAction
{
  /* No available fields */
}

Action for tap gestures

ClutterTapAction is a sub-class of ClutterGestureAction that implements the logic for recognizing mouse clicks and touch tap gestures.

The simplest usage of ClutterTapAction consists in adding it to a ClutterActor, setting it as reactive and connecting a callback for the ClutterTapAction::tap signal, along the lines of the following code:

  clutter_actor_add_action (actor, clutter_tap_action_new ());
  clutter_actor_set_reactive (actor, TRUE);
  g_signal_connect (action, "tap", G_CALLBACK (on_tap_callback), NULL);

Hierarchy

hierarchy this ClutterTapAction ancestor_0 ClutterGestureAction 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_tap_action_new

Creates a new ClutterTapAction instance.

Instance methods

Methods inherited from ClutterGestureAction (16)
clutter_gesture_action_cancel

Cancel a ClutterGestureAction before it begins.

clutter_gesture_action_get_device

Retrieves the ClutterInputDevice of a touch point.

clutter_gesture_action_get_last_event

Retrieves a reference to the last ClutterEvent for a touch point. Call clutter_event_copy() if you need to store the reference somewhere.

clutter_gesture_action_get_motion_coords

Retrieves the coordinates, in stage space, of the latest motion event during the dragging.

clutter_gesture_action_get_motion_delta

Retrieves the incremental delta since the last motion event during the dragging.

clutter_gesture_action_get_n_current_points

Retrieves the number of points currently active.

clutter_gesture_action_get_n_touch_points

Retrieves the number of requested points to trigger the gesture.

clutter_gesture_action_get_press_coords

Retrieves the coordinates, in stage space, of the press event that started the dragging for a specific touch point.

clutter_gesture_action_get_release_coords

Retrieves the coordinates, in stage space, where the touch point was last released.

clutter_gesture_action_get_sequence

Retrieves the ClutterEventSequence of a touch point.

clutter_gesture_action_get_threshold_trigger_distance

Retrieves the threshold trigger distance of the gesture action, as set using clutter_gesture_action_set_threshold_trigger_distance().

clutter_gesture_action_get_threshold_trigger_edge

Retrieves the edge trigger of the gesture action, as set using clutter_gesture_action_set_threshold_trigger_edge().

clutter_gesture_action_get_velocity

Retrieves the velocity, in stage pixels per millisecond, of the latest motion event during the dragging.

clutter_gesture_action_set_n_touch_points

Sets the number of points needed to trigger the gesture.

clutter_gesture_action_set_threshold_trigger_distance

Sets the threshold trigger distance for the gesture drag threshold, if any.

clutter_gesture_action_set_threshold_trigger_edge

Sets the edge trigger for the gesture drag threshold, if any.

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

Properties inherited from ClutterGestureAction (4)
Clutter.GestureAction:n-touch-points

Number of touch points to trigger a gesture action.

Clutter.GestureAction:threshold-trigger-distance-x

The horizontal trigger distance to be used by the action to either emit the ClutterGestureAction::gesture-begin signal or to emit the ClutterGestureAction::gesture-cancel signal.

Clutter.GestureAction:threshold-trigger-distance-y

The vertical trigger distance to be used by the action to either emit the ClutterGestureAction::gesture-begin signal or to emit the ClutterGestureAction::gesture-cancel signal.

Clutter.GestureAction:threshold-trigger-edge

The trigger edge to be used by the action to either emit the ClutterGestureAction::gesture-begin signal or to emit the ClutterGestureAction::gesture-cancel signal.

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.TapAction::tap

The signal is emitted when the tap gesture is complete.

Signals inherited from ClutterGestureAction (4)
ClutterGestureAction::gesture-begin

The signal is emitted when the ClutterActor to which a ClutterGestureAction has been applied starts receiving a gesture.

ClutterGestureAction::gesture-cancel

The signal is emitted when the ongoing gesture gets cancelled from the ClutterGestureAction::gesture-progress signal handler.

ClutterGestureAction::gesture-end

The signal is emitted at the end of the gesture gesture, when the pointer’s button is released.

ClutterGestureAction::gesture-progress

The signal is emitted for each motion event after the ClutterGestureAction::gesture-begin signal has been emitted.

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 ClutterTapActionClass {
  gboolean (* tap) (
    ClutterTapAction* action,
    ClutterActor* actor
  );
  
}

The ClutterTapActionClass structure contains only private data.

Class members
tap: gboolean (* tap) ( ClutterTapAction* action, ClutterActor* actor )

Class handler for the ClutterTapAction::tap signal.

Virtual methods

Clutter.TapActionClass.tap

Class handler for the ClutterTapAction::tap signal.