Dazzle.Animation¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`calculate_duration` (monitor, from_value, to_value)
	`add_property` (pspec, value)
	`start` ()
	`stop` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`duration`	`int`	w/co	The duration of the animation
`frame-clock`	`Gdk.FrameClock`	w/co	An optional frame-clock to synchronize with.
`mode`	`Dazzle.AnimationMode`	w/co	The animation mode
`target`	`GObject.Object`	w/co	The target of the animation

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`tick`	The “tick” signal is emitted on each frame in the animation.

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Dazzle.Animation(**kwargs)¶

Bases:: GObject.InitiallyUnowned
Abstract:: No
Structure:: Dazzle.AnimationClass

classmethod calculate_duration(monitor, from_value, to_value)¶

Parameters:

monitor (Gdk.Monitor) –
from_value (float) –
to_value (float) –

Return type:

int

add_property(pspec, value)¶

Parameters:

pspec (GObject.ParamSpec) – A #ParamSpec of target or a Gtk.Widget ‘s parent.
value (GObject.Value) – The new value for the property at the end of the animation.

Adds a new property to the set of properties to be animated during the lifetime of the animation.

Side effects: None.

start()¶

Start the animation. When the animation stops, the internal reference will be dropped and the animation may be finalized.

Side effects: None.

stop()¶

Stops a running animation. The internal reference to the animation is dropped and therefore may cause the object to finalize.

As a convenience, this function accepts None for self but does nothing if that should occur.

Signal Details¶

Dazzle.Animation.signals.tick(animation)¶

Signal Name:: tick
Flags:: RUN_FIRST
Parameters:: animation (Dazzle.Animation) – The object which received the signal

The “tick” signal is emitted on each frame in the animation.

Property Details¶

Dazzle.Animation.props.duration¶

Name:: duration
Type:: int
Default Value:: 250
Flags:: WRITABLE, CONSTRUCT_ONLY

The “duration” property is the total number of milliseconds that the animation should run before being completed.

Dazzle.Animation.props.frame_clock¶

Name:: frame-clock
Type:: Gdk.FrameClock
Default Value:: None
Flags:: WRITABLE, CONSTRUCT_ONLY

An optional frame-clock to synchronize with.

Dazzle.Animation.props.mode¶

Name:: mode
Type:: Dazzle.AnimationMode
Default Value:: Dazzle.AnimationMode.LINEAR
Flags:: WRITABLE, CONSTRUCT_ONLY

The “mode” property is the Alpha function that should be used to determine the offset within the animation based on the current offset in the animations duration.

Dazzle.Animation.props.target¶

Name:: target
Type:: GObject.Object
Default Value:: None
Flags:: WRITABLE, CONSTRUCT_ONLY

The “target” property is the GObject.Object that should have its properties animated.