v_sim.Animation¶

Subclasses:: None

Methods¶

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

class	`new` (obj, property)
	`abort` ()
	`animate` (tick)
	`getFrom` ()
	`getTo` ()
	`isRunning` ()
	`start` (to, tick, duration, loop, type)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`running`	`bool`	r	animation is running

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class v_sim.Animation(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: v_sim.AnimationClass

Common name to refer to a #_VisuAnimation.

classmethod new(obj, property)¶

Parameters:

obj (GObject.Object) – a GObject.Object object.
property (str) – a property name.

Returns:

a new v_sim.Animation object.

Return type:

v_sim.Animation

Create an animation for property of obj.

New in version 3.8.

abort()¶: Stop the current animation.

New in version 3.8.

animate(tick)¶

Parameters:: tick (int) – a time clock.
Returns:: True if the animation is finished.
Return type:: bool

Update the property animated by self to the value it should take at tick.

New in version 3.8.

getFrom()¶

Returns:: a location to store the initial value of self.
Return type:: from_: GObject.Value

Retrieves the initial value of self. The animation should be running for this value to be defined.

New in version 3.8.

getTo()¶

Returns:: a location to store the final value of self.
Return type:: to: GObject.Value

Retrieves the final value of self. The animation should be running for this value to be defined.

New in version 3.8.

isRunning()¶

Returns:: True if self is running.
Return type:: bool

Inquires if self is currently running.

New in version 3.8.

start(to, tick, duration, loop, type)¶

Parameters:

to (GObject.Value) – a final value.
tick (int) – the current clock time.
duration (int) – a duration in micro-seconds.
loop (bool) – a boolean.
type (v_sim.AnimationType) – a type.

Returns:

True if the animation is actually started.

Return type:

bool

Starts self, to go to the value to from its current value following type evolution. tick is the current clock time and the animation is scheduled to last for duration. If loop is true, when the animation reaches to it restarts again from the initial value. Use v_sim.Animation.abort() to stop it.

New in version 3.8.

Property Details¶

v_sim.Animation.props.running¶

Name:: running
Type:: bool
Default Value:: False
Flags:: READABLE

animation is running