|
Wt
4.10.0
|
A value class that defines a transition effect. More...
#include <Wt/WAnimation.h>
Public Types | |
| typedef AnimationEffect | Effect |
| Typedef for enum Wt::AnimationEffect. | |
Public Member Functions | |
| WAnimation () | |
| Default constructor. | |
| WAnimation (WFlags< AnimationEffect > effects, TimingFunction timing=TimingFunction::Linear, int duration=250) | |
| Creates an animation. | |
| void | setEffects (WFlags< AnimationEffect > effects) |
| Sets the animation effects. | |
| WFlags< AnimationEffect > | effects () const |
| Returns animation effects. | |
| bool | operator== (const WAnimation &other) const |
| Comparison operator. | |
| bool | operator!= (const WAnimation &other) const |
| Comparison operator. | |
| void | setDuration (int msecs) |
| Sets the duration. | |
| int | duration () const |
| Returns the duration. | |
| void | setTimingFunction (TimingFunction function) |
| Sets a timing function. | |
| TimingFunction | timingFunction () const |
| Returns the timing function. | |
| bool | empty () const |
| Returns whether the animation is empty. | |
A value class that defines a transition effect.
This class defines an animation used as a transition to show or hide a widget.
The animation can be defined as a motion effect (e.g. sliding in or out), optionally combined with a fade effect. A timing function defines how the effects(s) are animated during the total duration of the animation.
| Wt::WAnimation::WAnimation | ( | ) |
Default constructor.
Creates an animation that actually represent no animation. (effects() == 0).
| Wt::WAnimation::WAnimation | ( | WFlags< AnimationEffect > | effects, |
| TimingFunction | timing = TimingFunction::Linear, |
||
| int | duration = 250 |
||
| ) |
Creates an animation.
An animation is created with given effects, timing and duration.
| int Wt::WAnimation::duration | ( | ) | const |
Returns the duration.
| WFlags< AnimationEffect > Wt::WAnimation::effects | ( | ) | const |
Returns animation effects.
| bool Wt::WAnimation::empty | ( | ) | const |
Returns whether the animation is empty.
An animation is empty (meaning the transition is instant), if the duration is 0, or if no effects are defined.
| bool Wt::WAnimation::operator!= | ( | const WAnimation & | other | ) | const |
Comparison operator.
Returns true if the transitions are different.
| bool Wt::WAnimation::operator== | ( | const WAnimation & | other | ) | const |
Comparison operator.
Returns true if the transitions are exactly the same.
| void Wt::WAnimation::setDuration | ( | int | msecs | ) |
| void Wt::WAnimation::setEffects | ( | WFlags< AnimationEffect > | effects | ) |
Sets the animation effects.
A motion effect (SlideInFromLeft, SlideInFromRight, SlideInFromBottom, SlideInFromTop or Pop) can be combined with a fade effect (Fade).
When effects are 0, the animation does not actually specify an animation, but instead an instant transition.
| void Wt::WAnimation::setTimingFunction | ( | TimingFunction | function | ) |
Sets a timing function.
The default timinig function is TimingFunction::Linear.
| TimingFunction Wt::WAnimation::timingFunction | ( | ) | const |
Returns the timing function.