• Home
• Axiom
• Components
• Paging
• PagedWorldSection

C# Class Axiom.Components.Paging.PagedWorldSection

Show file Open project: WolfgangSt/axiom Class Usage Examples

Public Properties

Property	Type	Description
CHUNK_ID	uint
CHUNK_VERSION	ushort

Protected Properties

Property	Type	Description
mAABB	Axiom.Math.AxisAlignedBox
mName	string
mPageProvider	PageProvider
mPages	Page>.Dictionary
mParent	PageWorld
mSceneMgr	Axiom.Core.SceneManager
mStrategy	Axiom.Components.Paging.PageStrategy
mStrategyData	IPageStrategyData

Public Methods

Method	Description
AttachPage ( Page page ) : void	Attach a page to this section.
DetachPage ( Page page ) : void	Detach a page to this section.
FrameEnd ( float timeElapsed ) : void	Called when the frame ends
FrameStart ( float timeSinceLastFrame ) : void	Called when the frame starts
GetPage ( PageID pageID ) : Page	Retrieves a Page.
GetPageID ( Vector3 worldPos ) : PageID	Get the page ID for a given world position.
HoldPage ( PageID pageID ) : void	Ask for a page to be kept in memory if it's loaded.
Load ( StreamSerializer stream ) : bool	Load this section from a stream (returns true if successful)
LoadOrCreatePage ( Vector3 worldPos ) : Page	Load or create a page against this section covering the given world space position.
LoadPage ( PageID pageID ) : void	Ask for a page to be loaded with the given (section-relative) PageID
LoadPage ( PageID pageID, bool forceSynchronous ) : void	Ask for a page to be loaded with the given (section-relative) PageID
LoadProcedualPage ( Page page ) : bool	Give a section the opportunity to load page content procedurally
NotifyCamerea ( Camera cam ) : void	Notify a section of the current camera
PagedWorldSection ( PageWorld parent ) : System	Construct a new instance, specifying just the parent (expecting to load).
PagedWorldSection ( string name, PageWorld parent, Axiom.Components.Paging.PageStrategy strategy, SceneManager sm ) : System
PrepareProcedualePage ( Page page ) : bool	Give a section the opportunity to prepare page content procedurally.
ReadPageStream ( PageID pageID ) : StreamSerializer	Get a serialiser set up to read Page data for the given PageID.
RemoveAllPages ( ) : void	Remove all pages immediately.
Save ( StreamSerializer stream ) : void	Save this section to a stream
SetSceneManager ( SceneManager sm ) : void	Change the SceneManager.
SetSceneManager ( string smName ) : void	Change the SceneManager.
SetStrategy ( string stratName ) : void
ToString ( ) : string
UnloadPage ( Page page, bool sync ) : void
UnloadPage ( PageID pageId ) : void	Ask for a page to be unloaded with the given (section-relative) PageID
UnloadPage ( PageID pageID, bool forceSynchonous ) : void	Ask for a page to be unloaded with the given (section-relative) PageID
UnloadProcedualPage ( Page page ) : bool	Give a section the opportunity to unload page content procedurally.
UnprepareProcedualPage ( Page page ) : bool	Give a section the opportunity to unprepare page content procedurally. This method indicates that a page should be retained if it's already in memory, but if it's not then it won't trigger a load. This is useful for retaining pages that have just gone out of range, but which you don't want to unload just yet because it's quite possible they may come back into the active set again very quickly / easily. But at the same time, if they've already been purged you don't want to force them to load. This is the 'maybe' region of pages.
WritePageStream ( PageID pageID ) : StreamSerializer	Get a serialiser set up to write Page data for the given PageID.

Method Details

Property Details