1. Epic GamesDeveloper
  3. INavigationToolItem

INavigationToolItem

An Navigation Tool Item is the class that represents a Single Element (i.e. Node) in the Navigation Tool Tree.

API > API/Plugins > API/Plugins/SequenceNavigator

An Navigation Tool Item is the class that represents a Single Element (i.e. Node) in the Navigation Tool Tree. This can be an Item that represents an Object (e.g. Actor,Component) or a Folder, or something else.

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

Syntax

class INavigationToolItem :  
    public UE::SequenceNavigator::INavigationToolItemTypeCastable ,  
    public TSharedFromThis< INavigationToolItem >

Inheritance Hierarchy

Derived Classes

Typedefs

Name Type Remarks Include Path
FNavigationToolItemInherits TNavigationToolItemInherits< INavigationToolItem, INavigationToolItemTypeCastable >   Items/INavigationToolItem.h
FOnExpansionChanged TMulticastDelegate< void(const TSharedPtr< INavigationToolView > &, bool)> Delegate signature for when the Item Expansion Changes const TSharedPtr& - The Navigation Tool View where this Expansion happened bool - Whether the Item is expanded Items/INavigationToolItem.h
FOnRenameAction TMulticastDelegate< void(ENavigationToolRenameAction, const TSharedPtr< INavigationToolView > &)> Delegate signature for relaying an Item Rename action ENavigationToolRenameAction the type of action being relayed (e.g. request a rename, or notify rename complete, etc) const TSharedPtr& - The Navigation Tool View where the rename action is taking place Items/INavigationToolItem.h
IndexType TArray< INavigationToolItem >::SizeType   Items/INavigationToolItem.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

FReply AcceptDrop ( const FDragDropEvent& InDragDropEvent,
const EItemDropZone InDropZone
)

 Processes the Drag and Drop Event for this Item Items/INavigationToolItem.h  

bool AddChild ( const FNavigationToolAddItemParams& InAddItemParams
)

 Adds another Child under this Item if such Item is supported. Items/INavigationToolItem.h  

void AddFlags ( const ENavigationToolItemFlags InFlag
)

   Items/INavigationToolItem.h  

TOptional< EItemDropZone > CanAcceptDrop ( const FDragDropEvent& InDragDropEvent,
const EItemDropZone InDropZone
)

 Determines if and where the incoming Drag Drop Event can be processed by this item Items/INavigationToolItem.h  

bool CanAddChild ( const FNavigationToolItemPtr& InChild
) const

 Determines whether the given Child is supported and can be added under this Item Items/INavigationToolItem.h  

bool CanAutoExpand()

 Whether the Item is able to expand when AutoExpand functionality is enabled Items/INavigationToolItem.h  

bool CanBeTopLevel ()

 Whether this Item can be at the Top Level just beneath the Root, or it needs to always be under some other Item E.g. Items/INavigationToolItem.h  

bool CanDelete()

 Whether this Item can be deleted or not Items/INavigationToolItem.h  

bool CanReceiveParentVisibilityPropagation()

 Whether a change in Parent Visibility should also affect this Item's Visibility Items/INavigationToolItem.h  

bool Delete()

 The implementation to delete the item Items/INavigationToolItem.h  

InItemType * FindAncestorOfType ( const bool bInIncludeThis
) const

   Items/INavigationToolItem.h  

InItemType * FindAncestorOfType ( const bool bInIncludeThis
)

 Finds the first ancestor view model that implements the given type Items/INavigationToolItem.h  

TArray< InItemType * > FindAncestorsOfType ( const bool bInIncludeThis
) const

   Items/INavigationToolItem.h  

void FindChildren ( TArray< FNavigationToolItemPtr >& OutChildren,
const bool bInRecursive
)

 Figures out the Children of this Item. Items/INavigationToolItem.h  

virtual TArray< FNavigationToolItemPtr > FindPath ( const TArray< FNavigationToolItemPtr >& Items
) const

 Tries to Find the First Path of Descendants (not including self) that lead to a given Item in the Set. Items/INavigationToolItem.h  

virtual void FindValidChildren ( TArray< FNavigationToolItemPtr >& OutChildren,
const bool bInRecursive
)

   Items/INavigationToolItem.h  

TSharedRef< SWidget > GenerateLabelWidget ( const TSharedRef< SNavigationToolTreeRow >& InRow
)

 Function responsible of Generating the Label Widget for this Item (i.e. the column containing the Icon and the Name) Items/INavigationToolItem.h  

virtual FNavigationToolItemPtr GetChildAt ( const IndexType Index
) const

 Gets the Child Item at the given Index. Items/INavigationToolItem.h  

virtual IndexType GetChildIndex ( const FNavigationToolItemPtr& ChildItem
) const

 Gets the Index that the given Child Item is at. Items/INavigationToolItem.h  

const TArray< FNavigationToolItemPtr > & GetChildren()

 Gets the current Child Items of this Item Items/INavigationToolItem.h  

TArray< FNavigationToolItemPtr > & GetChildrenMutable()

 Gets the current Child Items of this Item Items/INavigationToolItem.h  

TArray< InItemType * > GetChildrenOfType ( const bool bInIncludeThis
) const

   Items/INavigationToolItem.h  

FText GetClassName()

 Gets the Class/Type of this Item (e.g. for Items that represent UObjects, it will be the UObject class) Items/INavigationToolItem.h  

virtual const FSlateBrush * GetDefaultIconBrush()

   Items/INavigationToolItem.h  

TArray< FNavigationToolItemPtr > GetDescendants ( const bool bInIncludeThis
)

   Items/INavigationToolItem.h  

TArray< InItemType * > GetDescendantsOfType ( const bool bInIncludeThis
) const

   Items/INavigationToolItem.h  

FText GetDisplayName()

 Gets the Display NameText of the Item Items/INavigationToolItem.h  

ENavigationToolItemFlags GetFlags()

   Items/INavigationToolItem.h  

FString GetFullPath()

 Returns the path to this item in the tree. Ex. "RootId,ChildId,ChildId" Items/INavigationToolItem.h  

FSlateIcon GetIcon()

 Gets the slate icon for the item Items/INavigationToolItem.h  

const FSlateBrush * GetIconBrush()

   Items/INavigationToolItem.h  

FSlateColor GetIconColor()

 Gets the color for the item icon Items/INavigationToolItem.h  

FText GetIconTooltipText()

 Gets the tooltip text for the item icon Items/INavigationToolItem.h  

FNavigationToolItemId GetItemId()

 Gets the Id of this Item Items/INavigationToolItem.h  

FSlateColor GetItemLabelColor()

 Gets the color to use for the item label Items/INavigationToolItem.h  

virtual UObject * GetItemObject()

 Gets the UObject that this item represents. May be null due if no item association or multiple. Items/INavigationToolItem.h  

virtual void GetItemProxies ( TArray< TSharedPtr< FNavigationToolItemProxy > >& OutItemProxies
)

 Gets the Item Proxies for this Item (e.g. Component Item that represent Primitives add in a Material Proxy to display) Items/INavigationToolItem.h  

FLinearColor GetItemTintColor()

 Gets the color to use to tint the entire item row (all column content) Items/INavigationToolItem.h  

virtual int32 GetItemTreeHeight()

 Returns the item's height in tree, Root Item should return 0 as it has no Parent Items/INavigationToolItem.h  

INavigationTool & GetOwnerTool()

 Gets the Navigation Tool that owns this item Items/INavigationToolItem.h  

FNavigationToolItemPtr GetParent ()

 Gets the Parent of this Item. Items/INavigationToolItem.h  

virtual TSet< FNavigationToolItemPtr > GetParents ( const bool bInIncludeRoot
) const

 Gets the list of all parents up the tree from this Item Items/INavigationToolItem.h  
Gets the module provider responsible for the creation of this item Items/INavigationToolItem.h  

FNavigationToolSaveState * GetProviderSaveState()

 Gets the providers saved state Items/INavigationToolItem.h  

ENavigationToolItemViewMode GetSupportedViewModes ( const INavigationToolView& InToolView
) const

 Gets the View Modes that this Item Supports Items/INavigationToolItem.h  

virtual TArray< FName > GetTags()

 Gets the Tags found for this Item (e.g. for Actors, actor tags and for Components Component Tags) Items/INavigationToolItem.h  

bool GetVisibility()

 Whether this Item is currently visible or not for the Given Type Items/INavigationToolItem.h  

bool HasAllFlags ( const ENavigationToolItemFlags InFlag
) const

   Items/INavigationToolItem.h  

bool HasAnyFlags ( const ENavigationToolItemFlags InFlag
) const

   Items/INavigationToolItem.h  

bool IsAllowedInTool()

 Returns whether this Item (and what it represents) should be allowed to be registered in Navigation Tool Items/INavigationToolItem.h  

bool IsExpanded()

 Gets whether this item is expanded Items/INavigationToolItem.h  
Whether Ignoring Pending Kill. Items/INavigationToolItem.h  

bool IsItemValid()

 Determines whether the Item properties are in a valid state Items/INavigationToolItem.h  

virtual bool IsSelectable()

 Whether the Item can be selected in Navigation Tool at all Items/INavigationToolItem.h  

virtual bool IsSelected ( const FNavigationToolScopedSelection& InSelection
) const

 Determines whether the given Item is selected in the given Scoped Selection Items/INavigationToolItem.h  

virtual bool IsViewModeSupported ( const ENavigationToolItemViewMode InViewMode,
const INavigationToolView& InToolView
) const

 Whether this Item should be visualized in the given View Mode, for the given Navigation Tool View Items/INavigationToolItem.h  

virtual FNavigationToolSerializedItem MakeSerializedItem()

 Converts this Navigation Tool item to a serialized item that can be saved in the sequence Items/INavigationToolItem.h  

virtual void OnDoubleClick()

 Called when an Item is double-clicked with the mouse Items/INavigationToolItem.h  

FOnExpansionChanged & OnExpansionChanged()

 Called when Expansion state (Expanded/Collapsed) has been changed Items/INavigationToolItem.h  

virtual void OnItemRegistered()

 Called when the Item has been registered into the Navigation Tool Items/INavigationToolItem.h  

virtual void OnItemSelectionChanged ( const bool bInIsSelected
)

 Called when the Item been selected/deselected from the Tree View Items/INavigationToolItem.h  

virtual void OnItemUnregistered()

 Called when the Item has been unregistered from the Navigation Tool Items/INavigationToolItem.h  

virtual void OnObjectsReplaced ( const TMap< UObject*, UObject* >& InReplacementMap,
const bool bInRecursive
)

 Called when objects have been replaced on the Engine side. Items/INavigationToolItem.h  

FOnRenameAction & OnRenameAction()

 Broadcasts whenever a rename action takes place from a given view (e.g. when pressing "F2" to rename, or committing the rename text) Items/INavigationToolItem.h  

virtual void OnSelect()

 Called when an Item is selected Items/INavigationToolItem.h  

virtual void OnVisibilityChanged ( const bool bInNewVisibility
)

 Called when the Visibility on Item has been changed on the Navigation Tool side Items/INavigationToolItem.h  

void RefreshChildren()

 Refreshes what the Parent and Children are of this Item. (not recursive!) Items/INavigationToolItem.h  

bool RemoveChild ( const FNavigationToolRemoveItemParams& InRemoveItemParams
)

 Removes the given child from this Item if it was ever indeed a child. Items/INavigationToolItem.h  

void RemoveFlags ( const ENavigationToolItemFlags InFlag
)

   Items/INavigationToolItem.h  

virtual void ResetChildren()

 Resets both the Cached Visible Children and Children (before doing so, sets all child's parents to null) Items/INavigationToolItem.h  

virtual void Select ( FNavigationToolScopedSelection& InSelection
) const

 Used to signal the Scoped Selection that this Item should be Selected Items/INavigationToolItem.h  

void SetExpansion ( const bool bInIsExpanded
)

 Sets the expansion state of this item Items/INavigationToolItem.h  

void SetFlags ( const ENavigationToolItemFlags InFlags
)

   Items/INavigationToolItem.h  

void SetParent ( FNavigationToolItemPtr InParent
)

 Sets the Parent. Note that the Parent must've already have this instance as a child (check is done) Items/INavigationToolItem.h  

bool ShouldSort ()

 Determines whether this item can be sorted by the Navigation Tool or not. Items/INavigationToolItem.h  

bool ShowVisibility()

 Whether this Item supports Visibility for the Given Type Items/INavigationToolItem.h  

Overridden from INavigationToolItemTypeCastable

Name Remarks Include Path Unreal Specifiers

virtual const void * CastTo_Impl ( FNavigationToolItemTypeId InCastToType
) const

   Items/INavigationToolItem.h  

virtual FNavigationToolItemTypeId GetTypeId()

   Items/INavigationToolItem.h  

Static

Name Remarks Include Path Unreal Specifiers

static FNavigationToolItemTypeId GetStaticTypeId()

   Items/INavigationToolItem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page