Navigation
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
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNavigationToolItemProxy
(
INavigationTool& InTool, |
Items/NavigationToolItemProxy.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FNavigationToolItemInherits | TNavigationToolItemInherits< FNavigationToolItemProxy, FNavigationToolItem,> | Items/NavigationToolItemProxy.h | |
| Super | FNavigationToolItem | Items/NavigationToolItemProxy.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Priority | uint32 | This Item Proxy's Order Priority (i.e. Highest priority is placed topmost or leftmost (depending on Orientation). Priority 0 is lowest priority | Items/NavigationToolItemProxy.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint32 GetPriority() |
Items/NavigationToolItemProxy.h | ||
void GetProxiedItems
(
const TSharedRef< INavigationToolItem >& InParent, |
Gets the Items that this Item Proxy is representing / holding (i.e. children) | Items/NavigationToolItemProxy.h | |
void SetPriority
(
uint32 InPriority |
Items/NavigationToolItemProxy.h |
Overridden from INavigationToolItem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanAutoExpand() |
Whether the Item is able to expand when AutoExpand functionality is enabled | Items/NavigationToolItemProxy.h | |
virtual void FindChildren
(
TArray< FNavigationToolItemPtr >& OutChildren, |
Figures out the Children of this Item. | 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 |
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
(
FNavigationToolItemPtr InParent |
Sets the Parent. Note that the Parent must've already have this instance as a child (check is done) | Items/NavigationToolItemProxy.h |
Overridden from INavigationToolItemTypeCastable
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const void * CastTo_Impl
(
FNavigationToolItemTypeId InCastToType |
Items/NavigationToolItemProxy.h | ||
virtual FNavigationToolItemTypeId GetTypeId() |
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 FNavigationToolItemTypeId GetStaticTypeId() |
Items/NavigationToolItemProxy.h |