From 9eb18859231c7e6579e4eb2134350e3095ad4ec7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Mon, 10 Sep 2018 18:59:50 +0200 Subject: [PATCH] Animation: doc++ --- src/Magnum/Animation/Player.h | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/src/Magnum/Animation/Player.h b/src/Magnum/Animation/Player.h index 5aaafbb6c..41fb3ace0 100644 --- a/src/Magnum/Animation/Player.h +++ b/src/Magnum/Animation/Player.h @@ -81,7 +81,13 @@ namespace Implementation { Provides a generic way for querying interpolated results from multiple animation tracks of distinct types from a single place, together with managing -their running state. +the animation running state. + +Similarly to @ref Track / @ref TrackView, the player is also partially statless +--- in particular, it neither accesses any global timer or keeps any notion of +"current time". Instead, all time-dependent functions take absolute time as a +parameter. This both simplifies the internal state management and adds +additional flexibility on user side. @section Animation-Player-setup Setting up @@ -128,11 +134,6 @@ You can use @ref setDuration() to specify a custom duration: @section Animation-Player-playback Animation playback -The @ref Player class doesn't access any global timer functionality, but -instead requires you to call its APIs with explicit time values. That allows -for greater flexibility and control over animation playback, among other -things. - By default, the player is in a @ref State::Stopped state. Call @ref play() with a time value denoting the moment at which the animation should start. After that, the @ref advance() function is meant to be called every frame with @@ -597,7 +598,7 @@ template