SOutlinerView

The tree view used in the sequencer

API > API/Editor > API/Editor/SequencerCore > API/Editor/SequencerCore/MVVM > API/Editor/SequencerCore/MVVM/Views

Inheritance Hierarchy

References

   
Module SequencerCore
Header /Engine/Source/Editor/SequencerCore/Public/MVVM/Views/SOutlinerView.h
Include #include "MVVM/Views/SOutlinerView.h"

Syntax

class SOutlinerView : public STreeView< TWeakViewModelPtr< IOutlinerExtension > >

Remarks

The tree view used in the sequencer

Variables

  Type Name Description
Protected variable TArray< FCachedGeometry > PhysicalNodes Linear, sorted array of nodes that we currently have generated widgets for

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Add a SOutlinerView object that should be modified or updated when this Treeview is updated
Public function void

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

 Construct this widget
Protected function void  
Protected function void

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

 Set the item's expansion state, including all of its children
Protected function TSharedPtr< STrackLane >  
Public function void  
Protected function Const TSharedRef< SWidget >

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

 Generate a widget for the specified Node and Column
Public function Const const TArray< FCachedGeometry > & Access all the physical nodes currently visible on the sequencer
Public function Const int32  
Public function Const TSharedPtr< FOutlinerViewModel >  
Public function Const float  
Public function Const void  
Public function Const TViewModelPtr< IOutlinerExtension >

HitTestNode ( float InPhysical
)

 Get the tree item model at the specified physical vertical position
Protected function FReply

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

  
Protected function void

OnExpansionChanged ( TWeakViewModelPtr< IOutlinerExtension > InItem,
bool bIsExpanded
)

 Called when a node has been expanded or collapsed
Protected function TSharedRef< ITableRow >

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

 Generate a row for a particular node
Protected function Const void Gather the children from the specified node
Protected function FString  
Public function Const float

PhysicalToVirtual ( float InPhysical
)

 Convert the specified physical vertical position into an absolute virtual position, ignoring expanded states
Protected function Virtual void  
Protected function Virtual void

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

 Tree selection methods which must be overriden to maintain selection consistency with the rest of sequencer.
Public function void

Refresh ()

 Refresh this tree as a result of the underlying tree data changing
Public function void

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

  
Public function void

ScrollByDelta ( float DeltaInSlateUnits
)

 Scroll this tree view by the specified number of slate units
Public function void

SetPrimaryTreeView ( TSharedPtr< SOutlinerView > InPrimaryTreeView
)

 Set a SOutlinerView object this Treeview is pinned to, for operations that should happen on the primary
Public function void

SetShowPinned ( bool bShowPinned
)

 Set whether this TreeView should show only pinned nodes or only non-pinned nodes
Protected function void

SetupColumns ( const FArguments& InArgs
)

 Populate the map of column definitions, and add relevant columns to the header row
Public function void

ToggleExpandCollapseNodes ( ETreeRecursion Recursion,
bool bExpandAll,
bool bCollapseAll
)

 Expand or collapse nodes
Public function void Ensure that the track area column is either show or hidden, depending on the visibility of the curve editor
Public function Const float

VirtualToPhysical ( float InVirtual
)

 Convert the specified absolute virtual position into a physical position in the tree.

Overridden from STableViewBase

  Type Name Description
Protected function Virtual void

OnRightMouseButtonDown ( const FPointerEvent& MouseEvent
)

 Right click down
Protected function Virtual void

OnRightMouseButtonUp ( const FPointerEvent& MouseEvent
)

 Opens a context menu as the result of a right click if OnContextMenuOpening is bound and we are not right click scrolling.

Overridden from SWidget

  Type Name Description
Protected function Virtual FReply

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

 Called during drag and drop when the the mouse is being dragged over a widget.
Protected function Virtual FReply

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

 Called when the user is dropping something onto a widget; terminates drag and drop.
Public function Virtual FReply

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

 Called after a key is pressed when this widget has focus (this event bubbles if not handled)
Public function Virtual Const int32

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

 The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
Public function Virtual void

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

 See SWidget::Tick()

Overridden from ITypedTableView

  Type Name Description
Protected function Virtual void Empty the selection set.
Protected function Virtual void Notify the ItemsWidget that we changed its selection.

Classes

  Type Name Description
Public struct FArguments    
Public struct FCachedGeometry Structure used to cache physical geometry for a particular node  

Constants

Name Description
TrackNameColumn  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page