1. Epic GamesDeveloper
  3. IAvaOutliner

IAvaOutliner

The Outliner Object that is commonly instanced once per World (unless for advanced use where there are different outliner instances with different item ordering and behaviors).

API > API/Plugins > API/Plugins/AvalancheOutliner

The Outliner Object that is commonly instanced once per World (unless for advanced use where there are different outliner instances with different item ordering and behaviors). This is the object that dictates core outliner behavior like how items are sorted, which items are allowed, etc. Views are the objects that take this core behavior and show a part of it (e.g. through filters).

   
Name IAvaOutliner
Type class
Header File /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheOutliner/Public/IAvaOutliner.h
Include Path #include "IAvaOutliner.h"

Syntax

class IAvaOutliner : public TSharedFromThis< IAvaOutliner >

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IAvaOutliner()

   IAvaOutliner.h  

Typedefs

Name Type Remarks Include Path
FOnOutlinerLoaded TMulticastDelegate_NoParams< void >   IAvaOutliner.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

FAvaOutlinerItemPtr FindItem ( const FAvaOutlinerItemId& InItemId
) const

 Finds the Registered Item that has the given Id IAvaOutliner.h  

TSharedRef< InItemType > FindOrAdd ( InArgTypes&&... InArgs
)

 Instantiates a new Item and automatically registers it to the Outliner IAvaOutliner.h  

IAvaOutlinerItemProxyFactory * GetItemProxyFactory()

 Tries to find the Item Proxy Factory for the given Item Proxy Type Name IAvaOutliner.h  

FOnOutlinerLoaded & GetOnOutlinerLoaded()

   IAvaOutliner.h  

TSharedPtr< FAvaOutlinerItemProxy > GetOrCreateItemProxy ( const FAvaOutlinerItemPtr& InParentItem
)

 Tries to get the Item Proxy Factory for the given Item Proxy type, first trying the Outliner Registry then the Module's then returns an existing item proxy created via the factory, or creates one if there's no existing item proxy IAvaOutliner.h  

TSharedPtr< IAvaOutlinerView > GetOutlinerView ( int32 InOutlinerViewId
) const

 Gets the Outliner View bound to the given id IAvaOutliner.h  

IAvaOutlinerProvider & GetProvider()

   IAvaOutliner.h  

TSharedRef< FAvaOutlinerItem > GetTreeRoot()

 Gets the Tree Root Item of the Outliner IAvaOutliner.h  

UWorld * GetWorld()

 Gets the World the Outliner is working with IAvaOutliner.h  

void GroupSelection ( AActor* InGroupingActor,
const TOptional< FAttachmentTransformRules >& InTransformRules
)

 Gets all the Selected Items and puts/attaches them under the given Grouping Actor. IAvaOutliner.h  

bool IsDefaultWorldActorToHide ( const UWorld*const InWorld,
const AActor*const InActor
) const

 Returns true if the given actor is a default actor of the given world that will be hidden from the outliner. IAvaOutliner.h  

void OnActorsCopied ( FString& InOutCopiedData,
TConstArrayView< AActor* > InCopiedActors
)

 Should be called when Actors have been copied and give Ava Outliner opportunity to add to the Buffer to copy the Outliner data for those Actors IAvaOutliner.h  

void OnActorsDuplicated ( const TMap< AActor*, AActor* >& InDuplicateActorMap,
FAvaOutlinerItemPtr InRelativeItem,
TOptional< EItemDropZone > InRelativeDropZone
)

 Handles when Actors have been Duplicated IAvaOutliner.h  

void OnActorsPasted ( FStringView InPastedData,
const TMap< FName, AActor* >& InPastedActors
)

 Should be called when Actors have been pasted to parse the data that was filled in by IAvaOutliner::OnActorsCopied IAvaOutliner.h  

void OnObjectSelectionChanged ( const FAvaEditorSelection& InEditorSelection
)

 Called when the objects have been selected and notified through USelection Instances in Mode Tools IAvaOutliner.h  

void Refresh ()

 Flushes the Pending Actions from the Queue while also updating the state of the Outliner. IAvaOutliner.h  

void RegisterItem ( const FAvaOutlinerItemPtr& InItem
)

 Registers the given Item, replacing the old one. IAvaOutliner.h  

TSharedPtr< IAvaOutlinerView > RegisterOutlinerView ( int32 InOutlinerViewId
)

 Register a new Outliner View to the Outliner to the given id, replacing the old view that was bound to the given id IAvaOutliner.h  

void RequestRefresh()

 Ensures that the next time Refresh is called in tick, Refresh will be called IAvaOutliner.h  

void Serialize ( FArchive& Ar
)

 Serializes the Outliner Save State to the given archive IAvaOutliner.h  

void SetBaseCommandList ( const TSharedPtr< FUICommandList >& InBaseCommandList
)

 Sets the Command List that the Outliner Views will use to append their Command Lists to IAvaOutliner.h  

void SetIgnoreNotify ( EAvaOutlinerIgnoreNotifyFlags InFlag,
bool bIgnore
)

 Adds or Removes the Ignore Notify Flags to prevent certain actions from automatically happening when they're triggered IAvaOutliner.h  

void UnregisterItem ( const FAvaOutlinerItemId& InItemId
)

 Unregisters the Item having the given ItemId IAvaOutliner.h  

Protected

Name Remarks Include Path Unreal Specifiers

const FAvaOutlinerItemProxyRegistry & GetItemProxyRegistry()

   IAvaOutliner.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page