Class ResourceBase

Engine/source/core/resource.h:84–187

All resources are derived from this type. The base type is only instantiated by the resource manager (the resource manager will return a base resource which a derived resource, Resource , will construct itself with). Base class handles locking and unlocking and provides several virtual functions to be defined by derived resource.

// provides several virtual functions to be defined by
// derived resource.
class ResourceBase
{
   friend class ResourceManager;
 
protected:
   class Header;

public:
   typedef U32 Signature;

public:
   ResourceBase(Header *header) { mResourceHeader = (header ? header : &smBlank); }
   virtual ~ResourceBase() {}

   const Torque::Path &getPath() const
   {
      AssertFatal(mResourceHeader != NULL,"ResourceBase::getPath called on invalid resource");
      return mResourceHeader->getPath();
   }

   U32   getChecksum() const
   {
      AssertFatal(mResourceHeader != NULL,"ResourceBase::getChecksum called on invalid resource");
      return mResourceHeader->getChecksum();
   }

protected:

   typedef void ( *NotifyUnloadFn )( const Torque::Path& path, void* resource );

   class Header : public StrongRefBase
   {
   public:
      Header()
      : mSignature(0),
         mResource(NULL),
         mNotifyUnload( NULL )
      {
      }

      const Torque::Path   &getPath() const { return mPath; }

      Signature   getSignature() const { return mSignature; }
      void *getResource() const { return (mResource ? mResource->getResource() : NULL); }
      U32   getChecksum() const;

      virtual void destroySelf();

   private:
      
      friend class ResourceBase;
      friend class ResourceManager;

      Signature            mSignature;
      ResourceHolderBase*  mResource;
      Torque::Path         mPath;
      NotifyUnloadFn       mNotifyUnload;
   };