Navigation
API > API/Plugins > API/Plugins/SequenceNavigator
Base implementation of INavigationToolItem
| Name | FNavigationToolItem |
| Type | class |
| Header File | /Engine/Plugins/Experimental/SequenceNavigator/Source/SequenceNavigator/Public/Items/NavigationToolItem.h |
| Include Path | #include "Items/NavigationToolItem.h" |
Syntax
class FNavigationToolItem :
public Sequencer::TOutlinerModelMixin< Sequencer::FViewModel >,
public UE::SequenceNavigator::INavigationToolItem ,
public UE::SequenceNavigator::IColorExtension
Inheritance Hierarchy
- Sequencer::TOutlinerModelMixin< Sequencer::FViewModel > → FNavigationToolItem
Derived Classes
FNavigationToolItem derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNavigationToolItem
(
INavigationTool& InTool, |
Items/NavigationToolItem.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FNavigationToolGetToolState | TBaseDelegate_OneParam< FNavigationToolSaveState *, const FNavigationToolViewModelPtr > | Items/NavigationToolItem.h | |
| Implements | ::UE::Sequencer::TImplements< Sequencer::TOutlinerModelMixin< Sequencer::FViewModel >, INavigationToolItem, IColorExtension > | Items/NavigationToolItem.h | |
| IndexType | TArray< INavigationToolItem >::SizeType | Items/NavigationToolItem.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AutoRegisterTypeTable | ::UE::Sequencer::ICastable::FAutoRegisterTypeTable | Items/NavigationToolItem.h | ||
| ID | ::UE::Sequencer::TAutoRegisterViewModelTypeID< FNavigationToolItem > | Items/NavigationToolItem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
Sequencer::TViewModelPtr< FNavigationToolItem > AsItemViewModel() |
Items/NavigationToolItem.h | ||
Sequencer::TViewModelPtr< FNavigationToolItem > AsItemViewModelConst() |
Items/NavigationToolItem.h | ||
virtual Sequencer::FOutlinerSizing GetOutlinerSizing() |
Items/NavigationToolItem.h |
Overridden from INavigationToolItem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FReply AcceptDrop
(
const FDragDropEvent& InDragDropEvent, |
Processes the Drag and Drop Event for this Item | Items/NavigationToolItem.h | |
virtual bool AddChild
(
const FNavigationToolAddItemParams& InAddItemParams |
Adds another Child under this Item if such Item is supported. | Items/NavigationToolItem.h | |
virtual void AddFlags
(
ENavigationToolItemFlags Flags |
Items/NavigationToolItem.h | ||
virtual TOptional< EItemDropZone > CanAcceptDrop
(
const FDragDropEvent& InDragDropEvent, |
Returns the item's height in the tree. | Items/NavigationToolItem.h | |
virtual bool CanAddChild
(
const FNavigationToolViewModelPtr& InChild |
Determines whether the given Child is supported and can be added under this Item | Items/NavigationToolItem.h | |
virtual bool CanAutoExpand() |
Delegate signature for when the Item Expansion Changes const TSharedPtr |
Items/NavigationToolItem.h | |
virtual 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/NavigationToolItem.h | |
virtual bool CanDelete() |
Whether this Item can be deleted or not | Items/NavigationToolItem.h | |
virtual bool CanReceiveParentVisibilityPropagation() |
Whether a change in Parent Visibility should also affect this Item's Visibility | Items/NavigationToolItem.h | |
virtual bool Delete() |
The implementation to delete the item | Items/NavigationToolItem.h | |
virtual void FindChildren
(
TArray< FNavigationToolViewModelWeakPtr >& OutWeakChildren, |
Finds this items children. | Items/NavigationToolItem.h | |
| Tries to find the first path of descendants (not including self) that lead to a given item in the set. | Items/NavigationToolItem.h | ||
virtual void FindValidChildren
(
TArray< FNavigationToolViewModelWeakPtr >& OutWeakChildren, |
Items/NavigationToolItem.h | ||
virtual 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/NavigationToolItem.h | |
virtual FNavigationToolViewModelWeakPtr GetChildAt
(
const IndexType InIndex |
Gets the Child Item at the given Index. | Items/NavigationToolItem.h | |
virtual IndexType GetChildIndex
(
const FNavigationToolViewModelWeakPtr& InWeakChildItem |
Gets the Index that the given Child Item is at. | Items/NavigationToolItem.h | |
virtual const TArray< FNavigationToolViewModelWeakPtr > & GetChildren() |
Gets the current Child Items of this item | Items/NavigationToolItem.h | |
virtual TArray< FNavigationToolViewModelWeakPtr > & GetChildrenMutable() |
Gets the current Child Items of this Item | Items/NavigationToolItem.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/NavigationToolItem.h | |
virtual FText GetDisplayName() |
Gets the display name text of the item | Items/NavigationToolItem.h | |
virtual ENavigationToolItemFlags GetFlags() |
Items/NavigationToolItem.h | ||
virtual FString GetFullPath() |
Returns the path to this item in the tree. Ex. "RootId,ChildId,ChildId" | Items/NavigationToolItem.h | |
virtual const FSlateBrush * GetIconBrush() |
Items/NavigationToolItem.h | ||
virtual FSlateColor GetIconColor() |
Gets the color for the item icon | Items/NavigationToolItem.h | |
virtual FNavigationToolItemId GetItemId() |
Gets the Id of this item | Items/NavigationToolItem.h | |
virtual FSlateColor GetItemLabelColor() |
Gets the color to use for the item label | Items/NavigationToolItem.h | |
virtual FLinearColor GetItemTintColor() |
Gets the color to use to tint the entire item row (all column content) | Items/NavigationToolItem.h | |
virtual INavigationTool & GetOwnerTool() |
Gets the Navigation Tool that owns this item | Items/NavigationToolItem.h | |
virtual FNavigationToolViewModelPtr GetParent () |
Gets the Parent of this item. | Items/NavigationToolItem.h | |
virtual TSet< FNavigationToolViewModelPtr > GetParents
(
const bool bInIncludeRoot |
Gets the list of all parents up the tree from this Item | Items/NavigationToolItem.h | |
virtual TSharedPtr< FNavigationToolProvider > GetProvider() |
Gets the module provider responsible for the creation of this item | Items/NavigationToolItem.h | |
virtual FNavigationToolSaveState * GetProviderSaveState() |
Gets the providers saved state | Items/NavigationToolItem.h | |
virtual ENavigationToolItemViewMode GetSupportedViewModes
(
const INavigationToolView& InToolView |
Gets the View Modes that this Item Supports | Items/NavigationToolItem.h | |
| Gets the Tags found for this item (e.g. for Actors, actor tags and for Components, component tags) | Items/NavigationToolItem.h | ||
virtual bool GetVisibility() |
Whether this Item is currently visible or not for the Given Type | Items/NavigationToolItem.h | |
virtual bool HasAllFlags
(
ENavigationToolItemFlags Flags |
Items/NavigationToolItem.h | ||
virtual bool HasAnyFlags
(
ENavigationToolItemFlags Flags |
Items/NavigationToolItem.h | ||
virtual bool IsAllowedInTool() |
Returns whether this item (and what it represents) should be allowed to be registered in Navigation Tool | Items/NavigationToolItem.h | |
virtual bool IsExpanded() |
Gets whether this item is expanded | Items/NavigationToolItem.h | |
virtual bool IsIgnoringPendingKill () |
Whether Ignoring Pending Kill. | Items/NavigationToolItem.h | |
virtual bool IsItemValid() |
Determines whether the Item properties are in a valid state | Items/NavigationToolItem.h | |
virtual bool IsViewModeSupported
(
const ENavigationToolItemViewMode InViewMode, |
Whether this Item should be visualized in the given View Mode, for the given Navigation Tool View | Items/NavigationToolItem.h | |
virtual FNavigationToolSerializedItem MakeSerializedItem() |
Converts this Navigation Tool item to a serialized item that can be saved in the sequence | Items/NavigationToolItem.h | |
virtual void OnObjectsReplaced
(
const TMap< UObject*, UObject* >& InReplacementMap, |
Called when objects have been replaced on the Engine side. | Items/NavigationToolItem.h | |
virtual void RefreshChildren() |
Refreshes what the Parent and Children are of this Item. (not recursive!) | Items/NavigationToolItem.h | |
virtual bool RemoveChild
(
const FNavigationToolRemoveItemParams& InRemoveItemParams |
Removes the given child from this Item if it was ever indeed a child. | Items/NavigationToolItem.h | |
virtual void RemoveFlags
(
ENavigationToolItemFlags Flags |
Items/NavigationToolItem.h | ||
virtual void ResetChildren() |
Resets both the cached visible children and children (before doing so, sets all child's parents to null) | Items/NavigationToolItem.h | |
virtual void SetExpansion
(
const bool bInIsExpanded |
Sets the expansion state of this item | Items/NavigationToolItem.h | |
virtual void SetFlags
(
ENavigationToolItemFlags InFlags |
Items/NavigationToolItem.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/NavigationToolItem.h | |
virtual bool ShouldSort () |
Determines whether this item can be sorted by the Navigation Tool or not. | Items/NavigationToolItem.h | |
virtual bool ShowVisibility() |
Whether this Item supports Visibility for the Given Type | Items/NavigationToolItem.h |
Overridden from IColorExtension
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Items/NavigationToolItem.h | |||
| Items/NavigationToolItem.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddChildChecked
(
const FNavigationToolAddItemParams& InAddItemParams |
The actual implementation of putting the given item under the children array | Items/NavigationToolItem.h | |
FNavigationToolItemId CalculateItemId() |
Gets the Item Id with the latest information (e.g. parent, object, etc) | Items/NavigationToolItem.h | |
void HandleNewSortableChildren
(
TArray< FNavigationToolViewModelWeakPtr > InWeakSortableChildren |
Careful handling of multiple children being detected and added to this item children array | Items/NavigationToolItem.h | |
void RecalculateItemId() |
Sets the ItemId member var to what CalculateItemId returns | Items/NavigationToolItem.h | |
bool RemoveChildChecked
(
const FNavigationToolRemoveItemParams& InRemoveItemParams |
The actual implementation of removing the given item from the Children array | Items/NavigationToolItem.h | |
void SetProvider
(
const TWeakPtr< FNavigationToolProvider >& InWeakProvider |
Items/NavigationToolItem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void RegisterTypeID() |
Items/NavigationToolItem.h |