Class
BisSpringAnimation
Description [src]
final class Bis.SpringAnimation : Bis.Animation {
/* No available fields */
}A spring-based BisAnimation.
BisSpringAnimation implements an animation driven by a physical model of a
spring described by BisSpringParams, with a resting position in
BisSpringAnimation:value-to, stretched to
BisSpringAnimation:value-from.
Since the animation is physically simulated, spring animations don’t have a
fixed duration. The animation will stop when the simulated spring comes to a
rest - when the amplitude of the oscillations becomes smaller than
BisSpringAnimation:epsilon, or immediately when it reaches
BisSpringAnimation:value-to if
BisSpringAnimation:latch is set to TRUE. The estimated duration can
be obtained with BisSpringAnimation:estimated-duration.
Due to the nature of spring-driven motion the animation can overshoot
BisSpringAnimation:value-to before coming to a rest. Whether the
animation will overshoot or not depends on the damping ratio of the spring.
See BisSpringParams for more information about specific damping ratio values.
If BisSpringAnimation:latch is TRUE, the animation will abruptly
end as soon as it reaches the final value, preventing overshooting.
Animations can have an initial velocity value, set via
BisSpringAnimation:initial-velocity, which adjusts the curve without
changing the duration. This makes spring animations useful for deceleration
at the end of gestures.
If the initial and final values are equal, and the initial velocity is not 0, the animation value will bounce and return to its resting position.
| Available since: | 1.0 |
Instance methods
bis_spring_animation_get_estimated_duration
Gets the estimated duration of self.
Available since: 1.0
bis_spring_animation_get_spring_params
Gets the physical parameters of the spring of self.
Available since: 1.0
bis_spring_animation_set_spring_params
Sets the physical parameters of the spring of self.
Available since: 1.0
Methods inherited from BisAnimation (10)
bis_animation_get_state
Gets the current value of self.
Available since: 1.0
bis_animation_get_target
Gets the target self animates.
Available since: 1.0
bis_animation_get_value
Gets the current value of self.
Available since: 1.0
bis_animation_get_widget
Gets the widget self was created for.
Available since: 1.0
bis_animation_pause
Pauses a playing animation for self.
Available since: 1.0
bis_animation_play
Starts the animation for self.
Available since: 1.0
bis_animation_reset
Resets the animation for self.
Available since: 1.0
bis_animation_resume
Resumes a paused animation for self.
Available since: 1.0
bis_animation_set_target
Sets the target self animates to target.
Available since: 1.0
bis_animation_skip
Skips the animation for self.
Available since: 1.0
Properties
Bis.SpringAnimation:estimated-duration
Estimated duration of the animation, in milliseconds.
Available since: 1.0
Bis.SpringAnimation:initial-velocity
The initial velocity to start the animation with.
Available since: 1.0
Properties inherited from BisAnimation (4)
Bis.Animation:state
The animation state.
Available since: 1.0
Bis.Animation:target
The target to animate.
Available since: 1.0
Bis.Animation:value
The current value of the animation.
Available since: 1.0
Bis.Animation:widget
The animation widget.
Available since: 1.0
Signals
Signals inherited from BisAnimation (1)
Bis.Animation::done
This signal is emitted when the animation has been completed, either on its
own or via calling bis_animation_skip().
Available since: 1.0
Signals inherited from GObject (1)
GObject.Object::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.