\hypertarget{class_ogre_1_1_particle_affector}{}\doxysection{Ogre\+::Particle\+Affector Class Reference}
\label{class_ogre_1_1_particle_affector}\index{Ogre::ParticleAffector@{Ogre::ParticleAffector}}


Abstract class defining the interface to be implemented by particle affectors.  




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



Inheritance diagram for Ogre\+::Particle\+Affector\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{class_ogre_1_1_particle_affector__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_ogre_1_1_particle_affector_aacc7b02cc126155d291dcd4ca092050e}{Particle\+Affector}} (\mbox{\hyperlink{class_ogre_1_1_particle_system}{Particle\+System}} $\ast$parent)
\item 
virtual \mbox{\hyperlink{class_ogre_1_1_particle_affector_a89f39b39422328cf8dd11c46eeccb9d0}{$\sim$\+Particle\+Affector}} ()
\begin{DoxyCompactList}\small\item\em Virtual destructor essential. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_particle_affector_a61826c830fc3ef4f37410a656aae7a81}{\+\_\+affect\+Particles}} (\mbox{\hyperlink{class_ogre_1_1_particle_system}{Particle\+System}} $\ast$p\+System, \mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} time\+Elapsed)=0
\begin{DoxyCompactList}\small\item\em Method called to allow the affector to \textquotesingle{}do it\textquotesingle{}s stuff\textquotesingle{} on all active particles in the system. \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 
\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 
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 
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}\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{Detailed Description}
Abstract class defining the interface to be implemented by particle affectors. 

\begin{DoxyRemark}{Remarks}
\mbox{\hyperlink{class_ogre_1_1_particle}{Particle}} affectors modify particles in a particle system over their lifetime. They can be grouped into types, e.\+g. \textquotesingle{}vector force\textquotesingle{} affectors, \textquotesingle{}fader\textquotesingle{} affectors etc; each type will modify particles in a different way, using different parameters. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
Because there are so many types of affectors you could use, O\+G\+RE chooses not to dictate the available types. It comes with some in-\/built, but allows plugins or applications to extend the affector types available. This is done by subclassing \mbox{\hyperlink{class_ogre_1_1_particle_affector}{Particle\+Affector}} to have the appropriate emission behaviour you want, and also creating a subclass of \mbox{\hyperlink{class_ogre_1_1_particle_affector_factory}{Particle\+Affector\+Factory}} which is responsible for creating instances of your new affector type. You register this factory with the \mbox{\hyperlink{class_ogre_1_1_particle_system_manager}{Particle\+System\+Manager}} using add\+Affector\+Factory, and from then on affectors of this type can be created either from code or through text particle scripts by naming the type. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{}
This same approach is used for Particle\+Emitters (which are the source of particles in a system). This means that O\+G\+RE is particularly flexible when it comes to creating particle system effects, with literally infinite combinations of affector and affector types, and parameters within those types. 
\end{DoxyParagraph}


\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_particle_affector_aacc7b02cc126155d291dcd4ca092050e}\label{class_ogre_1_1_particle_affector_aacc7b02cc126155d291dcd4ca092050e}} 
\index{Ogre::ParticleAffector@{Ogre::ParticleAffector}!ParticleAffector@{ParticleAffector}}
\index{ParticleAffector@{ParticleAffector}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\doxysubsubsection{\texorpdfstring{ParticleAffector()}{ParticleAffector()}}
{\footnotesize\ttfamily Ogre\+::\+Particle\+Affector\+::\+Particle\+Affector (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_particle_system}{Particle\+System}} $\ast$}]{parent }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}

\mbox{\Hypertarget{class_ogre_1_1_particle_affector_a89f39b39422328cf8dd11c46eeccb9d0}\label{class_ogre_1_1_particle_affector_a89f39b39422328cf8dd11c46eeccb9d0}} 
\index{Ogre::ParticleAffector@{Ogre::ParticleAffector}!````~ParticleAffector@{$\sim$ParticleAffector}}
\index{````~ParticleAffector@{$\sim$ParticleAffector}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\doxysubsubsection{\texorpdfstring{$\sim$ParticleAffector()}{~ParticleAffector()}}
{\footnotesize\ttfamily virtual Ogre\+::\+Particle\+Affector\+::$\sim$\+Particle\+Affector (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Virtual destructor essential. 



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_particle_affector_a5f401d9023e7bb484ff3ff49e70c9510}\label{class_ogre_1_1_particle_affector_a5f401d9023e7bb484ff3ff49e70c9510}} 
\index{Ogre::ParticleAffector@{Ogre::ParticleAffector}!\_initParticle@{\_initParticle}}
\index{\_initParticle@{\_initParticle}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\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]}}



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_a61826c830fc3ef4f37410a656aae7a81}\label{class_ogre_1_1_particle_affector_a61826c830fc3ef4f37410a656aae7a81}} 
\index{Ogre::ParticleAffector@{Ogre::ParticleAffector}!\_affectParticles@{\_affectParticles}}
\index{\_affectParticles@{\_affectParticles}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\doxysubsubsection{\texorpdfstring{\_affectParticles()}{\_affectParticles()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Particle\+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 [pure virtual]}}



Method called to allow the affector to \textquotesingle{}do it\textquotesingle{}s stuff\textquotesingle{} on all active particles in the system. 

\begin{DoxyRemark}{Remarks}
This is where the affector gets the chance to apply it\textquotesingle{}s effects to the particles of a system. The affector is expected to apply it\textquotesingle{}s effect to 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\+System} & Pointer to a \mbox{\hyperlink{class_ogre_1_1_particle_system}{Particle\+System}} to affect. \\
\hline
{\em time\+Elapsed} & The number of seconds which have elapsed since the last call. \\
\hline
\end{DoxyParams}


Implemented in \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector2_a61ae2e9fef2329eefcbde9b819fa0d7a}{Ogre\+::\+Colour\+Fader\+Affector2}}, \mbox{\hyperlink{class_ogre_1_1_rotation_affector_a4ddd5ad806b1a5f3363f2667430c5b95}{Ogre\+::\+Rotation\+Affector}}, \mbox{\hyperlink{class_ogre_1_1_colour_fader_affector_a423d0d34b3f0e1579110dae05b416fbb}{Ogre\+::\+Colour\+Fader\+Affector}}, \mbox{\hyperlink{class_ogre_1_1_linear_force_affector_a2edf749dcb05d15fdb363e6d44163742}{Ogre\+::\+Linear\+Force\+Affector}}, \mbox{\hyperlink{group___particle_f_x_gafd1e8ecc0e92f66725b7736d884967e3}{Ogre\+::\+Direction\+Randomiser\+Affector}}, \mbox{\hyperlink{class_ogre_1_1_deflector_plane_affector_ad886dbce8b80a8e8d914b9c3cf9e893c}{Ogre\+::\+Deflector\+Plane\+Affector}}, \mbox{\hyperlink{class_ogre_1_1_colour_interpolator_affector_a28d59576dcb488c86373eb74d6f0e1ed}{Ogre\+::\+Colour\+Interpolator\+Affector}}, \mbox{\hyperlink{class_ogre_1_1_scale_affector_ad5a1709ff925c5ce5c6205cef8b3bafb}{Ogre\+::\+Scale\+Affector}}, and \mbox{\hyperlink{class_ogre_1_1_colour_image_affector_a9c00c2785abad52b3c006988196a2cd4}{Ogre\+::\+Colour\+Image\+Affector}}.

\mbox{\Hypertarget{class_ogre_1_1_particle_affector_ab38dc9df81b23a9b041b56d7329cb5b9}\label{class_ogre_1_1_particle_affector_ab38dc9df81b23a9b041b56d7329cb5b9}} 
\index{Ogre::ParticleAffector@{Ogre::ParticleAffector}!getType@{getType}}
\index{getType@{getType}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\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]}}



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::ParticleAffector@{Ogre::ParticleAffector}!getParamDictionary@{getParamDictionary}}
\index{getParamDictionary@{getParamDictionary}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\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::ParticleAffector@{Ogre::ParticleAffector}!getParamDictionary@{getParamDictionary}}
\index{getParamDictionary@{getParamDictionary}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\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::ParticleAffector@{Ogre::ParticleAffector}!getParameters@{getParameters}}
\index{getParameters@{getParameters}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\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::ParticleAffector@{Ogre::ParticleAffector}!setParameter@{setParameter}}
\index{setParameter@{setParameter}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\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::ParticleAffector@{Ogre::ParticleAffector}!setParameterList@{setParameterList}}
\index{setParameterList@{setParameterList}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\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::ParticleAffector@{Ogre::ParticleAffector}!getParameter@{getParameter}}
\index{getParameter@{getParameter}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\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::ParticleAffector@{Ogre::ParticleAffector}!copyParametersTo@{copyParametersTo}}
\index{copyParametersTo@{copyParametersTo}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\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::ParticleAffector@{Ogre::ParticleAffector}!cleanupDictionary@{cleanupDictionary}}
\index{cleanupDictionary@{cleanupDictionary}!Ogre::ParticleAffector@{Ogre::ParticleAffector}}
\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. 

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