v_sim.Animatable

Implementations:

v_sim.GlView, v_sim.NodeMover, v_sim.Plane, v_sim.PlaneSet, v_sim.Vibration

Methods

	animate (anim, to, duration, loop, type)
	animateDouble (anim, to, duration, loop, type)
	animateDoubleByName (prop, to, duration, loop, type)
	animateFloat (anim, to, duration, loop, type)
	animateFloatByName (prop, to, duration, loop, type)
	getAnimation (prop)

Virtual Methods

None

Properties

None

Signals

Name	Short Description
animate	This signal is emitted when properties start an animation.

Fields

None

Class Details

class v_sim.Animatable

Bases:

GObject.GInterface

Structure:

v_sim.AnimatableInterface

Interface object.

New in version 3.8.

animate(anim, to, duration, loop, type)

Parameters:

• anim (v_sim.Animation) – a v_sim.Animation object.

• to (GObject.Value) – a destination value.

• duration (int) – a duration in milliseconds.

• loop (bool) – a boolean.

• type (v_sim.AnimationType) – a type.

Returns:

True if animation is started.

Return type:

bool

Animates anim from its current value to to. The animation is scheduled to last duration and will follow the evolution described by type. If loop is true, when the value of anim reaches to, it goes back to its current value and animates again to reach to. In that case, use v_sim.Animation.abort() on anim to stop it.

New in version 3.8.

animateDouble(anim, to, duration, loop, type)

Parameters:

• anim (v_sim.Animation) – a v_sim.Animation object.

• to (float) – a destination value.

• duration (int) – a duration in milliseconds.

• loop (bool) – a boolean.

• type (v_sim.AnimationType) – a type.

Returns:

True if animation is started.

Return type:

bool

Like v_sim.Animatable.animate() for a double destination value.

New in version 3.8.

animateDoubleByName(prop, to, duration, loop, type)

Parameters:

• prop (str) – a property name from self.

• to (float) – a destination value.

• duration (int) – a duration in milliseconds.

• loop (bool) – a boolean.

• type (v_sim.AnimationType) – a type.

Returns:

True if animation is started.

Return type:

bool

Like v_sim.Animatable.animate() for a double destination value.

New in version 3.8.

animateFloat(anim, to, duration, loop, type)

Parameters:

• anim (v_sim.Animation) – a v_sim.Animation object.

• to (float) – a destination value.

• duration (int) – a duration in milliseconds.

• loop (bool) – a boolean.

• type (v_sim.AnimationType) – a type.

Returns:

True if animation is started.

Return type:

bool

Like v_sim.Animatable.animate() for a float destination value.

New in version 3.8.

animateFloatByName(prop, to, duration, loop, type)

Parameters:

• prop (str) – a property name from self.

• to (float) – a destination value.

• duration (int) – a duration in milliseconds.

• loop (bool) – a boolean.

• type (v_sim.AnimationType) – a type.

Returns:

True if animation is started.

Return type:

bool

Like v_sim.Animatable.animate() for a float destination value.

New in version 3.8.

getAnimation(prop)

Parameters:

prop (str) – a property name.

Returns:

a v_sim.Animation object or None if none is associated to prop.

Return type:

v_sim.Animation

A method to retrieve the v_sim.Animation from self given the property name prop.

New in version 3.8.

Signal Details

v_sim.Animatable.signals.animate(animatable, animation, value, at, loop, type)

Signal Name:

animate

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

• animatable (v_sim.Animatable) – The object which received the signal

• animation (v_sim.Animation) – the object emitting the signal.

• value (GObject.Value) – the target value.

• at (int) – the current tick time.

• loop (bool) – if animation should loop.

• type (int) – the animation type.

Returns:

True if animation is successfully started.

Return type:

bool

This signal is emitted when properties start an animation.

New in version 3.8.