ObjectSerializeAccessScope.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
#include "UObject/ObjectHandleTracking.h"
 
#if UE_WITH_OBJECT_HANDLE_TRACKING
 
namespace UE::CoreUObject::Private
{
    struct FObjectSerializeAccessScope
    {
        FObjectSerializeAccessScope(const UObject& Object);
        ~FObjectSerializeAccessScope();
 
        FObjectSerializeAccessScope(const FObjectSerializeAccessScope&) = delete;
        FObjectSerializeAccessScope& operator=(const FObjectSerializeAccessScope&) = delete;
 
        struct FSuspendScope
        {
            FSuspendScope();
            ~FSuspendScope();
 
            FSuspendScope(const FSuspendScope&) = delete;
            FSuspendScope& operator=(const FSuspendScope&) = delete;
        };
 
    private:
        friend struct FObjectSerializeAccessScopeImpl;
 
        //object being serialized
        const UObject& Object;
 
        //parent scope for the serialization stack
        FObjectSerializeAccessScope* Parent;
        
        //suspend to pause logging.
        //progress bars for instance can "pause" serialize
        //and do other work that kick object handle reads
        bool bSuspended;
    };
}
#define UE_SERIALIZE_ACCCESS_SCOPE(Object) UE::CoreUObject::Private::FObjectSerializeAccessScope PREPROCESSOR_JOIN(_Scope, __LINE__)(*(Object))
#define UE_SERIALIZE_ACCCESS_SCOPE_SUSPEND() UE::CoreUObject::Private::FObjectSerializeAccessScope::FSuspendScope PREPROCESSOR_JOIN(_Suspend, __LINE__)
 
#else
 
#define UE_SERIALIZE_ACCCESS_SCOPE(Object)
#define UE_SERIALIZE_ACCCESS_SCOPE_SUSPEND()
 
#endif