The Nebula Device 3: Resources::TexturePoolMapperScheduler Class Reference

The Nebula Device 3

Resources::TexturePoolMapperScheduler Class Reference

#include <texturepoolmapperscheduler.h>

Inheritance diagram for Resources::TexturePoolMapperScheduler:

Resources::ResourceScheduler Core::RefCounted

Detailed Description

A simple (example) for a ResourceScheduler for TexturePools based on NRU (not recently used) algorithm.

(C) 2010 Radon Labs GmbH

Public Member Functions

 TexturePoolMapperScheduler ()
 constructor
 ~TexturePoolMapperScheduler ()
 destructor
virtual void SetMapper (const Ptr< StreamingResourceMapper > &mapper)
 sets the ResourceMapper and the PoolResourceMapper (downcasts the ResourceMapper)
virtual void DoResourceLOD (const Ptr< ManagedResource > &managedResource)
 analyzes and reacts on changes of the distance of given ManagedResource
virtual bool OnRequestManagedResource (const Ptr< ManagedResource > &managedResource, const ResourceRequestInfo *requestInfo)
 tries to load a resource and returns true if request was successful
virtual void OnRemoveFromMapper ()
 call this as the scheduler is removed from its mapper
virtual const Ptr< LoadingResource > & AppendLoadingResource (const Core::Rtti &loadingType, const Ptr< ManagedResource > &managedResource, const Ptr< Resource > &resourceToLoad)
 appends resource to loading-queue
virtual void CleanUpLoadingQueue ()
 cleans the loading queue
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Protected Member Functions

virtual bool OnRequestOtherMipMap (const Ptr< ManagedTexture > &managedTexture, const TextureRequestInfo *requestInfo)
 tries to copy as much texture data from texture in memory to another slot fitting new mipMap level

Protected Attributes

Ptr< PoolResourceMapperpoolMapper

Member Function Documentation

void Resources::TexturePoolMapperScheduler::SetMapper ( const Ptr< StreamingResourceMapper > &  mapper  )  [virtual]

sets the ResourceMapper and the PoolResourceMapper (downcasts the ResourceMapper)

This stores a downcasted copy of the Ptr as a separate PoolResourceMapper so we don't need to cast it frequently OnFrame.

Reimplemented from Resources::ResourceScheduler.

bool Resources::TexturePoolMapperScheduler::OnRequestManagedResource ( const Ptr< ManagedResource > &  managedResource,
const ResourceRequestInfo *  requestInfo 
) [virtual]

tries to load a resource and returns true if request was successful

Looks up a fitting pool and a free slot in this pool is looked up. If there is a free slot available the slot's Resource is set to requested Resource and a new LoadingResource-entry is sorted into the loadingQueue. If NO free slot is currently available false is returned. If NO free pool is found an error is thrown as this must not occur as each requested resource should have a valid entry in the resource dictionary.

Reimplemented from Resources::ResourceScheduler.

void Resources::ResourceScheduler::CleanUpLoadingQueue (  )  [virtual, inherited]

cleans the loading queue

As a very basic this method cleans up loadingQueue and removes loaded Resources. If loading failed or canceled StreamingResourceMapper::ResourceLoadException is called appropriate Resource. Overload this method in subclasses to perform additional clean-ups of the loadingQueue like kicking out requests which are out of date.

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.


Field Documentation

points to same target as ResourceScheduler::mapper but we do need this as we want to have some PoolResourceMapper specific functionalities