\hypertarget{class_ogre_1_1_animation_container}{}\section{Ogre\+:\+:Animation\+Container Class Reference}
\label{class_ogre_1_1_animation_container}\index{Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}}


An animation container interface, which allows generic access to sibling animations.  




{\ttfamily \#include $<$Ogre\+Animation.\+h$>$}



Inheritance diagram for Ogre\+:\+:Animation\+Container\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=326pt]{class_ogre_1_1_animation_container__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
virtual \hyperlink{class_ogre_1_1_animation_container_a9d9d886059a3b1e8033876557a3cda75}{$\sim$\+Animation\+Container} ()
\item 
virtual \hyperlink{class_ogre_1_1_animation}{Animation} $\ast$ \hyperlink{class_ogre_1_1_animation_container_ac1469c7aff1e39df3e99a69ba99ff61f}{create\+Animation} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} length)=0
\begin{DoxyCompactList}\small\item\em Create a new animation with a given length owned by this container. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_animation}{Animation} $\ast$ \hyperlink{class_ogre_1_1_animation_container_ab1f763d5e833e2759c96de43f3bbdab7}{get\+Animation} (unsigned short index) const =0
\begin{DoxyCompactList}\small\item\em Retrieve an animation by index. \end{DoxyCompactList}\item 
virtual \hyperlink{class_ogre_1_1_animation}{Animation} $\ast$ \hyperlink{class_ogre_1_1_animation_container_a26d1ef5239d4ac29f68e825f8a7e70e2}{get\+Animation} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name) const =0
\begin{DoxyCompactList}\small\item\em Retrieve an animation by name. \end{DoxyCompactList}\item 
virtual unsigned short \hyperlink{class_ogre_1_1_animation_container_aa9a928534a786e5f345cc0595ded694c}{get\+Num\+Animations} (void) const =0
\begin{DoxyCompactList}\small\item\em Gets the number of animations in this container. \end{DoxyCompactList}\item 
virtual bool \hyperlink{class_ogre_1_1_animation_container_ae31ca8ef4dfaa0904a9f5aa05e12e455}{has\+Animation} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name) const =0
\begin{DoxyCompactList}\small\item\em Returns whether this object contains the named animation. \end{DoxyCompactList}\item 
virtual void \hyperlink{class_ogre_1_1_animation_container_abf8658873fe91d6010482248819740e8}{remove\+Animation} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&name)=0
\begin{DoxyCompactList}\small\item\em Removes an \hyperlink{class_ogre_1_1_animation}{Animation} from this container. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
An animation container interface, which allows generic access to sibling animations. 

\begin{DoxyRemark}{Remarks}
Because \hyperlink{class_ogre_1_1_animation}{Animation} instances can be held by different kinds of classes, and there are sometimes instances when you need to reference other \hyperlink{class_ogre_1_1_animation}{Animation} instances within the same container, this class allows generic access to named animations within that container, whatever it may be. 
\end{DoxyRemark}


\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_animation_container_a9d9d886059a3b1e8033876557a3cda75}\label{class_ogre_1_1_animation_container_a9d9d886059a3b1e8033876557a3cda75}} 
\index{Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}!````~Animation\+Container@{$\sim$\+Animation\+Container}}
\index{````~Animation\+Container@{$\sim$\+Animation\+Container}!Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}}
\subsubsection{\texorpdfstring{$\sim$\+Animation\+Container()}{~AnimationContainer()}}
{\footnotesize\ttfamily virtual Ogre\+::\+Animation\+Container\+::$\sim$\+Animation\+Container (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_animation_container_aa9a928534a786e5f345cc0595ded694c}\label{class_ogre_1_1_animation_container_aa9a928534a786e5f345cc0595ded694c}} 
\index{Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}!get\+Num\+Animations@{get\+Num\+Animations}}
\index{get\+Num\+Animations@{get\+Num\+Animations}!Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}}
\subsubsection{\texorpdfstring{get\+Num\+Animations()}{getNumAnimations()}}
{\footnotesize\ttfamily virtual unsigned short Ogre\+::\+Animation\+Container\+::get\+Num\+Animations (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Gets the number of animations in this container. 



Implemented in \hyperlink{class_ogre_1_1_mesh_a8f8cad841ab891a46811361546105edb}{Ogre\+::\+Mesh}, \hyperlink{class_ogre_1_1_skeleton_a4bbb64b4062dc27de0a62781b7d264c7}{Ogre\+::\+Skeleton}, and \hyperlink{class_ogre_1_1_skeleton_instance_a828877882fef8ca8ffe9453a58a4612c}{Ogre\+::\+Skeleton\+Instance}.

\mbox{\Hypertarget{class_ogre_1_1_animation_container_ab1f763d5e833e2759c96de43f3bbdab7}\label{class_ogre_1_1_animation_container_ab1f763d5e833e2759c96de43f3bbdab7}} 
\index{Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}!get\+Animation@{get\+Animation}}
\index{get\+Animation@{get\+Animation}!Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}}
\subsubsection{\texorpdfstring{get\+Animation()}{getAnimation()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual \hyperlink{class_ogre_1_1_animation}{Animation}$\ast$ Ogre\+::\+Animation\+Container\+::get\+Animation (\begin{DoxyParamCaption}\item[{unsigned short}]{index }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Retrieve an animation by index. 



Implemented in \hyperlink{class_ogre_1_1_mesh_a6150f4e5003c669db5f057c6d56a2feb}{Ogre\+::\+Mesh}, \hyperlink{class_ogre_1_1_skeleton_af7cba8c1f40e94ebe1fe1edf3fc78558}{Ogre\+::\+Skeleton}, and \hyperlink{class_ogre_1_1_skeleton_instance_afe5747313ca09ae513ead2d846767086}{Ogre\+::\+Skeleton\+Instance}.

\mbox{\Hypertarget{class_ogre_1_1_animation_container_a26d1ef5239d4ac29f68e825f8a7e70e2}\label{class_ogre_1_1_animation_container_a26d1ef5239d4ac29f68e825f8a7e70e2}} 
\index{Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}!get\+Animation@{get\+Animation}}
\index{get\+Animation@{get\+Animation}!Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}}
\subsubsection{\texorpdfstring{get\+Animation()}{getAnimation()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual \hyperlink{class_ogre_1_1_animation}{Animation}$\ast$ Ogre\+::\+Animation\+Container\+::get\+Animation (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Retrieve an animation by name. 



Implemented in \hyperlink{class_ogre_1_1_mesh_a99c5e25a135daa032869c0e5f2c964b5}{Ogre\+::\+Mesh}, and \hyperlink{class_ogre_1_1_skeleton_ae956060b928ee776a14b0c4634d64156}{Ogre\+::\+Skeleton}.

\mbox{\Hypertarget{class_ogre_1_1_animation_container_ac1469c7aff1e39df3e99a69ba99ff61f}\label{class_ogre_1_1_animation_container_ac1469c7aff1e39df3e99a69ba99ff61f}} 
\index{Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}!create\+Animation@{create\+Animation}}
\index{create\+Animation@{create\+Animation}!Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}}
\subsubsection{\texorpdfstring{create\+Animation()}{createAnimation()}}
{\footnotesize\ttfamily virtual \hyperlink{class_ogre_1_1_animation}{Animation}$\ast$ Ogre\+::\+Animation\+Container\+::create\+Animation (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{length }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Create a new animation with a given length owned by this container. 



Implemented in \hyperlink{class_ogre_1_1_mesh_a81f6bd4a02c67143c939da55bd35b1bc}{Ogre\+::\+Mesh}, \hyperlink{class_ogre_1_1_skeleton_aaffbdd130cfc11e8b61fb1ed76486a78}{Ogre\+::\+Skeleton}, and \hyperlink{class_ogre_1_1_skeleton_instance_a1a56402928aa992450dd5fee8a98cdc1}{Ogre\+::\+Skeleton\+Instance}.

\mbox{\Hypertarget{class_ogre_1_1_animation_container_ae31ca8ef4dfaa0904a9f5aa05e12e455}\label{class_ogre_1_1_animation_container_ae31ca8ef4dfaa0904a9f5aa05e12e455}} 
\index{Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}!has\+Animation@{has\+Animation}}
\index{has\+Animation@{has\+Animation}!Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}}
\subsubsection{\texorpdfstring{has\+Animation()}{hasAnimation()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Animation\+Container\+::has\+Animation (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [pure virtual]}}



Returns whether this object contains the named animation. 



Implemented in \hyperlink{class_ogre_1_1_mesh_a7c8b70b2c53108ebc963f08959855dde}{Ogre\+::\+Mesh}, and \hyperlink{class_ogre_1_1_skeleton_a1bde6f5490f1638bd5aab43651bd5612}{Ogre\+::\+Skeleton}.

\mbox{\Hypertarget{class_ogre_1_1_animation_container_abf8658873fe91d6010482248819740e8}\label{class_ogre_1_1_animation_container_abf8658873fe91d6010482248819740e8}} 
\index{Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}!remove\+Animation@{remove\+Animation}}
\index{remove\+Animation@{remove\+Animation}!Ogre\+::\+Animation\+Container@{Ogre\+::\+Animation\+Container}}
\subsubsection{\texorpdfstring{remove\+Animation()}{removeAnimation()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Animation\+Container\+::remove\+Animation (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [pure virtual]}}



Removes an \hyperlink{class_ogre_1_1_animation}{Animation} from this container. 



Implemented in \hyperlink{class_ogre_1_1_mesh_a4caff2592e1e2b223cfe9f62843c5153}{Ogre\+::\+Mesh}, \hyperlink{class_ogre_1_1_skeleton_a633c573a2b77bef7a2fe210358dcb280}{Ogre\+::\+Skeleton}, and \hyperlink{class_ogre_1_1_skeleton_instance_aefd460fc15dbe5bb494e28b78c8bfde9}{Ogre\+::\+Skeleton\+Instance}.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\hyperlink{_ogre_animation_8h}{Ogre\+Animation.\+h}\end{DoxyCompactItemize}
