C# Class Axiom.Components.Paging.Page

Inheritance: PageLoadableUnit

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
mContentCollections	List
mDebugNode	Axiom.Core.SceneNode
mFrameLastHeld	uint
mID	PageID
mParent	PagedWorldSection

Public Methods

Method	Description
AttachContentCollection ( Axiom.Components.Paging.PageContentCollection coll ) : void	Add a content collection to this Page. This class ceases to be responsible for deleting this collection.
CreateContentCollection ( string typeName ) : Axiom.Components.Paging.PageContentCollection	Create a new PageContentCollection within this page. This is equivalent to calling PageManager.CreateContentCollection and then attachContentCollection.
DestroyContentCollection ( Axiom.Components.Paging.PageContentCollection coll ) : void	Destroy a PageContentCollection within this page. This is equivalent to calling DetachContentCollection and PageManager.DestroyContentCollection.
DetachContentCollection ( Axiom.Components.Paging.PageContentCollection coll ) : void
FrameEnd ( float timeElapsed ) : void	Called when the frame ends
FrameStart ( float timeSinceLastFrame ) : void	Called when the frame starts
GetContentCollection ( int index ) : Axiom.Components.Paging.PageContentCollection	Get a content collection
NotifyAttached ( PagedWorldSection parent ) : void	Internal method to notify a page that it is attached
NotifyCamera ( Camera cam ) : void	Notify a section of the current camera
Page ( PageID pageID ) : System	Page class
Save ( StreamSerializer stream ) : void
ToString ( ) : string
Touch ( ) : void	'Touch' the page to let it know it's being used

Protected Methods

Method	Description
PrepareImpl ( StreamSerializer stream ) : bool
UpdateDebugDisplay ( ) : void

Method Details

AttachContentCollection() public method

Add a content collection to this Page.

This class ceases to be responsible for deleting this collection.

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

CreateContentCollection() public method

Create a new PageContentCollection within this page. This is equivalent to calling PageManager.CreateContentCollection and then attachContentCollection.

public CreateContentCollection ( string typeName ) : Axiom.Components.Paging.PageContentCollection
typeName	string	The name of the type of content collection (see PageManager.GetContentCollectionFactories)
return	Axiom.Components.Paging.PageContentCollection

DestroyContentCollection() public method

Destroy a PageContentCollection within this page. This is equivalent to calling DetachContentCollection and PageManager.DestroyContentCollection.

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

DetachContentCollection() public method

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

FrameEnd() public method

Called when the frame ends

public FrameEnd ( float timeElapsed ) : void
timeElapsed	float
return	void

FrameStart() public method

Called when the frame starts

public FrameStart ( float timeSinceLastFrame ) : void
timeSinceLastFrame	float
return	void

GetContentCollection() public method

Get a content collection

public GetContentCollection ( int index ) : Axiom.Components.Paging.PageContentCollection
index	int
return	Axiom.Components.Paging.PageContentCollection

NotifyAttached() public method

Internal method to notify a page that it is attached

public NotifyAttached ( PagedWorldSection parent ) : void
parent	PagedWorldSection
return	void

NotifyCamera() public method

Notify a section of the current camera

public NotifyCamera ( Camera cam ) : void
cam	Axiom.Core.Camera
return	void

Page() public method

Page class

public Page ( PageID pageID ) : System
pageID	PageID
return	System

PrepareImpl() protected method

protected PrepareImpl ( StreamSerializer stream ) : bool
stream	Axiom.Serialization.StreamSerializer
return	bool

Save() public method

public Save ( StreamSerializer stream ) : void
stream	Axiom.Serialization.StreamSerializer
return	void

ToString() public method

public ToString ( ) : string
return	string

Touch() public method

'Touch' the page to let it know it's being used

public Touch ( ) : void
return	void

UpdateDebugDisplay() protected method

protected UpdateDebugDisplay ( ) : void
return	void

Property Details

CHUNK_ID public static property

public static uint CHUNK_ID
return	uint

CHUNK_VERSION public static property

public static ushort CHUNK_VERSION
return	ushort

mContentCollections protected property

protected List mContentCollections
return	List

mDebugNode protected property

protected SceneNode,Axiom.Core mDebugNode
return	Axiom.Core.SceneNode

mFrameLastHeld protected property

protected uint mFrameLastHeld
return	uint

mID protected property

protected PageID,Axiom.Components.Paging mID
return	PageID

mParent protected property

protected PagedWorldSection,Axiom.Components.Paging mParent
return	PagedWorldSection