1. Epic GamesDeveloper
  3. INavigationTool

INavigationTool

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

API > API/Plugins > API/Plugins/SequenceNavigator

The Navigation Tool Object that is commonly instanced once per Sequencer (unless for advanced use where there are different Navigation Tool instances with different item ordering and behaviors). This is the object that dictates core Navigation Tool 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 INavigationTool
Type class
Header File /Engine/Plugins/Experimental/SequenceNavigator/Source/SequenceNavigator/Public/INavigationTool.h
Include Path #include "INavigationTool.h"

Syntax

class INavigationTool : public TSharedFromThis< INavigationTool >

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~INavigationTool()

   INavigationTool.h  

Typedefs

Name Type Remarks Include Path
FOnToolLoaded TMulticastDelegate_NoParams< void >   INavigationTool.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearItemSelection ( const bool bInSignalSelectionChange
) const

 Clears the Item Selection from all Navigation Tool Views INavigationTool.h  

void EnqueueItemAction ( InArgTypes&&... InArgs
)

 Instantiates a single new item action and immediately adds it to the Pending Actions Queue. INavigationTool.h  

void EnqueueItemActions ( TArray< TSharedPtr< INavigationToolItemAction > >&& InItemActions
)

 Adds the given actions to the Pending Action Queue INavigationTool.h  

FNavigationToolViewModelPtr FindItem ( const FNavigationToolItemId& InItemId
) const

 Finds the registered item that has the given Id INavigationTool.h  

TOptional< FColor > FindItemColor ( const FNavigationToolViewModelPtr& InItem,
bool bRecurseParent
) const

 Gets the color related to the Item INavigationTool.h  

FNavigationToolViewModelPtr FindOrAdd ( const TSharedRef< FNavigationToolProvider >& InProvider,
InArgTypes&&... InArgs
)

 Instantiates a new Item and automatically registers it to the Navigation Tool INavigationTool.h  

void ForEachProvider ( const TFunction< bool(const TSharedRef< FNavigationToolProvider >&InToolProvider)>& InPredicate
) const

   INavigationTool.h  

TSharedPtr< FUICommandList > GetBaseCommandList()

 Gets the Command List that the Navigation Tool Views will use to append their Command Lists to INavigationTool.h  

INavigationToolItemProxyFactory * GetItemProxyFactory()

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

TSharedPtr< INavigationToolView > GetMostRecentToolView()

 Gets the outliner view that was most recently used (i.e. called FNavigationTool::UpdateRecentToolViews) INavigationTool.h  

FOnToolLoaded & GetOnToolLoaded()

   INavigationTool.h  

TSharedPtr< FNavigationToolItemProxy > GetOrCreateItemProxy ( const FNavigationToolViewModelPtr& InParentItem,
InArgTypes&&... InArgs
)

 Tries to get the Item Proxy Factory for the given Item Proxy type, first trying the Navigation Tool 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 INavigationTool.h  

TArray< FName > GetRegisteredItemProxyTypeNames()

 Gathers the Type Names of all the Item Proxies that are registered both in the outliner proxy registry and the module's INavigationTool.h  

TArray< FNavigationToolViewModelWeakPtr > GetSelectedItems ( const bool bInNormalizeToTopLevelSelections
) const

 Returns the currently selected items in the most recent outliner view (since this list can vary between outliner views) INavigationTool.h  

TSharedPtr< ISequencer > GetSequencer()

   INavigationTool.h  

TSharedPtr< INavigationToolView > GetToolView ( const int32 InToolViewId
) const

 Gets the Navigation Tool View bound to the given id INavigationTool.h  

FNavigationToolViewModelWeakPtr GetTreeRoot()

 Gets the tree root item of the Navigation Tool INavigationTool.h  

bool IsObjectAllowedInTool ( const UObject*const InObject
) const

 Determines whether the given actor can be presented in the Navigation Tool, at all. INavigationTool.h  

bool IsToolTabVisible()

   INavigationTool.h  

TSharedRef< InItemActionType > NewItemAction ( InArgTypes&&... InArgs
)

 Instantiates a new item action without adding it to the Pending Actions Queue. INavigationTool.h  

void NotifyToolItemDeleted ( const FNavigationToolViewModelPtr& InItem
)

 Called when an Item has been deleted INavigationTool.h  

void NotifyToolItemRenamed ( const FNavigationToolViewModelPtr& InItem
)

 Called when an Item has been Renamed INavigationTool.h  

void OnSequencerSelectionChanged()

 Called when the Sequencer selection has changed INavigationTool.h  

void Refresh ()

 Flushes the Pending Actions from the Queue while also updating the state of the Navigation Tool. INavigationTool.h  

void RegisterItem ( const FNavigationToolViewModelPtr& InItem
)

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

TSharedPtr< INavigationToolView > RegisterToolView ( const int32 InToolViewId
)

 Register a new Navigation Tool View to the Navigation Tool to the given id, replacing the old view that was bound to the given id INavigationTool.h  

void RemoveItemColor ( const FNavigationToolViewModelPtr& InItem
)

 Removes the Color pairing of the given Item (can still have an inherited color though) INavigationTool.h  

void RequestRefresh()

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

void SelectItems ( const TArray< FNavigationToolViewModelWeakPtr >& InWeakItems,
const ENavigationToolItemSelectionFlags InFlags
) const

 Selects the given Items on all Navigation Tool Views INavigationTool.h  

void SetIgnoreNotify ( const ENavigationToolIgnoreNotifyFlags InFlag,
const bool bInIgnore
)

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

void SetItemColor ( const FNavigationToolViewModelPtr& InItem,
const FColor& InColor
)

 Pairs the Item with the given color name, overriding the inherited color if different INavigationTool.h  

void ShowHideToolTab ( const bool bInVisible
)

   INavigationTool.h  

void ToggleToolTabVisible()

   INavigationTool.h  

TArray< FNavigationToolViewModelPtr > TryFindItems ( const Sequencer::FViewModelPtr& InSequencerOutlinerViewModel
) const

 Attempts to find all items associated with a Sequencer outliner view model INavigationTool.h  

void UnregisterItem ( const FNavigationToolItemId& InItemId
)

 Unregisters the Item having the given ItemId INavigationTool.h  

Protected

Name Remarks Include Path Unreal Specifiers

const FNavigationToolItemProxyRegistry & GetItemProxyRegistry()

   INavigationTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page