Clutter.ZoomAction

Subclasses:

None

Methods

Inherited:

Clutter.GestureAction (18), Clutter.ActorMeta (5), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new ()
	get_focal_point ()
	get_transformed_focal_point ()
	get_zoom_axis ()
	set_zoom_axis (axis)

Virtual Methods

Inherited:

Clutter.GestureAction (5), Clutter.ActorMeta (1), GObject.Object (7)

do_zoom (actor, focal_point, factor)

Properties

Inherited:

Clutter.GestureAction (4), Clutter.ActorMeta (3)

Name	Type	Flags	Short Description
zoom-axis	Clutter.ZoomAxis	r/w	Constraints the zoom to an axis

Signals

Inherited:

Clutter.GestureAction (4), GObject.Object (1)

Name	Short Description
zoom	The ::zoom signal is emitted for each series of touch events that change the distance and focal point between the touch points.

Fields

Inherited:

Clutter.GestureAction (4), GObject.Object (1)

Name	Type	Access	Description
parent_instance	Clutter.GestureAction	r

Class Details

class Clutter.ZoomAction(**kwargs)

Bases:

Clutter.GestureAction

Abstract:

No

Structure:

Clutter.ZoomActionClass

The Clutter.ZoomAction structure contains only private data and should be accessed using the provided API

New in version 1.12.

classmethod new()

Returns:

the newly created Clutter.ZoomAction

Return type:

Clutter.Action

Creates a new Clutter.ZoomAction instance

New in version 1.12.

get_focal_point()

Returns:

a Clutter.Point

Return type:

point: Clutter.Point

Retrieves the focal point of the current zoom

New in version 1.12.

get_transformed_focal_point()

Returns:

a Clutter.Point

Return type:

point: Clutter.Point

Retrieves the focal point relative to the actor’s coordinates of the current zoom

New in version 1.12.

get_zoom_axis()

Returns:

the axis constraint

Return type:

Clutter.ZoomAxis

Retrieves the axis constraint set by Clutter.ZoomAction.set_zoom_axis()

New in version 1.12.

set_zoom_axis(axis)

Parameters:

axis (Clutter.ZoomAxis) – the axis to constraint the zooming to

Restricts the zooming action to a specific axis

New in version 1.12.

do_zoom(actor, focal_point, factor) virtual

Parameters:

• actor (Clutter.Actor) –

• focal_point (Clutter.Point) –

• factor (float) –

Return type:

bool

Signal Details

Clutter.ZoomAction.signals.zoom(zoom_action, actor, focal_point, factor)

Signal Name:

zoom

Flags:

RUN_LAST

Parameters:

• zoom_action (Clutter.ZoomAction) – The object which received the signal

• actor (Clutter.Actor) – the Clutter.Actor attached to the action

• focal_point (Clutter.Point) – the focal point of the zoom

• factor (float) – the initial distance between the 2 touch points

Returns:

True if the zoom should continue, and False if the zoom should be cancelled.

Return type:

bool

The ::zoom signal is emitted for each series of touch events that change the distance and focal point between the touch points.

The default handler of the signal will call Clutter.Actor.set_scale() on actor using the ratio of the first distance between the touch points and the current distance. To override the default behaviour, connect to this signal and return False.

New in version 1.12.

Property Details

Clutter.ZoomAction.props.zoom_axis

Name:

zoom-axis

Type:

Clutter.ZoomAxis

Default Value:

Clutter.ZoomAxis.BOTH

Flags:

READABLE, WRITABLE

Constraints the zooming action to the specified axis

New in version 1.12.