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

Represents a section of the PagedWorld which uses a given PageStrategy, and which is made up of a generally localised set of Page instances.
Показать файл Открыть проект Примеры использования класса

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

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

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

Свойство Тип Описание
mAABB Axiom.Math.AxisAlignedBox
mName string
mPageProvider PageProvider
mPages Page>.Dictionary
mParent PageWorld
mSceneMgr Axiom.Core.SceneManager
mStrategy Axiom.Components.Paging.PageStrategy
mStrategyData IPageStrategyData

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

Метод Описание
AttachPage ( Page page ) : void

Attach a page to this section.

DetachPage ( Page page ) : void

Detach a page to this section.

FrameEnd ( float timeElapsed ) : void

Called when the frame ends

FrameStart ( float timeSinceLastFrame ) : void

Called when the frame starts

GetPage ( PageID pageID ) : Page

Retrieves a Page.

GetPageID ( Vector3 worldPos ) : PageID

Get the page ID for a given world position.

HoldPage ( PageID pageID ) : void

Ask for a page to be kept in memory if it's loaded.

Load ( StreamSerializer stream ) : bool

Load this section from a stream (returns true if successful)

LoadOrCreatePage ( Vector3 worldPos ) : Page

Load or create a page against this section covering the given world space position.

LoadPage ( PageID pageID ) : void

Ask for a page to be loaded with the given (section-relative) PageID

LoadPage ( PageID pageID, bool forceSynchronous ) : void

Ask for a page to be loaded with the given (section-relative) PageID

LoadProcedualPage ( Page page ) : bool

Give a section the opportunity to load page content procedurally

NotifyCamerea ( Camera cam ) : void

Notify a section of the current camera

PagedWorldSection ( PageWorld parent ) : System

Construct a new instance, specifying just the parent (expecting to load).

PagedWorldSection ( string name, PageWorld parent, Axiom.Components.Paging.PageStrategy strategy, SceneManager sm ) : System

PrepareProcedualePage ( Page page ) : bool

Give a section the opportunity to prepare page content procedurally.

ReadPageStream ( PageID pageID ) : StreamSerializer

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

RemoveAllPages ( ) : void

Remove all pages immediately.

Save ( StreamSerializer stream ) : void

Save this section to a stream

SetSceneManager ( SceneManager sm ) : void

Change the SceneManager.

SetSceneManager ( string smName ) : void

Change the SceneManager.

SetStrategy ( string stratName ) : void

ToString ( ) : string

UnloadPage ( Page page, bool sync ) : void

UnloadPage ( PageID pageId ) : void

Ask for a page to be unloaded with the given (section-relative) PageID

UnloadPage ( PageID pageID, bool forceSynchonous ) : void

Ask for a page to be unloaded with the given (section-relative) PageID

UnloadProcedualPage ( Page page ) : bool

Give a section the opportunity to unload page content procedurally.

UnprepareProcedualPage ( Page page ) : bool

Give a section the opportunity to unprepare page content procedurally.

This method indicates that a page should be retained if it's already in memory, but if it's not then it won't trigger a load. This is useful for retaining pages that have just gone out of range, but which you don't want to unload just yet because it's quite possible they may come back into the active set again very quickly / easily. But at the same time, if they've already been purged you don't want to force them to load. This is the 'maybe' region of pages.

WritePageStream ( PageID pageID ) : StreamSerializer

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

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

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

Attach a page to this section.
public AttachPage ( Page page ) : void
page Page
Результат void

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

Detach a page to this section.
public DetachPage ( Page page ) : void
page Page
Результат 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

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

Retrieves a Page.
public GetPage ( PageID pageID ) : Page
pageID PageID
Результат Page

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

Get the page ID for a given world position.
public GetPageID ( Vector3 worldPos ) : PageID
worldPos Vector3
Результат PageID

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

Ask for a page to be kept in memory if it's loaded.
public HoldPage ( PageID pageID ) : void
pageID PageID
Результат void

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

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

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

Load or create a page against this section covering the given world space position.
public LoadOrCreatePage ( Vector3 worldPos ) : Page
worldPos Vector3
Результат Page

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

Ask for a page to be loaded with the given (section-relative) PageID
public LoadPage ( PageID pageID ) : void
pageID PageID The page ID to load
Результат void

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

Ask for a page to be loaded with the given (section-relative) PageID
public LoadPage ( PageID pageID, bool forceSynchronous ) : void
pageID PageID The page ID to load
forceSynchronous bool If true, the page will always be loaded synchronously
Результат void

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

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

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

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

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

Construct a new instance, specifying just the parent (expecting to load).
public PagedWorldSection ( PageWorld parent ) : System
parent PageWorld
Результат System

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

public PagedWorldSection ( string name, PageWorld parent, Axiom.Components.Paging.PageStrategy strategy, SceneManager sm ) : System
name string
parent PageWorld
strategy Axiom.Components.Paging.PageStrategy
sm Axiom.Core.SceneManager
Результат System

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

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

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

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

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

Remove all pages immediately.
public RemoveAllPages ( ) : void
Результат void

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

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

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

Change the SceneManager.
public SetSceneManager ( SceneManager sm ) : void
sm Axiom.Core.SceneManager The instance of the SceneManager
Результат void

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

Change the SceneManager.
public SetSceneManager ( string smName ) : void
smName string The instance name of the SceneManager
Результат void

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

public SetStrategy ( string stratName ) : void
stratName string
Результат void

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

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

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

public UnloadPage ( Page page, bool sync ) : void
page Page
sync bool
Результат void

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

Ask for a page to be unloaded with the given (section-relative) PageID
public UnloadPage ( PageID pageId ) : void
pageId PageID The page ID to unload
Результат void

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

Ask for a page to be unloaded with the given (section-relative) PageID
public UnloadPage ( PageID pageID, bool forceSynchonous ) : void
pageID PageID The page ID to unload
forceSynchonous bool If true, the page will always be unloaded synchronously
Результат void

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

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

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

Give a section the opportunity to unprepare page content procedurally.
This method indicates that a page should be retained if it's already in memory, but if it's not then it won't trigger a load. This is useful for retaining pages that have just gone out of range, but which you don't want to unload just yet because it's quite possible they may come back into the active set again very quickly / easily. But at the same time, if they've already been purged you don't want to force them to load. This is the 'maybe' region of pages.
public UnprepareProcedualPage ( Page page ) : bool
page Page
Результат bool

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

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

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

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

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

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

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

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

protected AxisAlignedBox,Axiom.Math mAABB
Результат Axiom.Math.AxisAlignedBox

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

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

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

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

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

protected Dictionary mPages
Результат Page>.Dictionary

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

protected PageWorld,Axiom.Components.Paging mParent
Результат PageWorld

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

protected SceneManager,Axiom.Core mSceneMgr
Результат Axiom.Core.SceneManager

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

protected PageStrategy,Axiom.Components.Paging mStrategy
Результат Axiom.Components.Paging.PageStrategy

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

protected IPageStrategyData mStrategyData
Результат IPageStrategyData