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


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




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

\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hypertarget{a00286_a518b7cb4271607fce2a80065adb4b638}{\hyperlink{a00286_a518b7cb4271607fce2a80065adb4b638}{Animation\+Handle} ()}\label{a00286_a518b7cb4271607fce2a80065adb4b638}

\begin{DoxyCompactList}\small\item\em Constructs an invalid animation handle (interpreted as handle of the reference pose) \end{DoxyCompactList}\item 
\hypertarget{a00286_af0684caa92d175113a38cec97f1a4803}{\hyperlink{a00286_af0684caa92d175113a38cec97f1a4803}{Animation\+Handle} (unsigned int \hyperlink{a00286_a0f5b96345414647a8593c5e965f3b622}{id\+Animation}, unsigned int \hyperlink{a00286_a8394eceb56cddd54ca37454f4109506b}{i\+Frame}=0)}\label{a00286_af0684caa92d175113a38cec97f1a4803}

\begin{DoxyCompactList}\small\item\em Constructs a valid handle for the given animation and frame. \end{DoxyCompactList}\item 
\hypertarget{a00286_a99a016d4d8d03862b7a963ab54de8631}{bool \hyperlink{a00286_a99a016d4d8d03862b7a963ab54de8631}{is\+Valid} () const }\label{a00286_a99a016d4d8d03862b7a963ab54de8631}

\begin{DoxyCompactList}\small\item\em Returns true if the handle is valid. \end{DoxyCompactList}\item 
\hypertarget{a00286_aa55decd13ad5a6ff98f1b8c40adddb07}{unsigned int \hyperlink{a00286_aa55decd13ad5a6ff98f1b8c40adddb07}{animation\+Index} () const }\label{a00286_aa55decd13ad5a6ff98f1b8c40adddb07}

\begin{DoxyCompactList}\small\item\em Returns the animation index (zero based) \end{DoxyCompactList}\item 
\hypertarget{a00286_a19fa2be999b8c7c74caae62ac97277ec}{unsigned int \hyperlink{a00286_a19fa2be999b8c7c74caae62ac97277ec}{frame} () const }\label{a00286_a19fa2be999b8c7c74caae62ac97277ec}

\begin{DoxyCompactList}\small\item\em Returns the selected frame (zero based) \end{DoxyCompactList}\item 
\hypertarget{a00286_a0efcf6813737c768dc7f5c25892e0df3}{void \hyperlink{a00286_a0efcf6813737c768dc7f5c25892e0df3}{set\+Frame} (unsigned int \+\_\+i\+Frame)}\label{a00286_a0efcf6813737c768dc7f5c25892e0df3}

\begin{DoxyCompactList}\small\item\em Sets the current animation frame (not failsafe) \end{DoxyCompactList}\item 
\hypertarget{a00286_ab05622d8375e6cebd546478370dd4735}{void \hyperlink{a00286_ab05622d8375e6cebd546478370dd4735}{first\+Frame} ()}\label{a00286_ab05622d8375e6cebd546478370dd4735}

\begin{DoxyCompactList}\small\item\em Returns to the first frame. \end{DoxyCompactList}\item 
\hypertarget{a00286_a1d83c5154fbcf72d35fd06c0afc2a1af}{void \hyperlink{a00286_a1d83c5154fbcf72d35fd06c0afc2a1af}{operator++} ()}\label{a00286_a1d83c5154fbcf72d35fd06c0afc2a1af}

\begin{DoxyCompactList}\small\item\em Increases the handle to the next frame (not failsafe) \end{DoxyCompactList}\item 
\hypertarget{a00286_abe8b736d9f9234ae083e5ed6e74b4f82}{void \hyperlink{a00286_abe8b736d9f9234ae083e5ed6e74b4f82}{operator-\/-\/} ()}\label{a00286_abe8b736d9f9234ae083e5ed6e74b4f82}

\begin{DoxyCompactList}\small\item\em Decreases the handle to the previous frame (not failsafe) \end{DoxyCompactList}\item 
\hypertarget{a00286_a2ae603f677981b3ab014bb4f0cc77bb4}{bool {\bfseries operator==} (const \hyperlink{a00286}{Animation\+Handle} \&rhs)}\label{a00286_a2ae603f677981b3ab014bb4f0cc77bb4}

\item 
\hypertarget{a00286_aa80185fcb764b8efa12001f22f6a9d07}{bool {\bfseries operator!=} (const \hyperlink{a00286}{Animation\+Handle} \&rhs)}\label{a00286_aa80185fcb764b8efa12001f22f6a9d07}

\end{DoxyCompactItemize}
\subsection*{Private Attributes}
\begin{DoxyCompactItemize}
\item 
\hypertarget{a00286_a0f5b96345414647a8593c5e965f3b622}{unsigned int \hyperlink{a00286_a0f5b96345414647a8593c5e965f3b622}{id\+Animation}}\label{a00286_a0f5b96345414647a8593c5e965f3b622}

\begin{DoxyCompactList}\small\item\em The one based index of the animation, set to 0 for invalid (or reference pose) \end{DoxyCompactList}\item 
\hypertarget{a00286_a8394eceb56cddd54ca37454f4109506b}{unsigned int \hyperlink{a00286_a8394eceb56cddd54ca37454f4109506b}{i\+Frame}}\label{a00286_a8394eceb56cddd54ca37454f4109506b}

\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 56 of file Animation\+Handle.\+hh.



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