Skylicht Engine
Loading...
Searching...
No Matches
CAnimationTimeline.h
1/*
2!@
3MIT License
4
5Copyright (c) 2019 Skylicht Technology CO., LTD
6
7Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files
8(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify,
9merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
10subject to the following conditions:
11
12The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
13
14THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
15INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
16IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
17WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
19
20This file is part of the "Skylicht Engine".
21https://github.com/skylicht-lab/skylicht-engine
22!#
23*/
24
25#pragma once
26
27namespace Skylicht
28{
44 class SKYLICHT_API CAnimationTimeline
45 {
46 public:
48 float From;
49
51 float To;
52
54 float Duration;
55
57 float Frame;
58
60 float Speed;
61
63 float Weight;
64
66 bool Loop;
67
69 bool Pause;
70
71 public:
72 CAnimationTimeline();
73
77 void update();
78
83 void play(bool fromBegin = true);
84
89 inline float getAnimDuration()
90 {
91 return To - From;
92 }
93
98 inline float getClipDuration()
99 {
100 return Duration;
101 }
102
107 bool isEnd();
108 };
109}
float Weight
Blending weight for this timeline (0 to 1).
Definition CAnimationTimeline.h:63
float From
Start frame of the playback range in seconds.
Definition CAnimationTimeline.h:48
float Frame
Current playback position in seconds.
Definition CAnimationTimeline.h:57
float To
End frame of the playback range in seconds.
Definition CAnimationTimeline.h:51
float getClipDuration()
Gets the total duration of the source animation clip.
Definition CAnimationTimeline.h:98
float Speed
Playback speed multiplier (default: 1.0).
Definition CAnimationTimeline.h:60
float Duration
Total duration of the animation clip in seconds.
Definition CAnimationTimeline.h:54
float getAnimDuration()
Gets the duration of the current playback range (To - From).
Definition CAnimationTimeline.h:89
bool Pause
Whether playback is currently paused.
Definition CAnimationTimeline.h:69
bool Loop
Whether the animation should restart when it reaches the 'To' frame.
Definition CAnimationTimeline.h:66
void play(bool fromBegin=true)
Starts or resumes playback.
bool isEnd()
Checks if the animation has reached or passed the 'To' frame.
void update()
Updates the current frame based on time step and speed.
Everything in the Skylicht Engine. You can start by looking at the topics.
Definition AudioDebugLog.h:29