C++ namespace MinSG::Extensions::OutOfCore
OutOfCore

Description

Classes

class	MinSG::OutOfCore::CacheContext Context for holding global cache information.
class	MinSG::OutOfCore::CacheLevel
class	MinSG::OutOfCore::CacheLevelFiles
class	MinSG::OutOfCore::CacheLevelFileSystem
class	MinSG::OutOfCore::CacheLevelGraphicsMemory
class	MinSG::OutOfCore::CacheLevelMainMemory
class	MinSG::OutOfCore::CacheManager
class	MinSG::OutOfCore::CacheObject
struct	MinSG::OutOfCore::CacheObjectCompare Structure used to sort cache objects by decreasing priority in STL containers.
class	MinSG::OutOfCore::CacheObjectPriority
class	MinSG::OutOfCore::DataStrategy
class	MinSG::OutOfCore::ImportHandler

Enumerations

enum	CacheLevelType {FILE_SYSTEM, FILES, MAIN_MEMORY, GRAPHICS_MEMORY} Possible types of cache levels.

Typedefs

typedef uint8_t	cacheLevelId_t Identifier of a cache level inside the cache hierarchy.

Variables

const cacheLevelId_t	maxNumCacheLevels Compile time maximum number of cache levels.

Functions

void	initMeshAttributeSerialization()
CacheManager &	getCacheManager() Return the single instance of CacheManager .
DataStrategy &	getDataStrategy() Return the single instance of DataStrategy .
void	setUp( FrameContext & context) Associate the out-of-core system to the FrameContext (so that it is triggered every frame) and register the MeshImport function.
void	shutDown() Remove the association of the out-of-core system and remove all cache levels.
bool	isSystemEnabled() Returntrue, if setUp() has been called at least once.
Rendering::Mesh *	addMesh(const Util::FileName & meshFile, const Geometry::Box & meshBB) Helper function to add a new mesh to the out-of-core system.

---

Documentation

enum
MinSG::OutOfCore::CacheLevelType

public

enum CacheLevelType

Enumerator		Description
Enumerator		Description
FILE_SYSTEM	= 1	See also: CacheLevelFileSystem
FILES	= 2	See also: CacheLevelFiles
MAIN_MEMORY	= 3	See also: CacheLevelMainMemory
GRAPHICS_MEMORY	= 4	See also: CacheLevelGraphicsMemory

Possible types of cache levels.

_{Defined in MinSG/Ext/OutOfCore/Definitions.h:28}

---

typedef
MinSG::OutOfCore::cacheLevelId_t

public

typedef uint8_t cacheLevelId_t

Identifier of a cache level inside the cache hierarchy.

_{Defined in MinSG/Ext/OutOfCore/Definitions.h:22}

---

variable
MinSG::OutOfCore::maxNumCacheLevels

public

const cacheLevelId_t maxNumCacheLevels

Compile time maximum number of cache levels.

_{Defined in MinSG/Ext/OutOfCore/Definitions.h:25}

---

function
MinSG::OutOfCore::initMeshAttributeSerialization

public

void initMeshAttributeSerialization(	)

Adds a handler for Util::_CounterAttribute to [Util::GenericAttributeSerialization](classUtil_1_1GenericAttributeSerialization) . S hould be called at least once before a *GenericAttribute is serialized which may contain a Mesh.

Note: Texture-Serialization may be added here when needed.

Note: The return value is always true and can be used for static initialization.

_{Defined in MinSG/Ext/OutOfCore/MeshAttributeSerialization.h:25}

---

function
MinSG::OutOfCore::getCacheManager

public

CacheManager & getCacheManager(	)

Return the single instance of CacheManager .

_{Defined in MinSG/Ext/OutOfCore/OutOfCore.h:33}

---

function
MinSG::OutOfCore::getDataStrategy

public

DataStrategy & getDataStrategy(	)

Return the single instance of DataStrategy .

_{Defined in MinSG/Ext/OutOfCore/OutOfCore.h:36}

---

function
MinSG::OutOfCore::setUp

public

void setUp(	FrameContext &	context )

Associate the out-of-core system to the FrameContext (so that it is triggered every frame) and register the MeshImport function.

_{Defined in MinSG/Ext/OutOfCore/OutOfCore.h:39}

---

function
MinSG::OutOfCore::shutDown

public

void shutDown(	)

Remove the association of the out-of-core system and remove all cache levels.

_{Defined in MinSG/Ext/OutOfCore/OutOfCore.h:42}

---

function
MinSG::OutOfCore::isSystemEnabled

public

bool isSystemEnabled(	)

Returntrue, if setUp() has been called at least once.

_{Defined in MinSG/Ext/OutOfCore/OutOfCore.h:45}

---

function
MinSG::OutOfCore::addMesh

public

Rendering::Mesh * addMesh(	const Util::FileName &	meshFile,
	const Geometry::Box &	meshBB
)

Helper function to add a new mesh to the out-of-core system.

_{Defined in MinSG/Ext/OutOfCore/OutOfCore.h:48}

---