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

Inheritance Hierarchy

  • TSharedFromThis< IAvaOutliner >
  • IAvaOutliner

References

   
Module AvalancheOutliner
Header /Engine/Plugins/Experimental/Avalanche/Source/AvalancheOutliner/Public/IAvaOutliner.h
Include #include "IAvaOutliner.h"

Syntax

class IAvaOutliner : public TSharedFromThis< IAvaOutliner >

Remarks

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).

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const FAvaOutlinerItemPtr

FindItem ( const FAvaOutlinerItemId& InItemId
)

 Finds the Registered Item that has the given Id
Public function TSharedRef< InItemType >

FindOrAdd ( InArgTypes&&... InArgs
)

 Instantiates a new Item and automatically registers it to the Outliner
Public function Const IAvaOutlinerItemProxyFactory * Tries to find the Item Proxy Factory for the given Item Proxy Type Name
Protected function Const const FAvaOutlinerItemProxyRegistry &  
Public function FOnOutlinerLoaded &  
Public function 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
Public function Const TSharedPtr< IAvaOutlinerView >

GetOutlinerView ( int32 InOutlinerViewId
)

 Gets the Outliner View bound to the given id
Public function Const IAvaOutlinerProvider &  
Public function Const TSharedRef< FAvaOutlinerItem > Gets the Tree Root Item of the Outliner
Public function Const UWorld * Gets the World the Outliner is working with
Public function void

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

 Gets all the Selected Items and puts/attaches them under the given Grouping Actor.
Public function 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
Public function void

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

 Handles when Actors have been Duplicated
Public function 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
Public function void

OnObjectSelectionChanged ( const FAvaEditorSelection& InEditorSelection
)

 Called when the objects have been selected and notified through USelection Instances in Mode Tools
Public function void

Refresh ()

 Flushes the Pending Actions from the Queue while also updating the state of the Outliner.
Public function void

RegisterItem ( const FAvaOutlinerItemPtr& InItem
)

 Registers the given Item, replacing the old one.
Public function 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
Public function void Ensures that the next time Refresh is called in tick, Refresh will be called
Public function void

Serialize ( FArchive& Ar
)

 Serializes the Outliner Save State to the given archive
Public function void

SetBaseCommandList ( const TSharedPtr< FUICommandList >& InBaseCommandList
)

 Sets the Command List that the Outliner Views will use to append their Command Lists to
Public function void Adds or Removes the Ignore Notify Flags to prevent certain actions from automatically happening when they're triggered
Public function void

UnregisterItem ( const FAvaOutlinerItemId& InItemId
)

 Unregisters the Item having the given ItemId

Typedefs

Name Description
FOnOutlinerLoaded  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page