1. Epic GamesDeveloper
  3. FNavigationToolSequence

FNavigationToolSequence

Item in Navigation Tool representing a Sequence.

API > API/Plugins > API/Plugins/SequenceNavigator

Item in Navigation Tool representing a Sequence.

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

Syntax

class FNavigationToolSequence :  
    public UE::SequenceNavigator::FNavigationToolItem ,  
    public UE::SequenceNavigator::IRenameableExtension ,  
    public UE::SequenceNavigator::ISequenceInactivableExtension ,  
    public UE::SequenceNavigator::ISequenceLockableExtension ,  
    public UE::SequenceNavigator::IMarkerVisibilityExtension ,  
    public UE::SequenceNavigator::IRevisionControlExtension ,  
    public UE::SequenceNavigator::IPlayheadExtension ,  
    public UE::SequenceNavigator::IInTimeExtension ,  
    public UE::SequenceNavigator::IOutTimeExtension

Constructors

Name Remarks Include Path Unreal Specifiers

FNavigationToolSequence ( INavigationTool& InTool,
const FNavigationToolItemPtr& InParentItem,
UMovieSceneSequence*const InSequence,
UMovieSceneSubSection*const InSubSection,
const int32 InSubSectionIndex
)

   Items/NavigationToolSequence.h  

Typedefs

Name Type Remarks Include Path
FNavigationToolItemInherits TNavigationToolItemInherits< FNavigationToolSequence, FNavigationToolItem, IRenameableExtension, ISequenceInactivableExtension, ISequenceLockableExtension, IMarkerVisibilityExtension, IRevisionControlExtension, IPlayheadExtension, IInTimeExtension, IOutTimeExtension >   Items/NavigationToolSequence.h
Super FNavigationToolItem   Items/NavigationToolSequence.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

UMovieSceneSequence * GetSequence()

   Items/NavigationToolSequence.h  

UMovieScene * GetSequenceMovieScene()

   Items/NavigationToolSequence.h  

TArray< FMovieSceneBinding > GetSortedBindings()

   Items/NavigationToolSequence.h  

UMovieSceneSubSection * GetSubSection()

   Items/NavigationToolSequence.h  

int32 GetSubSectionIndex()

   Items/NavigationToolSequence.h  

UE::Sequencer::TViewModelPtr< UE::Sequencer::FSectionModel > GetViewModel()

   Items/NavigationToolSequence.h  

Overridden from INavigationToolItem

Name Remarks Include Path Unreal Specifiers

virtual bool AddChild ( const FNavigationToolAddItemParams& InAddItemParams
)

 Adds another Child under this Item if such Item is supported. Items/NavigationToolSequence.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/NavigationToolSequence.h  

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

 Figures out the Children of this Item. Items/NavigationToolSequence.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/NavigationToolSequence.h  

virtual FText GetDisplayName()

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

virtual FSlateIcon GetIcon()

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

virtual FText GetIconTooltipText()

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

virtual UObject * GetItemObject()

 Gets the UObject that this item represents. May be null due if no item association or multiple. Items/NavigationToolSequence.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/NavigationToolSequence.h  

virtual ENavigationToolItemViewMode GetSupportedViewModes ( const INavigationToolView& InToolView
) const

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

virtual bool IsAllowedInTool()

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

virtual bool IsItemValid()

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

virtual bool IsSelected ( const FNavigationToolScopedSelection& InSelection
) const

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

virtual void OnDoubleClick()

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

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

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

virtual void OnSelect()

 Called when an Item is selected Items/NavigationToolSequence.h  

virtual bool RemoveChild ( const FNavigationToolRemoveItemParams& InRemoveItemParams
)

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

virtual void Select ( FNavigationToolScopedSelection& InSelection
) const

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

Overridden from INavigationToolItemTypeCastable

Name Remarks Include Path Unreal Specifiers

virtual const void * CastTo_Impl ( FNavigationToolItemTypeId InCastToType
) const

   Items/NavigationToolSequence.h  

virtual FNavigationToolItemTypeId GetTypeId()

   Items/NavigationToolSequence.h  

Overridden from IColorExtension

Name Remarks Include Path Unreal Specifiers

virtual TOptional< FColor > GetColor()

   Items/NavigationToolSequence.h  

virtual void SetColor ( const TOptional< FColor >& InColor
)

   Items/NavigationToolSequence.h  

Overridden from IRenameableExtension

Name Remarks Include Path Unreal Specifiers

virtual bool CanRename()

   Items/NavigationToolSequence.h  

virtual bool Rename ( const FString& InName
)

 The implementation to rename the item Items/NavigationToolSequence.h  

Overridden from ISequenceInactivableExtension

Name Remarks Include Path Unreal Specifiers

virtual EItemSequenceInactiveState GetInactiveState()

   Items/NavigationToolSequence.h  

virtual void SetIsInactive ( const bool bInIsInactive
)

   Items/NavigationToolSequence.h  

Overridden from ISequenceLockableExtension

Name Remarks Include Path Unreal Specifiers

virtual EItemSequenceLockState GetLockState()

   Items/NavigationToolSequence.h  

virtual void SetIsLocked ( const bool bInIsLocked
)

   Items/NavigationToolSequence.h  

Overridden from IMarkerVisibilityExtension

Name Remarks Include Path Unreal Specifiers

virtual EItemMarkerVisibility GetMarkerVisibility()

   Items/NavigationToolSequence.h  

virtual void SetMarkerVisibility ( const bool bInVisible
)

   Items/NavigationToolSequence.h  

Overridden from IRevisionControlExtension

Name Remarks Include Path Unreal Specifiers

virtual EItemRevisionControlState GetRevisionControlState()

   Items/NavigationToolSequence.h  

virtual const FSlateBrush * GetRevisionControlStatusIcon()

   Items/NavigationToolSequence.h  

virtual FText GetRevisionControlStatusText()

   Items/NavigationToolSequence.h  

Overridden from IPlayheadExtension

Name Remarks Include Path Unreal Specifiers

virtual EItemContainsPlayhead ContainsPlayhead()

   Items/NavigationToolSequence.h  

Overridden from IInTimeExtension

Name Remarks Include Path Unreal Specifiers

virtual FFrameNumber GetInTime()

   Items/NavigationToolSequence.h  

virtual void SetInTime ( const FFrameNumber& InTime
)

   Items/NavigationToolSequence.h  

Overridden from IOutTimeExtension

Name Remarks Include Path Unreal Specifiers

virtual FFrameNumber GetOutTime()

   Items/NavigationToolSequence.h  

virtual void SetOutTime ( const FFrameNumber& InTime
)

   Items/NavigationToolSequence.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/NavigationToolSequence.h  

Static

Name Remarks Include Path Unreal Specifiers

static FNavigationToolItemTypeId GetStaticTypeId()

   Items/NavigationToolSequence.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page