C# Класс Axiom.Components.Paging.PageWorld

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
CHUNK_ID uint
CHUNK_VERSION ushort

Защищенные свойства (Protected)

Свойство Тип Описание
mManger PageManager
mName string
mPageProvider PageProvider
mSectionNameGenerator NameGenerator
mSections PagedWorldSection>.Dictionary

Открытые методы

Метод Описание
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.

Приватные методы

Метод Описание
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.

Описание методов

DestroySection() публичный Метод

public DestroySection ( PagedWorldSection section ) : void
section PagedWorldSection
Результат void

DestroySection() публичный Метод

Destroy a section of world.
public DestroySection ( string name ) : void
name string
Результат void

FrameEnd() публичный Метод

Called when the frame ends
public FrameEnd ( float timeElapsed ) : void
timeElapsed float
Результат void

FrameStart() публичный Метод

Called when the frame starts
public FrameStart ( float timeSinceLastFrame ) : void
timeSinceLastFrame float
Результат void

GetSection() публичный Метод

Retrieve a section of the world.
public GetSection ( string name ) : PagedWorldSection
name string
Результат PagedWorldSection

Load() публичный Метод

Load world data from a serialiser (returns true if successful)
public Load ( StreamSerializer stream ) : bool
stream Axiom.Serialization.StreamSerializer
Результат bool

Load() публичный Метод

Load world data from a stream
public Load ( Stream stream ) : void
stream Stream
Результат void

Load() публичный Метод

Load world data from a file
public Load ( string fileName ) : void
fileName string
Результат void

LoadProcedualPage() публичный Метод

Give a world the opportunity to load page content procedurally.
public LoadProcedualPage ( Page page, PagedWorldSection section ) : bool
page Page
section PagedWorldSection
Результат bool

NotifyCamera() публичный Метод

Notify a world of the current camera
public NotifyCamera ( Camera cam ) : void
cam Axiom.Core.Camera
Результат void

PageWorld() публичный Метод

Default Constructor.
public PageWorld ( string name, PageManager manager ) : System
name string
manager PageManager
Результат System

PrepareProcedualPage() публичный Метод

Give a world the opportunity to prepare page content procedurally.
public PrepareProcedualPage ( Page page, PagedWorldSection section ) : bool
page Page
section PagedWorldSection
Результат bool

ReadPageStream() публичный Метод

Get a serialiser set up to read Page data for the given PageID.
public ReadPageStream ( PageID pageId, PagedWorldSection section ) : StreamSerializer
pageId PageID
section PagedWorldSection
Результат Axiom.Serialization.StreamSerializer

Save() публичный Метод

Save world data to a stream
public Save ( Stream stream ) : void
stream Stream
Результат void

Save() публичный Метод

Save world data to a serialiser
public Save ( StreamSerializer stream ) : void
stream Axiom.Serialization.StreamSerializer
Результат void

Save() публичный Метод

Save world data to a file
public Save ( string fileName ) : void
fileName string
Результат void

ToString() публичный Метод

public ToString ( ) : string
Результат string

UnPrepareProcedualPage() публичный Метод

public UnPrepareProcedualPage ( Page page, PagedWorldSection section ) : bool
page Page
section PagedWorldSection
Результат bool

UnloadProcedualPage() публичный Метод

Give a world the opportunity to unload page content procedurally.
public UnloadProcedualPage ( Page page, PagedWorldSection section ) : bool
page Page
section PagedWorldSection
Результат bool

WritePageStream() публичный Метод

Get a serialiser set up to write Page data for the given PageID.
public WritePageStream ( PageID pageId, PagedWorldSection section ) : StreamSerializer
pageId PageID
section PagedWorldSection
Результат Axiom.Serialization.StreamSerializer

Описание свойств

CHUNK_ID публичное статическое свойство

public static uint CHUNK_ID
Результат uint

CHUNK_VERSION публичное статическое свойство

public static ushort CHUNK_VERSION
Результат ushort

mManger защищенное свойство

protected PageManager,Axiom.Components.Paging mManger
Результат PageManager

mName защищенное свойство

protected string mName
Результат string

mPageProvider защищенное свойство

protected PageProvider,Axiom.Components.Paging mPageProvider
Результат PageProvider

mSectionNameGenerator защищенное свойство

protected NameGenerator mSectionNameGenerator
Результат NameGenerator

mSections защищенное свойство

protected Dictionary mSections
Результат PagedWorldSection>.Dictionary