FOutlinerFilter

A filter that can be applied to any type in the tree

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

SceneOutliner

Header

/Engine/Source/Editor/SceneOutliner/Public/SceneOutlinerFilters.h

Include

#include "SceneOutlinerFilters.h"

Syntax

class FOutlinerFilter :
    public SceneOutliner::ITreeItemVisitor,
    public IFilter< const ITreeItem & >

Remarks

A filter that can be applied to any type in the tree

Variables

Name Description

Protected variable

FChangedEvent

 

ChangedEvent

The event that broadcasts whenever a change occurs to the filter

Protected variable

const EDefaultF...

 

DefaultBehaviour

Default result of the filter when not overridden in derived classes

Public variable

EFailedFilterSt...

 

FailedItemState

Enum that defines how a tree item should be dealt with in the case where it appears in the tree, but doesn't match the filter (eg if it has a matching child)

Constructors

Name Description

Protected function

FOutlinerFilter

(
    EDefaultFilterBehaviour InDefaultBe...,
    EFailedFilterState InFailedFilterSt...
)

Constructor to specify the default result of a filter

Functions

Name Description

Protected function Virtual Const

bool

 

PassesFilter

(
    const AActor* Actor
)

Overridden in derived types to filter actors

Protected function Virtual Const

bool

 

PassesFilter

(
    const UActorComponent* ActorCo...
)

Overridden in derived types to filter actor components

Protected function Virtual Const

bool

 

PassesFilter

(
    const UWorld* World
)

Overridden in derived types to filter worlds

Protected function Virtual Const

bool

 

PassesFilter

(
    FName Folder
)

Overridden in derived types to filter folders

Overridden from IFilter

Name Description

Public function Virtual

FChangedEven...

 

OnChanged()

Event that is fired if this filter changes
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss