Resource.h

Go to the documentation of this file.

/*
   Copyright (c) 2018 DIVIDE-Studio
   Copyright (c) 2009 Ionut Cava
 
   This file is part of DIVIDE Framework.
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software
   and associated documentation files (the "Software"), to deal in the Software
   without restriction,
   including without limitation the rights to use, copy, modify, merge, publish,
   distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so,
   subject to the following conditions:
 
   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.
 
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED,
   INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
   PARTICULAR PURPOSE AND NONINFRINGEMENT.
   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
   DAMAGES OR OTHER LIABILITY,
   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
   IN CONNECTION WITH THE SOFTWARE
   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 */
 
#pragma once
#ifndef DVD_RESOURCE_H_
#define DVD_RESOURCE_H_
 
#include "Core/Headers/Hashable.h"
 
namespace Divide
{
 
 
    enum class ResourceState : U8
    {
        RES_UNKNOWN = 0,      
        RES_CREATED = 1,      
        RES_LOADING = 2,      
        RES_THREAD_LOADED = 3,
        RES_LOADED = 4,       
        RES_UNLOADING = 5,    
        COUNT
    };
 
    class Resource : public GUIDWrapper
    {
      public:
        explicit Resource( std::string_view resourceName, std::string_view typeName );
 
        [[nodiscard]] ResourceState getState() const noexcept;
 
        PROPERTY_R( Str<32>, typeName );
        PROPERTY_R( Str<256>, resourceName );
 
      protected:
        virtual void setState( ResourceState currentState );
 
      protected:
        std::atomic<ResourceState> _resourceState;
    };
 
    void WaitForReady( Resource* res );
    [[nodiscard]] bool SafeToDelete( Resource* res );
 
    struct ResourceDescriptorBase;
 
    class CachedResource : public Resource
    {
        friend class ResourceCache;
        friend struct ResourceLoader;
 
       public:
        explicit CachedResource( const ResourceDescriptorBase& descriptor, std::string_view typeName);
 
        virtual bool load( PlatformContext& context );
        virtual bool postLoad();
        virtual bool unload();
 
        void setState( ResourceState currentState ) final;
 
      protected:
        mutable Mutex _callbackLock{};
        PROPERTY_RW( ResourcePath, assetLocation );
        PROPERTY_RW( Str<256>, assetName );
        PROPERTY_R( size_t, descriptorHash );
    };
 
    template<typename T> requires std::is_base_of_v<CachedResource, T>
    using ResourcePtr = T*;
 
    template<typename T>
    struct PropertyDescriptor
    {
    };
 
    template<typename T>
    bool operator==( const PropertyDescriptor<T>& lhs, const PropertyDescriptor<T>& rhs ) noexcept;
    template<typename T>
    bool operator!=( const PropertyDescriptor<T>& lhs, const PropertyDescriptor<T>& rhs ) noexcept;
 
 
    template<typename T>
    [[nodiscard]] size_t GetHash( const PropertyDescriptor<T>& descriptor ) noexcept;
 
    struct ResourceDescriptorBase : public Hashable
    {
        explicit ResourceDescriptorBase( const std::string_view resourceName );
 
        [[nodiscard]] size_t getHash() const override;
 
        PROPERTY_RW( ResourcePath, assetLocation ); 
        PROPERTY_RW( Str<256>, assetName );     
        PROPERTY_RW( Str<256>, resourceName );
        PROPERTY_RW( vec3<U32>, data, VECTOR3_ZERO ); 
        PROPERTY_RW( U32, enumValue, 0u );
        PROPERTY_RW( U32, ID, 0u );
        PROPERTY_RW( P32, mask ); 
        PROPERTY_RW( bool, flag, false );
        PROPERTY_RW( bool, waitForReady, true );
    };
 
    template <typename T>
    struct ResourceDescriptor final : public ResourceDescriptorBase
    {
        explicit ResourceDescriptor( std::string_view resourceName );
        explicit ResourceDescriptor( std::string_view resourceName, const PropertyDescriptor<T>& descriptor );
 
        PropertyDescriptor<T> _propertyDescriptor;
 
        [[nodiscard]] size_t getHash() const final;
    };
 
    template<typename T>
    bool operator==( const ResourceDescriptor<T>& lhs, const ResourceDescriptor<T>& rhs ) noexcept;
    template<typename T>
    bool operator!=( const ResourceDescriptor<T>& lhs, const ResourceDescriptor<T>& rhs ) noexcept;
 
}  // namespace Divide
 
#endif //DVD_RESOURCE_H_
 
#include "Resource.inl"