USourceFilterCollection

API > API/Plugins > API/Plugins/SourceFilteringTrace

Inheritance Hierarchy

  • UDataAsset
  • USourceFilterCollection

References

   
Module SourceFilteringTrace
Header /Engine/Plugins/Developer/TraceSourceFiltering/Source/SourceFilteringTrace/Public/SourceFilterCollection.h
Include #include "SourceFilterCollection.h"

Syntax

UCLASS ()  
class USourceFilterCollection : public UDataAsset

Variables

  Type Name Description
Protected variable UProperty TMap< TObjectPtr< UDataSourceFilter >, TObjectPtr< UDataSourceFilterSet > > ChildToParent Child / Parent mapping for Filter (sets)
Protected variable UProperty Category visibleanywhere TArray< FActorClassFilter > 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< FObjectKey, FString > FilterClassMap Mapping from Filter Instance FObjectKeys to their class names
Protected variable UProperty Category visibleanywhere TArray< TObjectPtr< UDataSourceFilter > > Filters Root-level filter instances
Protected variable FSimpleMulticastDelegate SourceFiltersUpdatedDelegate  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddClassFilter ( TSubclassOf< AActor > InClass
)

 Add a class filter, used to filter AActors on a high-level
Protected function void 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 UDataSourceFilter *

AddFilterOfClass ( const TSubclassOf< UDataSourceFilter >& FilterClass
)

 Add a Filter instance of the provided class, will be added at the root level
Public function UDataSourceFilter * Add a Filter instance of the provided class, added to the provided filter set
Public function 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
Protected function void  
Public function UDataSourceFilterSet * Convert a Filter Instance to a Filter Set (with provided mode), this creates set containing the replace filter
Public function void

CopyData ( USourceFilterCollection* OtherCollection
)

 Copies Filter data from other provided Filter Collection
Protected function T *

CreateNewFilter ( UClass* Class
)

  
Protected function void  
Public function Const const TArray< FActorClassFilter > & Returns all class filters
Public function Const const TArray< UDataSourceFilter * > & Returns all top-level Filter instances
Public function void Returns flattened Filter instances
Public function UDataSourceFilterSet * Returns parent filter set, if any, for provided filter
Public function FSimpleMulticastDelegate & End UDataAsset overrides Delegate which is broadcasted any of this collection's state changes
Public function UDataSourceFilterSet * Creates an empty Filter Set (with provided mode)
Public function UDataSourceFilterSet * Create a Filter set (with provided mode) containing both Filter Instances
Public function void Move a Filter instance to a specific Filter Set (moved to root-level if Destination = nullptr)
Public function void

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

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

RecursiveCopyFilter ( UDataSourceFilter* Filter,
int32& FilterOffset
)

  
Protected function void  
Protected function void  
Public function void

RemoveClassFilter ( TSubclassOf< AActor > InClass
)

  
Public function void

RemoveFilter ( UDataSourceFilter* ToRemoveFilter
)

 Remove Filter instance, regardless of whether it is a root-level filter or part of a filter set
Public function void Remove a Filter Instance from a specific Filter Set
Protected function void Recursively removes filter and any contained child filters
Public function void Replace a Filter Instance with another
Public function void

Reset ()

 Resets all contained filter data
Public function Virtual void Begin UDataAsset overrides
Public function void 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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page