Unuk/Docs/latex/class_entity.tex

201 lines
7.0 KiB
TeX

\hypertarget{class_entity}{
\section{Entity Class Reference}
\label{class_entity}\index{Entity@{Entity}}
}
{\ttfamily \#include $<$Entity.h$>$}
Inheritance diagram for Entity:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{class_entity}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item
\hyperlink{class_entity_af7b7088ca610b9f247110ccf47ed178b}{Entity} (GameWorld $\ast$const gameWorld)
\item
virtual \hyperlink{class_entity_a6e8406be37172eb7f4e89dd3ba674113}{$\sim$Entity} (void)
\item
void \hyperlink{class_entity_a0a0be12a8170540fed0ce3de68f46790}{Prepare} (float dt)
\item
void \hyperlink{class_entity_a64da675ba3c24b2e4a3ee89917a5c970}{Render} (void) const
\item
void \hyperlink{class_entity_a8d03dea10779e4e91b4aef0fb7f571bc}{PostRender} (void)
\item
bool \hyperlink{class_entity_a81982ee7714b5126e09ad3e82207f146}{Initialize} (void)
\item
void \hyperlink{class_entity_a673a3a5c822c734d641e918a7a73f6e7}{Shutdown} (void)
\item
bool \hyperlink{class_entity_a2da196bad22f7c5a95d47564c7d0ea04}{CanBeRemoved} (void) const
\item
void \hyperlink{class_entity_a71b297ca801c1b3170a885a6f4d481c1}{Destroy} (void)
\item
virtual \hyperlink{struct_vector2}{Vector2} \hyperlink{class_entity_a26a31288cbf21650596a7b5a0adee7ee}{GetPosition} (void) const =0
\item
virtual void \hyperlink{class_entity_a8b8556ee6351c6104eb49dcefd78398f}{SetPosition} (const \hyperlink{struct_vector2}{Vector2} \&position)=0
\item
virtual \hyperlink{_entity_type_8h_ad79a57ed3105eb60d991a1aeb4a9dc44}{EntityType} \hyperlink{class_entity_a38188cc14a73fbcd0b7e5da55c709e2a}{GetType} (void) const =0
\end{DoxyCompactItemize}
\subsection{Detailed Description}
Definition at line 15 of file Entity.h.
\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_entity_af7b7088ca610b9f247110ccf47ed178b}{
\index{Entity@{Entity}!Entity@{Entity}}
\index{Entity@{Entity}!Entity@{Entity}}
\subsubsection[{Entity}]{\setlength{\rightskip}{0pt plus 5cm}Entity::Entity (
\begin{DoxyParamCaption}
\item[{GameWorld $\ast$const}]{gameWorld}
\end{DoxyParamCaption}
)}}
\label{class_entity_af7b7088ca610b9f247110ccf47ed178b}
Definition at line 3 of file Entity.cpp.
\hypertarget{class_entity_a6e8406be37172eb7f4e89dd3ba674113}{
\index{Entity@{Entity}!$\sim$Entity@{$\sim$Entity}}
\index{$\sim$Entity@{$\sim$Entity}!Entity@{Entity}}
\subsubsection[{$\sim$Entity}]{\setlength{\rightskip}{0pt plus 5cm}Entity::$\sim$Entity (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily \mbox{[}virtual\mbox{]}}}}
\label{class_entity_a6e8406be37172eb7f4e89dd3ba674113}
Definition at line 7 of file Entity.cpp.
\subsection{Member Function Documentation}
\hypertarget{class_entity_a2da196bad22f7c5a95d47564c7d0ea04}{
\index{Entity@{Entity}!CanBeRemoved@{CanBeRemoved}}
\index{CanBeRemoved@{CanBeRemoved}!Entity@{Entity}}
\subsubsection[{CanBeRemoved}]{\setlength{\rightskip}{0pt plus 5cm}bool Entity::CanBeRemoved (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
) const}}
\label{class_entity_a2da196bad22f7c5a95d47564c7d0ea04}
Definition at line 9 of file Entity.cpp.
\hypertarget{class_entity_a71b297ca801c1b3170a885a6f4d481c1}{
\index{Entity@{Entity}!Destroy@{Destroy}}
\index{Destroy@{Destroy}!Entity@{Entity}}
\subsubsection[{Destroy}]{\setlength{\rightskip}{0pt plus 5cm}void Entity::Destroy (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}
\label{class_entity_a71b297ca801c1b3170a885a6f4d481c1}
Definition at line 13 of file Entity.cpp.
\hypertarget{class_entity_a26a31288cbf21650596a7b5a0adee7ee}{
\index{Entity@{Entity}!GetPosition@{GetPosition}}
\index{GetPosition@{GetPosition}!Entity@{Entity}}
\subsubsection[{GetPosition}]{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf Vector2} Entity::GetPosition (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily \mbox{[}pure virtual\mbox{]}}}}
\label{class_entity_a26a31288cbf21650596a7b5a0adee7ee}
\hypertarget{class_entity_a38188cc14a73fbcd0b7e5da55c709e2a}{
\index{Entity@{Entity}!GetType@{GetType}}
\index{GetType@{GetType}!Entity@{Entity}}
\subsubsection[{GetType}]{\setlength{\rightskip}{0pt plus 5cm}virtual {\bf EntityType} Entity::GetType (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
) const\hspace{0.3cm}{\ttfamily \mbox{[}pure virtual\mbox{]}}}}
\label{class_entity_a38188cc14a73fbcd0b7e5da55c709e2a}
\hypertarget{class_entity_a81982ee7714b5126e09ad3e82207f146}{
\index{Entity@{Entity}!Initialize@{Initialize}}
\index{Initialize@{Initialize}!Entity@{Entity}}
\subsubsection[{Initialize}]{\setlength{\rightskip}{0pt plus 5cm}bool Entity::Initialize (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}
\label{class_entity_a81982ee7714b5126e09ad3e82207f146}
Definition at line 29 of file Entity.cpp.
\hypertarget{class_entity_a8d03dea10779e4e91b4aef0fb7f571bc}{
\index{Entity@{Entity}!PostRender@{PostRender}}
\index{PostRender@{PostRender}!Entity@{Entity}}
\subsubsection[{PostRender}]{\setlength{\rightskip}{0pt plus 5cm}void Entity::PostRender (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}
\label{class_entity_a8d03dea10779e4e91b4aef0fb7f571bc}
\hypertarget{class_entity_a0a0be12a8170540fed0ce3de68f46790}{
\index{Entity@{Entity}!Prepare@{Prepare}}
\index{Prepare@{Prepare}!Entity@{Entity}}
\subsubsection[{Prepare}]{\setlength{\rightskip}{0pt plus 5cm}void Entity::Prepare (
\begin{DoxyParamCaption}
\item[{float}]{dt}
\end{DoxyParamCaption}
)}}
\label{class_entity_a0a0be12a8170540fed0ce3de68f46790}
Definition at line 17 of file Entity.cpp.
\hypertarget{class_entity_a64da675ba3c24b2e4a3ee89917a5c970}{
\index{Entity@{Entity}!Render@{Render}}
\index{Render@{Render}!Entity@{Entity}}
\subsubsection[{Render}]{\setlength{\rightskip}{0pt plus 5cm}void Entity::Render (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
) const}}
\label{class_entity_a64da675ba3c24b2e4a3ee89917a5c970}
Definition at line 21 of file Entity.cpp.
\hypertarget{class_entity_a8b8556ee6351c6104eb49dcefd78398f}{
\index{Entity@{Entity}!SetPosition@{SetPosition}}
\index{SetPosition@{SetPosition}!Entity@{Entity}}
\subsubsection[{SetPosition}]{\setlength{\rightskip}{0pt plus 5cm}virtual void Entity::SetPosition (
\begin{DoxyParamCaption}
\item[{const {\bf Vector2} \&}]{position}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily \mbox{[}pure virtual\mbox{]}}}}
\label{class_entity_a8b8556ee6351c6104eb49dcefd78398f}
\hypertarget{class_entity_a673a3a5c822c734d641e918a7a73f6e7}{
\index{Entity@{Entity}!Shutdown@{Shutdown}}
\index{Shutdown@{Shutdown}!Entity@{Entity}}
\subsubsection[{Shutdown}]{\setlength{\rightskip}{0pt plus 5cm}void Entity::Shutdown (
\begin{DoxyParamCaption}
\item[{void}]{}
\end{DoxyParamCaption}
)}}
\label{class_entity_a673a3a5c822c734d641e918a7a73f6e7}
Definition at line 33 of file Entity.cpp.
The documentation for this class was generated from the following files:\begin{DoxyCompactItemize}
\item
src/libUnuk/\hyperlink{_entity_8h}{Entity.h}\item
src/libUnuk/\hyperlink{_entity_8cpp}{Entity.cpp}\end{DoxyCompactItemize}