\hypertarget{class_ogre_1_1_colour_fader_affector}{}\doxysection{Ogre\+::Colour\+Fader\+Affector Class Reference}
\label{class_ogre_1_1_colour_fader_affector}\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}


This plugin subclass of \mbox{\hyperlink{class_ogre_1_1_particle_affector}{Particle\+Affector}} allows you to alter the colour of particles.  




{\ttfamily \#include $<$Ogre\+Colour\+Fader\+Affector.\+h$>$}



Inheritance diagram for Ogre\+::Colour\+Fader\+Affector\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=270pt]{class_ogre_1_1_colour_fader_affector__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
class \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_1_1_cmd_alpha_adjust}{Cmd\+Alpha\+Adjust}}
\begin{DoxyCompactList}\small\item\em Command object for alpha adjust (see \mbox{\hyperlink{class_ogre_1_1_param_command}{Param\+Command}}). \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_1_1_cmd_blue_adjust}{Cmd\+Blue\+Adjust}}
\begin{DoxyCompactList}\small\item\em Command object for blue adjust (see \mbox{\hyperlink{class_ogre_1_1_param_command}{Param\+Command}}). \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_1_1_cmd_green_adjust}{Cmd\+Green\+Adjust}}
\begin{DoxyCompactList}\small\item\em Command object for green adjust (see \mbox{\hyperlink{class_ogre_1_1_param_command}{Param\+Command}}). \end{DoxyCompactList}\item 
class \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_1_1_cmd_red_adjust}{Cmd\+Red\+Adjust}}
\begin{DoxyCompactList}\small\item\em Command object for red adjust (see \mbox{\hyperlink{class_ogre_1_1_param_command}{Param\+Command}}). \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_ac2a68a0de0951830620221bf56084ea1}{Colour\+Fader\+Affector}} (\mbox{\hyperlink{class_ogre_1_1_particle_system}{Particle\+System}} $\ast$psys)
\begin{DoxyCompactList}\small\item\em Default constructor. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_a423d0d34b3f0e1579110dae05b416fbb}{\+\_\+affect\+Particles}} (\mbox{\hyperlink{class_ogre_1_1_particle_system}{Particle\+System}} $\ast$p\+System, \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} time\+Elapsed)
\begin{DoxyCompactList}\small\item\em See \mbox{\hyperlink{class_ogre_1_1_particle_affector}{Particle\+Affector}}. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_particle_affector_a5f401d9023e7bb484ff3ff49e70c9510}{\+\_\+init\+Particle}} (\mbox{\hyperlink{class_ogre_1_1_particle}{Particle}} $\ast$p\+Particle)
\begin{DoxyCompactList}\small\item\em Method called to allow the affector to initialize all newly created particles in the system. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_string_interface_aad68d8b18faad14e8286a67527094654}{copy\+Parameters\+To}} (\mbox{\hyperlink{class_ogre_1_1_string_interface}{String\+Interface}} $\ast$dest) const
\begin{DoxyCompactList}\small\item\em Method for copying this object\textquotesingle{}s parameters to another object. \end{DoxyCompactList}\item 
float \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_a636e13e4596f27a085f86037675b33f0}{get\+Alpha\+Adjust}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the alpha adjustment to be made per second to particles. \end{DoxyCompactList}\item 
float \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_ad04be7986be747570cc16ec7b5a428ce}{get\+Blue\+Adjust}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the blue adjustment to be made per second to particles. \end{DoxyCompactList}\item 
float \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_aeea404d5aa6ccb44de52087ae28b1e28}{get\+Green\+Adjust}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the green adjustment to be made per second to particles. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_string_interface_ae3e13925bde11db245f6c9bbf5031a93}{get\+Param\+Dictionary}} (void)
\begin{DoxyCompactList}\small\item\em Retrieves the parameter dictionary for this class. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_string_interface_a0f55da0550a7e1ab70a1c8bf598a3e20}{get\+Param\+Dictionary}} (void) const
\item 
\mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \mbox{\hyperlink{class_ogre_1_1_string_interface_a1d078304c38a9f85d483fc8ed0cdf1fe}{get\+Parameter}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&name) const
\begin{DoxyCompactList}\small\item\em Generic parameter retrieval method. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{group___general_ga1838c2b0619ade1f5e29767062212872}{Parameter\+List}} \& \mbox{\hyperlink{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}{get\+Parameters}} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves a list of parameters valid for this object. \end{DoxyCompactList}\item 
float \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_af6b82cb7b01ace5ca06f04a0c44948c9}{get\+Red\+Adjust}} (void) const
\begin{DoxyCompactList}\small\item\em Gets the red adjustment to be made per second to particles. \end{DoxyCompactList}\item 
const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \& \mbox{\hyperlink{class_ogre_1_1_particle_affector_ab38dc9df81b23a9b041b56d7329cb5b9}{get\+Type}} (void) const
\begin{DoxyCompactList}\small\item\em Returns the name of the type of affector. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_ab4cd1a28bd756c76b18f70e0e7f74434}{set\+Adjust}} (float red, float green, float blue, float alpha=0.\+0)
\begin{DoxyCompactList}\small\item\em Sets the colour adjustment to be made per second to particles. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_ae2dc5379ebf31c0db589248c20d0dd03}{set\+Alpha\+Adjust}} (float alpha)
\begin{DoxyCompactList}\small\item\em Sets the alpha adjustment to be made per second to particles. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_a25604357e6db26577b5cf682f624065b}{set\+Blue\+Adjust}} (float blue)
\begin{DoxyCompactList}\small\item\em Sets the blue adjustment to be made per second to particles. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_acd32e4ca7c8d9eb2a73965548d0457b2}{set\+Green\+Adjust}} (float green)
\begin{DoxyCompactList}\small\item\em Sets the green adjustment to be made per second to particles. \end{DoxyCompactList}\item 
bool \mbox{\hyperlink{class_ogre_1_1_string_interface_a08d117bf25f011f96d81f1f4ecb25113}{set\+Parameter}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&name, const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&value)
\begin{DoxyCompactList}\small\item\em Generic parameter setting method. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_string_interface_a9aac32f93bd149a34b809a57a9f01f8f}{set\+Parameter\+List}} (const \mbox{\hyperlink{group___general_ga0537f38d7a77fcbe9f600f6ed8a926d6}{Name\+Value\+Pair\+List}} \&param\+List)
\begin{DoxyCompactList}\small\item\em Generic multiple parameter setting method. \end{DoxyCompactList}\item 
void \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_aaee9d32ed0a73fafca95bb28c5cde0a8}{set\+Red\+Adjust}} (float red)
\begin{DoxyCompactList}\small\item\em Sets the red adjustment to be made per second to particles. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
static void \mbox{\hyperlink{class_ogre_1_1_string_interface_a1bea65fa2b3c2ac5a9f3be59b46a80e8}{cleanup\+Dictionary}} ()
\begin{DoxyCompactList}\small\item\em Cleans up the static \textquotesingle{}ms\+Dictionary\textquotesingle{} required to reset \mbox{\hyperlink{namespace_ogre}{Ogre}}, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the \mbox{\hyperlink{class_ogre_1_1_resource_manager}{Resource\+Manager}} implementers (e.\+g. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
static \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_1_1_cmd_alpha_adjust}{Cmd\+Alpha\+Adjust}} \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_a735a1f8fc6b5504d7a1dcd2ccb4f5660}{ms\+Alpha\+Cmd}}
\item 
static \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_1_1_cmd_blue_adjust}{Cmd\+Blue\+Adjust}} \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_adc4b2abf2d8a4dfef4f9e7d0e08bbe3c}{ms\+Blue\+Cmd}}
\item 
static \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_1_1_cmd_green_adjust}{Cmd\+Green\+Adjust}} \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_ad840b36b008e6f0eafaf1185d450e4ab}{ms\+Green\+Cmd}}
\item 
static \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_1_1_cmd_red_adjust}{Cmd\+Red\+Adjust}} \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_a9dba68a0a01e6fa6fc74b62cc2ae149a}{ms\+Red\+Cmd}}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
This plugin subclass of \mbox{\hyperlink{class_ogre_1_1_particle_affector}{Particle\+Affector}} allows you to alter the colour of particles. 

\begin{DoxyRemark}{Remarks}
This class supplies the \mbox{\hyperlink{class_ogre_1_1_particle_affector}{Particle\+Affector}} implementation required to modify the colour of particle in mid-\/flight. 
\end{DoxyRemark}


\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_ac2a68a0de0951830620221bf56084ea1}\label{class_ogre_1_1_colour_fader_affector_ac2a68a0de0951830620221bf56084ea1}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!ColourFaderAffector@{ColourFaderAffector}}
\index{ColourFaderAffector@{ColourFaderAffector}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{ColourFaderAffector()}{ColourFaderAffector()}}
{\footnotesize\ttfamily Ogre\+::\+Colour\+Fader\+Affector\+::\+Colour\+Fader\+Affector (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_particle_system}{Particle\+System}} $\ast$}]{psys }\end{DoxyParamCaption})}



Default constructor. 



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_a423d0d34b3f0e1579110dae05b416fbb}\label{class_ogre_1_1_colour_fader_affector_a423d0d34b3f0e1579110dae05b416fbb}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!\_affectParticles@{\_affectParticles}}
\index{\_affectParticles@{\_affectParticles}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{\_affectParticles()}{\_affectParticles()}}
{\footnotesize\ttfamily void Ogre\+::\+Colour\+Fader\+Affector\+::\+\_\+affect\+Particles (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_particle_system}{Particle\+System}} $\ast$}]{p\+System,  }\item[{\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}}]{time\+Elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



See \mbox{\hyperlink{class_ogre_1_1_particle_affector}{Particle\+Affector}}. 



Implements \mbox{\hyperlink{class_ogre_1_1_particle_affector_a61826c830fc3ef4f37410a656aae7a81}{Ogre\+::\+Particle\+Affector}}.

\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_ab4cd1a28bd756c76b18f70e0e7f74434}\label{class_ogre_1_1_colour_fader_affector_ab4cd1a28bd756c76b18f70e0e7f74434}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!setAdjust@{setAdjust}}
\index{setAdjust@{setAdjust}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{setAdjust()}{setAdjust()}}
{\footnotesize\ttfamily void Ogre\+::\+Colour\+Fader\+Affector\+::set\+Adjust (\begin{DoxyParamCaption}\item[{float}]{red,  }\item[{float}]{green,  }\item[{float}]{blue,  }\item[{float}]{alpha = {\ttfamily 0.0} }\end{DoxyParamCaption})}



Sets the colour adjustment to be made per second to particles. 


\begin{DoxyParams}{Parameters}
{\em red,green,blue,alpha} & Sets the adjustment to be made to each of the colour components per second. These values will be added to the colour of all particles every second, scaled over each frame for a smooth adjustment. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_aaee9d32ed0a73fafca95bb28c5cde0a8}\label{class_ogre_1_1_colour_fader_affector_aaee9d32ed0a73fafca95bb28c5cde0a8}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!setRedAdjust@{setRedAdjust}}
\index{setRedAdjust@{setRedAdjust}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{setRedAdjust()}{setRedAdjust()}}
{\footnotesize\ttfamily void Ogre\+::\+Colour\+Fader\+Affector\+::set\+Red\+Adjust (\begin{DoxyParamCaption}\item[{float}]{red }\end{DoxyParamCaption})}



Sets the red adjustment to be made per second to particles. 


\begin{DoxyParams}{Parameters}
{\em red} & The adjustment to be made to the colour component per second. This value will be added to the colour of all particles every second, scaled over each frame for a smooth adjustment. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_af6b82cb7b01ace5ca06f04a0c44948c9}\label{class_ogre_1_1_colour_fader_affector_af6b82cb7b01ace5ca06f04a0c44948c9}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!getRedAdjust@{getRedAdjust}}
\index{getRedAdjust@{getRedAdjust}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{getRedAdjust()}{getRedAdjust()}}
{\footnotesize\ttfamily float Ogre\+::\+Colour\+Fader\+Affector\+::get\+Red\+Adjust (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the red adjustment to be made per second to particles. 

\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_acd32e4ca7c8d9eb2a73965548d0457b2}\label{class_ogre_1_1_colour_fader_affector_acd32e4ca7c8d9eb2a73965548d0457b2}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!setGreenAdjust@{setGreenAdjust}}
\index{setGreenAdjust@{setGreenAdjust}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{setGreenAdjust()}{setGreenAdjust()}}
{\footnotesize\ttfamily void Ogre\+::\+Colour\+Fader\+Affector\+::set\+Green\+Adjust (\begin{DoxyParamCaption}\item[{float}]{green }\end{DoxyParamCaption})}



Sets the green adjustment to be made per second to particles. 


\begin{DoxyParams}{Parameters}
{\em green} & The adjustment to be made to the colour component per second. This value will be added to the colour of all particles every second, scaled over each frame for a smooth adjustment. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_aeea404d5aa6ccb44de52087ae28b1e28}\label{class_ogre_1_1_colour_fader_affector_aeea404d5aa6ccb44de52087ae28b1e28}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!getGreenAdjust@{getGreenAdjust}}
\index{getGreenAdjust@{getGreenAdjust}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{getGreenAdjust()}{getGreenAdjust()}}
{\footnotesize\ttfamily float Ogre\+::\+Colour\+Fader\+Affector\+::get\+Green\+Adjust (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the green adjustment to be made per second to particles. 

\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_a25604357e6db26577b5cf682f624065b}\label{class_ogre_1_1_colour_fader_affector_a25604357e6db26577b5cf682f624065b}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!setBlueAdjust@{setBlueAdjust}}
\index{setBlueAdjust@{setBlueAdjust}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{setBlueAdjust()}{setBlueAdjust()}}
{\footnotesize\ttfamily void Ogre\+::\+Colour\+Fader\+Affector\+::set\+Blue\+Adjust (\begin{DoxyParamCaption}\item[{float}]{blue }\end{DoxyParamCaption})}



Sets the blue adjustment to be made per second to particles. 


\begin{DoxyParams}{Parameters}
{\em blue} & The adjustment to be made to the colour component per second. This value will be added to the colour of all particles every second, scaled over each frame for a smooth adjustment. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_ad04be7986be747570cc16ec7b5a428ce}\label{class_ogre_1_1_colour_fader_affector_ad04be7986be747570cc16ec7b5a428ce}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!getBlueAdjust@{getBlueAdjust}}
\index{getBlueAdjust@{getBlueAdjust}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{getBlueAdjust()}{getBlueAdjust()}}
{\footnotesize\ttfamily float Ogre\+::\+Colour\+Fader\+Affector\+::get\+Blue\+Adjust (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the blue adjustment to be made per second to particles. 

\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_ae2dc5379ebf31c0db589248c20d0dd03}\label{class_ogre_1_1_colour_fader_affector_ae2dc5379ebf31c0db589248c20d0dd03}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!setAlphaAdjust@{setAlphaAdjust}}
\index{setAlphaAdjust@{setAlphaAdjust}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{setAlphaAdjust()}{setAlphaAdjust()}}
{\footnotesize\ttfamily void Ogre\+::\+Colour\+Fader\+Affector\+::set\+Alpha\+Adjust (\begin{DoxyParamCaption}\item[{float}]{alpha }\end{DoxyParamCaption})}



Sets the alpha adjustment to be made per second to particles. 


\begin{DoxyParams}{Parameters}
{\em alpha} & The adjustment to be made to the colour component per second. This value will be added to the colour of all particles every second, scaled over each frame for a smooth adjustment. \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_a636e13e4596f27a085f86037675b33f0}\label{class_ogre_1_1_colour_fader_affector_a636e13e4596f27a085f86037675b33f0}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!getAlphaAdjust@{getAlphaAdjust}}
\index{getAlphaAdjust@{getAlphaAdjust}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{getAlphaAdjust()}{getAlphaAdjust()}}
{\footnotesize\ttfamily float Ogre\+::\+Colour\+Fader\+Affector\+::get\+Alpha\+Adjust (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the alpha adjustment to be made per second to particles. 

\mbox{\Hypertarget{class_ogre_1_1_particle_affector_a5f401d9023e7bb484ff3ff49e70c9510}\label{class_ogre_1_1_particle_affector_a5f401d9023e7bb484ff3ff49e70c9510}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!\_initParticle@{\_initParticle}}
\index{\_initParticle@{\_initParticle}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{\_initParticle()}{\_initParticle()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Particle\+Affector\+::\+\_\+init\+Particle (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_particle}{Particle}} $\ast$}]{p\+Particle }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}, {\ttfamily [inherited]}}



Method called to allow the affector to initialize all newly created particles in the system. 

\begin{DoxyRemark}{Remarks}
This is where the affector gets the chance to initialize it\textquotesingle{}s effects to the particles of a system. The affector is expected to initialize some or all of the particles in the system passed to it, depending on the affector\textquotesingle{}s approach. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em p\+Particle} & Pointer to a \mbox{\hyperlink{class_ogre_1_1_particle}{Particle}} to initialize. \\
\hline
\end{DoxyParams}


Reimplemented in \mbox{\hyperlink{class_ogre_1_1_rotation_affector_acac2cf0655f915ad316f2f800482441c}{Ogre\+::\+Rotation\+Affector}}, and \mbox{\hyperlink{class_ogre_1_1_colour_image_affector_a984fc468041419661aa75af91d0d2757}{Ogre\+::\+Colour\+Image\+Affector}}.

\mbox{\Hypertarget{class_ogre_1_1_particle_affector_ab38dc9df81b23a9b041b56d7329cb5b9}\label{class_ogre_1_1_particle_affector_ab38dc9df81b23a9b041b56d7329cb5b9}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!getType@{getType}}
\index{getType@{getType}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{getType()}{getType()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}}\& Ogre\+::\+Particle\+Affector\+::get\+Type (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Returns the name of the type of affector. 

\begin{DoxyRemark}{Remarks}
This property is useful for determining the type of affector procedurally so another can be created. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_ae3e13925bde11db245f6c9bbf5031a93}\label{class_ogre_1_1_string_interface_ae3e13925bde11db245f6c9bbf5031a93}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!getParamDictionary@{getParamDictionary}}
\index{getParamDictionary@{getParamDictionary}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{getParamDictionary()}{getParamDictionary()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary}}$\ast$ Ogre\+::\+String\+Interface\+::get\+Param\+Dictionary (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Retrieves the parameter dictionary for this class. 

\begin{DoxyRemark}{Remarks}
Only valid to call this after create\+Param\+Dictionary. 
\end{DoxyRemark}
\begin{DoxyReturn}{Returns}
Pointer to \mbox{\hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary}} shared by all instances of this class which you can add parameters to, retrieve parameters etc. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_a0f55da0550a7e1ab70a1c8bf598a3e20}\label{class_ogre_1_1_string_interface_a0f55da0550a7e1ab70a1c8bf598a3e20}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!getParamDictionary@{getParamDictionary}}
\index{getParamDictionary@{getParamDictionary}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{getParamDictionary()}{getParamDictionary()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily const \mbox{\hyperlink{class_ogre_1_1_param_dictionary}{Param\+Dictionary}}$\ast$ Ogre\+::\+String\+Interface\+::get\+Param\+Dictionary (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}

\mbox{\Hypertarget{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}\label{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!getParameters@{getParameters}}
\index{getParameters@{getParameters}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{getParameters()}{getParameters()}}
{\footnotesize\ttfamily const \mbox{\hyperlink{group___general_ga1838c2b0619ade1f5e29767062212872}{Parameter\+List}}\& Ogre\+::\+String\+Interface\+::get\+Parameters (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inherited]}}



Retrieves a list of parameters valid for this object. 

\begin{DoxyReturn}{Returns}
A reference to a static list of \mbox{\hyperlink{class_ogre_1_1_parameter_def}{Parameter\+Def}} objects. 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_a08d117bf25f011f96d81f1f4ecb25113}\label{class_ogre_1_1_string_interface_a08d117bf25f011f96d81f1f4ecb25113}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!setParameter@{setParameter}}
\index{setParameter@{setParameter}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{setParameter()}{setParameter()}}
{\footnotesize\ttfamily bool Ogre\+::\+String\+Interface\+::set\+Parameter (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{name,  }\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{value }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Generic parameter setting method. 

\begin{DoxyRemark}{Remarks}
Call this method with the name of a parameter and a string version of the value to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from \mbox{\hyperlink{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}{String\+Interface\+::get\+Parameters}}. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em name} & The name of the parameter to set \\
\hline
{\em value} & String value. Must be in the right format for the type specified in the parameter definition. See the \mbox{\hyperlink{class_ogre_1_1_string_converter}{String\+Converter}} class for more information. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
true if set was successful, false otherwise (NB no exceptions thrown -\/ tolerant method) 
\end{DoxyReturn}


Referenced by Ogre\+::\+String\+Interface\+::copy\+Parameters\+To().

\mbox{\Hypertarget{class_ogre_1_1_string_interface_a9aac32f93bd149a34b809a57a9f01f8f}\label{class_ogre_1_1_string_interface_a9aac32f93bd149a34b809a57a9f01f8f}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!setParameterList@{setParameterList}}
\index{setParameterList@{setParameterList}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{setParameterList()}{setParameterList()}}
{\footnotesize\ttfamily void Ogre\+::\+String\+Interface\+::set\+Parameter\+List (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{group___general_ga0537f38d7a77fcbe9f600f6ed8a926d6}{Name\+Value\+Pair\+List}} \&}]{param\+List }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inherited]}}



Generic multiple parameter setting method. 

\begin{DoxyRemark}{Remarks}
Call this method with a list of name / value pairs to set. The implementor will convert the string to a native type internally. If in doubt, check the parameter definition in the list returned from \mbox{\hyperlink{class_ogre_1_1_string_interface_ad4b984bfbf148ddb3310b3d0ba8a9d5d}{String\+Interface\+::get\+Parameters}}. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em param\+List} & Name/value pair list \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_string_interface_a1d078304c38a9f85d483fc8ed0cdf1fe}\label{class_ogre_1_1_string_interface_a1d078304c38a9f85d483fc8ed0cdf1fe}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!getParameter@{getParameter}}
\index{getParameter@{getParameter}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{getParameter()}{getParameter()}}
{\footnotesize\ttfamily \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} Ogre\+::\+String\+Interface\+::get\+Parameter (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{name }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Generic parameter retrieval method. 

\begin{DoxyRemark}{Remarks}
Call this method with the name of a parameter to retrieve a string-\/format value of the parameter in question. If in doubt, check the parameter definition in the list returned from get\+Parameters for the type of this parameter. If you like you can use \mbox{\hyperlink{class_ogre_1_1_string_converter}{String\+Converter}} to convert this string back into a native type. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em name} & The name of the parameter to get \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
String value of parameter, blank if not found 
\end{DoxyReturn}


References Ogre\+::\+Param\+Command\+::do\+Get().

\mbox{\Hypertarget{class_ogre_1_1_string_interface_aad68d8b18faad14e8286a67527094654}\label{class_ogre_1_1_string_interface_aad68d8b18faad14e8286a67527094654}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!copyParametersTo@{copyParametersTo}}
\index{copyParametersTo@{copyParametersTo}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{copyParametersTo()}{copyParametersTo()}}
{\footnotesize\ttfamily void Ogre\+::\+String\+Interface\+::copy\+Parameters\+To (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_string_interface}{String\+Interface}} $\ast$}]{dest }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [inherited]}}



Method for copying this object\textquotesingle{}s parameters to another object. 

\begin{DoxyRemark}{Remarks}
This method takes the values of all the object\textquotesingle{}s parameters and tries to set the same values on the destination object. This provides a completely type independent way to copy parameters to other objects. Note that because of the String manipulation involved, this should not be regarded as an efficient process and should be saved for times outside of the rendering loop. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
\mbox{\hyperlink{class_ogre_1_1_any}{Any}} unrecognised parameters will be ignored as with set\+Parameter method. 
\end{DoxyParagraph}

\begin{DoxyParams}{Parameters}
{\em dest} & Pointer to object to have it\textquotesingle{}s parameters set the same as this object. \\
\hline
\end{DoxyParams}


References Ogre\+::\+String\+Interface\+::set\+Parameter().

\mbox{\Hypertarget{class_ogre_1_1_string_interface_a1bea65fa2b3c2ac5a9f3be59b46a80e8}\label{class_ogre_1_1_string_interface_a1bea65fa2b3c2ac5a9f3be59b46a80e8}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!cleanupDictionary@{cleanupDictionary}}
\index{cleanupDictionary@{cleanupDictionary}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{cleanupDictionary()}{cleanupDictionary()}}
{\footnotesize\ttfamily static void Ogre\+::\+String\+Interface\+::cleanup\+Dictionary (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [static]}, {\ttfamily [inherited]}}



Cleans up the static \textquotesingle{}ms\+Dictionary\textquotesingle{} required to reset \mbox{\hyperlink{namespace_ogre}{Ogre}}, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the \mbox{\hyperlink{class_ogre_1_1_resource_manager}{Resource\+Manager}} implementers (e.\+g. 

\mbox{\hyperlink{class_ogre_1_1_material_manager}{Material\+Manager}}) initializes. 

\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_a9dba68a0a01e6fa6fc74b62cc2ae149a}\label{class_ogre_1_1_colour_fader_affector_a9dba68a0a01e6fa6fc74b62cc2ae149a}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!msRedCmd@{msRedCmd}}
\index{msRedCmd@{msRedCmd}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{msRedCmd}{msRedCmd}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_1_1_cmd_red_adjust}{Cmd\+Red\+Adjust}} Ogre\+::\+Colour\+Fader\+Affector\+::ms\+Red\+Cmd\hspace{0.3cm}{\ttfamily [static]}}

\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_ad840b36b008e6f0eafaf1185d450e4ab}\label{class_ogre_1_1_colour_fader_affector_ad840b36b008e6f0eafaf1185d450e4ab}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!msGreenCmd@{msGreenCmd}}
\index{msGreenCmd@{msGreenCmd}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{msGreenCmd}{msGreenCmd}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_1_1_cmd_green_adjust}{Cmd\+Green\+Adjust}} Ogre\+::\+Colour\+Fader\+Affector\+::ms\+Green\+Cmd\hspace{0.3cm}{\ttfamily [static]}}

\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_adc4b2abf2d8a4dfef4f9e7d0e08bbe3c}\label{class_ogre_1_1_colour_fader_affector_adc4b2abf2d8a4dfef4f9e7d0e08bbe3c}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!msBlueCmd@{msBlueCmd}}
\index{msBlueCmd@{msBlueCmd}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{msBlueCmd}{msBlueCmd}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_1_1_cmd_blue_adjust}{Cmd\+Blue\+Adjust}} Ogre\+::\+Colour\+Fader\+Affector\+::ms\+Blue\+Cmd\hspace{0.3cm}{\ttfamily [static]}}

\mbox{\Hypertarget{class_ogre_1_1_colour_fader_affector_a735a1f8fc6b5504d7a1dcd2ccb4f5660}\label{class_ogre_1_1_colour_fader_affector_a735a1f8fc6b5504d7a1dcd2ccb4f5660}} 
\index{Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}!msAlphaCmd@{msAlphaCmd}}
\index{msAlphaCmd@{msAlphaCmd}!Ogre::ColourFaderAffector@{Ogre::ColourFaderAffector}}
\doxysubsubsection{\texorpdfstring{msAlphaCmd}{msAlphaCmd}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_1_1_cmd_alpha_adjust}{Cmd\+Alpha\+Adjust}} Ogre\+::\+Colour\+Fader\+Affector\+::ms\+Alpha\+Cmd\hspace{0.3cm}{\ttfamily [static]}}



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{_ogre_colour_fader_affector_8h}{Ogre\+Colour\+Fader\+Affector.\+h}}\end{DoxyCompactItemize}
