\hypertarget{class_ogre_1_1_billboard}{}\section{Ogre\+:\+:Billboard Class Reference}
\label{class_ogre_1_1_billboard}\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}


A billboard is a primitive which always faces the camera in every frame.  




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



Inheritance diagram for Ogre\+:\+:Billboard\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=169pt]{class_ogre_1_1_billboard__inherit__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_billboard_a39ef001d2052cbae98014753e210b732}{Billboard} ()
\begin{DoxyCompactList}\small\item\em Default constructor. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_billboard_aff96bdb3a3446cdf08499e58aa03c3c5}{Billboard} (const \hyperlink{class_ogre_1_1_vector3}{Vector3} \&position, \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set} $\ast$owner, const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \&colour=\hyperlink{class_ogre_1_1_colour_value_a8eba66b2908f44f00f8d9c9ec25877de}{Colour\+Value\+::\+White})
\begin{DoxyCompactList}\small\item\em Normal constructor as called by \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_billboard_a3ef9bffd0c2a51d1bbac274bdf86c869}{$\sim$\+Billboard} ()
\begin{DoxyCompactList}\small\item\em Default destructor. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_billboard_a88d66ce919092367df57a2e3abcae059}{\+\_\+notify\+Owner} (\hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set} $\ast$owner)
\begin{DoxyCompactList}\small\item\em Internal method for notifying the billboard of it\textquotesingle{}s owner. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \& \hyperlink{class_ogre_1_1_billboard_a0643a04e31d7612792bf8e5137726c30}{get\+Colour} (void) const
\begin{DoxyCompactList}\small\item\em Gets the colour of this billboard. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_billboard_a359337280fbb6db1368e9b834edf168b}{get\+Own\+Height} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves the billboard\textquotesingle{}s personal height, if has\+Own\+Dimensions is true. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} \hyperlink{class_ogre_1_1_billboard_a808dafeb8d3a80f536b89588677bbf83}{get\+Own\+Width} (void) const
\begin{DoxyCompactList}\small\item\em Retrieves the billboard\textquotesingle{}s personal width, if has\+Own\+Dimensions is true. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_vector3}{Vector3} \& \hyperlink{class_ogre_1_1_billboard_a6089e6827491d6674a8e0d69c26c84f3}{get\+Position} (void) const
\begin{DoxyCompactList}\small\item\em Get the position of the billboard. \end{DoxyCompactList}\item 
const \hyperlink{class_ogre_1_1_radian}{Radian} \& \hyperlink{class_ogre_1_1_billboard_afd87344afce380562846280259bedfac}{get\+Rotation} (void) const
\begin{DoxyCompactList}\small\item\em Get the rotation of the billboard. \end{DoxyCompactList}\item 
\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16} \hyperlink{class_ogre_1_1_billboard_a67c55fa7b1487eece36c78bc0148e843}{get\+Texcoord\+Index} (void) const
\begin{DoxyCompactList}\small\item\em \hyperlink{class_ogre_1_1_billboard_a67c55fa7b1487eece36c78bc0148e843}{get\+Texcoord\+Index()} returns the previous value set by \hyperlink{class_ogre_1_1_billboard_ae8aa54c0303721dfc34ebbd8bdf1e8f4}{set\+Texcoord\+Index()}. \end{DoxyCompactList}\item 
const \hyperlink{group___general_ga39213af9254535e83b4beca0859e8a2f}{Float\+Rect} \& \hyperlink{class_ogre_1_1_billboard_ad9b6a9b61cfa3cb665fac5c304c556ef}{get\+Texcoord\+Rect} (void) const
\begin{DoxyCompactList}\small\item\em \hyperlink{class_ogre_1_1_billboard_ad9b6a9b61cfa3cb665fac5c304c556ef}{get\+Texcoord\+Rect()} returns the previous value set by \hyperlink{class_ogre_1_1_billboard_a22f28d979395f04c6039d46a68c4eefb}{set\+Texcoord\+Rect()}. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_billboard_af51d1dcde1023fb18ee9d3d9e5650625}{has\+Own\+Dimensions} (void) const
\begin{DoxyCompactList}\small\item\em Returns true if this billboard deviates from the \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}\textquotesingle{}s default dimensions (i.\+e. \end{DoxyCompactList}\item 
bool \hyperlink{class_ogre_1_1_billboard_a3aced837be58b2b578c5cc63b87e01c3}{is\+Use\+Texcoord\+Rect} (void) const
\begin{DoxyCompactList}\small\item\em Returns true if this billboard use individual texture coordinate rect (i.\+e. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_billboard_ae5bf31f1d013a1f0c3b5a92e46c76d11}{reset\+Dimensions} (void)
\begin{DoxyCompactList}\small\item\em Resets this \hyperlink{class_ogre_1_1_billboard}{Billboard} to use the parent \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}\textquotesingle{}s dimensions instead of it\textquotesingle{}s own. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_billboard_a9126c29605e55b8bdb5f81adf267259a}{set\+Colour} (const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \&colour)
\begin{DoxyCompactList}\small\item\em Sets the colour of this billboard. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_billboard_ac7c7422926a4387ae58c7303b701b8f0}{set\+Dimensions} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} width, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} height)
\begin{DoxyCompactList}\small\item\em Sets the width and height for this billboard. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_billboard_aeb9ce5d9c11492faf34f3ee61e4a4a40}{set\+Position} (const \hyperlink{class_ogre_1_1_vector3}{Vector3} \&position)
\begin{DoxyCompactList}\small\item\em Set the position of the billboard. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_billboard_a0e78e6b90bbf3184f45d0a87bbeb229b}{set\+Position} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} x, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} y, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} z)
\begin{DoxyCompactList}\small\item\em Set the position of the billboard. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_billboard_a8e64eda09ec65dea10dc180b68801d94}{set\+Rotation} (const \hyperlink{class_ogre_1_1_radian}{Radian} \&rotation)
\begin{DoxyCompactList}\small\item\em Set the rotation of the billboard. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_billboard_ae8aa54c0303721dfc34ebbd8bdf1e8f4}{set\+Texcoord\+Index} (\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16} texcoord\+Index)
\begin{DoxyCompactList}\small\item\em \hyperlink{class_ogre_1_1_billboard_ae8aa54c0303721dfc34ebbd8bdf1e8f4}{set\+Texcoord\+Index()} sets which texture coordinate rect this billboard will use when rendering. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_billboard_a22f28d979395f04c6039d46a68c4eefb}{set\+Texcoord\+Rect} (const \hyperlink{group___general_ga39213af9254535e83b4beca0859e8a2f}{Float\+Rect} \&texcoord\+Rect)
\begin{DoxyCompactList}\small\item\em \hyperlink{class_ogre_1_1_billboard_a22f28d979395f04c6039d46a68c4eefb}{set\+Texcoord\+Rect()} sets the individual texture coordinate rect of this billboard will use when rendering. \end{DoxyCompactList}\item 
void \hyperlink{class_ogre_1_1_billboard_a78525470bb318948f9cf68ddf9281aa8}{set\+Texcoord\+Rect} (\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} u0, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} v0, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} u1, \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} v1)
\begin{DoxyCompactList}\small\item\em \hyperlink{class_ogre_1_1_billboard_a22f28d979395f04c6039d46a68c4eefb}{set\+Texcoord\+Rect()} sets the individual texture coordinate rect of this billboard will use when rendering. \end{DoxyCompactList}\end{DoxyCompactItemize}
\subsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \hyperlink{class_ogre_1_1_billboard_aef9f7ad996732865cd2c8842ee265064}{m\+Colour}
\item 
\hyperlink{class_ogre_1_1_vector3}{Vector3} \hyperlink{class_ogre_1_1_billboard_a64425b354973d2d957bc878fca407aad}{m\+Direction}
\begin{DoxyCompactList}\small\item\em Normalised direction vector. \end{DoxyCompactList}\item 
\hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set} $\ast$ \hyperlink{class_ogre_1_1_billboard_aaa2fce61abce942e356fd81925c394fd}{m\+Parent\+Set}
\item 
\hyperlink{class_ogre_1_1_vector3}{Vector3} \hyperlink{class_ogre_1_1_billboard_aa7ad6c8789d8589787c4da34c670d66c}{m\+Position}
\item 
\hyperlink{class_ogre_1_1_radian}{Radian} \hyperlink{class_ogre_1_1_billboard_ad861053413ca65e059dd74131a084839}{m\+Rotation}
\end{DoxyCompactItemize}
\subsection*{Friends}
\begin{DoxyCompactItemize}
\item 
class \hyperlink{class_ogre_1_1_billboard_a261647d2b3ed936e9a2f05309ae878d0}{Billboard\+Particle\+Renderer}
\item 
class \hyperlink{class_ogre_1_1_billboard_a7f055c0ed81c6b3bef6d154d128093a1}{Billboard\+Set}
\end{DoxyCompactItemize}


\subsection{Detailed Description}
A billboard is a primitive which always faces the camera in every frame. 

\begin{DoxyRemark}{Remarks}
Billboards can be used for special effects or some other trickery which requires the triangles to always facing the camera no matter where it is. \hyperlink{namespace_ogre}{Ogre} groups billboards into sets for efficiency, so you should never create a billboard on it\textquotesingle{}s own (it\textquotesingle{}s ok to have a set of one if you need it). 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
Billboards have their geometry generated every frame depending on where the camera is. It is most beneficial for all billboards in a set to be identically sized since \hyperlink{namespace_ogre}{Ogre} can take advantage of this and save some calculations -\/ useful when you have sets of hundreds of billboards as is possible with special effects. You can deviate from this if you wish (example\+: a smoke effect would probably have smoke puffs expanding as they rise, so each billboard will legitimately have it\textquotesingle{}s own size) but be aware the extra overhead this brings and try to avoid it if you can. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{}
Billboards are just the mechanism for rendering a range of effects such as particles. It is other classes which use billboards to create their individual effects, so the methods here are quite generic. 
\end{DoxyParagraph}
\begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set} 
\end{DoxySeeAlso}


\subsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_billboard_a39ef001d2052cbae98014753e210b732}\label{class_ogre_1_1_billboard_a39ef001d2052cbae98014753e210b732}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!Billboard@{Billboard}}
\index{Billboard@{Billboard}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{Billboard()}{Billboard()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily Ogre\+::\+Billboard\+::\+Billboard (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Default constructor. 

\mbox{\Hypertarget{class_ogre_1_1_billboard_a3ef9bffd0c2a51d1bbac274bdf86c869}\label{class_ogre_1_1_billboard_a3ef9bffd0c2a51d1bbac274bdf86c869}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!````~Billboard@{$\sim$\+Billboard}}
\index{````~Billboard@{$\sim$\+Billboard}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{$\sim$\+Billboard()}{~Billboard()}}
{\footnotesize\ttfamily Ogre\+::\+Billboard\+::$\sim$\+Billboard (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})}



Default destructor. 

\mbox{\Hypertarget{class_ogre_1_1_billboard_aff96bdb3a3446cdf08499e58aa03c3c5}\label{class_ogre_1_1_billboard_aff96bdb3a3446cdf08499e58aa03c3c5}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!Billboard@{Billboard}}
\index{Billboard@{Billboard}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{Billboard()}{Billboard()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily Ogre\+::\+Billboard\+::\+Billboard (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_vector3}{Vector3} \&}]{position,  }\item[{\hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set} $\ast$}]{owner,  }\item[{const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \&}]{colour = {\ttfamily \hyperlink{class_ogre_1_1_colour_value_a8eba66b2908f44f00f8d9c9ec25877de}{Colour\+Value\+::\+White}} }\end{DoxyParamCaption})}



Normal constructor as called by \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}. 



\subsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_billboard_afd87344afce380562846280259bedfac}\label{class_ogre_1_1_billboard_afd87344afce380562846280259bedfac}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!get\+Rotation@{get\+Rotation}}
\index{get\+Rotation@{get\+Rotation}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{get\+Rotation()}{getRotation()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_radian}{Radian}\& Ogre\+::\+Billboard\+::get\+Rotation (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Get the rotation of the billboard. 

\begin{DoxyRemark}{Remarks}
This rotation is relative to the center of the billboard. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_billboard_a8e64eda09ec65dea10dc180b68801d94}\label{class_ogre_1_1_billboard_a8e64eda09ec65dea10dc180b68801d94}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!set\+Rotation@{set\+Rotation}}
\index{set\+Rotation@{set\+Rotation}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{set\+Rotation()}{setRotation()}}
{\footnotesize\ttfamily void Ogre\+::\+Billboard\+::set\+Rotation (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_radian}{Radian} \&}]{rotation }\end{DoxyParamCaption})}



Set the rotation of the billboard. 

\begin{DoxyRemark}{Remarks}
This rotation is relative to the center of the billboard. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_billboard_aeb9ce5d9c11492faf34f3ee61e4a4a40}\label{class_ogre_1_1_billboard_aeb9ce5d9c11492faf34f3ee61e4a4a40}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!set\+Position@{set\+Position}}
\index{set\+Position@{set\+Position}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{set\+Position()}{setPosition()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Billboard\+::set\+Position (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_vector3}{Vector3} \&}]{position }\end{DoxyParamCaption})}



Set the position of the billboard. 

\begin{DoxyRemark}{Remarks}
This position is relative to a point on the quad which is the billboard. Depending on the \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}, this may be the center of the quad, the top-\/left etc. See \hyperlink{class_ogre_1_1_billboard_set_ae57f3915d9864c79ca7f0735679f7a13}{Billboard\+Set\+::set\+Billboard\+Origin} for more info. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_billboard_a0e78e6b90bbf3184f45d0a87bbeb229b}\label{class_ogre_1_1_billboard_a0e78e6b90bbf3184f45d0a87bbeb229b}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!set\+Position@{set\+Position}}
\index{set\+Position@{set\+Position}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{set\+Position()}{setPosition()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Billboard\+::set\+Position (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{x,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{y,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{z }\end{DoxyParamCaption})}



Set the position of the billboard. 

\begin{DoxyRemark}{Remarks}
This position is relative to a point on the quad which is the billboard. Depending on the \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}, this may be the center of the quad, the top-\/left etc. See \hyperlink{class_ogre_1_1_billboard_set_ae57f3915d9864c79ca7f0735679f7a13}{Billboard\+Set\+::set\+Billboard\+Origin} for more info. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_billboard_a6089e6827491d6674a8e0d69c26c84f3}\label{class_ogre_1_1_billboard_a6089e6827491d6674a8e0d69c26c84f3}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!get\+Position@{get\+Position}}
\index{get\+Position@{get\+Position}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{get\+Position()}{getPosition()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_vector3}{Vector3}\& Ogre\+::\+Billboard\+::get\+Position (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Get the position of the billboard. 

\begin{DoxyRemark}{Remarks}
This position is relative to a point on the quad which is the billboard. Depending on the \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}, this may be the center of the quad, the top-\/left etc. See \hyperlink{class_ogre_1_1_billboard_set_ae57f3915d9864c79ca7f0735679f7a13}{Billboard\+Set\+::set\+Billboard\+Origin} for more info. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_billboard_ac7c7422926a4387ae58c7303b701b8f0}\label{class_ogre_1_1_billboard_ac7c7422926a4387ae58c7303b701b8f0}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!set\+Dimensions@{set\+Dimensions}}
\index{set\+Dimensions@{set\+Dimensions}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{set\+Dimensions()}{setDimensions()}}
{\footnotesize\ttfamily void Ogre\+::\+Billboard\+::set\+Dimensions (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{width,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{height }\end{DoxyParamCaption})}



Sets the width and height for this billboard. 

\begin{DoxyRemark}{Remarks}
Note that it is most efficient for every billboard in a \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set} to have the same dimensions. If you choose to alter the dimensions of an individual billboard the set will be less efficient. Do not call this method unless you really need to have different billboard dimensions within the same set. Otherwise just call the \hyperlink{class_ogre_1_1_billboard_set_ac3b1429e01d1fc5b20152eb2fe077ead}{Billboard\+Set\+::set\+Default\+Dimensions} method instead. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_billboard_ae5bf31f1d013a1f0c3b5a92e46c76d11}\label{class_ogre_1_1_billboard_ae5bf31f1d013a1f0c3b5a92e46c76d11}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!reset\+Dimensions@{reset\+Dimensions}}
\index{reset\+Dimensions@{reset\+Dimensions}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{reset\+Dimensions()}{resetDimensions()}}
{\footnotesize\ttfamily void Ogre\+::\+Billboard\+::reset\+Dimensions (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}}



Resets this \hyperlink{class_ogre_1_1_billboard}{Billboard} to use the parent \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}\textquotesingle{}s dimensions instead of it\textquotesingle{}s own. 

\mbox{\Hypertarget{class_ogre_1_1_billboard_a9126c29605e55b8bdb5f81adf267259a}\label{class_ogre_1_1_billboard_a9126c29605e55b8bdb5f81adf267259a}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!set\+Colour@{set\+Colour}}
\index{set\+Colour@{set\+Colour}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{set\+Colour()}{setColour()}}
{\footnotesize\ttfamily void Ogre\+::\+Billboard\+::set\+Colour (\begin{DoxyParamCaption}\item[{const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} \&}]{colour }\end{DoxyParamCaption})}



Sets the colour of this billboard. 

\begin{DoxyRemark}{Remarks}
Billboards can be tinted based on a base colour. This allows variations in colour irrespective of the base colour of the material allowing more varied billboards. The default colour is white. The tinting is effected using vertex colours. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_billboard_a0643a04e31d7612792bf8e5137726c30}\label{class_ogre_1_1_billboard_a0643a04e31d7612792bf8e5137726c30}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!get\+Colour@{get\+Colour}}
\index{get\+Colour@{get\+Colour}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{get\+Colour()}{getColour()}}
{\footnotesize\ttfamily const \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value}\& Ogre\+::\+Billboard\+::get\+Colour (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Gets the colour of this billboard. 

\mbox{\Hypertarget{class_ogre_1_1_billboard_af51d1dcde1023fb18ee9d3d9e5650625}\label{class_ogre_1_1_billboard_af51d1dcde1023fb18ee9d3d9e5650625}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!has\+Own\+Dimensions@{has\+Own\+Dimensions}}
\index{has\+Own\+Dimensions@{has\+Own\+Dimensions}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{has\+Own\+Dimensions()}{hasOwnDimensions()}}
{\footnotesize\ttfamily bool Ogre\+::\+Billboard\+::has\+Own\+Dimensions (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Returns true if this billboard deviates from the \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}\textquotesingle{}s default dimensions (i.\+e. 

if the \hyperlink{class_ogre_1_1_billboard_ac7c7422926a4387ae58c7303b701b8f0}{Billboard\+::set\+Dimensions} method has been called for this instance). \begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_billboard_ac7c7422926a4387ae58c7303b701b8f0}{Billboard\+::set\+Dimensions} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_billboard_a808dafeb8d3a80f536b89588677bbf83}\label{class_ogre_1_1_billboard_a808dafeb8d3a80f536b89588677bbf83}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!get\+Own\+Width@{get\+Own\+Width}}
\index{get\+Own\+Width@{get\+Own\+Width}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{get\+Own\+Width()}{getOwnWidth()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Billboard\+::get\+Own\+Width (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Retrieves the billboard\textquotesingle{}s personal width, if has\+Own\+Dimensions is true. 

\mbox{\Hypertarget{class_ogre_1_1_billboard_a359337280fbb6db1368e9b834edf168b}\label{class_ogre_1_1_billboard_a359337280fbb6db1368e9b834edf168b}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!get\+Own\+Height@{get\+Own\+Height}}
\index{get\+Own\+Height@{get\+Own\+Height}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{get\+Own\+Height()}{getOwnHeight()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real} Ogre\+::\+Billboard\+::get\+Own\+Height (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const}



Retrieves the billboard\textquotesingle{}s personal height, if has\+Own\+Dimensions is true. 

\mbox{\Hypertarget{class_ogre_1_1_billboard_a88d66ce919092367df57a2e3abcae059}\label{class_ogre_1_1_billboard_a88d66ce919092367df57a2e3abcae059}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!\+\_\+notify\+Owner@{\+\_\+notify\+Owner}}
\index{\+\_\+notify\+Owner@{\+\_\+notify\+Owner}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{\+\_\+notify\+Owner()}{\_notifyOwner()}}
{\footnotesize\ttfamily void Ogre\+::\+Billboard\+::\+\_\+notify\+Owner (\begin{DoxyParamCaption}\item[{\hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set} $\ast$}]{owner }\end{DoxyParamCaption})}



Internal method for notifying the billboard of it\textquotesingle{}s owner. 

\mbox{\Hypertarget{class_ogre_1_1_billboard_a3aced837be58b2b578c5cc63b87e01c3}\label{class_ogre_1_1_billboard_a3aced837be58b2b578c5cc63b87e01c3}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!is\+Use\+Texcoord\+Rect@{is\+Use\+Texcoord\+Rect}}
\index{is\+Use\+Texcoord\+Rect@{is\+Use\+Texcoord\+Rect}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{is\+Use\+Texcoord\+Rect()}{isUseTexcoordRect()}}
{\footnotesize\ttfamily bool Ogre\+::\+Billboard\+::is\+Use\+Texcoord\+Rect (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Returns true if this billboard use individual texture coordinate rect (i.\+e. 

if the \hyperlink{class_ogre_1_1_billboard_a22f28d979395f04c6039d46a68c4eefb}{Billboard\+::set\+Texcoord\+Rect} method has been called for this instance), or returns false if use texture coordinates defined in the parent \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}\textquotesingle{}s texture coordinates array (i.\+e. if the \hyperlink{class_ogre_1_1_billboard_ae8aa54c0303721dfc34ebbd8bdf1e8f4}{Billboard\+::set\+Texcoord\+Index} method has been called for this instance). \begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_billboard_ae8aa54c0303721dfc34ebbd8bdf1e8f4}{Billboard\+::set\+Texcoord\+Index()} \hyperlink{class_ogre_1_1_billboard_a22f28d979395f04c6039d46a68c4eefb}{Billboard\+::set\+Texcoord\+Rect()} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_billboard_ae8aa54c0303721dfc34ebbd8bdf1e8f4}\label{class_ogre_1_1_billboard_ae8aa54c0303721dfc34ebbd8bdf1e8f4}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!set\+Texcoord\+Index@{set\+Texcoord\+Index}}
\index{set\+Texcoord\+Index@{set\+Texcoord\+Index}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{set\+Texcoord\+Index()}{setTexcoordIndex()}}
{\footnotesize\ttfamily void Ogre\+::\+Billboard\+::set\+Texcoord\+Index (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}}]{texcoord\+Index }\end{DoxyParamCaption})}



\hyperlink{class_ogre_1_1_billboard_ae8aa54c0303721dfc34ebbd8bdf1e8f4}{set\+Texcoord\+Index()} sets which texture coordinate rect this billboard will use when rendering. 

The parent billboard set may contain more than one, in which case a billboard can be textured with different pieces of a larger texture sheet very efficiently. \begin{DoxySeeAlso}{See also}
\hyperlink{class_ogre_1_1_billboard_set_a674d274f03d34cc1446f7de9255236a7}{Billboard\+Set\+::set\+Texture\+Coords()} 
\end{DoxySeeAlso}
\mbox{\Hypertarget{class_ogre_1_1_billboard_a67c55fa7b1487eece36c78bc0148e843}\label{class_ogre_1_1_billboard_a67c55fa7b1487eece36c78bc0148e843}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!get\+Texcoord\+Index@{get\+Texcoord\+Index}}
\index{get\+Texcoord\+Index@{get\+Texcoord\+Index}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{get\+Texcoord\+Index()}{getTexcoordIndex()}}
{\footnotesize\ttfamily \hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16} Ogre\+::\+Billboard\+::get\+Texcoord\+Index (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



\hyperlink{class_ogre_1_1_billboard_a67c55fa7b1487eece36c78bc0148e843}{get\+Texcoord\+Index()} returns the previous value set by \hyperlink{class_ogre_1_1_billboard_ae8aa54c0303721dfc34ebbd8bdf1e8f4}{set\+Texcoord\+Index()}. 

The default value is 0, which is always a valid texture coordinate set. \begin{DoxyRemark}{Remarks}
This value is useful only when is\+Use\+Texcoord\+Rect return false. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_billboard_a22f28d979395f04c6039d46a68c4eefb}\label{class_ogre_1_1_billboard_a22f28d979395f04c6039d46a68c4eefb}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!set\+Texcoord\+Rect@{set\+Texcoord\+Rect}}
\index{set\+Texcoord\+Rect@{set\+Texcoord\+Rect}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{set\+Texcoord\+Rect()}{setTexcoordRect()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Billboard\+::set\+Texcoord\+Rect (\begin{DoxyParamCaption}\item[{const \hyperlink{group___general_ga39213af9254535e83b4beca0859e8a2f}{Float\+Rect} \&}]{texcoord\+Rect }\end{DoxyParamCaption})}



\hyperlink{class_ogre_1_1_billboard_a22f28d979395f04c6039d46a68c4eefb}{set\+Texcoord\+Rect()} sets the individual texture coordinate rect of this billboard will use when rendering. 

The parent billboard set may contain more than one, in which case a billboard can be textured with different pieces of a larger texture sheet very efficiently. \mbox{\Hypertarget{class_ogre_1_1_billboard_a78525470bb318948f9cf68ddf9281aa8}\label{class_ogre_1_1_billboard_a78525470bb318948f9cf68ddf9281aa8}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!set\+Texcoord\+Rect@{set\+Texcoord\+Rect}}
\index{set\+Texcoord\+Rect@{set\+Texcoord\+Rect}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{set\+Texcoord\+Rect()}{setTexcoordRect()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily void Ogre\+::\+Billboard\+::set\+Texcoord\+Rect (\begin{DoxyParamCaption}\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{u0,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{v0,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{u1,  }\item[{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}]{v1 }\end{DoxyParamCaption})}



\hyperlink{class_ogre_1_1_billboard_a22f28d979395f04c6039d46a68c4eefb}{set\+Texcoord\+Rect()} sets the individual texture coordinate rect of this billboard will use when rendering. 

The parent billboard set may contain more than one, in which case a billboard can be textured with different pieces of a larger texture sheet very efficiently. \mbox{\Hypertarget{class_ogre_1_1_billboard_ad9b6a9b61cfa3cb665fac5c304c556ef}\label{class_ogre_1_1_billboard_ad9b6a9b61cfa3cb665fac5c304c556ef}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!get\+Texcoord\+Rect@{get\+Texcoord\+Rect}}
\index{get\+Texcoord\+Rect@{get\+Texcoord\+Rect}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{get\+Texcoord\+Rect()}{getTexcoordRect()}}
{\footnotesize\ttfamily const \hyperlink{group___general_ga39213af9254535e83b4beca0859e8a2f}{Float\+Rect}\& Ogre\+::\+Billboard\+::get\+Texcoord\+Rect (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



\hyperlink{class_ogre_1_1_billboard_ad9b6a9b61cfa3cb665fac5c304c556ef}{get\+Texcoord\+Rect()} returns the previous value set by \hyperlink{class_ogre_1_1_billboard_a22f28d979395f04c6039d46a68c4eefb}{set\+Texcoord\+Rect()}. 

\begin{DoxyRemark}{Remarks}
This value is useful only when is\+Use\+Texcoord\+Rect returns true. 
\end{DoxyRemark}


\subsection{Friends And Related Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_billboard_a7f055c0ed81c6b3bef6d154d128093a1}\label{class_ogre_1_1_billboard_a7f055c0ed81c6b3bef6d154d128093a1}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!Billboard\+Set@{Billboard\+Set}}
\index{Billboard\+Set@{Billboard\+Set}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{Billboard\+Set}{BillboardSet}}
{\footnotesize\ttfamily friend class \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}\hspace{0.3cm}{\ttfamily [friend]}}

\mbox{\Hypertarget{class_ogre_1_1_billboard_a261647d2b3ed936e9a2f05309ae878d0}\label{class_ogre_1_1_billboard_a261647d2b3ed936e9a2f05309ae878d0}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!Billboard\+Particle\+Renderer@{Billboard\+Particle\+Renderer}}
\index{Billboard\+Particle\+Renderer@{Billboard\+Particle\+Renderer}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{Billboard\+Particle\+Renderer}{BillboardParticleRenderer}}
{\footnotesize\ttfamily friend class \hyperlink{class_ogre_1_1_billboard_particle_renderer}{Billboard\+Particle\+Renderer}\hspace{0.3cm}{\ttfamily [friend]}}



\subsection{Member Data Documentation}
\mbox{\Hypertarget{class_ogre_1_1_billboard_aa7ad6c8789d8589787c4da34c670d66c}\label{class_ogre_1_1_billboard_aa7ad6c8789d8589787c4da34c670d66c}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!m\+Position@{m\+Position}}
\index{m\+Position@{m\+Position}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{m\+Position}{mPosition}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_vector3}{Vector3} Ogre\+::\+Billboard\+::m\+Position}

\mbox{\Hypertarget{class_ogre_1_1_billboard_a64425b354973d2d957bc878fca407aad}\label{class_ogre_1_1_billboard_a64425b354973d2d957bc878fca407aad}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!m\+Direction@{m\+Direction}}
\index{m\+Direction@{m\+Direction}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{m\+Direction}{mDirection}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_vector3}{Vector3} Ogre\+::\+Billboard\+::m\+Direction}



Normalised direction vector. 

\mbox{\Hypertarget{class_ogre_1_1_billboard_aaa2fce61abce942e356fd81925c394fd}\label{class_ogre_1_1_billboard_aaa2fce61abce942e356fd81925c394fd}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!m\+Parent\+Set@{m\+Parent\+Set}}
\index{m\+Parent\+Set@{m\+Parent\+Set}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{m\+Parent\+Set}{mParentSet}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_billboard_set}{Billboard\+Set}$\ast$ Ogre\+::\+Billboard\+::m\+Parent\+Set}

\mbox{\Hypertarget{class_ogre_1_1_billboard_aef9f7ad996732865cd2c8842ee265064}\label{class_ogre_1_1_billboard_aef9f7ad996732865cd2c8842ee265064}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!m\+Colour@{m\+Colour}}
\index{m\+Colour@{m\+Colour}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{m\+Colour}{mColour}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_colour_value}{Colour\+Value} Ogre\+::\+Billboard\+::m\+Colour}

\mbox{\Hypertarget{class_ogre_1_1_billboard_ad861053413ca65e059dd74131a084839}\label{class_ogre_1_1_billboard_ad861053413ca65e059dd74131a084839}} 
\index{Ogre\+::\+Billboard@{Ogre\+::\+Billboard}!m\+Rotation@{m\+Rotation}}
\index{m\+Rotation@{m\+Rotation}!Ogre\+::\+Billboard@{Ogre\+::\+Billboard}}
\subsubsection{\texorpdfstring{m\+Rotation}{mRotation}}
{\footnotesize\ttfamily \hyperlink{class_ogre_1_1_radian}{Radian} Ogre\+::\+Billboard\+::m\+Rotation}



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