Developer Documentation
AnimationHandle.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 #pragma once
43 
48 {
49 public:
53  AnimationHandle(size_t idAnimation, size_t iFrame = 0) : idAnimation(idAnimation + 1), iFrame(iFrame) {};
55  inline bool isValid() const { return idAnimation > 0; }
57  inline size_t animationIndex() const { return idAnimation - 1; }
58 
60  inline size_t frame() const { return iFrame; }
62  inline void setFrame(size_t _iFrame) { iFrame = _iFrame; }
63 
65  inline void firstFrame() { iFrame = 0; }
67  inline void operator++() { ++iFrame; }
69  inline void operator--() { --iFrame; }
70 
71  inline bool operator==(const AnimationHandle &rhs) { return (idAnimation == rhs.idAnimation) && (iFrame == rhs.iFrame); }
72  inline bool operator!=(const AnimationHandle &rhs) { return (idAnimation != rhs.idAnimation) || (iFrame != rhs.iFrame); }
73 
74 private:
76  size_t idAnimation;
78  size_t iFrame;
79 };
80 
size_t iFrame
The frame number.
size_t animationIndex() const
Returns the animation index (zero based)
AnimationHandle(size_t idAnimation, size_t iFrame=0)
Constructs a valid handle for the given animation and frame.
void firstFrame()
Returns to the first frame.
size_t frame() const
Returns the selected frame (zero based)
size_t idAnimation
The one based index of the animation, set to 0 for invalid (or reference pose)
A handle used to refer to an animation or to a specific frame in an animation.
void operator++()
Increases the handle to the next frame (not failsafe)
void setFrame(size_t _iFrame)
Sets the current animation frame (not failsafe)
bool isValid() const
Returns true if the handle is valid.
AnimationHandle()
Constructs an invalid animation handle (interpreted as handle of the reference pose) ...
void operator--()
Decreases the handle to the previous frame (not failsafe)