USourceFilterCollection

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

SourceFilteringTrace

Header

/Engine/Plugins/Developer/TraceSourceFiltering/Source/SourceFilteringTrace/Public/SourceFilterCollection.h

Include

#include "SourceFilterCollection.h"

Syntax

UCLASS()
class USourceFilterCollection : public UDataAsset

Variables

Name Description

Protected variable UProperty

TMap< UDataSour...

 

ChildToParent

Child / Parent mapping for Filter (sets)

Protected variable UProperty Category visibleanywhere

TArray< FActorC...

 

ClassFilters

Class filters, used for high-level filtering of AActor instances inside of a UWorld

Protected variable UProperty

TArray< FString...

 

FilterClasses

Flat version of the Filter classes contained by this collection, stored according to Filters ordering, with child filters inline

Protected variable

TMap< FObjectKe...

 

FilterClassMap

Mapping from Filter Instance FObjectKeys to their class names

Protected variable UProperty Category visibleanywhere

TArray< UDataSo...

 

Filters

Root-level filter instances

Protected variable

FSimpleMulticas...

 

SourceFiltersUpdatedDelegate

Destructors

Name Description

Public function Virtual

~USourceFilterCollection()

Functions

Name Description

Public function

void

 

AddClassFilter

(
    TSubclassOf< AActor > InClass
)

Add a class filter, used to filter AActors on a high-level

Protected function

void

 

AddClassName

(
    UDataSourceFilter* Filter
)

Adds unique filter class name

Public function

void

 

AddFilter

(
    UDataSourceFilter* NewFilter
)

Add Filter instance to the collection, will be added at the root level

Public function

UDataSourceF...

 

AddFilterOfClass

(
    const TSubclassOf< UDataSourceFilte...
)

Add a Filter instance of the provided class, will be added at the root level

Public function

UDataSourceF...

 

AddFilterOfClassToSet

(
    const TSubclassOf< UDataSourceFilte...,
    UDataSourceFilterSet* FilterSe...
)

Add a Filter instance of the provided class, added to the provided filter set

Public function

void

 

AddFiltersFromPreset

(
    const TArray< FString >& ClassName...,
    const TMap< int32, int32 >& ChildT...
)

Creates a new collection of filter (sets), provided the filter class names and parent/child relationship

Protected function

void

 

AddFilterToSet

(
    UDataSourceFilter* Filter,
    UDataSourceFilterSet* FilterSe...
)

Public function

UDataSourceF...

 

ConvertFilterToSet

(
    UDataSourceFilter* ReplacedFil...,
    EFilterSetMode Mode
)

Convert a Filter Instance to a Filter Set (with provided mode), this creates set containing the replace filter

Public function

void

 

CopyData

(
    USourceFilterCollection* Other...
)

Copies Filter data from other provided Filter Collection

Protected function

T *

 

CreateNewFilter

(
    UClass* Class
)

Protected function

void

 

DestroyFilter

(
    UDataSourceFilter* Filter
)

Public function Const

const TArray...

 

GetClassFilters()

Returns all class filters

Public function Const

const TArray...

 

GetFilters()

Returns all top-level Filter instances

Public function

void

 

GetFlatFilters

(
    TArray< UDataSourceFilter* >&...
)

Returns flattened Filter instances

Public function

UDataSourceF...

 

GetParentForFilter

(
    UDataSourceFilter* Filter
)

Returns parent filter set, if any, for provided filter

Public function

FSimpleMulti...

 

GetSourceFiltersUpdated()

End UDataAsset overrides Delegate which is broadcasted any of this collection's state changes

Public function

UDataSourceF...

 

MakeEmptyFilterSet

(
    EFilterSetMode Mode
)

Creates an empty Filter Set (with provided mode)

Public function

UDataSourceF...

 

MakeFilterSet

(
    UDataSourceFilter* FilterOne,
    UDataSourceFilter* FilterTwo,
    EFilterSetMode Mode
)

Create a Filter set (with provided mode) containing both Filter Instances

Public function

void

 

MoveFilter

(
    UDataSourceFilter* Filter,
    UDataSourceFilterSet* Destinat...
)

Move a Filter instance to a specific Filter Set (moved to root-level if Destination = nullptr)

Public function

void

 

OnObjectsReplaced

(
    const TMap< UObject*, UObject ...
)

Callback for patching up contained UDataSourceFilter blueprint instances which just got re-instanced

Protected function

UDataSourceF...

 

RecursiveCopyFilter

(
    UDataSourceFilter* Filter,
    int32& FilterOffset
)

Protected function

void

 

RecursiveGenerateFilterClassNames

(
    UDataSourceFilter* Filter
)

Protected function

void

 

RecursiveRetrieveFilterClassNames

(
    UDataSourceFilter* Filter
)

Public function

void

 

RemoveClassFilter

(
    TSubclassOf< AActor > InClass
)

Public function

void

 

RemoveFilter

(
    UDataSourceFilter* ToRemoveFil...
)

Remove Filter instance, regardless of whether it is a root-level filter or part of a filter set

Public function

void

 

RemoveFilterFromSet

(
    UDataSourceFilter* ToRemoveFil...,
    UDataSourceFilterSet* FilterSe...
)

Remove a Filter Instance from a specific Filter Set

Protected function

void

 

RemoveFilterRecursive

(
    UDataSourceFilter* ToRemoveFil...
)

Recursively removes filter and any contained child filters

Public function

void

 

ReplaceFilter

(
    UDataSourceFilter* Destination,
    UDataSourceFilter* Source
)

Replace a Filter Instance with another

Public function

void

 

Reset()

Resets all contained filter data

Public function

void

 

SetFilterSetMode

(
    UDataSourceFilterSet* FilterSe...,
    EFilterSetMode Mode
)

Set the filtering mode for the provided filter set

Public function

void

 

SetFilterState

(
    UDataSourceFilter* Filter,
    bool bEnabledState
)

Sets whether or not a filter is enabled

Public function

void

 

UpdateClassFilter

(
    TSubclassOf< AActor > InClass,
    bool bIncludeDerivedClasses
)

Updating whether or not classes derived from the filter class should be included when applying filtering

Overridden from UObject

Name Description

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Begin UDataAsset overrides