TypedElementSelectionSetLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Elements/Framework/TypedElementListProxy.h"
#include "Elements/Framework/TypedElementSelectionSet.h"
 
#include "CoreMinimal.h"
#include "UObject/Stack.h"
 
#include "TypedElementSelectionSetLibrary.generated.h"
 
namespace UE::TypedElementFramework::Private
{
    // Return true if the selection set is invalid
    bool CheckForInvalidSelectionSet(UTypedElementSelectionSet* SelectionSet)
    {
        if (!SelectionSet)
        {
            FFrame::KismetExecutionMessage(TEXT("SelectionSet is null."), ELogVerbosity::Error);
        }
 
        return true;
    }
}
 
UCLASS()
class UTypedElementSelectionSetLibrary : public UObject
{
    GENERATED_BODY()
    
public:
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|Selection", meta=(ScriptMethod))
    static bool SelectElementsFromList(UTypedElementSelectionSet* SelectionSet, const FScriptTypedElementListProxy ElementList, const FTypedElementSelectionOptions SelectionOptions)
    {
        if (!UE::TypedElementFramework::Private::CheckForInvalidSelectionSet(SelectionSet))
        {
            return false;
        }
 
        FTypedElementListPtr NativeList = UE::TypedElementFramework::ConvertToNativeTypedElementList(ElementList.GetElementList());
        if (!NativeList)
        {
            FFrame::KismetExecutionMessage(TEXT("ElementList is in a invalid state."), ELogVerbosity::Error);
            return false;
        }
 
        return SelectionSet->SelectElements(NativeList.ToSharedRef(), SelectionOptions);
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|Selection", meta=(ScriptMethod))
    static bool DeselectElementsFromList(UTypedElementSelectionSet* SelectionSet, const FScriptTypedElementListProxy ElementList, const FTypedElementSelectionOptions SelectionOptions)
    {
        if (!UE::TypedElementFramework::Private::CheckForInvalidSelectionSet(SelectionSet))
        {
            return false;
        }
 
        FTypedElementListPtr NativeList = UE::TypedElementFramework::ConvertToNativeTypedElementList(ElementList.GetElementList());
        if (!NativeList)
        {
            FFrame::KismetExecutionMessage(TEXT("ElementList is in a invalid state."), ELogVerbosity::Error);
            return false;
        }
 
        return SelectionSet->DeselectElements(NativeList.ToSharedRef(), SelectionOptions);
    }
 
    UFUNCTION(BlueprintCallable, Category="TypedElementFramework|Selection", meta=(ScriptMethod))
    static bool SetSelectionFromList(UTypedElementSelectionSet* SelectionSet, const FScriptTypedElementListProxy ElementList, const FTypedElementSelectionOptions SelectionOptions)
    {
        if (!UE::TypedElementFramework::Private::CheckForInvalidSelectionSet(SelectionSet))
        {
            return false;
        }
 
        FTypedElementListPtr NativeList = UE::TypedElementFramework::ConvertToNativeTypedElementList(ElementList.GetElementList());
        return NativeList
            ? SelectionSet->SetSelection(NativeList.ToSharedRef(), SelectionOptions)
            : SelectionSet->ClearSelection(SelectionOptions);
    }
 
    UFUNCTION(BlueprintPure, Category="TypedElementFramework|Selection", meta=(ScriptMethod))
    static FScriptTypedElementListProxy GetNormalizedSelection(UTypedElementSelectionSet* SelectionSet, const FTypedElementSelectionNormalizationOptions NormalizationOptions)
    {
        if (!UE::TypedElementFramework::Private::CheckForInvalidSelectionSet(SelectionSet))
        {
            return FScriptTypedElementListProxy();
        }
 
        FScriptTypedElementListPtr NormalizedSelection = UE::TypedElementFramework::ConvertToScriptTypedElementList(SelectionSet->GetNormalizedSelection(NormalizationOptions));
        return NormalizedSelection ? NormalizedSelection.ToSharedRef() : FScriptTypedElementListProxy();
    }
 
    UFUNCTION(BlueprintPure, Category="TypedElementFramework|Selection", meta=(ScriptMethod))
    static FScriptTypedElementListProxy GetNormalizedElementList(UTypedElementSelectionSet* SelectionSet, const FScriptTypedElementListProxy ElementList, const FTypedElementSelectionNormalizationOptions NormalizationOptions)
    {
        if (!UE::TypedElementFramework::Private::CheckForInvalidSelectionSet(SelectionSet))
        {
            return FScriptTypedElementListProxy();
        }
 
        FTypedElementListPtr NativeList = UE::TypedElementFramework::ConvertToNativeTypedElementList(ElementList.GetElementList());
        return NativeList ?  UE::TypedElementFramework::ConvertToScriptTypedElementList(SelectionSet->GetNormalizedElementList(NativeList.ToSharedRef(), NormalizationOptions)).ToSharedRef() : FScriptTypedElementListProxy();
    }
};