Developer Documentation

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
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 /*===========================================================================*\
43 * *
44 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49
50 #ifndef ANIMATIONHANDLE_HH
51 #define ANIMATIONHANDLE_HH
52
56 class AnimationHandle
57 {
58 public:
60 AnimationHandle() : idAnimation(0), iFrame(0) {};
62 AnimationHandle(unsigned int idAnimation, unsigned int iFrame = 0) : idAnimation(idAnimation + 1), iFrame(iFrame) {};
64 inline bool isValid() const { return idAnimation > 0; }
66 inline unsigned int animationIndex() const { return idAnimation - 1; }
67
69 inline unsigned int frame() const { return iFrame; }
71 inline void setFrame(unsigned int _iFrame) { iFrame = _iFrame; }
72
74 inline void firstFrame() { iFrame = 0; }
76 inline void operator++() { ++iFrame; }
78 inline void operator--() { --iFrame; }
79
80 inline bool operator==(const AnimationHandle &rhs) { return (idAnimation == rhs.idAnimation) && (iFrame == rhs.iFrame); }
81 inline bool operator!=(const AnimationHandle &rhs) { return (idAnimation != rhs.idAnimation) || (iFrame != rhs.iFrame); }
82
83 private:
85 unsigned int idAnimation;
87 unsigned int iFrame;
88 };
89
90 #endif // ANIMATIONHANDLE_HH
AnimationHandle::isValid
bool isValid() const
Returns true if the handle is valid.
Definition: AnimationHandle.hh:64
AnimationHandle::operator--
void operator--()
Decreases the handle to the previous frame (not failsafe)
Definition: AnimationHandle.hh:78
AnimationHandle::animationIndex
unsigned int animationIndex() const
Returns the animation index (zero based)
Definition: AnimationHandle.hh:66
AnimationHandle::iFrame
unsigned int iFrame
The frame number.
Definition: AnimationHandle.hh:87
AnimationHandle::AnimationHandle
AnimationHandle()
Constructs an invalid animation handle (interpreted as handle of the reference pose) ...
Definition: AnimationHandle.hh:60
AnimationHandle::frame
unsigned int frame() const
Returns the selected frame (zero based)
Definition: AnimationHandle.hh:69
AnimationHandle::idAnimation
unsigned int idAnimation
The one based index of the animation, set to 0 for invalid (or reference pose)
Definition: AnimationHandle.hh:85
AnimationHandle
A handle used to refer to an animation or to a specific frame in an animation.
Definition: AnimationHandle.hh:56
AnimationHandle::operator++
void operator++()
Increases the handle to the next frame (not failsafe)
Definition: AnimationHandle.hh:76
AnimationHandle::setFrame
void setFrame(unsigned int _iFrame)
Sets the current animation frame (not failsafe)
Definition: AnimationHandle.hh:71
AnimationHandle::firstFrame
void firstFrame()
Returns to the first frame.
Definition: AnimationHandle.hh:74
AnimationHandle::AnimationHandle
AnimationHandle(unsigned int idAnimation, unsigned int iFrame=0)
Constructs a valid handle for the given animation and frame.
Definition: AnimationHandle.hh:62