C# Class Axiom.Components.Paging.PageWorld

Afficher le fichier Open project: WolfgangSt/axiom Class Usage Examples

Méthodes publiques

Свойство Type Description
CHUNK_ID uint
CHUNK_VERSION ushort

Protected Properties

Свойство Type Description
mManger PageManager
mName string
mPageProvider PageProvider
mSectionNameGenerator NameGenerator
mSections PagedWorldSection>.Dictionary

Méthodes publiques

Méthode 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

Méthode 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 méthode

public DestroySection ( PagedWorldSection section ) : void
section PagedWorldSection
Résultat void

DestroySection() public méthode

Destroy a section of world.
public DestroySection ( string name ) : void
name string
Résultat void

FrameEnd() public méthode

Called when the frame ends
public FrameEnd ( float timeElapsed ) : void
timeElapsed float
Résultat void

FrameStart() public méthode

Called when the frame starts
public FrameStart ( float timeSinceLastFrame ) : void
timeSinceLastFrame float
Résultat void

GetSection() public méthode

Retrieve a section of the world.
public GetSection ( string name ) : PagedWorldSection
name string
Résultat PagedWorldSection

Load() public méthode

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

Load() public méthode

Load world data from a stream
public Load ( Stream stream ) : void
stream Stream
Résultat void

Load() public méthode

Load world data from a file
public Load ( string fileName ) : void
fileName string
Résultat void

LoadProcedualPage() public méthode

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

NotifyCamera() public méthode

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

PageWorld() public méthode

Default Constructor.
public PageWorld ( string name, PageManager manager ) : System
name string
manager PageManager
Résultat System

PrepareProcedualPage() public méthode

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

ReadPageStream() public méthode

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

Save() public méthode

Save world data to a stream
public Save ( Stream stream ) : void
stream Stream
Résultat void

Save() public méthode

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

Save() public méthode

Save world data to a file
public Save ( string fileName ) : void
fileName string
Résultat void

ToString() public méthode

public ToString ( ) : string
Résultat string

UnPrepareProcedualPage() public méthode

public UnPrepareProcedualPage ( Page page, PagedWorldSection section ) : bool
page Page
section PagedWorldSection
Résultat bool

UnloadProcedualPage() public méthode

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

WritePageStream() public méthode

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

Property Details

CHUNK_ID public_oe static_oe property

public static uint CHUNK_ID
Résultat uint

CHUNK_VERSION public_oe static_oe property

public static ushort CHUNK_VERSION
Résultat ushort

mManger protected_oe property

protected PageManager,Axiom.Components.Paging mManger
Résultat PageManager

mName protected_oe property

protected string mName
Résultat string

mPageProvider protected_oe property

protected PageProvider,Axiom.Components.Paging mPageProvider
Résultat PageProvider

mSectionNameGenerator protected_oe property

protected NameGenerator mSectionNameGenerator
Résultat NameGenerator

mSections protected_oe property

protected Dictionary mSections
Résultat PagedWorldSection>.Dictionary