AssetRef.h

Go to the documentation of this file.

#pragma once
 
#include "PolyphaseAPI.h"
#include "Asset.h"
#include "Constants.h"
#include <vector>
#include "Assertion.h"
 
#include <unordered_set>
 
//class Asset;
class AssetManager;
struct AsyncLoadRequest;
 
POLYPHASE_API MutexObject* GetAssetRefMutex();
 
class POLYPHASE_API AssetRef
{
public:
 
    AssetRef();
    AssetRef(Asset* asset);
    AssetRef(const AssetRef& src);
    ~AssetRef();
    AssetRef& operator=(const AssetRef& src);
    AssetRef& operator=(const Asset* srcAsset);
 
    bool operator==(const AssetRef& other) const;
    bool operator!=(const AssetRef& other) const;
    bool operator==(const Asset* other) const;
    bool operator!=(const Asset* other) const;
 
    Asset* Get() const;
 
    template<typename T>
    T* Get() const
    {
        OCT_ASSERT(!mAsset || mAsset->GetType() == T::GetStaticType() || mAsset->Is(T::ClassRuntimeId()));
        return static_cast<T*>(Get());
    }
 
    void SetLoadRequest(AsyncLoadRequest* loadRequest);
    AsyncLoadRequest* GetLoadRequest();
 
    // Drops mAsset without touching its refcount. The normal `*this = nullptr`
    // assignment decrements the old asset's refcount, which crashes if the
    // pointer is already dangling (post-purge cross-project leak). Defensive
    // call sites that detected the dangling pointer via AssetManager
    // pointer-validation use this to neutralize the ref so subsequent
    // accesses (and the eventual ~AssetRef) don't redo the same crash.
    void ClearDangling();
 
private:
 
    void EraseAsyncLoadRef();
 
    Asset* mAsset = nullptr;
    AsyncLoadRequest* mLoadRequest = nullptr;
 
#if ASSET_LIVE_REF_TRACKING
public:
    static void ReplaceReferencesToAsset(Asset* oldAsset, Asset* newAsset);
    static void EraseReferencesToAsset(Asset* asset);
private:
    static void AddLiveRef(AssetRef* ref);
    static void RemoveLiveRef(AssetRef* ref);
#endif
 
};
 
typedef AssetRef TextureRef;
typedef AssetRef StaticMeshRef;
typedef AssetRef MaterialRef;
typedef AssetRef SkeletalMeshRef;
typedef AssetRef ParticleSystemRef;
typedef AssetRef SoundWaveRef;
typedef AssetRef FontRef;
typedef AssetRef SceneRef;
typedef AssetRef TimelineRef;
typedef AssetRef TransformAnimationRef;
typedef AssetRef DataAssetRef;
typedef AssetRef SpriteAnimationRef;
typedef AssetRef SkeletalAnimationRef;
typedef AssetRef HumanoidAvatarRef;
typedef AssetRef BoneMaskRef;