C# Class Axiom.Components.Paging.PageManager

Show file Open project: WolfgangSt/axiom Class Usage Examples

Protected Properties

Property	Type	Description
mCameraList	List
mContentCollectionFactories	IPageContentCollectionFactory>.Dictionary
mContentFactories	IPageContentFactory>.Dictionary
mDebugDisplayLvl	uint
mEventRouter	EventRouter
mGrid2DPageStrategy	Grid2PageStrategy
mPageProvider	PageProvider
mPageResourceGroup	string
mQueue	PageRequestQueue
mSimpleCollectionFactory	SimplePageContentCollectionFactory
mStrategies	PageStrategy>.Dictionary
mWorldNameGenerator	NameGenerator
mWorlds	PageWorld>.Dictionary

Public Methods

Method	Description
AddCamera ( Camera c ) : void
AddContentCollectionFactory ( IPageContentCollectionFactory f ) : void
AddContentFactory ( IPageContentFactory f ) : void
AddStrategy ( Axiom.Components.Paging.PageStrategy strategy ) : void
AttachWorld ( PageWorld world ) : void	Attach a pre-created PagedWorld instance to this manager.
CreateContent ( string typeName ) : PageContent
CreateContentCollection ( string typeName ) : Axiom.Components.Paging.PageContentCollection
CreateWorld ( ) : PageWorld
CreateWorld ( string name ) : PageWorld	Create a new PagedWorld instance.
DestroyContent ( PageContent c ) : void
DestroyContentenCollection ( Axiom.Components.Paging.PageContentCollection coll ) : void
DestroyWorld ( PageWorld world ) : void	Destroy a world.
DestroyWorld ( string name ) : void	Destroy a world.
DetachWorld ( PageWorld world ) : void	Detach a PagedWorld instance from this manager (note: the caller then becomes responsible for the correct destruction of this instance)
GetContentCollectionFactory ( string name ) : IPageContentCollectionFactory
GetContentFactory ( string name ) : IPageContentFactory
GetStrategy ( string stratName ) : Axiom.Components.Paging.PageStrategy
GetWorld ( string name ) : PageWorld
HasCamera ( Camera c ) : bool
LoadProcedualPage ( Page page, PagedWorldSection section ) : bool
LoadWorld ( Stream stream ) : PageWorld
LoadWorld ( Stream stream, string name ) : PageWorld
LoadWorld ( string fileName ) : PageWorld
LoadWorld ( string fileName, string name ) : PageWorld
PageManager ( ) : System	The PageManager is the entry point through which you load all PagedWorld instances, and the place where PageStrategy instances and factory classes are registered to customise the paging behaviour.
PrepareProcedualPage ( Page page, PagedWorldSection section ) : bool
ReadPageStream ( PageID pageId, PagedWorldSection section ) : StreamSerializer
ReadWorldStream ( string fileName ) : StreamSerializer
RemoveCamera ( Camera c ) : void
RemoveContentCollectionFactory ( IPageContentCollectionFactory f ) : void
RemoveContentFactory ( IPageContentFactory f ) : void
RemoveStrategy ( Axiom.Components.Paging.PageStrategy strategy ) : void
SaveWorld ( PageWorld world, Stream stream ) : void
SaveWorld ( PageWorld world, string fileName ) : void
UnPrepareProcedualPage ( Page page, PagedWorldSection section ) : bool
UnloadProcedualPage ( Page page, PagedWorldSection section ) : bool
WritePageStream ( PageID pageId, PagedWorldSection section ) : StreamSerializer
WriteWorldStream ( string fileName ) : StreamSerializer

Protected Methods

Method	Description
CreateStandardContentFactories ( ) : void
CreateStandardStrategies ( ) : void

Method Details

AddCamera() public method

public AddCamera ( Camera c ) : void
c	Axiom.Core.Camera
return	void

AddContentCollectionFactory() public method

public AddContentCollectionFactory ( IPageContentCollectionFactory f ) : void
f	IPageContentCollectionFactory
return	void

AddContentFactory() public method

public AddContentFactory ( IPageContentFactory f ) : void
f	IPageContentFactory
return	void

AddStrategy() public method

public AddStrategy ( Axiom.Components.Paging.PageStrategy strategy ) : void
strategy	Axiom.Components.Paging.PageStrategy
return	void

AttachWorld() public method

Attach a pre-created PagedWorld instance to this manager.

public AttachWorld ( PageWorld world ) : void
world	PageWorld
return	void

CreateContent() public method

public CreateContent ( string typeName ) : PageContent
typeName	string
return	PageContent

CreateContentCollection() public method

public CreateContentCollection ( string typeName ) : Axiom.Components.Paging.PageContentCollection
typeName	string
return	Axiom.Components.Paging.PageContentCollection

CreateStandardContentFactories() protected method

protected CreateStandardContentFactories ( ) : void
return	void

CreateStandardStrategies() protected method

protected CreateStandardStrategies ( ) : void
return	void

CreateWorld() public method

public CreateWorld ( ) : PageWorld
return	PageWorld

CreateWorld() public method

Create a new PagedWorld instance.

public CreateWorld ( string name ) : PageWorld
name	string	name Optionally give a name to the world (if no name is given, one /// will be generated).
return	PageWorld

DestroyContent() public method

public DestroyContent ( PageContent c ) : void
c	PageContent
return	void

DestroyContentenCollection() public method

public DestroyContentenCollection ( Axiom.Components.Paging.PageContentCollection coll ) : void
coll	Axiom.Components.Paging.PageContentCollection
return	void

DestroyWorld() public method

Destroy a world.

public DestroyWorld ( PageWorld world ) : void
world	PageWorld
return	void

DestroyWorld() public method

Destroy a world.

public DestroyWorld ( string name ) : void
name	string
return	void

DetachWorld() public method

Detach a PagedWorld instance from this manager (note: the caller then becomes responsible for the correct destruction of this instance)

public DetachWorld ( PageWorld world ) : void
world	PageWorld
return	void

GetContentCollectionFactory() public method

public GetContentCollectionFactory ( string name ) : IPageContentCollectionFactory
name	string
return	IPageContentCollectionFactory

GetContentFactory() public method

public GetContentFactory ( string name ) : IPageContentFactory
name	string
return	IPageContentFactory

GetStrategy() public method

public GetStrategy ( string stratName ) : Axiom.Components.Paging.PageStrategy
stratName	string
return	Axiom.Components.Paging.PageStrategy

GetWorld() public method

public GetWorld ( string name ) : PageWorld
name	string
return	PageWorld

HasCamera() public method

public HasCamera ( Camera c ) : bool
c	Axiom.Core.Camera
return	bool

LoadProcedualPage() public method

public LoadProcedualPage ( Page page, PagedWorldSection section ) : bool
page	Page
section	PagedWorldSection
return	bool

LoadWorld() public method

public LoadWorld ( Stream stream ) : PageWorld
stream	Stream
return	PageWorld

LoadWorld() public method

public LoadWorld ( Stream stream, string name ) : PageWorld
stream	Stream
name	string
return	PageWorld

LoadWorld() public method

public LoadWorld ( string fileName ) : PageWorld
fileName	string
return	PageWorld

LoadWorld() public method

public LoadWorld ( string fileName, string name ) : PageWorld
fileName	string
name	string
return	PageWorld

PageManager() public method

The PageManager is the entry point through which you load all PagedWorld instances, and the place where PageStrategy instances and factory classes are registered to customise the paging behaviour.

public PageManager ( ) : System
return	System

PrepareProcedualPage() public method

public PrepareProcedualPage ( Page page, PagedWorldSection section ) : bool
page	Page
section	PagedWorldSection
return	bool

ReadPageStream() public method

public ReadPageStream ( PageID pageId, PagedWorldSection section ) : StreamSerializer
pageId	PageID
section	PagedWorldSection
return	Axiom.Serialization.StreamSerializer

ReadWorldStream() public method

public ReadWorldStream ( string fileName ) : StreamSerializer
fileName	string
return	Axiom.Serialization.StreamSerializer

RemoveCamera() public method

public RemoveCamera ( Camera c ) : void
c	Axiom.Core.Camera
return	void

RemoveContentCollectionFactory() public method

public RemoveContentCollectionFactory ( IPageContentCollectionFactory f ) : void
f	IPageContentCollectionFactory
return	void

RemoveContentFactory() public method

public RemoveContentFactory ( IPageContentFactory f ) : void
f	IPageContentFactory
return	void

RemoveStrategy() public method

public RemoveStrategy ( Axiom.Components.Paging.PageStrategy strategy ) : void
strategy	Axiom.Components.Paging.PageStrategy
return	void

SaveWorld() public method

public SaveWorld ( PageWorld world, Stream stream ) : void
world	PageWorld
stream	Stream
return	void

SaveWorld() public method

public SaveWorld ( PageWorld world, string fileName ) : void
world	PageWorld
fileName	string
return	void

UnPrepareProcedualPage() public method

public UnPrepareProcedualPage ( Page page, PagedWorldSection section ) : bool
page	Page
section	PagedWorldSection
return	bool

UnloadProcedualPage() public method

public UnloadProcedualPage ( Page page, PagedWorldSection section ) : bool
page	Page
section	PagedWorldSection
return	bool

WritePageStream() public method

public WritePageStream ( PageID pageId, PagedWorldSection section ) : StreamSerializer
pageId	PageID
section	PagedWorldSection
return	Axiom.Serialization.StreamSerializer

WriteWorldStream() public method

public WriteWorldStream ( string fileName ) : StreamSerializer
fileName	string
return	Axiom.Serialization.StreamSerializer

Property Details

mCameraList protected property

protected List mCameraList
return	List

mContentCollectionFactories protected property

protected Dictionary mContentCollectionFactories
return	IPageContentCollectionFactory>.Dictionary

mContentFactories protected property

protected Dictionary mContentFactories
return	IPageContentFactory>.Dictionary

mDebugDisplayLvl protected property

protected uint mDebugDisplayLvl
return	uint

mEventRouter protected property

protected EventRouter mEventRouter
return	EventRouter

mGrid2DPageStrategy protected property

protected Grid2PageStrategy,Axiom.Components.Paging mGrid2DPageStrategy
return	Grid2PageStrategy

mPageProvider protected property

protected PageProvider,Axiom.Components.Paging mPageProvider
return	PageProvider

mPageResourceGroup protected property

protected string mPageResourceGroup
return	string

mQueue protected property

protected PageRequestQueue,Axiom.Components.Paging mQueue
return	PageRequestQueue

mSimpleCollectionFactory protected property

protected SimplePageContentCollectionFactory,Axiom.Components.Paging mSimpleCollectionFactory
return	SimplePageContentCollectionFactory

mStrategies protected property

protected Dictionary mStrategies
return	PageStrategy>.Dictionary

mWorldNameGenerator protected property

protected NameGenerator mWorldNameGenerator
return	NameGenerator

mWorlds protected property

protected Dictionary mWorlds
return	PageWorld>.Dictionary