ArchiveCookContext.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "AssetRegistry/CookTagList.h"
#include "UObject/CookEnums.h"
 
namespace UE::Cook { class ICookInfo; }
 
struct FArchiveCookContext
{
public:
    UE_DEPRECATED(5.4, "Use UE::Cook::ECookType")
    typedef UE::Cook::ECookType ECookType;
    UE_DEPRECATED(5.4, "Use UE::Cook::ECookingDLC")
    typedef UE::Cook::ECookingDLC ECookingDLC;
    UE_DEPRECATED(5.4, "Use UE::Cook::ECookType::Unknown")
    static const UE::Cook::ECookType ECookTypeUnknown = UE::Cook::ECookType::Unknown;
    UE_DEPRECATED(5.4, "Use UE::Cook::ECookType::OnTheFly")
    static const UE::Cook::ECookType ECookOnTheFly = UE::Cook::ECookType::OnTheFly;
    UE_DEPRECATED(5.4, "Use UE::Cook::ECookType::ByTheBook")
    static const UE::Cook::ECookType ECookByTheBook = UE::Cook::ECookType::ByTheBook;
    UE_DEPRECATED(5.4, "Use UE::Cook::ECookingDLC::Unknown")
    static const UE::Cook::ECookingDLC ECookingDLCUnknown = UE::Cook::ECookingDLC::Unknown;
    UE_DEPRECATED(5.4, "Use UE::Cook::ECookingDLC::Yes")
    static const UE::Cook::ECookingDLC ECookingDLCYes = UE::Cook::ECookingDLC::Yes;
    UE_DEPRECATED(5.4, "Use UE::Cook::ECookingDLC::No")
    static const UE::Cook::ECookingDLC ECookingDLCNo = UE::Cook::ECookingDLC::No;
 
private:
 
    FCookTagList CookTagList;
    const ITargetPlatform* TargetPlatform = nullptr;
    bool bCookTagListEnabled = false;
    UE::Cook::ECookType CookType = UE::Cook::ECookType::Unknown;
    UE::Cook::ECookingDLC CookingDLC = UE::Cook::ECookingDLC::Unknown;
    UE::Cook::ICookInfo* CookInfo = nullptr;
 
public:
 
    UE_DEPRECATED(5.4, "Call version that takes TargetPlatform and CookInfo")
    FArchiveCookContext(UPackage* InPackage, UE::Cook::ECookType InCookType, UE::Cook::ECookingDLC InCookingDLC);
    UE_DEPRECATED(5.6, "Call version that takes CookInfo")
    FArchiveCookContext(UPackage* InPackage, UE::Cook::ECookType InCookType, UE::Cook::ECookingDLC InCookingDLC,
        const ITargetPlatform* InTargetPlatform);
 
    FArchiveCookContext(UPackage* InPackage, UE::Cook::ECookType InCookType, UE::Cook::ECookingDLC InCookingDLC,
        const ITargetPlatform* InTargetPlatform, UE::Cook::ICookInfo* InCookInfo);
 
    void Reset();
 
    FCookTagList* GetCookTagList();
    const ITargetPlatform* GetTargetPlatform() const;
 
    bool IsCookByTheBook() const;
    bool IsCookOnTheFly() const;
    bool IsCookTypeUnknown() const;
    UE::Cook::ECookType GetCookType() const;
    UE::Cook::ECookingDLC GetCookingDLC() const;
    UE::Cook::ICookInfo* GetCookInfo();
};
 
 
// Inline implementations
 
 
inline FArchiveCookContext::FArchiveCookContext(UPackage* InPackage, UE::Cook::ECookType InCookType, 
    UE::Cook::ECookingDLC InCookingDLC)
    : FArchiveCookContext(InPackage, InCookType, InCookingDLC, nullptr, nullptr)
{
}
 
inline FArchiveCookContext::FArchiveCookContext(UPackage* InPackage, UE::Cook::ECookType InCookType,
    UE::Cook::ECookingDLC InCookingDLC, const ITargetPlatform* InTargetPlatform)
    : FArchiveCookContext(InPackage, InCookType, InCookingDLC, InTargetPlatform, nullptr)
{
}
 
inline FArchiveCookContext::FArchiveCookContext(UPackage* InPackage, UE::Cook::ECookType InCookType,
    UE::Cook::ECookingDLC InCookingDLC, const ITargetPlatform* InTargetPlatform, UE::Cook::ICookInfo* InCookInfo)
    : CookTagList(InPackage)
    , TargetPlatform(InTargetPlatform)
    , bCookTagListEnabled(InPackage && InCookType == UE::Cook::ECookType::ByTheBook)
    , CookType(InCookType)
    , CookingDLC(InCookingDLC)
    , CookInfo(InCookInfo)
{
}
 
inline void FArchiveCookContext::Reset()
{
    CookTagList.Reset();
}
 
inline FCookTagList* FArchiveCookContext::GetCookTagList()
{
    return bCookTagListEnabled ? &CookTagList : nullptr;
}
 
inline const ITargetPlatform* FArchiveCookContext::GetTargetPlatform() const
{
    return TargetPlatform;
}
 
inline bool FArchiveCookContext::IsCookByTheBook() const
{
    return CookType == UE::Cook::ECookType::ByTheBook;
}
 
inline bool FArchiveCookContext::IsCookOnTheFly() const
{
    return CookType == UE::Cook::ECookType::OnTheFly;
}
 
inline bool FArchiveCookContext::IsCookTypeUnknown() const
{
    return CookType == UE::Cook::ECookType::Unknown;
}
 
inline UE::Cook::ECookType FArchiveCookContext::GetCookType() const
{
    return CookType;
}
 
inline UE::Cook::ECookingDLC FArchiveCookContext::GetCookingDLC() const
{
    return CookingDLC;
}
 
inline UE::Cook::ICookInfo* FArchiveCookContext::GetCookInfo()
{
    return CookInfo;
}