Class: Clutter::PanAction

Inherits:
GestureAction show all
Defined in:
(unknown)

Overview

The Clutter::PanActionClass structure contains
only private data.

Instance Method Summary collapse

Methods inherited from GestureAction

#cancel, #get_device, #get_last_event, #get_press_coords, #get_release_coords, #get_sequence, #get_threshold_trigger_distance, #get_velocity, #n_current_points, #n_touch_points, #n_touch_points=, #set_threshold_trigger_distance, #threshold_trigger_distance_x, #threshold_trigger_distance_x=, #threshold_trigger_distance_y, #threshold_trigger_distance_y=, #threshold_trigger_edge, #threshold_trigger_edge=, #threshold_trigger_egde

Methods inherited from ActorMeta

#actor, #actor=, #enabled, #enabled=, #enabled?, #name, #name=

Constructor Details

#initialize ⇒ Clutter::Action

Creates a new Clutter::PanAction instance

Instance Method Details

#acceleration_factor ⇒ Float

The initial acceleration factor

The kinetic momentum measured at the time of releasing the pointer will
be multiplied by the factor specified by this property before being used
to generate interpolated ::pan events.

Returns:

  • (Float) —

    acceleration-factor

#acceleration_factor=(acceleration_factor) ⇒ Float

The initial acceleration factor

The kinetic momentum measured at the time of releasing the pointer will
be multiplied by the factor specified by this property before being used
to generate interpolated ::pan events.

Parameters:

  • acceleration_factor (Float)

Returns:

  • (Float) —

    acceleration-factor

  • (Float) —

    acceleration-factor

#deceleration ⇒ Float

The rate at which the interpolated panning will decelerate in

Clutter::PanAction will emit interpolated ::pan events with decreasing
scroll deltas, using the rate specified by this property.

Returns:

  • (Float) —

    deceleration

#deceleration=(deceleration) ⇒ Float

The rate at which the interpolated panning will decelerate in

Clutter::PanAction will emit interpolated ::pan events with decreasing
scroll deltas, using the rate specified by this property.

Parameters:

  • deceleration (Float)

Returns:

  • (Float) —

    deceleration

  • (Float) —

    deceleration

#get_constrained_motion_delta(point, delta_x, delta_y) ⇒ Clutter::gfloat

Retrieves the delta, in stage space, dependent on the current state
of the Clutter::PanAction, and respecting the constraint specified by the
Clutter::PanAction:pan-axis property.

Parameters:

  • point (Integer) —

    the touch point index, with 0 being the first touch
    point received by the action

  • delta_x (Clutter::gfloat) —

    return location for the X delta

  • delta_y (Clutter::gfloat) —

    return location for the Y delta

Returns:

  • (Clutter::gfloat) —

    the distance since last motion event

#get_interpolated_coords(interpolated_x, interpolated_y) ⇒ nil

Retrieves the coordinates, in stage space, of the latest interpolated
event, analogous to clutter_gesture_action_get_motion_coords().

Parameters:

  • interpolated_x (Clutter::gfloat) —

    return location for the latest
    interpolated event's X coordinate

  • interpolated_y (Clutter::gfloat) —

    return location for the latest
    interpolated event's Y coordinate

Returns:

  • (nil)

#get_interpolated_delta(delta_x, delta_y) ⇒ Clutter::gfloat

Retrieves the delta, in stage space, since the latest interpolated
event, analogous to clutter_gesture_action_get_motion_delta().

Parameters:

  • delta_x (Clutter::gfloat) —

    return location for the X delta since
    the latest interpolated event

  • delta_y (Clutter::gfloat) —

    return location for the Y delta since
    the latest interpolated event

Returns:

  • (Clutter::gfloat) —

    the distance since the latest interpolated event

#get_motion_coords(point, motion_x, motion_y) ⇒ nil

Retrieves the coordinates, in stage space, dependent on the current state
of the Clutter::PanAction. If it is inactive, both fields will be
set to 0. If it is panning by user action, the values will be equivalent
to those returned by clutter_gesture_action_get_motion_coords().
If it is interpolating with some form of kinetic scrolling, the values
will be equivalent to those returned by
clutter_pan_action_get_interpolated_coords(). This is a convenience
method designed to be used in replacement "pan" signal handlers.

Parameters:

  • point (Integer) —

    the touch point index, with 0 being the first touch
    point received by the action

  • motion_x (Clutter::gfloat) —

    return location for the X coordinate

  • motion_y (Clutter::gfloat) —

    return location for the Y coordinate

Returns:

  • (nil)

#get_motion_delta(point, delta_x, delta_y) ⇒ Clutter::gfloat

Retrieves the delta, in stage space, dependent on the current state
of the Clutter::PanAction. If it is inactive, both fields will be
set to 0. If it is panning by user action, the values will be equivalent
to those returned by clutter_gesture_action_get_motion_delta().
If it is interpolating with some form of kinetic scrolling, the values
will be equivalent to those returned by
clutter_pan_action_get_interpolated_delta(). This is a convenience
method designed to be used in replacement "pan" signal handlers.

Parameters:

  • point (Integer) —

    the touch point index, with 0 being the first touch
    point received by the action

  • delta_x (Clutter::gfloat) —

    return location for the X delta

  • delta_y (Clutter::gfloat) —

    return location for the Y delta

Returns:

  • (Clutter::gfloat)

#interpolate ⇒ Boolean

Checks if the action should emit ::pan events even after releasing
the pointer during a panning gesture, to emulate some kind of
kinetic inertia.

Returns:

  • (Boolean) —

    true if interpolated events emission is active.

#interpolate=(interpolate) ⇒ Boolean

Whether interpolated events emission is enabled.

Parameters:

  • interpolate (Boolean)

Returns:

  • (Boolean) —

    interpolate

  • (Boolean) —

    interpolate

#interpolate? ⇒ Boolean

Whether interpolated events emission is enabled.

Returns:

  • (Boolean) —

    interpolate

#pan_axis ⇒ Clutter::PanAxis

Constraints the panning action to the specified axis

Returns:

#pan_axis=(pan_axis) ⇒ Clutter::PanAxis

Constraints the panning action to the specified axis

Parameters:

Returns: