ArticyFilterHelpers.h

//  
// Copyright (c) 2023 articy Software GmbH & Co. KG. All rights reserved.  
//
 
#pragma once
 
#include "ArticyGlobalVariables.h"
#include "FrontendFilterBase.h"
#include "Misc/TextFilterExpressionEvaluator.h"
#include "ArticyObject.h"
 
#define LOCTEXT_NAMESPACE "ArticyFilterHelpers"
 
// Define the filter types used for Articy objects and variables.
typedef const FAssetData& FArticyObjectFilterType;
typedef TFilterCollection<FArticyObjectFilterType> FArticyObjectFilterCollectionType;
 
typedef const UArticyVariable*& FArticyVariableFilterType;
typedef TFilterCollection<const UArticyVariable*&> FArticyVariableFilterCollectionType;

class FFrontendFilter_ArticyObject : public IFilter<FArticyObjectFilterType>
{
public:
    FFrontendFilter_ArticyObject();
    ~FFrontendFilter_ArticyObject();
 
    // FFrontendFilter implementation
    virtual FString GetName() const { return TEXT("ArticyObjectFilter"); }
    virtual FText GetDisplayName() const { return LOCTEXT("FrontendFilter_ArticyObjectFilter", "Articy Object Filter"); }
    virtual FText GetToolTipText() const { return LOCTEXT("FrontendFilter_ArticyObjectTooltip", "Show only articy objects that match the criteria"); }
 
    // IFilter implementation
    virtual bool PassesFilter(FArticyObjectFilterType InItem) const override;
 
    DECLARE_DERIVED_EVENT(FFrontendFilter_ArticyObject, IFilter<FArticyObjectFilterType>::FChangedEvent, FChangedEvent);
    virtual FChangedEvent& OnChanged() override { return ChangedEvent; }
 
    FChangedEvent ChangedEvent;
protected:
    void BroadcastChangedEvent() const { ChangedEvent.Broadcast(); }
public:
    FText GetRawFilterText() const;

    void SetRawFilterText(const FText& InFilterText);

    FText GetFilterErrorText() const;

    void SetIncludeClassName(const bool InIncludeClassName);
 
private:

    TSharedRef<class FFrontendFilter_ArticyObjectFilterExpressionContext> TextFilterExpressionContext;

    FTextFilterExpressionEvaluator TextFilterExpressionEvaluator;
};

class FArticyClassRestrictionFilter : public IFilter<FArticyObjectFilterType>
{
public:
    FArticyClassRestrictionFilter(TSubclassOf<UArticyObject> AllowedClass, bool bExactClass);

    void UpdateFilteredClass(TSubclassOf<UArticyObject> NewAllowedClass) { AllowedClass = NewAllowedClass;  OnChanged().Broadcast(); }
    void UpdateExactClass(bool bNewExactClass) { bExactClass = bNewExactClass; OnChanged().Broadcast(); }
    // IFilter implementation
    virtual bool PassesFilter(FArticyObjectFilterType InItem) const override;
 
    // IFilter implementation
    DECLARE_DERIVED_EVENT(FArticyClassRestrictionFilter, IFilter<FArticyObjectFilterType>::FChangedEvent, FChangedEvent);
    virtual FChangedEvent& OnChanged() override { return ChangedEvent; }
 
    FChangedEvent ChangedEvent;
private:
    TSubclassOf<UArticyObject> AllowedClass = UArticyObject::StaticClass();
    bool bExactClass = false;
};

class FFrontendFilter_ArticyVariable : public IFilter<FArticyVariableFilterType>
{
public:
    FFrontendFilter_ArticyVariable();
    ~FFrontendFilter_ArticyVariable();
 
    // FFrontendFilter implementation
    virtual FString GetName() const { return TEXT("ArticyVariableFilter"); }
    virtual FText GetDisplayName() const { return LOCTEXT("FrontendFilter_ArticyVariable", "Articy Variable Filter"); }
    virtual FText GetToolTipText() const { return LOCTEXT("FrontendFilter_ArticyVariableTooltip", "Show only articy variables that match the criteria"); }
 
    // IFilter implementation
    virtual bool PassesFilter(FArticyVariableFilterType InItem) const override;
 
public:
    FText GetRawFilterText() const;

    void SetRawFilterText(const FText& InFilterText);

    FText GetFilterErrorText() const;
 
private:
    TSharedRef<class FFrontendFilter_ArticyGVFilterExpressionContext> TextFilterExpressionContext;
    FTextFilterExpressionEvaluator TextFilterExpressionEvaluator;
 
    DECLARE_DERIVED_EVENT(FFrontendFilter, IFilter<FArticyVariableFilterType>::FChangedEvent, FChangedEvent);
    virtual FChangedEvent& OnChanged() override { return ChangedEvent; }
 
private:
    FChangedEvent ChangedEvent;
 
};
 
#undef LOCTEXT_NAMESPACE