\hypertarget{classAnimationHandle}{}\section{Animation\+Handle Class Reference}
\label{classAnimationHandle}\index{Animation\+Handle@{Animation\+Handle}}


A handle used to refer to an animation or to a specific frame in an animation.  




{\ttfamily \#include $<$Type-\/\+Skeleton/\+Object\+Types/\+Skeleton/\+Animation/\+Animation\+Handle.\+hh$>$}

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classAnimationHandle_a518b7cb4271607fce2a80065adb4b638}\label{classAnimationHandle_a518b7cb4271607fce2a80065adb4b638}} 
\hyperlink{classAnimationHandle_a518b7cb4271607fce2a80065adb4b638}{Animation\+Handle} ()
\begin{DoxyCompactList}\small\item\em Constructs an invalid animation handle (interpreted as handle of the reference pose) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classAnimationHandle_a6e227c7ffadc538001b39ece5de4857c}\label{classAnimationHandle_a6e227c7ffadc538001b39ece5de4857c}} 
\hyperlink{classAnimationHandle_a6e227c7ffadc538001b39ece5de4857c}{Animation\+Handle} (size\+\_\+t \hyperlink{classAnimationHandle_aed9614224fc805cf7d3bdf8d9ac3ae0b}{id\+Animation}, size\+\_\+t \hyperlink{classAnimationHandle_a4b606c00810a40a89ffc3443599229db}{i\+Frame}=0)
\begin{DoxyCompactList}\small\item\em Constructs a valid handle for the given animation and frame. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classAnimationHandle_a1373419318b1fb1f7c448906f17fa62b}\label{classAnimationHandle_a1373419318b1fb1f7c448906f17fa62b}} 
bool \hyperlink{classAnimationHandle_a1373419318b1fb1f7c448906f17fa62b}{is\+Valid} () const
\begin{DoxyCompactList}\small\item\em Returns true if the handle is valid. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classAnimationHandle_ad191925ecd32cf0294b6d20a7bed8536}\label{classAnimationHandle_ad191925ecd32cf0294b6d20a7bed8536}} 
size\+\_\+t \hyperlink{classAnimationHandle_ad191925ecd32cf0294b6d20a7bed8536}{animation\+Index} () const
\begin{DoxyCompactList}\small\item\em Returns the animation index (zero based) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classAnimationHandle_a60fb075c10d6f2c60d0ee0d5c125eb87}\label{classAnimationHandle_a60fb075c10d6f2c60d0ee0d5c125eb87}} 
size\+\_\+t \hyperlink{classAnimationHandle_a60fb075c10d6f2c60d0ee0d5c125eb87}{frame} () const
\begin{DoxyCompactList}\small\item\em Returns the selected frame (zero based) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classAnimationHandle_ab177764ff2ed8922c8fac608e81043f8}\label{classAnimationHandle_ab177764ff2ed8922c8fac608e81043f8}} 
void \hyperlink{classAnimationHandle_ab177764ff2ed8922c8fac608e81043f8}{set\+Frame} (size\+\_\+t \+\_\+i\+Frame)
\begin{DoxyCompactList}\small\item\em Sets the current animation frame (not failsafe) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classAnimationHandle_ab05622d8375e6cebd546478370dd4735}\label{classAnimationHandle_ab05622d8375e6cebd546478370dd4735}} 
void \hyperlink{classAnimationHandle_ab05622d8375e6cebd546478370dd4735}{first\+Frame} ()
\begin{DoxyCompactList}\small\item\em Returns to the first frame. \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classAnimationHandle_a1d83c5154fbcf72d35fd06c0afc2a1af}\label{classAnimationHandle_a1d83c5154fbcf72d35fd06c0afc2a1af}} 
void \hyperlink{classAnimationHandle_a1d83c5154fbcf72d35fd06c0afc2a1af}{operator++} ()
\begin{DoxyCompactList}\small\item\em Increases the handle to the next frame (not failsafe) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classAnimationHandle_abe8b736d9f9234ae083e5ed6e74b4f82}\label{classAnimationHandle_abe8b736d9f9234ae083e5ed6e74b4f82}} 
void \hyperlink{classAnimationHandle_abe8b736d9f9234ae083e5ed6e74b4f82}{operator-\/-\/} ()
\begin{DoxyCompactList}\small\item\em Decreases the handle to the previous frame (not failsafe) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classAnimationHandle_a2ae603f677981b3ab014bb4f0cc77bb4}\label{classAnimationHandle_a2ae603f677981b3ab014bb4f0cc77bb4}} 
bool {\bfseries operator==} (const \hyperlink{classAnimationHandle}{Animation\+Handle} \&rhs)
\item 
\mbox{\Hypertarget{classAnimationHandle_aa80185fcb764b8efa12001f22f6a9d07}\label{classAnimationHandle_aa80185fcb764b8efa12001f22f6a9d07}} 
bool {\bfseries operator!=} (const \hyperlink{classAnimationHandle}{Animation\+Handle} \&rhs)
\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\Hypertarget{classAnimationHandle_aed9614224fc805cf7d3bdf8d9ac3ae0b}\label{classAnimationHandle_aed9614224fc805cf7d3bdf8d9ac3ae0b}} 
size\+\_\+t \hyperlink{classAnimationHandle_aed9614224fc805cf7d3bdf8d9ac3ae0b}{id\+Animation}
\begin{DoxyCompactList}\small\item\em The one based index of the animation, set to 0 for invalid (or reference pose) \end{DoxyCompactList}\item 
\mbox{\Hypertarget{classAnimationHandle_a4b606c00810a40a89ffc3443599229db}\label{classAnimationHandle_a4b606c00810a40a89ffc3443599229db}} 
size\+\_\+t \hyperlink{classAnimationHandle_a4b606c00810a40a89ffc3443599229db}{i\+Frame}
\begin{DoxyCompactList}\small\item\em The frame number. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
A handle used to refer to an animation or to a specific frame in an animation. 

Definition at line 47 of file Animation\+Handle.\+hh.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
Type-\/\+Skeleton/\+Object\+Types/\+Skeleton/\+Animation/Animation\+Handle.\+hh\end{DoxyCompactItemize}
