\hypertarget{class_ogre_1_1_paged_world_section}{}\doxysection{Ogre\+::Paged\+World\+Section Class Reference}
\label{class_ogre_1_1_paged_world_section}\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}


Represents a section of the \mbox{\hyperlink{class_ogre_1_1_paged_world}{Paged\+World}} which uses a given \mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}}, and which is made up of a generally localised set of \mbox{\hyperlink{class_ogre_1_1_page}{Page}} instances.  




{\ttfamily \#include $<$Ogre\+Paged\+World\+Section.\+h$>$}



Inheritance diagram for Ogre\+::Paged\+World\+Section\+:
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=252pt]{class_ogre_1_1_paged_world_section__inherit__graph}
\end{center}
\end{figure}
\doxysubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
typedef std\+::map$<$ \mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}}, \mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$ $>$ \mbox{\hyperlink{class_ogre_1_1_paged_world_section_abddb5f4dcbcac2c298f58e25dea3ac58}{Page\+Map}}
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{class_ogre_1_1_paged_world_section_a39f38e5a37b3eacf67fdb3509611f13d}{Paged\+World\+Section}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&name, \mbox{\hyperlink{class_ogre_1_1_paged_world}{Paged\+World}} $\ast$parent, \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} $\ast$sm)
\begin{DoxyCompactList}\small\item\em Construct a new instance, specifying the parent and scene manager. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_paged_world_section_ad5623dc85e1cb81f7a7b0d1fb5dfcd3f}{$\sim$\+Paged\+World\+Section}} ()
\item 
virtual bool \mbox{\hyperlink{class_ogre_1_1_paged_world_section_ac0c8f91bad2fa313ecde9d0f6e8491b9}{\+\_\+load\+Procedural\+Page}} (\mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$page)
\begin{DoxyCompactList}\small\item\em Give a section the opportunity to prepare page content procedurally. \end{DoxyCompactList}\item 
virtual bool \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a495c03ee2f1c570495d640053bb33c03}{\+\_\+prepare\+Procedural\+Page}} (\mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$page)
\begin{DoxyCompactList}\small\item\em Give a section the opportunity to prepare page content procedurally. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_stream_serialiser}{Stream\+Serialiser}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_paged_world_section_ace50c38bd8514388683c2baff141e452}{\+\_\+read\+Page\+Stream}} (\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}} page\+ID)
\begin{DoxyCompactList}\small\item\em Get a serialiser set up to read \mbox{\hyperlink{class_ogre_1_1_page}{Page}} data for the given Page\+ID. \end{DoxyCompactList}\item 
virtual bool \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a9479d0ae02a6b258f7eea12526561cb2}{\+\_\+unload\+Procedural\+Page}} (\mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$page)
\begin{DoxyCompactList}\small\item\em Give a section the opportunity to unload page content procedurally. \end{DoxyCompactList}\item 
virtual bool \mbox{\hyperlink{class_ogre_1_1_paged_world_section_ab719550f4970c6ec32e949bd0ab79b4a}{\+\_\+unprepare\+Procedural\+Page}} (\mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$page)
\begin{DoxyCompactList}\small\item\em Give a section the opportunity to unprepare page content procedurally. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_stream_serialiser}{Stream\+Serialiser}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a62d2d4952b2c5d0fb42294b4a67f2ef8}{\+\_\+write\+Page\+Stream}} (\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}} page\+ID)
\begin{DoxyCompactList}\small\item\em Get a serialiser set up to write \mbox{\hyperlink{class_ogre_1_1_page}{Page}} data for the given Page\+ID. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_ae70969b195c560958b225d8783bfea6c}{frame\+End}} (\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} time\+Elapsed)
\begin{DoxyCompactList}\small\item\em Called when the frame ends. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_ad5f43b304e2c51ca1c3a0390230bf45c}{frame\+Start}} (\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}} time\+Since\+Last\+Frame)
\begin{DoxyCompactList}\small\item\em Called when the frame starts. \end{DoxyCompactList}\item 
virtual const \mbox{\hyperlink{class_ogre_1_1_axis_aligned_box}{Axis\+Aligned\+Box}} \& \mbox{\hyperlink{class_ogre_1_1_paged_world_section_aed6f4fd44a218aeffb6e147e383e4e7c}{get\+Bounding\+Box}} () const
\begin{DoxyCompactList}\small\item\em Get the bounds of this section. \end{DoxyCompactList}\item 
\mbox{\hyperlink{class_ogre_1_1_page_manager}{Page\+Manager}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a53c9a5653cf91cbdaed47d52a9045956}{get\+Manager}} () const
\item 
virtual const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \& \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a7c71c5f8fdc8528b5222394bd7b87993}{get\+Name}} () const
\begin{DoxyCompactList}\small\item\em Get the name of this section. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_paged_world_section_ab5d4ec9ce6571345f4f072f2ab1404dc}{get\+Page}} (\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}} page\+ID)
\begin{DoxyCompactList}\small\item\em Retrieves a \mbox{\hyperlink{class_ogre_1_1_page}{Page}}. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}} \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a3ccafb61dcc690bb1a1efd6c8a6b907b}{get\+Page\+ID}} (const \mbox{\hyperlink{namespace_ogre_ac94fc4008c1165dea017263fee56b273}{Vector3}} \&world\+Pos)
\begin{DoxyCompactList}\small\item\em Get the page ID for a given world position. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_page_provider}{Page\+Provider}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a54b15191c5e2f5fa5d3ee4800ec27637}{get\+Page\+Provider}} () const
\begin{DoxyCompactList}\small\item\em Get the \mbox{\hyperlink{class_ogre_1_1_page_provider}{Page\+Provider}} which can provide streams for Pages in this section. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a5e422865ca032d8c8b11dd693d50b75f}{get\+Scene\+Manager}} () const
\begin{DoxyCompactList}\small\item\em Get the current \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}}. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a874715e09aacf6b7b68d983b19d0f1c6}{get\+Strategy}} () const
\begin{DoxyCompactList}\small\item\em Get the page strategy which this section is using. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_page_strategy_data}{Page\+Strategy\+Data}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a8e0306f93de0c40466a0b11e7315bdf8}{get\+Strategy\+Data}} () const
\begin{DoxyCompactList}\small\item\em Get the data required by the \mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}} which is specific to this world section. \end{DoxyCompactList}\item 
virtual const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \& \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a6896f555077a1a7d44588fc74446ed57}{get\+Type}} ()
\begin{DoxyCompactList}\small\item\em Get the type name of this section. \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_paged_world}{Paged\+World}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a97a82e613670fe3a17625b17e70acf89}{get\+World}} () const
\begin{DoxyCompactList}\small\item\em Get the parent world. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_aa05961d63f7a427e11b96ec9e03578d0}{hold\+Page}} (\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}} page\+ID)
\begin{DoxyCompactList}\small\item\em Ask for a page to be kept in memory if it\textquotesingle{}s loaded. \end{DoxyCompactList}\item 
virtual bool \mbox{\hyperlink{class_ogre_1_1_paged_world_section_abdc7575c0502aa8bd7ecb736eb7eb64e}{load}} (\mbox{\hyperlink{class_ogre_1_1_stream_serialiser}{Stream\+Serialiser}} \&stream)
\begin{DoxyCompactList}\small\item\em Load this section from a stream (returns true if successful) \end{DoxyCompactList}\item 
virtual \mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$ \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a010ecd6e4f224f86dc8811f0711df3cd}{load\+Or\+Create\+Page}} (const \mbox{\hyperlink{namespace_ogre_ac94fc4008c1165dea017263fee56b273}{Vector3}} \&world\+Pos)
\begin{DoxyCompactList}\small\item\em Load or create a page against this section covering the given world space position. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a0e390153652b3283abc91950017aa280}{load\+Page}} (\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}} page\+ID, bool force\+Synchronous=false)
\begin{DoxyCompactList}\small\item\em Ask for a page to be loaded with the given (section-\/relative) Page\+ID. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a78f2718c5437d59bbe682ea353674056}{notify\+Camera}} (\mbox{\hyperlink{class_ogre_1_1_camera}{Camera}} $\ast$cam)
\begin{DoxyCompactList}\small\item\em Notify a section of the current camera. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a2c2cfc82a89da128f8cb51b4b6bbb97c}{remove\+All\+Pages}} ()
\begin{DoxyCompactList}\small\item\em Remove all pages immediately. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_ab6144d3304276aedd2e78d3c0da044cc}{save}} (\mbox{\hyperlink{class_ogre_1_1_stream_serialiser}{Stream\+Serialiser}} \&stream)
\begin{DoxyCompactList}\small\item\em Save this section to a stream. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a3bfa7a14cafcfae85481b42a865e5ce7}{set\+Bounding\+Box}} (const \mbox{\hyperlink{class_ogre_1_1_axis_aligned_box}{Axis\+Aligned\+Box}} \&box)
\begin{DoxyCompactList}\small\item\em Set the bounds of this section. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a4d4ad3e43086dcef834c14f5943ed906}{set\+Page\+Provider}} (\mbox{\hyperlink{class_ogre_1_1_page_provider}{Page\+Provider}} $\ast$provider)
\begin{DoxyCompactList}\small\item\em Set the \mbox{\hyperlink{class_ogre_1_1_page_provider}{Page\+Provider}} which can provide streams Pages in this section. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_ad55558c5a6e30836099c9526a0031497}{set\+Scene\+Manager}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&sm\+Name)
\begin{DoxyCompactList}\small\item\em Change the \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}}. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_afb1bd74b97880325a1c0f5a76dde4173}{set\+Scene\+Manager}} (\mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} $\ast$sm)
\begin{DoxyCompactList}\small\item\em Change the \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}}. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a5c2f98ce0e1b4f1df7850538eabfd790}{set\+Strategy}} (const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&strat\+Name)
\begin{DoxyCompactList}\small\item\em Change the page strategy. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a0fb34b7fab911e6f37549d418bd7d983}{set\+Strategy}} (\mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}} $\ast$strat)
\begin{DoxyCompactList}\small\item\em Change the page strategy. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_ae228d76c74b2b30b584abc22191887ec}{unload\+Page}} (\mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$p, bool force\+Synchronous=false)
\begin{DoxyCompactList}\small\item\em Ask for a page to be unloaded with the given (section-\/relative) Page\+ID. \end{DoxyCompactList}\item 
virtual void \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a8079567efda9298ba00516ddd41b0911}{unload\+Page}} (\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}} page\+ID, bool force\+Synchronous=false)
\begin{DoxyCompactList}\small\item\em Ask for a page to be unloaded with the given (section-\/relative) Page\+ID. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Static Public Attributes}
\begin{DoxyCompactItemize}
\item 
static const \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a10f86869b319e962411835604857909d}{C\+H\+U\+N\+K\+\_\+\+ID}}
\item 
static const \mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}} \mbox{\hyperlink{class_ogre_1_1_paged_world_section_a95709472b243e346dd0be46b05927beb}{C\+H\+U\+N\+K\+\_\+\+V\+E\+R\+S\+I\+ON}}
\end{DoxyCompactItemize}
\doxysubsection*{Friends}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{_ogre_paging_prerequisites_8h_a12507ffbcb05d7b7af41403ff7db8a5c}{\+\_\+\+Ogre\+Paging\+Export}} friend std\+::ostream \& \mbox{\hyperlink{class_ogre_1_1_paged_world_section_aeb00ceddc4315000f13b86256e365644}{operator$<$$<$}} (std\+::ostream \&o, const \mbox{\hyperlink{class_ogre_1_1_paged_world_section}{Paged\+World\+Section}} \&p)
\begin{DoxyCompactList}\small\item\em Function for writing to a stream. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
Represents a section of the \mbox{\hyperlink{class_ogre_1_1_paged_world}{Paged\+World}} which uses a given \mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}}, and which is made up of a generally localised set of \mbox{\hyperlink{class_ogre_1_1_page}{Page}} instances. 

\begin{DoxyRemark}{Remarks}
The reason for \mbox{\hyperlink{class_ogre_1_1_paged_world_section}{Paged\+World\+Section}} is that you may wish to cater for multiple sections of your world which use a different approach to paging (ie a different \mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}}), or which are significantly far apart or separate that the parameters you want to pass to the \mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}} are different. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
\mbox{\hyperlink{class_ogre_1_1_paged_world_section}{Paged\+World\+Section}} instances are fully contained within the \mbox{\hyperlink{class_ogre_1_1_paged_world}{Paged\+World}} and their definitions are loaded in their entirety when the \mbox{\hyperlink{class_ogre_1_1_paged_world}{Paged\+World}} is loaded. However, no \mbox{\hyperlink{class_ogre_1_1_page}{Page}} instances are initially loaded -\/ those are the responsibility of the \mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}}. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{}
\mbox{\hyperlink{class_ogre_1_1_paged_world_section}{Paged\+World\+Section}} can be subclassed and derived types provided by a \mbox{\hyperlink{class_ogre_1_1_paged_world_section_factory}{Paged\+World\+Section\+Factory}}. These subclasses might come preconfigured with a strategy for example, or with additional metadata used only for that particular type of section. 
\end{DoxyParagraph}
\begin{DoxyParagraph}{}
A \mbox{\hyperlink{class_ogre_1_1_paged_world_section}{Paged\+World\+Section}} targets a specific \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}}. When you create one in code via \mbox{\hyperlink{class_ogre_1_1_paged_world_afdd910dcc3bdcaac40d3a30c1f21611e}{Paged\+World\+::create\+Section}}, you pass that \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} in manually. When loading from a saved world file however, the \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} type and instance name are saved and that \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} is looked up on loading, or created if it didn\textquotesingle{}t exist. 
\end{DoxyParagraph}


\doxysubsection{Member Typedef Documentation}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_abddb5f4dcbcac2c298f58e25dea3ac58}\label{class_ogre_1_1_paged_world_section_abddb5f4dcbcac2c298f58e25dea3ac58}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!PageMap@{PageMap}}
\index{PageMap@{PageMap}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{PageMap}{PageMap}}
{\footnotesize\ttfamily typedef std\+::map$<$\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}}, \mbox{\hyperlink{class_ogre_1_1_page}{Page}}$\ast$$>$ \mbox{\hyperlink{class_ogre_1_1_paged_world_section_abddb5f4dcbcac2c298f58e25dea3ac58}{Ogre\+::\+Paged\+World\+Section\+::\+Page\+Map}}}



\doxysubsection{Constructor \& Destructor Documentation}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a39f38e5a37b3eacf67fdb3509611f13d}\label{class_ogre_1_1_paged_world_section_a39f38e5a37b3eacf67fdb3509611f13d}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!PagedWorldSection@{PagedWorldSection}}
\index{PagedWorldSection@{PagedWorldSection}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{PagedWorldSection()}{PagedWorldSection()}}
{\footnotesize\ttfamily Ogre\+::\+Paged\+World\+Section\+::\+Paged\+World\+Section (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{name,  }\item[{\mbox{\hyperlink{class_ogre_1_1_paged_world}{Paged\+World}} $\ast$}]{parent,  }\item[{\mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} $\ast$}]{sm }\end{DoxyParamCaption})}



Construct a new instance, specifying the parent and scene manager. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_ad5623dc85e1cb81f7a7b0d1fb5dfcd3f}\label{class_ogre_1_1_paged_world_section_ad5623dc85e1cb81f7a7b0d1fb5dfcd3f}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!````~PagedWorldSection@{$\sim$PagedWorldSection}}
\index{````~PagedWorldSection@{$\sim$PagedWorldSection}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{$\sim$PagedWorldSection()}{~PagedWorldSection()}}
{\footnotesize\ttfamily virtual Ogre\+::\+Paged\+World\+Section\+::$\sim$\+Paged\+World\+Section (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



\doxysubsection{Member Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a53c9a5653cf91cbdaed47d52a9045956}\label{class_ogre_1_1_paged_world_section_a53c9a5653cf91cbdaed47d52a9045956}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!getManager@{getManager}}
\index{getManager@{getManager}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{getManager()}{getManager()}}
{\footnotesize\ttfamily \mbox{\hyperlink{class_ogre_1_1_page_manager}{Page\+Manager}}$\ast$ Ogre\+::\+Paged\+World\+Section\+::get\+Manager (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const}

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a7c71c5f8fdc8528b5222394bd7b87993}\label{class_ogre_1_1_paged_world_section_a7c71c5f8fdc8528b5222394bd7b87993}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!getName@{getName}}
\index{getName@{getName}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{getName()}{getName()}}
{\footnotesize\ttfamily virtual const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}}\& Ogre\+::\+Paged\+World\+Section\+::get\+Name (\begin{DoxyParamCaption}\item[{void}]{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Get the name of this section. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a874715e09aacf6b7b68d983b19d0f1c6}\label{class_ogre_1_1_paged_world_section_a874715e09aacf6b7b68d983b19d0f1c6}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!getStrategy@{getStrategy}}
\index{getStrategy@{getStrategy}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{getStrategy()}{getStrategy()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}}$\ast$ Ogre\+::\+Paged\+World\+Section\+::get\+Strategy (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Get the page strategy which this section is using. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a0fb34b7fab911e6f37549d418bd7d983}\label{class_ogre_1_1_paged_world_section_a0fb34b7fab911e6f37549d418bd7d983}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!setStrategy@{setStrategy}}
\index{setStrategy@{setStrategy}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{setStrategy()}{setStrategy()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::set\+Strategy (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}} $\ast$}]{strat }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Change the page strategy. 

\begin{DoxyRemark}{Remarks}
Doing this will invalidate any pages attached to this world section, and require the \mbox{\hyperlink{class_ogre_1_1_page_strategy_data}{Page\+Strategy\+Data}} to be repopulated. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a5c2f98ce0e1b4f1df7850538eabfd790}\label{class_ogre_1_1_paged_world_section_a5c2f98ce0e1b4f1df7850538eabfd790}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!setStrategy@{setStrategy}}
\index{setStrategy@{setStrategy}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{setStrategy()}{setStrategy()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::set\+Strategy (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{strat\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Change the page strategy. 

\begin{DoxyRemark}{Remarks}
Doing this will invalidate any pages attached to this world section, and require the \mbox{\hyperlink{class_ogre_1_1_page_strategy_data}{Page\+Strategy\+Data}} to be repopulated. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_afb1bd74b97880325a1c0f5a76dde4173}\label{class_ogre_1_1_paged_world_section_afb1bd74b97880325a1c0f5a76dde4173}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!setSceneManager@{setSceneManager}}
\index{setSceneManager@{setSceneManager}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{setSceneManager()}{setSceneManager()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::set\+Scene\+Manager (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} $\ast$}]{sm }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Change the \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}}. 

\begin{DoxyRemark}{Remarks}
Doing this will invalidate any pages attached to this world section, and require the pages to be reloaded. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_ad55558c5a6e30836099c9526a0031497}\label{class_ogre_1_1_paged_world_section_ad55558c5a6e30836099c9526a0031497}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!setSceneManager@{setSceneManager}}
\index{setSceneManager@{setSceneManager}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{setSceneManager()}{setSceneManager()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::set\+Scene\+Manager (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}} \&}]{sm\+Name }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Change the \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}}. 

\begin{DoxyRemark}{Remarks}
Doing this will invalidate any pages attached to this world section, and require the pages to be reloaded. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em sm\+Name} & The instance name of the \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}} \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a5e422865ca032d8c8b11dd693d50b75f}\label{class_ogre_1_1_paged_world_section_a5e422865ca032d8c8b11dd693d50b75f}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!getSceneManager@{getSceneManager}}
\index{getSceneManager@{getSceneManager}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{getSceneManager()}{getSceneManager()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}}$\ast$ Ogre\+::\+Paged\+World\+Section\+::get\+Scene\+Manager (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Get the current \mbox{\hyperlink{class_ogre_1_1_scene_manager}{Scene\+Manager}}. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a97a82e613670fe3a17625b17e70acf89}\label{class_ogre_1_1_paged_world_section_a97a82e613670fe3a17625b17e70acf89}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!getWorld@{getWorld}}
\index{getWorld@{getWorld}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{getWorld()}{getWorld()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_paged_world}{Paged\+World}}$\ast$ Ogre\+::\+Paged\+World\+Section\+::get\+World (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Get the parent world. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a8e0306f93de0c40466a0b11e7315bdf8}\label{class_ogre_1_1_paged_world_section_a8e0306f93de0c40466a0b11e7315bdf8}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!getStrategyData@{getStrategyData}}
\index{getStrategyData@{getStrategyData}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{getStrategyData()}{getStrategyData()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_page_strategy_data}{Page\+Strategy\+Data}}$\ast$ Ogre\+::\+Paged\+World\+Section\+::get\+Strategy\+Data (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Get the data required by the \mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}} which is specific to this world section. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a3bfa7a14cafcfae85481b42a865e5ce7}\label{class_ogre_1_1_paged_world_section_a3bfa7a14cafcfae85481b42a865e5ce7}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!setBoundingBox@{setBoundingBox}}
\index{setBoundingBox@{setBoundingBox}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{setBoundingBox()}{setBoundingBox()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::set\+Bounding\+Box (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{class_ogre_1_1_axis_aligned_box}{Axis\+Aligned\+Box}} \&}]{box }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Set the bounds of this section. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_aed6f4fd44a218aeffb6e147e383e4e7c}\label{class_ogre_1_1_paged_world_section_aed6f4fd44a218aeffb6e147e383e4e7c}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!getBoundingBox@{getBoundingBox}}
\index{getBoundingBox@{getBoundingBox}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{getBoundingBox()}{getBoundingBox()}}
{\footnotesize\ttfamily virtual const \mbox{\hyperlink{class_ogre_1_1_axis_aligned_box}{Axis\+Aligned\+Box}}\& Ogre\+::\+Paged\+World\+Section\+::get\+Bounding\+Box (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [virtual]}}



Get the bounds of this section. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_abdc7575c0502aa8bd7ecb736eb7eb64e}\label{class_ogre_1_1_paged_world_section_abdc7575c0502aa8bd7ecb736eb7eb64e}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!load@{load}}
\index{load@{load}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{load()}{load()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Paged\+World\+Section\+::load (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_stream_serialiser}{Stream\+Serialiser}} \&}]{stream }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Load this section from a stream (returns true if successful) 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_ab6144d3304276aedd2e78d3c0da044cc}\label{class_ogre_1_1_paged_world_section_ab6144d3304276aedd2e78d3c0da044cc}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!save@{save}}
\index{save@{save}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{save()}{save()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::save (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_stream_serialiser}{Stream\+Serialiser}} \&}]{stream }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Save this section to a stream. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_ad5f43b304e2c51ca1c3a0390230bf45c}\label{class_ogre_1_1_paged_world_section_ad5f43b304e2c51ca1c3a0390230bf45c}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!frameStart@{frameStart}}
\index{frameStart@{frameStart}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{frameStart()}{frameStart()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::frame\+Start (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}}]{time\+Since\+Last\+Frame }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Called when the frame starts. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_ae70969b195c560958b225d8783bfea6c}\label{class_ogre_1_1_paged_world_section_ae70969b195c560958b225d8783bfea6c}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!frameEnd@{frameEnd}}
\index{frameEnd@{frameEnd}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{frameEnd()}{frameEnd()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::frame\+End (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_aa3a7b6dfb905e6572d62f0dfa3d4274d}{Real}}}]{time\+Elapsed }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Called when the frame ends. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a78f2718c5437d59bbe682ea353674056}\label{class_ogre_1_1_paged_world_section_a78f2718c5437d59bbe682ea353674056}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!notifyCamera@{notifyCamera}}
\index{notifyCamera@{notifyCamera}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{notifyCamera()}{notifyCamera()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::notify\+Camera (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_camera}{Camera}} $\ast$}]{cam }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Notify a section of the current camera. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a010ecd6e4f224f86dc8811f0711df3cd}\label{class_ogre_1_1_paged_world_section_a010ecd6e4f224f86dc8811f0711df3cd}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!loadOrCreatePage@{loadOrCreatePage}}
\index{loadOrCreatePage@{loadOrCreatePage}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{loadOrCreatePage()}{loadOrCreatePage()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_page}{Page}}$\ast$ Ogre\+::\+Paged\+World\+Section\+::load\+Or\+Create\+Page (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_ac94fc4008c1165dea017263fee56b273}{Vector3}} \&}]{world\+Pos }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Load or create a page against this section covering the given world space position. 

\begin{DoxyRemark}{Remarks}
This method is designed mainly for editors -\/ it will try to load an existing page if there is one, otherwise it will create a new one synchronously. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a3ccafb61dcc690bb1a1efd6c8a6b907b}\label{class_ogre_1_1_paged_world_section_a3ccafb61dcc690bb1a1efd6c8a6b907b}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!getPageID@{getPageID}}
\index{getPageID@{getPageID}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{getPageID()}{getPageID()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}} Ogre\+::\+Paged\+World\+Section\+::get\+Page\+ID (\begin{DoxyParamCaption}\item[{const \mbox{\hyperlink{namespace_ogre_ac94fc4008c1165dea017263fee56b273}{Vector3}} \&}]{world\+Pos }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Get the page ID for a given world position. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a0e390153652b3283abc91950017aa280}\label{class_ogre_1_1_paged_world_section_a0e390153652b3283abc91950017aa280}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!loadPage@{loadPage}}
\index{loadPage@{loadPage}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{loadPage()}{loadPage()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::load\+Page (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}}}]{page\+ID,  }\item[{bool}]{force\+Synchronous = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Ask for a page to be loaded with the given (section-\/relative) Page\+ID. 

\begin{DoxyRemark}{Remarks}
You would not normally call this manually, the \mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}} is in charge of it usually. If this page is already loaded, this request will not load it again. If the page needs loading, then it may be an asynchronous process depending on whether threading is enabled. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em page\+ID} & The page ID to load \\
\hline
{\em force\+Synchronous} & If true, the page will always be loaded synchronously \\
\hline
\end{DoxyParams}


Reimplemented in \mbox{\hyperlink{class_ogre_1_1_terrain_paged_world_section_a1757d16ae402efa4553fec18d44edda0}{Ogre\+::\+Terrain\+Paged\+World\+Section}}.

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a8079567efda9298ba00516ddd41b0911}\label{class_ogre_1_1_paged_world_section_a8079567efda9298ba00516ddd41b0911}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!unloadPage@{unloadPage}}
\index{unloadPage@{unloadPage}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{unloadPage()}{unloadPage()}\hspace{0.1cm}{\footnotesize\ttfamily [1/2]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::unload\+Page (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}}}]{page\+ID,  }\item[{bool}]{force\+Synchronous = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Ask for a page to be unloaded with the given (section-\/relative) Page\+ID. 

\begin{DoxyRemark}{Remarks}
You would not normally call this manually, the \mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}} is in charge of it usually. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em page\+ID} & The page ID to unload \\
\hline
{\em force\+Synchronous} & If true, the page will always be unloaded synchronously \\
\hline
\end{DoxyParams}


Reimplemented in \mbox{\hyperlink{class_ogre_1_1_terrain_paged_world_section_a11bef4778399774ee5e32480f6b2bb69}{Ogre\+::\+Terrain\+Paged\+World\+Section}}.

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_ae228d76c74b2b30b584abc22191887ec}\label{class_ogre_1_1_paged_world_section_ae228d76c74b2b30b584abc22191887ec}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!unloadPage@{unloadPage}}
\index{unloadPage@{unloadPage}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{unloadPage()}{unloadPage()}\hspace{0.1cm}{\footnotesize\ttfamily [2/2]}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::unload\+Page (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$}]{p,  }\item[{bool}]{force\+Synchronous = {\ttfamily false} }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Ask for a page to be unloaded with the given (section-\/relative) Page\+ID. 

\begin{DoxyRemark}{Remarks}
You would not normally call this manually, the \mbox{\hyperlink{class_ogre_1_1_page_strategy}{Page\+Strategy}} is in charge of it usually. 
\end{DoxyRemark}

\begin{DoxyParams}{Parameters}
{\em p} & The \mbox{\hyperlink{class_ogre_1_1_page}{Page}} to unload \\
\hline
{\em force\+Synchronous} & If true, the page will always be unloaded synchronously \\
\hline
\end{DoxyParams}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a495c03ee2f1c570495d640053bb33c03}\label{class_ogre_1_1_paged_world_section_a495c03ee2f1c570495d640053bb33c03}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!\_prepareProceduralPage@{\_prepareProceduralPage}}
\index{\_prepareProceduralPage@{\_prepareProceduralPage}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{\_prepareProceduralPage()}{\_prepareProceduralPage()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Paged\+World\+Section\+::\+\_\+prepare\+Procedural\+Page (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$}]{page }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Give a section the opportunity to prepare page content procedurally. 

\begin{DoxyRemark}{Remarks}
You should not call this method directly. This call may well happen in a separate thread so it should not access G\+PU resources, use \+\_\+load\+Procedural\+Page for that 
\end{DoxyRemark}
\begin{DoxyReturn}{Returns}
true if the page was populated, false otherwise 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_ac0c8f91bad2fa313ecde9d0f6e8491b9}\label{class_ogre_1_1_paged_world_section_ac0c8f91bad2fa313ecde9d0f6e8491b9}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!\_loadProceduralPage@{\_loadProceduralPage}}
\index{\_loadProceduralPage@{\_loadProceduralPage}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{\_loadProceduralPage()}{\_loadProceduralPage()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Paged\+World\+Section\+::\+\_\+load\+Procedural\+Page (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$}]{page }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Give a section the opportunity to prepare page content procedurally. 

\begin{DoxyRemark}{Remarks}
You should not call this method directly. This call will happen in the main render thread so it can access G\+PU resources. Use \+\_\+prepare\+Procedural\+Page for background preparation. 
\end{DoxyRemark}
\begin{DoxyReturn}{Returns}
true if the page was populated, false otherwise 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a9479d0ae02a6b258f7eea12526561cb2}\label{class_ogre_1_1_paged_world_section_a9479d0ae02a6b258f7eea12526561cb2}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!\_unloadProceduralPage@{\_unloadProceduralPage}}
\index{\_unloadProceduralPage@{\_unloadProceduralPage}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{\_unloadProceduralPage()}{\_unloadProceduralPage()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Paged\+World\+Section\+::\+\_\+unload\+Procedural\+Page (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$}]{page }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Give a section the opportunity to unload page content procedurally. 

\begin{DoxyRemark}{Remarks}
You should not call this method directly. This call will happen in the main render thread so it can access G\+PU resources. Use \+\_\+unprepare\+Procedural\+Page for background preparation. 
\end{DoxyRemark}
\begin{DoxyReturn}{Returns}
true if the page was populated, false otherwise 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_ab719550f4970c6ec32e949bd0ab79b4a}\label{class_ogre_1_1_paged_world_section_ab719550f4970c6ec32e949bd0ab79b4a}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!\_unprepareProceduralPage@{\_unprepareProceduralPage}}
\index{\_unprepareProceduralPage@{\_unprepareProceduralPage}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{\_unprepareProceduralPage()}{\_unprepareProceduralPage()}}
{\footnotesize\ttfamily virtual bool Ogre\+::\+Paged\+World\+Section\+::\+\_\+unprepare\+Procedural\+Page (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_page}{Page}} $\ast$}]{page }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Give a section the opportunity to unprepare page content procedurally. 

\begin{DoxyRemark}{Remarks}
You should not call this method directly. This call may well happen in a separate thread so it should not access G\+PU resources, use \+\_\+unload\+Procedural\+Page for that 
\end{DoxyRemark}
\begin{DoxyReturn}{Returns}
true if the page was unpopulated, false otherwise 
\end{DoxyReturn}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_aa05961d63f7a427e11b96ec9e03578d0}\label{class_ogre_1_1_paged_world_section_aa05961d63f7a427e11b96ec9e03578d0}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!holdPage@{holdPage}}
\index{holdPage@{holdPage}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{holdPage()}{holdPage()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::hold\+Page (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}}}]{page\+ID }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Ask for a page to be kept in memory if it\textquotesingle{}s loaded. 

\begin{DoxyRemark}{Remarks}
This method indicates that a page should be retained if it\textquotesingle{}s already in memory, but if it\textquotesingle{}s not then it won\textquotesingle{}t trigger a load. This is useful for retaining pages that have just gone out of range, but which you don\textquotesingle{}t want to unload just yet because it\textquotesingle{}s quite possible they may come back into the active set again very quickly / easily. But at the same time, if they\textquotesingle{}ve already been purged you don\textquotesingle{}t want to force them to load. This is the \textquotesingle{}maybe\textquotesingle{} region of pages. 
\end{DoxyRemark}
\begin{DoxyParagraph}{}
\mbox{\hyperlink{class_ogre_1_1_any}{Any}} \mbox{\hyperlink{class_ogre_1_1_page}{Page}} that is neither requested nor held in a frame will be deemed a candidate for unloading. 
\end{DoxyParagraph}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_ab5d4ec9ce6571345f4f072f2ab1404dc}\label{class_ogre_1_1_paged_world_section_ab5d4ec9ce6571345f4f072f2ab1404dc}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!getPage@{getPage}}
\index{getPage@{getPage}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{getPage()}{getPage()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_page}{Page}}$\ast$ Ogre\+::\+Paged\+World\+Section\+::get\+Page (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}}}]{page\+ID }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Retrieves a \mbox{\hyperlink{class_ogre_1_1_page}{Page}}. 

\begin{DoxyRemark}{Remarks}
This method will only return \mbox{\hyperlink{class_ogre_1_1_page}{Page}} instances that are already loaded. It will return null if a page is not loaded. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a2c2cfc82a89da128f8cb51b4b6bbb97c}\label{class_ogre_1_1_paged_world_section_a2c2cfc82a89da128f8cb51b4b6bbb97c}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!removeAllPages@{removeAllPages}}
\index{removeAllPages@{removeAllPages}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{removeAllPages()}{removeAllPages()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::remove\+All\+Pages (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Remove all pages immediately. 

\begin{DoxyRemark}{Remarks}
Effectively \textquotesingle{}resets\textquotesingle{} this section by deleting all pages. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a4d4ad3e43086dcef834c14f5943ed906}\label{class_ogre_1_1_paged_world_section_a4d4ad3e43086dcef834c14f5943ed906}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!setPageProvider@{setPageProvider}}
\index{setPageProvider@{setPageProvider}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{setPageProvider()}{setPageProvider()}}
{\footnotesize\ttfamily virtual void Ogre\+::\+Paged\+World\+Section\+::set\+Page\+Provider (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{class_ogre_1_1_page_provider}{Page\+Provider}} $\ast$}]{provider }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Set the \mbox{\hyperlink{class_ogre_1_1_page_provider}{Page\+Provider}} which can provide streams Pages in this section. 

\begin{DoxyRemark}{Remarks}
This is the top-\/level way that you can direct how \mbox{\hyperlink{class_ogre_1_1_page}{Page}} data is loaded. When data for a \mbox{\hyperlink{class_ogre_1_1_page}{Page}} is requested for a \mbox{\hyperlink{class_ogre_1_1_paged_world_section}{Paged\+World\+Section}}, the following sequence of classes will be checked to see if they have a provider willing to supply the stream\+: \mbox{\hyperlink{class_ogre_1_1_paged_world_section}{Paged\+World\+Section}}, \mbox{\hyperlink{class_ogre_1_1_paged_world}{Paged\+World}}, \mbox{\hyperlink{class_ogre_1_1_page_manager}{Page\+Manager}}. If none of these do, then the default behaviour is to look for a file called worldname\+\_\+sectionname\+\_\+page\+I\+D.\+page. 
\end{DoxyRemark}
\begin{DoxyNote}{Note}
The caller remains responsible for the destruction of the provider. 
\end{DoxyNote}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a54b15191c5e2f5fa5d3ee4800ec27637}\label{class_ogre_1_1_paged_world_section_a54b15191c5e2f5fa5d3ee4800ec27637}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!getPageProvider@{getPageProvider}}
\index{getPageProvider@{getPageProvider}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{getPageProvider()}{getPageProvider()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_page_provider}{Page\+Provider}}$\ast$ Ogre\+::\+Paged\+World\+Section\+::get\+Page\+Provider (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}, {\ttfamily [virtual]}}



Get the \mbox{\hyperlink{class_ogre_1_1_page_provider}{Page\+Provider}} which can provide streams for Pages in this section. 

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_ace50c38bd8514388683c2baff141e452}\label{class_ogre_1_1_paged_world_section_ace50c38bd8514388683c2baff141e452}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!\_readPageStream@{\_readPageStream}}
\index{\_readPageStream@{\_readPageStream}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{\_readPageStream()}{\_readPageStream()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_stream_serialiser}{Stream\+Serialiser}}$\ast$ Ogre\+::\+Paged\+World\+Section\+::\+\_\+read\+Page\+Stream (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}}}]{page\+ID }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Get a serialiser set up to read \mbox{\hyperlink{class_ogre_1_1_page}{Page}} data for the given Page\+ID. 


\begin{DoxyParams}{Parameters}
{\em page\+ID} & The ID of the page being requested \\
\hline
\end{DoxyParams}
\begin{DoxyRemark}{Remarks}
The \mbox{\hyperlink{class_ogre_1_1_stream_serialiser}{Stream\+Serialiser}} returned is the responsibility of the caller to delete. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a62d2d4952b2c5d0fb42294b4a67f2ef8}\label{class_ogre_1_1_paged_world_section_a62d2d4952b2c5d0fb42294b4a67f2ef8}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!\_writePageStream@{\_writePageStream}}
\index{\_writePageStream@{\_writePageStream}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{\_writePageStream()}{\_writePageStream()}}
{\footnotesize\ttfamily virtual \mbox{\hyperlink{class_ogre_1_1_stream_serialiser}{Stream\+Serialiser}}$\ast$ Ogre\+::\+Paged\+World\+Section\+::\+\_\+write\+Page\+Stream (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{namespace_ogre_a5126a9c9fbccbfe4c78070263098acb2}{Page\+ID}}}]{page\+ID }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Get a serialiser set up to write \mbox{\hyperlink{class_ogre_1_1_page}{Page}} data for the given Page\+ID. 


\begin{DoxyParams}{Parameters}
{\em page\+ID} & The ID of the page being requested \\
\hline
\end{DoxyParams}
\begin{DoxyRemark}{Remarks}
The \mbox{\hyperlink{class_ogre_1_1_stream_serialiser}{Stream\+Serialiser}} returned is the responsibility of the caller to delete. 
\end{DoxyRemark}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a6896f555077a1a7d44588fc74446ed57}\label{class_ogre_1_1_paged_world_section_a6896f555077a1a7d44588fc74446ed57}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!getType@{getType}}
\index{getType@{getType}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{getType()}{getType()}}
{\footnotesize\ttfamily virtual const \mbox{\hyperlink{namespace_ogre_af73bbdc8bed8a3e6fcd56bb8fa188c45}{String}}\& Ogre\+::\+Paged\+World\+Section\+::get\+Type (\begin{DoxyParamCaption}{ }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [virtual]}}



Get the type name of this section. 



\doxysubsection{Friends And Related Function Documentation}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_aeb00ceddc4315000f13b86256e365644}\label{class_ogre_1_1_paged_world_section_aeb00ceddc4315000f13b86256e365644}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!operator$<$$<$@{operator$<$$<$}}
\index{operator$<$$<$@{operator$<$$<$}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{operator$<$$<$}{operator<<}}
{\footnotesize\ttfamily \mbox{\hyperlink{_ogre_paging_prerequisites_8h_a12507ffbcb05d7b7af41403ff7db8a5c}{\+\_\+\+Ogre\+Paging\+Export}} friend std\+::ostream\& operator$<$$<$ (\begin{DoxyParamCaption}\item[{std\+::ostream \&}]{o,  }\item[{const \mbox{\hyperlink{class_ogre_1_1_paged_world_section}{Paged\+World\+Section}} \&}]{p }\end{DoxyParamCaption})\hspace{0.3cm}{\ttfamily [friend]}}



Function for writing to a stream. 



\doxysubsection{Member Data Documentation}
\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a10f86869b319e962411835604857909d}\label{class_ogre_1_1_paged_world_section_a10f86869b319e962411835604857909d}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!CHUNK\_ID@{CHUNK\_ID}}
\index{CHUNK\_ID@{CHUNK\_ID}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{CHUNK\_ID}{CHUNK\_ID}}
{\footnotesize\ttfamily const \mbox{\hyperlink{namespace_ogre_adf2a0cf2e77143b5ee1d38a75e289545}{uint32}} Ogre\+::\+Paged\+World\+Section\+::\+C\+H\+U\+N\+K\+\_\+\+ID\hspace{0.3cm}{\ttfamily [static]}}

\mbox{\Hypertarget{class_ogre_1_1_paged_world_section_a95709472b243e346dd0be46b05927beb}\label{class_ogre_1_1_paged_world_section_a95709472b243e346dd0be46b05927beb}} 
\index{Ogre::PagedWorldSection@{Ogre::PagedWorldSection}!CHUNK\_VERSION@{CHUNK\_VERSION}}
\index{CHUNK\_VERSION@{CHUNK\_VERSION}!Ogre::PagedWorldSection@{Ogre::PagedWorldSection}}
\doxysubsubsection{\texorpdfstring{CHUNK\_VERSION}{CHUNK\_VERSION}}
{\footnotesize\ttfamily const \mbox{\hyperlink{namespace_ogre_aa8263b218e7d187ad5ef03a73a6ad7fd}{uint16}} Ogre\+::\+Paged\+World\+Section\+::\+C\+H\+U\+N\+K\+\_\+\+V\+E\+R\+S\+I\+ON\hspace{0.3cm}{\ttfamily [static]}}



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{_ogre_paged_world_section_8h}{Ogre\+Paged\+World\+Section.\+h}}\end{DoxyCompactItemize}
