1. Epic GamesDeveloper
  3. USourceFilterCollection

USourceFilterCollection

API > API/Plugins > API/Plugins/SourceFilteringTrace

   
Name USourceFilterCollection
Type class
Header File /Engine/Plugins/Developer/TraceSourceFiltering/Source/SourceFilteringTrace/Public/SourceFilterCollection.h
Include Path #include "SourceFilterCollection.h"

Syntax

UCLASS (MinimalAPI)  
class USourceFilterCollection : public UDataAsset

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~USourceFilterCollection()

   SourceFilterCollection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddClassFilter ( TSubclassOf< AActor > InClass
)

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

void AddFilter ( UDataSourceFilter* NewFilter
)

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

UDataSourceFilter * AddFilterOfClass ( const TSubclassOf< UDataSourceFilter >& FilterClass
)

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

UDataSourceFilter * AddFilterOfClassToSet ( const TSubclassOf< UDataSourceFilter >& FilterClass,
UDataSourceFilterSet* FilterSet
)

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

void AddFiltersFromPreset ( const TArray< FString >& ClassNames,
const TMap< int32, int32 >& ChildToParentIndices
)

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

UDataSourceFilterSet * ConvertFilterToSet ( UDataSourceFilter* ReplacedFilter,
EFilterSetMode Mode
)

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

void CopyData ( USourceFilterCollection* OtherCollection
)

 Copies Filter data from other provided Filter Collection SourceFilterCollection.h  

const TArray< FActorClassFilter > & GetClassFilters()

 Returns all class filters SourceFilterCollection.h  

const TArray< UDataSourceFilter * > & GetFilters()

 Returns all top-level Filter instances SourceFilterCollection.h  

void GetFlatFilters ( TArray< TObjectPtr< UDataSourceFilter > >& OutFilters
)

 Returns flattened Filter instances SourceFilterCollection.h  

UDataSourceFilterSet * GetParentForFilter ( UDataSourceFilter* Filter
)

 Returns parent filter set, if any, for provided filter SourceFilterCollection.h  

FSimpleMulticastDelegate & GetSourceFiltersUpdated()

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

UDataSourceFilterSet * MakeEmptyFilterSet ( EFilterSetMode Mode
)

 Creates an empty Filter Set (with provided mode) SourceFilterCollection.h  

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

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

void MoveFilter ( UDataSourceFilter* Filter,
UDataSourceFilterSet* Destination
)

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

void OnObjectsReplaced ( const TMap< UObject*, UObject* >& OldToNewInstanceMap
)

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

void RemoveClassFilter ( TSubclassOf< AActor > InClass
)

   SourceFilterCollection.h  

void RemoveFilter ( UDataSourceFilter* ToRemoveFilter
)

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

void RemoveFilterFromSet ( UDataSourceFilter* ToRemoveFilter,
UDataSourceFilterSet* FilterSet
)

 Remove a Filter Instance from a specific Filter Set SourceFilterCollection.h  

void ReplaceFilter ( UDataSourceFilter* Destination,
UDataSourceFilter* Source
)

 Replace a Filter Instance with another SourceFilterCollection.h  

void Reset()

 Resets all contained filter data SourceFilterCollection.h  

virtual void Serialize ( FArchive& Ar
)

 Begin UDataAsset overrides SourceFilterCollection.h  

void SetFilterSetMode ( UDataSourceFilterSet* FilterSet,
EFilterSetMode Mode
)

 Set the filtering mode for the provided filter set SourceFilterCollection.h  

void SetFilterState ( UDataSourceFilter* Filter,
bool bEnabledState
)

 Sets whether or not a filter is enabled SourceFilterCollection.h  

void UpdateClassFilter ( TSubclassOf< AActor > InClass,
bool bIncludeDerivedClasses
)

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

Protected

Name Remarks Include Path Unreal Specifiers

void AddClassName ( UDataSourceFilter* Filter
)

 Adds unique filter class name SourceFilterCollection.h  

void AddFilterToSet ( UDataSourceFilter* Filter,
UDataSourceFilterSet* FilterSet
)

   SourceFilterCollection.h  

T * CreateNewFilter ( UClass* Class
)

   SourceFilterCollection.h  

void DestroyFilter ( UDataSourceFilter* Filter
)

   SourceFilterCollection.h  

UDataSourceFilter * RecursiveCopyFilter ( UDataSourceFilter* Filter,
int32& FilterOffset
)

   SourceFilterCollection.h  

void RecursiveGenerateFilterClassNames ( UDataSourceFilter* Filter
)

   SourceFilterCollection.h  

void RecursiveRetrieveFilterClassNames ( UDataSourceFilter* Filter
)

   SourceFilterCollection.h  

void RemoveFilterRecursive ( UDataSourceFilter* ToRemoveFilter
)

 Recursively removes filter and any contained child filters SourceFilterCollection.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page