1. Epic GamesDeveloper
  3. ISceneOutlinerTreeItem

ISceneOutlinerTreeItem

Base tree item interface

API > API/Editor > API/Editor/SceneOutliner

Inheritance Hierarchy

References

   
Module SceneOutliner
Header /Engine/Source/Editor/SceneOutliner/Public/ISceneOutlinerTreeItem.h
Include #include "ISceneOutlinerTreeItem.h"

Syntax

struct ISceneOutlinerTreeItem : public TSharedFromThis< ISceneOutlinerTreeItem >

Remarks

Base tree item interface

Variables

  Type Name Description
Protected variable TSet< TWeakPtr< ISceneOutlinerTreeItem > > Children Array of children contained underneath this item
Public variable FlagsType Flags Flags for this item
Protected variable TWeakPtr< ISceneOutlinerTreeItem > Parent This item's parent, if any.
Public variable FOnRenameRequest RenameRequestEvent Broadcasts whenever a rename is requested
Public variable friend SSceneOutliner Friendship required for access to various internals
Protected variable FSceneOutlinerTreeItemType TreeType Tree item type identifier
Public variable TWeakPtr< ISceneOutliner > WeakSceneOutliner Weak Outliner pointer

Constructors

  Type Name Description
Protected function   Default constructor

Destructors

  Type Name Description
Protected function Virtual    

Functions

  Type Name Description
Public function void

AddChild ( FSceneOutlinerTreeItemRef Child
)

 Add a child to this item
Public function Const bool Check whether it should be possible to interact with this tree item
Public function T *

CastTo ()

 Attempt to cast this item to another type if it is of that type. Returns nullptr if it fails
Public function Const const T *

CastTo ()

 Attempt to cast this item to another type if it is of that type. Returns nullptr if it fails
Public function Const bool  
Public function Virtual void Generate a context menu for this item. Only called if only this item is selected.
Public function Virtual TSharedRef< SWidget >

GenerateLabelWidget ( ISceneOutliner& Outliner,
const STableRow< FSceneOutlinerTreeItemPtr >& InRow
)

 Generate the label widget for this item
Public function Const const TSet< TWeakPtr< ISceneOutlinerTreeItem > > & Get this item's children, if any.
Public function Const FString Get the raw string to display for this tree item - used for sorting
Public function Const FSceneOutlinerTreeItemID

GetID ()

 Get the ID that represents this tree item. Used to reference this item in a map
Public function Const bool  
Public function Const FSceneOutlinerTreeItemPtr Get this item's parent. Can be nullptr.
Public function Virtual Const bool Query the pinned staet of this item. Only called if the item has its own pinned state info
Public function Virtual Const FFolder::FRootObject Get the optional context object root of a tree item.
Public function Virtual Const bool Query this items visibility state. Only called if the item type has visibility info
Public function Virtual Const bool Returns true if this item can set its own pinned state
Public function Virtual Const bool Returns true if this item can set its own visibility
Public function Const bool

IsA ()

 Returns true if this item is of the specified type
Public function Const bool

IsValid ()

 Returns true if the data the item references is valid
Public function Virtual void Called when this item is expanded or collapsed
Public function Virtual void Called when this item's label has changed
Public function Virtual void

OnVisibilityChanged ( const bool bNewVisibility
)

 Called when this items visibility changed
Public function void

RemoveChild ( const FSceneOutlinerTreeItemRef& Child
)

 Remove a child from this item
Public function Virtual Const bool Returns true if this item should show pinned state
Public function Virtual Const bool Returns true if this item should show its visibility state

Classes

  Type Name Description
Public struct FlagsType Flags structure  

Typedefs

Name Description
FFilterPredicate  
FInteractivePredicate  
FOnRenameRequest Delegate for hooking up an inline editable text block to be notified that a rename is requested.

Constants

Name Description
Type Static type identifier for the base class tree item

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page