ComponentElementData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Elements/Framework/TypedElementData.h"
#include "UObject/Object.h"
#include "UObject/WeakObjectPtr.h"
 
class UActorComponent;
struct FTypedElementHandle;
 
struct FComponentElementData
{
    UE_DECLARE_TYPED_ELEMENT_DATA_RTTI(FComponentElementData);
 
    ENGINE_API FComponentElementData();
    ENGINE_API ~FComponentElementData();
    ENGINE_API FComponentElementData(const FComponentElementData& Other);
    ENGINE_API FComponentElementData(FComponentElementData&& Other);
    ENGINE_API FComponentElementData& operator=(const FComponentElementData& Other);
    ENGINE_API FComponentElementData& operator=(FComponentElementData&& Other);
 
    // TypedElementHandles are defer destroyed and can outlive their UObjects, leaving a stale
    // handle to the Component.
    // Use ComponentWeak instead to check for validity before use, especially in code that runs during
    // deferred element handle destruction
    UE_DEPRECATED(5.7, "Use ComponentWeak")
    UActorComponent* Component = nullptr;
    
    TWeakObjectPtr<UActorComponent> ComponentWeak = nullptr;
};
 
template<> ENGINE_API FString GetTypedElementDebugId<FComponentElementData>(const FComponentElementData& InElementData);
 
namespace ComponentElementDataUtil
{
 
ENGINE_API UActorComponent* GetComponentFromHandle(const FTypedElementHandle& InHandle, const bool bSilent = false);
 
ENGINE_API UActorComponent* GetComponentFromHandleChecked(const FTypedElementHandle& InHandle);
 
template <typename ElementHandleType>
TArray<UActorComponent*> GetComponentsFromHandles(TArrayView<const ElementHandleType> InHandles, const bool bSilent = false)
{
    TArray<UActorComponent*> Components;
    Components.Reserve(InHandles.Num());
 
    for (const FTypedElementHandle& Handle : InHandles)
    {
        if (UActorComponent* Component = GetComponentFromHandle(Handle, bSilent))
        {
            Components.Add(Component);
        }
    }
 
    return Components;
}
 
template <typename ElementHandleType>
TArray<UActorComponent*> GetComponentsFromHandlesChecked(TArrayView<const ElementHandleType> InHandles)
{
    TArray<UActorComponent*> Components;
    Components.Reserve(InHandles.Num());
 
    for (const FTypedElementHandle& Handle : InHandles)
    {
        Components.Add(GetComponentFromHandleChecked(Handle));
    }
 
    return Components;
}
 
} // namespace ComponentElementDataUtil