C# Class Axiom.Components.Paging.PageWorld

ファイルを表示 Open project: WolfgangSt/axiom Class Usage Examples

Public Properties

Property Type Description
CHUNK_ID uint
CHUNK_VERSION ushort

Protected Properties

Property Type Description
mManger PageManager
mName string
mPageProvider PageProvider
mSectionNameGenerator NameGenerator
mSections PagedWorldSection>.Dictionary

Public Methods

Method Description
DestroySection ( PagedWorldSection section ) : void

DestroySection ( string name ) : void

Destroy a section of world.

FrameEnd ( float timeElapsed ) : void

Called when the frame ends

FrameStart ( float timeSinceLastFrame ) : void

Called when the frame starts

GetSection ( string name ) : PagedWorldSection

Retrieve a section of the world.

Load ( StreamSerializer stream ) : bool

Load world data from a serialiser (returns true if successful)

Load ( Stream stream ) : void

Load world data from a stream

Load ( string fileName ) : void

Load world data from a file

LoadProcedualPage ( Page page, PagedWorldSection section ) : bool

Give a world the opportunity to load page content procedurally.

NotifyCamera ( Camera cam ) : void

Notify a world of the current camera

PageWorld ( string name, PageManager manager ) : System

Default Constructor.

PrepareProcedualPage ( Page page, PagedWorldSection section ) : bool

Give a world the opportunity to prepare page content procedurally.

ReadPageStream ( PageID pageId, PagedWorldSection section ) : StreamSerializer

Get a serialiser set up to read Page data for the given PageID.

Save ( Stream stream ) : void

Save world data to a stream

Save ( StreamSerializer stream ) : void

Save world data to a serialiser

Save ( string fileName ) : void

Save world data to a file

ToString ( ) : string

UnPrepareProcedualPage ( Page page, PagedWorldSection section ) : bool

UnloadProcedualPage ( Page page, PagedWorldSection section ) : bool

Give a world the opportunity to unload page content procedurally.

WritePageStream ( PageID pageId, PagedWorldSection section ) : StreamSerializer

Get a serialiser set up to write Page data for the given PageID.

Private Methods

Method Description
CreateSection ( Axiom.Components.Paging.PageStrategy strategy, SceneManager sceneMgr ) : PagedWorldSection

Create a new section of the world.

CreateSection ( Axiom.Components.Paging.PageStrategy strategy, SceneManager sceneMgr, string sectionName ) : PagedWorldSection

Create a new section of the world.

CreateSection ( string strategyName, SceneManager sceneMgr ) : PagedWorldSection

Create a new section of the world.

CreateSection ( string strategyName, SceneManager sceneMgr, string sectionName ) : PagedWorldSection

Create a new section of the world.

Method Details

DestroySection() public method

public DestroySection ( PagedWorldSection section ) : void
section PagedWorldSection
return void

DestroySection() public method

Destroy a section of world.
public DestroySection ( string name ) : void
name string
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

GetSection() public method

Retrieve a section of the world.
public GetSection ( string name ) : PagedWorldSection
name string
return PagedWorldSection

Load() public method

Load world data from a serialiser (returns true if successful)
public Load ( StreamSerializer stream ) : bool
stream Axiom.Serialization.StreamSerializer
return bool

Load() public method

Load world data from a stream
public Load ( Stream stream ) : void
stream Stream
return void

Load() public method

Load world data from a file
public Load ( string fileName ) : void
fileName string
return void

LoadProcedualPage() public method

Give a world the opportunity to load page content procedurally.
public LoadProcedualPage ( Page page, PagedWorldSection section ) : bool
page Page
section PagedWorldSection
return bool

NotifyCamera() public method

Notify a world of the current camera
public NotifyCamera ( Camera cam ) : void
cam Axiom.Core.Camera
return void

PageWorld() public method

Default Constructor.
public PageWorld ( string name, PageManager manager ) : System
name string
manager PageManager
return System

PrepareProcedualPage() public method

Give a world the opportunity to prepare page content procedurally.
public PrepareProcedualPage ( Page page, PagedWorldSection section ) : bool
page Page
section PagedWorldSection
return bool

ReadPageStream() public method

Get a serialiser set up to read Page data for the given PageID.
public ReadPageStream ( PageID pageId, PagedWorldSection section ) : StreamSerializer
pageId PageID
section PagedWorldSection
return Axiom.Serialization.StreamSerializer

Save() public method

Save world data to a stream
public Save ( Stream stream ) : void
stream Stream
return void

Save() public method

Save world data to a serialiser
public Save ( StreamSerializer stream ) : void
stream Axiom.Serialization.StreamSerializer
return void

Save() public method

Save world data to a file
public Save ( string fileName ) : void
fileName string
return void

ToString() public method

public ToString ( ) : string
return string

UnPrepareProcedualPage() public method

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

UnloadProcedualPage() public method

Give a world the opportunity to unload page content procedurally.
public UnloadProcedualPage ( Page page, PagedWorldSection section ) : bool
page Page
section PagedWorldSection
return bool

WritePageStream() public method

Get a serialiser set up to write Page data for the given PageID.
public WritePageStream ( PageID pageId, PagedWorldSection section ) : StreamSerializer
pageId PageID
section PagedWorldSection
return Axiom.Serialization.StreamSerializer

Property Details

CHUNK_ID public_oe static_oe property

public static uint CHUNK_ID
return uint

CHUNK_VERSION public_oe static_oe property

public static ushort CHUNK_VERSION
return ushort

mManger protected_oe property

protected PageManager,Axiom.Components.Paging mManger
return PageManager

mName protected_oe property

protected string mName
return string

mPageProvider protected_oe property

protected PageProvider,Axiom.Components.Paging mPageProvider
return PageProvider

mSectionNameGenerator protected_oe property

protected NameGenerator mSectionNameGenerator
return NameGenerator

mSections protected_oe property

protected Dictionary mSections
return PagedWorldSection>.Dictionary