C# Class Axiom.Components.Paging.PageRequestQueue

Show file Open project: WolfgangSt/axiom Class Usage Examples

Protected Properties

Property	Type	Description
mBackgroundQueue	Deque
mForceSynchronous	bool
mPageManager	PageManager
mRenderQueue	Deque
mRenderThreadTimeLimit	uint

Public Methods

Method	Description
CancelOperationsForPage ( Page page ) : void	Cancel any pending operations for a Page.
LoadPage ( Page page, PagedWorldSection section ) : void	Load a Page, for a given PagedWorldSection.
LoadPage ( Page page, PagedWorldSection section, bool forceSync ) : void	Load a Page, for a given PagedWorldSection.
PageRequestQueue ( PageManager manager ) : System	The PageRequestQueue is where pages are queued for loading and freeing.
ProcessRenderThreadsRequest ( ) : void	To be called in the main render thread each frame
UnLoadPage ( Page page, PagedWorldSection section, bool forceSync ) : void	Dispose of a page

Protected Methods

Method	Description
AddBackgroundRequest ( Request r ) : void
AddBackgroundRequest ( Request r, bool forceSync ) : void
AddRenderRequest ( Request r ) : void
AddRenderRequest ( Request r, bool forceSync ) : void
ProcessBackgroundRequest ( Request r ) : void	Process the background portion of a request (may be threaded)
ProcessRenderRequest ( Request r ) : void	Process the render portion of a request (may be threaded)

Method Details

AddBackgroundRequest() protected method

protected AddBackgroundRequest ( Request r ) : void
r	Request
return	void

AddBackgroundRequest() protected method

protected AddBackgroundRequest ( Request r, bool forceSync ) : void
r	Request
forceSync	bool
return	void

AddRenderRequest() protected method

protected AddRenderRequest ( Request r ) : void
r	Request
return	void

AddRenderRequest() protected method

protected AddRenderRequest ( Request r, bool forceSync ) : void
r	Request
forceSync	bool
return	void

CancelOperationsForPage() public method

Cancel any pending operations for a Page.

public CancelOperationsForPage ( Page page ) : void
page	Page
return	void

LoadPage() public method

Load a Page, for a given PagedWorldSection.

public LoadPage ( Page page, PagedWorldSection section ) : void
page	Page
section	PagedWorldSection
return	void

LoadPage() public method

Load a Page, for a given PagedWorldSection.

public LoadPage ( Page page, PagedWorldSection section, bool forceSync ) : void
page	Page
section	PagedWorldSection
forceSync	bool
return	void

PageRequestQueue() public method

The PageRequestQueue is where pages are queued for loading and freeing.

public PageRequestQueue ( PageManager manager ) : System
manager	PageManager
return	System

ProcessBackgroundRequest() protected method

Process the background portion of a request (may be threaded)

protected ProcessBackgroundRequest ( Request r ) : void
r	Request
return	void

ProcessRenderRequest() protected method

Process the render portion of a request (may be threaded)

protected ProcessRenderRequest ( Request r ) : void
r	Request
return	void

ProcessRenderThreadsRequest() public method

To be called in the main render thread each frame

public ProcessRenderThreadsRequest ( ) : void
return	void

UnLoadPage() public method

Dispose of a page

public UnLoadPage ( Page page, PagedWorldSection section, bool forceSync ) : void
page	Page
section	PagedWorldSection
forceSync	bool
return	void

Property Details

mBackgroundQueue protected property

Requests pending for the background queue

protected Deque mBackgroundQueue
return	Deque

mForceSynchronous protected property

Enable this option if you want to force synchronous loading of all future requests.

protected bool mForceSynchronous
return	bool

mPageManager protected property

protected PageManager,Axiom.Components.Paging mPageManager
return	PageManager

mRenderQueue protected property

Requests pending for the render queue (follow on from background)

protected Deque mRenderQueue
return	Deque

mRenderThreadTimeLimit protected property

Set the amount of time the render thread is allowed to spend on pending requests.

protected uint mRenderThreadTimeLimit
return	uint