Files
Bret Curtis 4addabaf95 Let the resource cache be told what it stores, and free its values from OSG
GenericObjectCache stored osg::ref_ptr<osg::Object>, so everything cached had to
derive from osg::Object whether that meant anything or not: NifFileHolder and
BgsmFileHolder existed for no other reason, Resource::BulletShape and
ESMTerrain::LandObject carried META_Object and a CopyOp constructor nothing ever
called, and every getter paid a static_cast on the way out. The cache and
MultiObjectCache now take their value type as a template parameter, ask "is
anything else holding this?" through a useCount overload rather than a base class
method, and constrain accept and releaseGLObjects so a value type with neither is
not an error. Both holders are deleted; BulletShape, BulletShapeInstance and
LandObject become plain classes held by std::shared_ptr across physics,
pathfinding, navmeshtool and terrain storage; MWPhysics::HeightField's
type-erased osg::Object keep-alive becomes the LandObject it was always holding;
every remaining manager names the type it actually caches through the
NodeResourceManager alias, which removes eight static_casts and stops
clang-format wrapping the declarations. The preloader needs two keep-alive sets
for now, because the render-owned entries are still osg::Object; they merge once
those move behind the render backend.
2026-09-18 16:10:18 +02:00

105 lines
3.2 KiB
C++

#ifndef OPENMW_COMPONENTS_RESOURCE_MANAGER_H
#define OPENMW_COMPONENTS_RESOURCE_MANAGER_H
#include <memory>
#include <osg/Node>
#include <osg/ref_ptr>
#include <components/vfs/pathutil.hpp>
#include "objectcache.hpp"
namespace VFS
{
class Manager;
}
namespace osg
{
class Stats;
class State;
}
namespace Resource
{
class BaseResourceManager
{
public:
virtual ~BaseResourceManager() = default;
virtual void updateCache(double referenceTime) = 0;
virtual void clearCache() = 0;
virtual void setExpiryDelay(double expiryDelay) = 0;
virtual void reportStats(unsigned int frameNumber, osg::Stats* stats) const = 0;
virtual void releaseGLObjects(osg::State* state) = 0;
};
/// @brief Base class for managers that require a virtual file system and object cache.
/// @par This base class implements clearing of the cache, but populating it and what it's used for is up to the
/// individual sub classes.
template <class KeyType, class ValueType>
class GenericResourceManager : public BaseResourceManager
{
public:
typedef GenericObjectCache<KeyType, ValueType> CacheType;
explicit GenericResourceManager(const VFS::Manager* vfs, double expiryDelay)
: mVFS(vfs)
, mCache(std::make_unique<CacheType>())
, mExpiryDelay(expiryDelay)
{
}
virtual ~GenericResourceManager() = default;
/// Clear cache entries that have not been referenced for longer than expiryDelay.
void updateCache(double referenceTime) override { mCache->update(referenceTime, mExpiryDelay); }
/// Clear all cache entries.
void clearCache() override { mCache->clear(); }
/// How long to keep objects in cache after no longer being referenced.
void setExpiryDelay(double expiryDelay) final { mExpiryDelay = expiryDelay; }
double getExpiryDelay() const { return mExpiryDelay; }
const VFS::Manager* getVFS() const { return mVFS; }
void reportStats(unsigned int frameNumber, osg::Stats* stats) const override {}
void releaseGLObjects(osg::State* state) override
{
// Only meaningful for caches whose values are GL-backed; see objectcache.hpp.
if constexpr (requires { mCache->releaseGLObjects(state); })
mCache->releaseGLObjects(state);
}
protected:
const VFS::Manager* mVFS;
std::unique_ptr<CacheType> mCache;
double mExpiryDelay;
};
/// Caching a scene graph is the common case, so it gets a name rather than the
/// same template arguments at every use.
template <class KeyType>
using NodeResourceManager = GenericResourceManager<KeyType, osg::ref_ptr<osg::Node>>;
template <class ValueType>
class ResourceManager : public GenericResourceManager<std::string, ValueType>
{
public:
explicit ResourceManager(const VFS::Manager* vfs, double expiryDelay)
: GenericResourceManager<std::string, ValueType>(vfs, expiryDelay)
{
}
protected:
using GenericResourceManager<std::string, ValueType>::mCache;
using GenericResourceManager<std::string, ValueType>::mVFS;
};
}
#endif