Navigation
API > API/Plugins > API/Plugins/SequenceNavigator
Navigation Tool Item representing a Sequence binding
| Name | FNavigationToolBinding |
| Type | class |
| Header File | /Engine/Plugins/Experimental/SequenceNavigator/Source/SequenceNavigator/Public/Items/NavigationToolBinding.h |
| Include Path | #include "Items/NavigationToolBinding.h" |
Syntax
class FNavigationToolBinding :
public UE::SequenceNavigator::FNavigationToolItem ,
public UE::Sequencer::IRenameableExtension ,
public UE::SequenceNavigator::IPlayheadExtension ,
public UE::SequenceNavigator::IIdExtension
Inheritance Hierarchy
- Sequencer::TOutlinerModelMixin< Sequencer::FViewModel > → FNavigationToolItem → FNavigationToolBinding
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNavigationToolBinding
(
INavigationTool& InTool, |
Items/NavigationToolBinding.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Implements | ::UE::Sequencer::TImplements< FNavigationToolItem, Sequencer::IRenameableExtension, IPlayheadExtension, IIdExtension > | Items/NavigationToolBinding.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AutoRegisterTypeTable | ::UE::Sequencer::ICastable::FAutoRegisterTypeTable | Items/NavigationToolBinding.h | ||
| ID | ::UE::Sequencer::TAutoRegisterViewModelTypeID< FNavigationToolBinding > | Items/NavigationToolBinding.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UObject * CacheBoundObject() |
Caches the object if it's not already been cached and returns the result. | Items/NavigationToolBinding.h | |
const FMovieSceneBinding & GetBinding() |
Items/NavigationToolBinding.h | ||
UObject * GetCachedBoundObject() |
Items/NavigationToolBinding.h | ||
UMovieScene * GetMovieScene() |
Items/NavigationToolBinding.h | ||
UMovieSceneSequence * GetSequence() |
Items/NavigationToolBinding.h | ||
UE::Sequencer::TViewModelPtr< UE::Sequencer::FObjectBindingModel > GetViewModel() |
Items/NavigationToolBinding.h |
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/NavigationToolBinding.h |
Overridden from INavigationToolItem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
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/NavigationToolBinding.h | |
virtual bool CanDelete() |
Whether this Item can be deleted or not | Items/NavigationToolBinding.h | |
virtual bool Delete() |
The implementation to delete the item | Items/NavigationToolBinding.h | |
virtual void FindChildren
(
TArray< FNavigationToolViewModelWeakPtr >& OutWeakChildren, |
Finds this items children. | Items/NavigationToolBinding.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/NavigationToolBinding.h | |
virtual FText GetDisplayName() |
Gets the display name text of the item | Items/NavigationToolBinding.h | |
virtual FSlateIcon GetIcon() |
Gets the slate icon for the item | Items/NavigationToolBinding.h | |
virtual FSlateColor GetIconColor() |
Gets the color for the item icon | Items/NavigationToolBinding.h | |
virtual FText GetIconTooltipText() |
Gets the tooltip text for the item icon | Items/NavigationToolBinding.h | |
virtual UObject * GetItemObject () |
Gets the UObject that this item represents. | Items/NavigationToolBinding.h | |
virtual bool IsAllowedInTool() |
Returns whether this item (and what it represents) should be allowed to be registered in Navigation Tool | Items/NavigationToolBinding.h | |
virtual bool IsItemValid() |
Determines whether the Item properties are in a valid state | Items/NavigationToolBinding.h | |
virtual bool IsSelected
(
const FNavigationToolScopedSelection& InSelection |
Determines whether the given Item is selected in the given Scoped Selection | Items/NavigationToolBinding.h | |
virtual void OnDoubleClick() |
Called when an Item is double-clicked with the mouse | Items/NavigationToolBinding.h | |
virtual void OnSelect() |
Called when an Item is selected | Items/NavigationToolBinding.h | |
virtual void Select
(
FNavigationToolScopedSelection& InSelection |
Used to signal the Scoped Selection that this Item should be Selected | Items/NavigationToolBinding.h | |
virtual bool ShouldSort () |
Determines whether this item can be sorted by the Navigation Tool or not. | Items/NavigationToolBinding.h |
Overridden from IRenameableExtension
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanRename() |
Items/NavigationToolBinding.h | ||
virtual void Rename
(
const FText& InNewName |
Items/NavigationToolBinding.h |
Overridden from IPlayheadExtension
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EItemContainsPlayhead ContainsPlayhead() |
Items/NavigationToolBinding.h |
Overridden from IIdExtension
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FText GetId() |
Virtual EItemSequenceLockState GetLockState() const override; virtual void SetIsLocked(const bool bInIsLocked) override; | Items/NavigationToolBinding.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void RegisterTypeID() |
Items/NavigationToolBinding.h |