\hypertarget{class_ogre_1_1_animation_state}{}\section{Ogre\+:\+:Animation\+State Class Reference}
\label{class_ogre_1_1_animation_state}\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}


Represents the state of an animation and the weight of its influence.  




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



Inheritance diagram for Ogre\+:\+:Animation\+State\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=202pt]{class_ogre_1_1_animation_state__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef std\+::vector$<$ float $>$ \hyperlink{class_ogre_1_1_animation_state_a4acdb34d7886a9ba6e9d7fd977be468c}{Bone\+Blend\+Mask}
\begin{DoxyCompactList}\small\item\em Typedef for an array of float values used as a bone blend mask. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_animation_state_a0a78387f3637ec52d9eda6614adbf479}{Animation\+State} (const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&anim\+Name, \hyperlink{class_ogre_1_1_animation_state_set}{Animation\+State\+Set} $\ast$parent, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} time\+Pos, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} length, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} weight=1.\+0, bool enabled=false)
\begin{DoxyCompactList}\small\item\em Normal constructor with all params supplied. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_animation_state_a591c9a568799cf5261d3806129da2f5d}{Animation\+State} (\hyperlink{class_ogre_1_1_animation_state_set}{Animation\+State\+Set} $\ast$parent, const \hyperlink{class_ogre_1_1_animation_state}{Animation\+State} \&rhs)
\begin{DoxyCompactList}\small\item\em Constructor to copy from an existing state with new parent. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_animation_state_a1c17270d5133a34a1d2f846d34f61a69}{\+\_\+set\+Blend\+Mask} (const \hyperlink{class_ogre_1_1_animation_state_a4acdb34d7886a9ba6e9d7fd977be468c}{Bone\+Blend\+Mask} $\ast$blend\+Mask)
\begin{DoxyCompactList}\small\item\em Set the blend mask. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_animation_state_ad38d5a17259f4a88b29773fda638e9fa}{\+\_\+set\+Blend\+Mask\+Data} (const float $\ast$blend\+Mask\+Data)
\begin{DoxyCompactList}\small\item\em Set the blend mask data (might be dangerous) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_animation_state_a4670365ae58e531297816ede430b0971}{add\+Time} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} offset)
\begin{DoxyCompactList}\small\item\em Modifies the time position, adjusting for animation length. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_animation_state_ad49f3512efa4716c778e48d1223f1b4f}{copy\+State\+From} (const \hyperlink{class_ogre_1_1_animation_state}{Animation\+State} \&anim\+State)
\begin{DoxyCompactList}\small\item\em Copies the states from another animation state, preserving the animation name (unlike operator=) but copying everything else. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_animation_state_a06594a53335afbe8ccb67331e35a32fd}{create\+Blend\+Mask} (size\+\_\+t blend\+Mask\+Size\+Hint, float initial\+Weight=1.\+0f)
\begin{DoxyCompactList}\small\item\em Create a new blend mask with the given number of entries. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_animation_state_a78fe4050a91268162602c50cf03f9774}{destroy\+Blend\+Mask} ()
\begin{DoxyCompactList}\small\item\em Destroy the currently set blend mask. \end{DoxyCompactList}\item 
const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \& \hyperlink{class_ogre_1_1_animation_state_aeb2b66c49de14384860c6599db5b7f30}{get\+Animation\+Name} () const
\begin{DoxyCompactList}\small\item\em Gets the name of the animation to which this state applies. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_animation_state_a4acdb34d7886a9ba6e9d7fd977be468c}{Bone\+Blend\+Mask} $\ast$ \hyperlink{class_ogre_1_1_animation_state_ae4fd5f5523ac2428599220ab2ff0bd59}{get\+Blend\+Mask} () const
\begin{DoxyCompactList}\small\item\em Get the current blend mask (const version, may be 0) \end{DoxyCompactList}\item 
float \hyperlink{class_ogre_1_1_animation_state_a41115698455a3d6ed4451431bee0552b}{get\+Blend\+Mask\+Entry} (size\+\_\+t bone\+Handle) const
\begin{DoxyCompactList}\small\item\em Get the weight for the bone identified by the given handle. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_animation_state_af8670094f9bedeea874ca9997982829b}{get\+Enabled} (void) const
\begin{DoxyCompactList}\small\item\em Returns true if this animation is currently enabled. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_animation_state_a98eb1028a7112df116f976c309f9538f}{get\+Length} () const
\begin{DoxyCompactList}\small\item\em Gets the total length of this animation (may be shorter than whole animation) \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_animation_state_aeb306a097ff05af022b8d55a660812f2}{get\+Loop} (void) const
\begin{DoxyCompactList}\small\item\em Gets whether or not this animation loops. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_animation_state_set}{Animation\+State\+Set} $\ast$ \hyperlink{class_ogre_1_1_animation_state_a86a8707a6677b3c747f16fc5865902b1}{get\+Parent} (void) const
\begin{DoxyCompactList}\small\item\em Get the parent animation state set. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_animation_state_a3c8ad3c6386cadc0da243fb7daee5d87}{get\+Time\+Position} (void) const
\begin{DoxyCompactList}\small\item\em Gets the time position for this animation. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_animation_state_ae4b159b5488a0ddb7d10f0d2a4208cf5}{get\+Weight} (void) const
\begin{DoxyCompactList}\small\item\em Gets the weight (influence) of this animation. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_animation_state_add31ae35acaa09ebd7bc09e8d28415c3}{has\+Blend\+Mask} () const
\begin{DoxyCompactList}\small\item\em Return whether there is currently a valid blend mask set. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_animation_state_a18e023bab8cd75726512d15c78ee75ac}{has\+Ended} (void) const
\begin{DoxyCompactList}\small\item\em Returns true if the animation has reached the end and is not looping. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_animation_state_a61f86b8390348f36404afa5be769169d}{operator!=} (const \hyperlink{class_ogre_1_1_animation_state}{Animation\+State} \&rhs) const
\begin{DoxyCompactList}\small\item\em Inequality operator. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_animation_state_a4e500022b2ae6b5e4dcd667ed1943bb0}{operator==} (const \hyperlink{class_ogre_1_1_animation_state}{Animation\+State} \&rhs) const
\begin{DoxyCompactList}\small\item\em Equality operator. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_animation_state_acd87ade1535b3721676d7257b9370a5a}{set\+Blend\+Mask\+Entry} (size\+\_\+t bone\+Handle, float weight)
\begin{DoxyCompactList}\small\item\em Set the weight for the bone identified by the given handle. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_animation_state_a7acaa951a87614f39df6a7f767a88f60}{set\+Enabled} (bool enabled)
\begin{DoxyCompactList}\small\item\em Sets whether this animation is enabled. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_animation_state_af1910e8bbaebe61359ac7edb638e5cbc}{set\+Length} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} len)
\begin{DoxyCompactList}\small\item\em Sets the total length of this animation (may be shorter than whole animation) \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_animation_state_a1f6272f69d31ff9fdeca356cfcf0bc9d}{set\+Loop} (bool loop)
\begin{DoxyCompactList}\small\item\em Sets whether or not an animation loops at the start and end of the animation if the time continues to be altered. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_animation_state_ae69ff5a068d086be7ecc048a71ed8efc}{set\+Time\+Position} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} time\+Pos)
\begin{DoxyCompactList}\small\item\em Sets the time position for this animation. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_animation_state_a9666320c8d7739e3b0ee8ebd3bfe84aa}{set\+Weight} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} weight)
\begin{DoxyCompactList}\small\item\em Sets the weight (influence) of this animation. \end{DoxyCompactList}\end{DoxyCompactItemize}


\subsection{Detailed Description}
Represents the state of an animation and the weight of its influence. 

\begin{DoxyRemark}{Remarks}
Other classes can hold instances of this class to store the state of any animations they are using. 
\end{DoxyRemark}


\subsection{Member Typedef Documentation}
\mbox{\Hypertarget{class_ogre_1_1_animation_state_a4acdb34d7886a9ba6e9d7fd977be468c}\label{class_ogre_1_1_animation_state_a4acdb34d7886a9ba6e9d7fd977be468c}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!Bone\+Blend\+Mask@{Bone\+Blend\+Mask}}
\index{Bone\+Blend\+Mask@{Bone\+Blend\+Mask}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{Bone\+Blend\+Mask}{BoneBlendMask}}
{\footnotesize\ttfamily typedef std\+::vector$<$float$>$ \hyperlink{class_ogre_1_1_animation_state_a4acdb34d7886a9ba6e9d7fd977be468c}{Ogre\+::\+Animation\+State\+::\+Bone\+Blend\+Mask}}



Typedef for an array of float values used as a bone blend mask. 



\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_animation_state_a0a78387f3637ec52d9eda6614adbf479}\label{class_ogre_1_1_animation_state_a0a78387f3637ec52d9eda6614adbf479}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!Animation\+State@{Animation\+State}}
\index{Animation\+State@{Animation\+State}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{Animation\+State()}{AnimationState()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily Ogre\+::\+Animation\+State\+::\+Animation\+State (\begin{DoxyParamCaption}\item[{const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String} \&}]{anim\+Name,  }\item[{\hyperlink{class_ogre_1_1_animation_state_set}{Animation\+State\+Set} $\ast$}]{parent,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{time\+Pos,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{length,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{weight = {\ttfamily 1.0},  }\item[{bool}]{enabled = {\ttfamily false} }\end{DoxyParamCaption})}



Normal constructor with all params supplied. 


\begin{DoxyParams}{Parameters}
{\em anim\+Name} & The name of this state. \\
\hline
{\em parent} & The parent \hyperlink{class_ogre_1_1_animation_state_set}{Animation\+State\+Set} that this state will belong to. \\
\hline
{\em time\+Pos} & The position, in seconds, where this state will begin. \\
\hline
{\em length} & The length, in seconds, of this animation state. \\
\hline
{\em weight} & Weight to apply the animation state with. \\
\hline
{\em enabled} & Whether the animation state is enabled. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_animation_state_a591c9a568799cf5261d3806129da2f5d}\label{class_ogre_1_1_animation_state_a591c9a568799cf5261d3806129da2f5d}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!Animation\+State@{Animation\+State}}
\index{Animation\+State@{Animation\+State}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{Animation\+State()}{AnimationState()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily Ogre\+::\+Animation\+State\+::\+Animation\+State (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_animation_state_set}{Animation\+State\+Set} $\ast$}]{parent,  }\item[{const \hyperlink{class_ogre_1_1_animation_state}{Animation\+State} \&}]{rhs }\end{DoxyParamCaption})}



Constructor to copy from an existing state with new parent. 



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_animation_state_aeb2b66c49de14384860c6599db5b7f30}\label{class_ogre_1_1_animation_state_aeb2b66c49de14384860c6599db5b7f30}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!get\+Animation\+Name@{get\+Animation\+Name}}
\index{get\+Animation\+Name@{get\+Animation\+Name}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{get\+Animation\+Name()}{getAnimationName()}}
{\footnotesize\ttfamily const \hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}\& Ogre\+::\+Animation\+State\+::get\+Animation\+Name (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Gets the name of the animation to which this state applies. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_a3c8ad3c6386cadc0da243fb7daee5d87}\label{class_ogre_1_1_animation_state_a3c8ad3c6386cadc0da243fb7daee5d87}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!get\+Time\+Position@{get\+Time\+Position}}
\index{get\+Time\+Position@{get\+Time\+Position}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{get\+Time\+Position()}{getTimePosition()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Animation\+State\+::get\+Time\+Position (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the time position for this animation. 



Referenced by Ogre\+::\+Animation\+State\+Controller\+Value\+::get\+Value().

\mbox{\Hypertarget{class_ogre_1_1_animation_state_ae69ff5a068d086be7ecc048a71ed8efc}\label{class_ogre_1_1_animation_state_ae69ff5a068d086be7ecc048a71ed8efc}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!set\+Time\+Position@{set\+Time\+Position}}
\index{set\+Time\+Position@{set\+Time\+Position}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{set\+Time\+Position()}{setTimePosition()}}
{\footnotesize\ttfamily void Ogre\+::\+Animation\+State\+::set\+Time\+Position (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{time\+Pos }\end{DoxyParamCaption})}



Sets the time position for this animation. 



Referenced by Ogre\+::\+Animation\+State\+Controller\+Value\+::set\+Value().

\mbox{\Hypertarget{class_ogre_1_1_animation_state_a98eb1028a7112df116f976c309f9538f}\label{class_ogre_1_1_animation_state_a98eb1028a7112df116f976c309f9538f}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!get\+Length@{get\+Length}}
\index{get\+Length@{get\+Length}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{get\+Length()}{getLength()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Animation\+State\+::get\+Length (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}



Gets the total length of this animation (may be shorter than whole animation) 



Referenced by Ogre\+::\+Animation\+State\+Controller\+Value\+::get\+Value(), and Ogre\+::\+Animation\+State\+Controller\+Value\+::set\+Value().

\mbox{\Hypertarget{class_ogre_1_1_animation_state_af1910e8bbaebe61359ac7edb638e5cbc}\label{class_ogre_1_1_animation_state_af1910e8bbaebe61359ac7edb638e5cbc}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!set\+Length@{set\+Length}}
\index{set\+Length@{set\+Length}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{set\+Length()}{setLength()}}
{\footnotesize\ttfamily void Ogre\+::\+Animation\+State\+::set\+Length (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{len }\end{DoxyParamCaption})}



Sets the total length of this animation (may be shorter than whole animation) 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_ae4b159b5488a0ddb7d10f0d2a4208cf5}\label{class_ogre_1_1_animation_state_ae4b159b5488a0ddb7d10f0d2a4208cf5}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!get\+Weight@{get\+Weight}}
\index{get\+Weight@{get\+Weight}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{get\+Weight()}{getWeight()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Animation\+State\+::get\+Weight (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the weight (influence) of this animation. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_a9666320c8d7739e3b0ee8ebd3bfe84aa}\label{class_ogre_1_1_animation_state_a9666320c8d7739e3b0ee8ebd3bfe84aa}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!set\+Weight@{set\+Weight}}
\index{set\+Weight@{set\+Weight}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{set\+Weight()}{setWeight()}}
{\footnotesize\ttfamily void Ogre\+::\+Animation\+State\+::set\+Weight (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{weight }\end{DoxyParamCaption})}



Sets the weight (influence) of this animation. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_a4670365ae58e531297816ede430b0971}\label{class_ogre_1_1_animation_state_a4670365ae58e531297816ede430b0971}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!add\+Time@{add\+Time}}
\index{add\+Time@{add\+Time}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{add\+Time()}{addTime()}}
{\footnotesize\ttfamily void Ogre\+::\+Animation\+State\+::add\+Time (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{offset }\end{DoxyParamCaption})}



Modifies the time position, adjusting for animation length. 


\begin{DoxyParams}{Parameters}
{\em offset} & The amount of time, in seconds, to extend the animation. \\
\hline
\end{DoxyParams}
\begin{DoxyRemark}{Remarks}
This method loops at the edges if animation looping is enabled. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_animation_state_a18e023bab8cd75726512d15c78ee75ac}\label{class_ogre_1_1_animation_state_a18e023bab8cd75726512d15c78ee75ac}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!has\+Ended@{has\+Ended}}
\index{has\+Ended@{has\+Ended}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{has\+Ended()}{hasEnded()}}
{\footnotesize\ttfamily bool Ogre\+::\+Animation\+State\+::has\+Ended (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns true if the animation has reached the end and is not looping. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_af8670094f9bedeea874ca9997982829b}\label{class_ogre_1_1_animation_state_af8670094f9bedeea874ca9997982829b}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!get\+Enabled@{get\+Enabled}}
\index{get\+Enabled@{get\+Enabled}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{get\+Enabled()}{getEnabled()}}
{\footnotesize\ttfamily bool Ogre\+::\+Animation\+State\+::get\+Enabled (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns true if this animation is currently enabled. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_a7acaa951a87614f39df6a7f767a88f60}\label{class_ogre_1_1_animation_state_a7acaa951a87614f39df6a7f767a88f60}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!set\+Enabled@{set\+Enabled}}
\index{set\+Enabled@{set\+Enabled}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{set\+Enabled()}{setEnabled()}}
{\footnotesize\ttfamily void Ogre\+::\+Animation\+State\+::set\+Enabled (\begin{DoxyParamCaption}\item[{bool}]{enabled }\end{DoxyParamCaption})}



Sets whether this animation is enabled. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_a4e500022b2ae6b5e4dcd667ed1943bb0}\label{class_ogre_1_1_animation_state_a4e500022b2ae6b5e4dcd667ed1943bb0}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!operator==@{operator==}}
\index{operator==@{operator==}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{operator==()}{operator==()}}
{\footnotesize\ttfamily bool Ogre\+::\+Animation\+State\+::operator== (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_animation_state}{Animation\+State} \&}]{rhs }\end{DoxyParamCaption}) const}



Equality operator. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_a61f86b8390348f36404afa5be769169d}\label{class_ogre_1_1_animation_state_a61f86b8390348f36404afa5be769169d}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!operator"!=@{operator"!=}}
\index{operator"!=@{operator"!=}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{operator"!=()}{operator!=()}}
{\footnotesize\ttfamily bool Ogre\+::\+Animation\+State\+::operator!= (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_animation_state}{Animation\+State} \&}]{rhs }\end{DoxyParamCaption}) const}



Inequality operator. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_a1f6272f69d31ff9fdeca356cfcf0bc9d}\label{class_ogre_1_1_animation_state_a1f6272f69d31ff9fdeca356cfcf0bc9d}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!set\+Loop@{set\+Loop}}
\index{set\+Loop@{set\+Loop}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{set\+Loop()}{setLoop()}}
{\footnotesize\ttfamily void Ogre\+::\+Animation\+State\+::set\+Loop (\begin{DoxyParamCaption}\item[{bool}]{loop }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Sets whether or not an animation loops at the start and end of the animation if the time continues to be altered. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_aeb306a097ff05af022b8d55a660812f2}\label{class_ogre_1_1_animation_state_aeb306a097ff05af022b8d55a660812f2}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!get\+Loop@{get\+Loop}}
\index{get\+Loop@{get\+Loop}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{get\+Loop()}{getLoop()}}
{\footnotesize\ttfamily bool Ogre\+::\+Animation\+State\+::get\+Loop (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Gets whether or not this animation loops. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_ad49f3512efa4716c778e48d1223f1b4f}\label{class_ogre_1_1_animation_state_ad49f3512efa4716c778e48d1223f1b4f}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!copy\+State\+From@{copy\+State\+From}}
\index{copy\+State\+From@{copy\+State\+From}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{copy\+State\+From()}{copyStateFrom()}}
{\footnotesize\ttfamily void Ogre\+::\+Animation\+State\+::copy\+State\+From (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_animation_state}{Animation\+State} \&}]{anim\+State }\end{DoxyParamCaption})}



Copies the states from another animation state, preserving the animation name (unlike operator=) but copying everything else. 


\begin{DoxyParams}{Parameters}
{\em anim\+State} & Reference to animation state which will use as source. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_animation_state_a86a8707a6677b3c747f16fc5865902b1}\label{class_ogre_1_1_animation_state_a86a8707a6677b3c747f16fc5865902b1}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!get\+Parent@{get\+Parent}}
\index{get\+Parent@{get\+Parent}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{get\+Parent()}{getParent()}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_animation_state_set}{Animation\+State\+Set}$\ast$ Ogre\+::\+Animation\+State\+::get\+Parent (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the parent animation state set. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_a06594a53335afbe8ccb67331e35a32fd}\label{class_ogre_1_1_animation_state_a06594a53335afbe8ccb67331e35a32fd}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!create\+Blend\+Mask@{create\+Blend\+Mask}}
\index{create\+Blend\+Mask@{create\+Blend\+Mask}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{create\+Blend\+Mask()}{createBlendMask()}}
{\footnotesize\ttfamily void Ogre\+::\+Animation\+State\+::create\+Blend\+Mask (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{blend\+Mask\+Size\+Hint,  }\item[{float}]{initial\+Weight = {\ttfamily 1.0f} }\end{DoxyParamCaption})}



Create a new blend mask with the given number of entries. 

In addition to assigning a single weight value to a skeletal animation, it may be desirable to assign animation weights per bone using a \textquotesingle{}blend mask\textquotesingle{}.


\begin{DoxyParams}{Parameters}
{\em blend\+Mask\+Size\+Hint} & The number of bones of the skeleton owning this \hyperlink{class_ogre_1_1_animation_state}{Animation\+State}. \\
\hline
{\em initial\+Weight} & The value all the blend mask entries will be initialised with (negative to skip initialisation) \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_animation_state_a78fe4050a91268162602c50cf03f9774}\label{class_ogre_1_1_animation_state_a78fe4050a91268162602c50cf03f9774}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!destroy\+Blend\+Mask@{destroy\+Blend\+Mask}}
\index{destroy\+Blend\+Mask@{destroy\+Blend\+Mask}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{destroy\+Blend\+Mask()}{destroyBlendMask()}}
{\footnotesize\ttfamily void Ogre\+::\+Animation\+State\+::destroy\+Blend\+Mask (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Destroy the currently set blend mask. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_ad38d5a17259f4a88b29773fda638e9fa}\label{class_ogre_1_1_animation_state_ad38d5a17259f4a88b29773fda638e9fa}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!\+\_\+set\+Blend\+Mask\+Data@{\+\_\+set\+Blend\+Mask\+Data}}
\index{\+\_\+set\+Blend\+Mask\+Data@{\+\_\+set\+Blend\+Mask\+Data}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{\+\_\+set\+Blend\+Mask\+Data()}{\_setBlendMaskData()}}
{\footnotesize\ttfamily void Ogre\+::\+Animation\+State\+::\+\_\+set\+Blend\+Mask\+Data (\begin{DoxyParamCaption}\item[{const float $\ast$}]{blend\+Mask\+Data }\end{DoxyParamCaption})}



Set the blend mask data (might be dangerous) 

\begin{DoxyParagraph}{The size of the array should match the number of entries the}
blend mask was created with.
\end{DoxyParagraph}
\begin{DoxyParagraph}{Stick to the set\+Blend\+Mask\+Entry method if you don\textquotesingle{}t know exactly what you\textquotesingle{}re doing.}

\end{DoxyParagraph}
\mbox{\Hypertarget{class_ogre_1_1_animation_state_a1c17270d5133a34a1d2f846d34f61a69}\label{class_ogre_1_1_animation_state_a1c17270d5133a34a1d2f846d34f61a69}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!\+\_\+set\+Blend\+Mask@{\+\_\+set\+Blend\+Mask}}
\index{\+\_\+set\+Blend\+Mask@{\+\_\+set\+Blend\+Mask}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{\+\_\+set\+Blend\+Mask()}{\_setBlendMask()}}
{\footnotesize\ttfamily void Ogre\+::\+Animation\+State\+::\+\_\+set\+Blend\+Mask (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_animation_state_a4acdb34d7886a9ba6e9d7fd977be468c}{Bone\+Blend\+Mask} $\ast$}]{blend\+Mask }\end{DoxyParamCaption})}



Set the blend mask. 

\begin{DoxyParagraph}{The size of the array should match the number of entries the}
blend mask was created with.
\end{DoxyParagraph}
\begin{DoxyParagraph}{Stick to the set\+Blend\+Mask\+Entry method if you don\textquotesingle{}t know exactly what you\textquotesingle{}re doing.}

\end{DoxyParagraph}
\mbox{\Hypertarget{class_ogre_1_1_animation_state_ae4fd5f5523ac2428599220ab2ff0bd59}\label{class_ogre_1_1_animation_state_ae4fd5f5523ac2428599220ab2ff0bd59}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!get\+Blend\+Mask@{get\+Blend\+Mask}}
\index{get\+Blend\+Mask@{get\+Blend\+Mask}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{get\+Blend\+Mask()}{getBlendMask()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_animation_state_a4acdb34d7886a9ba6e9d7fd977be468c}{Bone\+Blend\+Mask}$\ast$ Ogre\+::\+Animation\+State\+::get\+Blend\+Mask (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the current blend mask (const version, may be 0) 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_add31ae35acaa09ebd7bc09e8d28415c3}\label{class_ogre_1_1_animation_state_add31ae35acaa09ebd7bc09e8d28415c3}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!has\+Blend\+Mask@{has\+Blend\+Mask}}
\index{has\+Blend\+Mask@{has\+Blend\+Mask}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{has\+Blend\+Mask()}{hasBlendMask()}}
{\footnotesize\ttfamily bool Ogre\+::\+Animation\+State\+::has\+Blend\+Mask (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Return whether there is currently a valid blend mask set. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_acd87ade1535b3721676d7257b9370a5a}\label{class_ogre_1_1_animation_state_acd87ade1535b3721676d7257b9370a5a}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!set\+Blend\+Mask\+Entry@{set\+Blend\+Mask\+Entry}}
\index{set\+Blend\+Mask\+Entry@{set\+Blend\+Mask\+Entry}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{set\+Blend\+Mask\+Entry()}{setBlendMaskEntry()}}
{\footnotesize\ttfamily void Ogre\+::\+Animation\+State\+::set\+Blend\+Mask\+Entry (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{bone\+Handle,  }\item[{float}]{weight }\end{DoxyParamCaption})}



Set the weight for the bone identified by the given handle. 

\mbox{\Hypertarget{class_ogre_1_1_animation_state_a41115698455a3d6ed4451431bee0552b}\label{class_ogre_1_1_animation_state_a41115698455a3d6ed4451431bee0552b}} 
\index{Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}!get\+Blend\+Mask\+Entry@{get\+Blend\+Mask\+Entry}}
\index{get\+Blend\+Mask\+Entry@{get\+Blend\+Mask\+Entry}!Ogre\+::\+Animation\+State@{Ogre\+::\+Animation\+State}}
\subsubsection{\texorpdfstring{get\+Blend\+Mask\+Entry()}{getBlendMaskEntry()}}
{\footnotesize\ttfamily float Ogre\+::\+Animation\+State\+::get\+Blend\+Mask\+Entry (\begin{DoxyParamCaption}\item[{size\+\_\+t}]{bone\+Handle }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the weight for the bone identified by the given handle. 



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