IWorldTreeItem

Base tree item interface for the World Browser

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IDropTarget

TSharedFromThis

IWorldTreeItem

References

Module

WorldBrowser

Header

/Engine/Source/Editor/WorldBrowser/Public/IWorldTreeItem.h

Include

#include "IWorldTreeItem.h"

Syntax

struct IWorldTreeItem :
    public WorldHierarchy::IDropTarget,
    public TSharedFromThis< IWorldTreeItem >

Remarks

Base tree item interface for the World Browser

Variables

Name Description

Protected variable

TArray< FWorldT...

 

Children

The children of this tree item, if any

Public variable

FlagsType

 

Flags

Protected variable

FWorldTreeItemP...

 

Parent

The parent of this tree item. Can be null.

Public variable

FOnRenameReques...

 

RenameRequestEvent

Public variable

friend

 

SWorldHierarchy

Public variable

TWeakPtr< FLeve...

 

WorldModel

Constructors

Name Description

Protected function

IWorldTreeItem()

Destructors

Name Description

Protected function Virtual

~IWorldTreeItem()

Functions

Name Description

Public function

void

 

AddChild

(
    FWorldTreeItemRef Child
)

Public function Const

void

 

AppendLevelModels

(
    FLevelModelList& OutLevelModels
)

Appends all level models for this tree item to the supplied array

Public function Virtual Const

bool

 

CanBeCurrent()

Can this ever become the current item?

Public function Const

bool

 

CanChangeParents()

Returns true if this item can have its parent changed

Public function Const

bool

 

CanHaveChildren()

Returns true if the item can have children

Public function Virtual Const

bool

 

CanSave()

Can this item be saved?

Public function Const

FWorldTreeIt...

 

CreateParent()

Create the parent item for this item, if it should have one

Public function Virtual

void

 

GenerateContextMenu

(
    UToolMenu* Menu,
    const SWorldHierarchyImpl& Hierarc...
)

Generates a context menu option for this item if and only if it's the only item selected in the hierarchy

Public function Const

TSet< FName ...

 

GetAncestorPaths()

Gets the set of all ancestor paths for this item

Public function Const

FFolderTreeI...

 

GetAsFolderTreeItem()

Public function Const

FLevelModelT...

 

GetAsLevelModelTreeItem()

Public function Const

const TArray...

 

GetChildren()

Public function Const

FString

 

GetDisplayString()

Gets the display string for this item

Public function Virtual Const

FLinearColor

 

GetDrawColor()

Gets the draw color for the item

Public function Virtual Const

const FSlate...

 

GetHierarchyItemBrush()

Public function Virtual Const

float

 

GetHierarchyItemBrushWidth()

Public function Const

FWorldTreeIt...

 

GetID()

Gets the ID for this tree item

Public function Const

FLevelModelL...

 

GetLevelModels()

Gets all level models for this tree item and its children

Public function Virtual Const

bool

 

GetLevelSelectionFlag()

Public function Const

FText

 

GetLockToolTipText()

Gets the tooltip for this item's lock icon

Public function Virtual Const

FLevelModelL...

 

GetModel()

Gets the level model for this item, excluding its children

Public function Virtual Const

FString

 

GetPackageFileName()

Gets the filename of the package for this item, if one exists

Public function Const

FWorldTreeIt...

 

GetParent()

Public function Const

FWorldTreeIt...

 

GetParentID()

Gets the ID of the parent item, even if it is not yet constructed

Public function Const

TSharedPtr< ...

 

GetRootItem()

Public function Const

FText

 

GetSaveToolTipText()

Gets the tooltip text for this item's save icon

Public function Const

int32

 

GetSortPriority()

Gets the sort priority of the item. A higher value means it will appear first in the list

Public function Const

FText

 

GetToolTipText()

Gets the tooltip for this item

Public function Const

FText

 

GetVisibilityToolTipText()

Gets the tooltip for this item's visibility icon

Public function Virtual Const

bool

 

HasColorButtonControls()

Does this item have color button controls?

Public function Virtual Const

bool

 

HasKismet()

Does this item have Kismet controls?

Public function Virtual Const

bool

 

HasLightingControls()

Does this item have lighting controls?

Public function Virtual Const

bool

 

HasLockControls()

Can the lock state on this item be toggled?

Public function Virtual Const

bool

 

HasModel

(
    TSharedPtr< FLevelModel > InLevelMo...
)

Returns true if this item has an associated level model with it

Public function Virtual Const

bool

 

HasValidPackage()

Does the item have a valid package?

Public function Virtual Const

bool

 

HasVisibilityControls()

Can visibility on this item be toggled?

Public function Virtual Const

bool

 

IsCurrent()

Is this the current item?

Public function Virtual Const

bool

 

IsDirty()

Is the item dirty?

Public function Virtual Const

bool

 

IsLightingScenario()

Public function Virtual Const

bool

 

IsLoaded()

Is the item loaded?

Public function Const

bool

 

IsLocked()

Public function Virtual Const

bool

 

IsReadOnly()

Is the item read-only?

Public function Virtual Const

bool

 

IsTransient()

Is the item transient?

Public function Const

bool

 

IsVisible()

Public function Virtual

void

 

MakeCurrent()

Make this item the current item

Public function Virtual

void

 

OnLockAllButSelected()

Public function Virtual

void

 

OnLockOnlySelected()

Public function Virtual

void

 

OnOpenKismet()

Public function Virtual

void

 

OnSave()

Public function Virtual

void

 

OnShowAllButSelected()

Public function Virtual

void

 

OnShowOnlySelected()

Public function Virtual

void

 

OnToggleLightingScenario()

Public function Virtual

void

 

OnToggleLock()

Public function Virtual

void

 

OnToggleVisibility()

Public function Virtual

void

 

PopulateLevelModelList

(
    FLevelModelList& InModelList
)

Public function

void

 

RemoveAllChildren()

Public function

void

 

RemoveChild

(
    const FWorldTreeItemRef& Child
)

Public function Virtual

void

 

SetDrawColor

(
    const FLinearColor& Color
)

Public function Virtual

void

 

SetExpansion

(
    bool bExpanded
)

Sets the item's expansion state

Public function

void

 

SetLocked

(
    bool bLocked
)

Sets the item's locked status

Public function

void

 

SetParentPath

(
    const FName& InParentPath
)

Changes the parent path of this item, without changing the name of this item

Public function

void

 

SetVisible

(
    bool bVisible
)

Sets the item's visible status

Classes

Name

Description

Public struct

FlagsType

Typedefs

Name

Description

FOnRenameRequest