FNavigationToolItemProxy | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/SequenceNavigator

Item Proxies are Navigation Tool Items that with the sole purpose to group and hold common items together. The description or name of such commonality between these items should be the name of the Proxy that holds them.

NOTE: Although Item proxies by default require a parent to be visible in Navigation Tool, they can be created without a parent as a means to override behavior (e.g. DisplayName, Icon, etc)


Name	FNavigationToolItemProxy
Type	class
Header File	/Engine/Plugins/Experimental/SequenceNavigator/Source/SequenceNavigator/Public/Items/NavigationToolItemProxy.h
Include Path	#include "Items/NavigationToolItemProxy.h"

Syntax

class FNavigationToolItemProxy : public UE::SequenceNavigator::FNavigationToolItem

Inheritance Hierarchy

Sequencer::TOutlinerModelMixin< Sequencer::FViewModel > → FNavigationToolItem → FNavigationToolItemProxy

Derived Classes

FNavigationToolComponentProxy

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FNavigationToolItemProxy ( INavigationTool& InTool, const FNavigationToolViewModelPtr& InParentItem )		Items/NavigationToolItemProxy.h

Typedefs

Name	Type	Remarks	Include Path
Implements	::UE::Sequencer::TImplements< FNavigationToolItem >		Items/NavigationToolItemProxy.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
AutoRegisterTypeTable	::UE::Sequencer::ICastable::FAutoRegisterTypeTable		Items/NavigationToolItemProxy.h
ID	::UE::Sequencer::TAutoRegisterViewModelTypeID< FNavigationToolItemProxy >		Items/NavigationToolItemProxy.h

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
Priority	uint32	This item proxy's order priority (ie. Highest priority is placed topmost or leftmost (depending on Orientation). Priority 0 is the lowest priority.	Items/NavigationToolItemProxy.h

Functions

Public

Name	Remarks	Include Path
uint32 GetPriority()		Items/NavigationToolItemProxy.h
void GetProxiedItems ( const FNavigationToolViewModelPtr& InParent, TArray< FNavigationToolViewModelWeakPtr >& OutWeakChildren, const bool bInRecursive )	Gets the items that this item proxy is representing / holding (ie. children)	Items/NavigationToolItemProxy.h
void SetPriority ( const uint32 InPriority )		Items/NavigationToolItemProxy.h

Overridden from INavigationToolItem

Name	Remarks	Include Path
virtual bool CanAutoExpand()	Delegate signature for when the Item Expansion Changes const TSharedPtr& - The Navigation Tool View where this Expansion happened bool - Whether the Item is expanded Called when Expansion state (Expanded/Collapsed) has been changed Whether the Item is able to expand when AutoExpand functionality is enabled	Items/NavigationToolItemProxy.h
virtual void FindChildren ( TArray< FNavigationToolViewModelWeakPtr >& OutWeakChildren, const bool bInRecursive )	Finds this items children.	Items/NavigationToolItemProxy.h
virtual FText GetClassName()	Gets the Class/Type of this Item (e.g. for Items that represent UObjects, it will be the UObject class)	Items/NavigationToolItemProxy.h
virtual ENavigationToolItemViewMode GetSupportedViewModes ( const INavigationToolView& InToolView ) const	Gets the View Modes that this Item Supports	Items/NavigationToolItemProxy.h
virtual bool IsItemValid()	Determines whether the Item properties are in a valid state	Items/NavigationToolItemProxy.h
virtual void SetParent ( FNavigationToolViewModelPtr InParent )	Sets the parent. Note that the parent must've already had this instance as a child (check is done)	Items/NavigationToolItemProxy.h

Protected

Overridden from FNavigationToolItem

Name	Remarks	Include Path	Unreal Specifiers
virtual FNavigationToolItemId CalculateItemId()	Gets the Item Id with the latest information (e.g. parent, object, etc)	Items/NavigationToolItemProxy.h

Static

Name	Remarks	Include Path	Unreal Specifiers
static void RegisterTypeID()		Items/NavigationToolItemProxy.h