1. Epic GamesDeveloper
  3. SOutlinerView

SOutlinerView

The tree view used in the sequencer

API > API/Editor > API/Editor/SequencerCore

The tree view used in the sequencer

   
Name SOutlinerView
Type class
Header File /Engine/Source/Editor/SequencerCore/Public/MVVM/Views/SOutlinerView.h
Include Path #include "MVVM/Views/SOutlinerView.h"

Syntax

class SOutlinerView : public STreeView< TWeakViewModelPtr< IOutlinerExtension > >

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

SOutlinerView()

   MVVM/Views/SOutlinerView.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~SOutlinerView()

   MVVM/Views/SOutlinerView.h  

Structs

Name Remarks
FArguments  
FCachedGeometry Structure used to cache physical geometry for a particular node

Typedefs

Name Type Remarks Include Path
FColumnGenerator TFunction< TSharedPtr< SWidget >(const FCreateOutlinerColumnParams &Params, const TSharedRef< SOutlinerViewRow > &)>   MVVM/Views/SOutlinerView.h

Constants

Name Type Remarks Include Path
TrackNameColumn const FName   MVVM/Views/SOutlinerView.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddPinnedTreeView ( TSharedPtr< SOutlinerView > PinnedTreeView
)

 Add a SOutlinerView object that should be modified or updated when this Treeview is updated MVVM/Views/SOutlinerView.h  

void Construct ( const FArguments& InArgs,
TWeakPtr< FOutlinerViewModel > InWeakOutliner,
const TSharedRef< STrackAreaView >& InTrackArea
)

 Construct this widget MVVM/Views/SOutlinerView.h  

void ExpandCollapseNode ( TViewModelPtr< IOutlinerExtension > InDataModel,
bool bExpansionState,
ETreeRecursion Recursion
)

 Set the item's expansion state, including all of its children MVVM/Views/SOutlinerView.h  

void ForceSetSelectedItems ( const TSet< TWeakViewModelPtr< IOutlinerExtension > >& InItems
)

   MVVM/Views/SOutlinerView.h  

const TArray< FCachedGeometry > & GetAllVisibleNodes()

 Access all the physical nodes currently visible on the sequencer MVVM/Views/SOutlinerView.h  

int32 GetNumRootNodes()

   MVVM/Views/SOutlinerView.h  

TSharedPtr< FOutlinerViewModel > GetOutlinerModel()

   MVVM/Views/SOutlinerView.h  

float GetVirtualTop()

   MVVM/Views/SOutlinerView.h  

void GetVisibleItems ( TArray< TViewModelPtr< IOutlinerExtension > >& OutItems
) const

   MVVM/Views/SOutlinerView.h  

TViewModelPtr< IOutlinerExtension > HitTestNode ( float InPhysical
) const

 Get the tree item model at the specified physical vertical position MVVM/Views/SOutlinerView.h  

bool IsColumnVisible ( const FName& InName
) const

   MVVM/Views/SOutlinerView.h  

float PhysicalToVirtual ( float InPhysical
) const

 Convert the specified physical vertical position into an absolute virtual position, ignoring expanded states MVVM/Views/SOutlinerView.h  

void Refresh()

 Refresh this tree as a result of the underlying tree data changing MVVM/Views/SOutlinerView.h  

void ReportChildRowGeometry ( const TViewModelPtr< IOutlinerExtension >& InNode,
const FGeometry& InGeometry
)

   MVVM/Views/SOutlinerView.h  

void ScrollByDelta ( float DeltaInSlateUnits
)

 Scroll this tree view by the specified number of slate units MVVM/Views/SOutlinerView.h  

void SetOutlinerColumns ( const TArray< TSharedPtr< IOutlinerColumn > >& InOutlinerColumns
)

 Updates the list of visible outliner columns and regenerates columns in the outliner view MVVM/Views/SOutlinerView.h  

void SetPrimaryTreeView ( TSharedPtr< SOutlinerView > InPrimaryTreeView
)

 Set a SOutlinerView object this Treeview is pinned to, for operations that should happen on the primary MVVM/Views/SOutlinerView.h  

void SetShowPinned ( bool bShowPinned
)

 Set whether this TreeView should show only pinned nodes or only non-pinned nodes MVVM/Views/SOutlinerView.h  

void ToggleExpandCollapseNodes ( ETreeRecursion Recursion,
bool bExpandAll,
bool bCollapseAll
)

 Expand or collapse nodes MVVM/Views/SOutlinerView.h  

float VirtualToPhysical ( float InVirtual
) const

 Convert the specified absolute virtual position into a physical position in the tree. MVVM/Views/SOutlinerView.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   MVVM/Views/SOutlinerView.h  

virtual int32 OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
) const

   MVVM/Views/SOutlinerView.h  

virtual void Tick ( const FGeometry& AllottedGeometry,
const double InCurrentTime,
const float InDeltaTime
)

   MVVM/Views/SOutlinerView.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ClearSelection()

 Private, unimplemented overloaded name for SetItemSelection to prevent external calls - use ForceSetItemSelection instead. MVVM/Views/SOutlinerView.h  

int32 CreateOutlinerColumnsForGroup ( int32 ColumnIndex,
EOutlinerColumnGroup Group
)

   MVVM/Views/SOutlinerView.h  

void CreateTrackLanesForRow ( TSharedRef< SOutlinerViewRow > InRow,
TViewModelPtr< IOutlinerExtension > InDataModel
)

   MVVM/Views/SOutlinerView.h  

TSharedPtr< STrackLane > FindOrCreateParentLane ( TViewModelPtr< IOutlinerExtension > InDataModel
)

   MVVM/Views/SOutlinerView.h  

TSharedRef< SWidget > GenerateWidgetForColumn ( TViewModelPtr< IOutlinerExtension > InDataModel,
const FName& ColumnId,
const TSharedRef< SOutlinerViewRow >& Row
) const

 Generate a widget for the specified Node and Column MVVM/Views/SOutlinerView.h  

void HandleTableViewScrolled ( double InScrollOffset
)

   MVVM/Views/SOutlinerView.h  

void InsertSeparatorColumn ( int32 InsertIndex,
int32 SeparatorID
)

 Insert a separator column at the specified column index, with a unique identifier MVVM/Views/SOutlinerView.h  

TSharedPtr< SWidget > OnContextMenuOpening()

 Handles the context menu opening when right clicking on the tree view. MVVM/Views/SOutlinerView.h  

FReply OnDragRow ( const FGeometry& InGeometry,
const FPointerEvent& InPointerEvent,
TSharedRef< SOutlinerViewRow > InRow
)

   MVVM/Views/SOutlinerView.h  

void OnExpansionChanged ( TWeakViewModelPtr< IOutlinerExtension > InItem,
bool bIsExpanded
)

 Called when a node has been expanded or collapsed MVVM/Views/SOutlinerView.h  

virtual TSharedRef< ITableRow > OnGenerateRow ( TWeakViewModelPtr< IOutlinerExtension > InDisplayNode,
const TSharedRef< STableViewBase >& OwnerTable
)

 Generate a row for a particular node MVVM/Views/SOutlinerView.h  

void OnGetChildren ( TWeakViewModelPtr< IOutlinerExtension > InParent,
TArray< TWeakViewModelPtr< IOutlinerExtension > >& OutChildren
) const

 Gather the children from the specified node MVVM/Views/SOutlinerView.h  

FString OnItemToString_Debug ( TWeakViewModelPtr< IOutlinerExtension > InWeakModel
)

   MVVM/Views/SOutlinerView.h  

virtual void Private_SelectRangeFromCurrentTo ( TWeakViewModelPtr< IOutlinerExtension > InRangeSelectionEnd
)

   MVVM/Views/SOutlinerView.h  

virtual void Private_SetItemSelection ( TWeakViewModelPtr< IOutlinerExtension > TheItem,
bool bShouldBeSelected,
bool bWasUserDirected
)

   MVVM/Views/SOutlinerView.h  

virtual void Private_UpdateParentHighlights()

 Tree selection methods which must be overriden to maintain selection consistency with the rest of sequencer. MVVM/Views/SOutlinerView.h  

void SetItemExpansionRecursive ( TWeakViewModelPtr< IOutlinerExtension > InItem,
bool bIsExpanded
)

   MVVM/Views/SOutlinerView.h  

void SetItemSelection()

 Private, unimplemented overloaded name for SetItemSelection to prevent external calls - use ForceSetItemSelection instead. MVVM/Views/SOutlinerView.h  

void UpdateModelSelectionFromView()

   MVVM/Views/SOutlinerView.h  
Populate the map of column definitions, and add relevant columns to the header row. MVVM/Views/SOutlinerView.h  

void UpdatePhysicalGeometry ( bool bIsRefresh
)

   MVVM/Views/SOutlinerView.h  

void UpdateViewSelectionFromModel()

   MVVM/Views/SOutlinerView.h  

Overridden from STableViewBase

Name Remarks Include Path Unreal Specifiers

virtual void OnRightMouseButtonDown ( const FPointerEvent& MouseEvent
)

   MVVM/Views/SOutlinerView.h  

virtual void OnRightMouseButtonUp ( const FPointerEvent& MouseEvent
)

   MVVM/Views/SOutlinerView.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FReply OnDragOver ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   MVVM/Views/SOutlinerView.h  

virtual FReply OnDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   MVVM/Views/SOutlinerView.h  

Overridden from ITypedTableView

Name Remarks Include Path Unreal Specifiers

virtual void Private_ClearSelection()

   MVVM/Views/SOutlinerView.h  

virtual void Private_SignalSelectionChanged ( ESelectInfo::Type SelectInfo
)

   MVVM/Views/SOutlinerView.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page