1. Epic GamesDeveloper
  3. SequenceNavigator

SequenceNavigator

API > API/Plugins

   
Name SequenceNavigator
Type Plugin
Part of Plugins Sequence Navigator
Location /Engine/Plugins/Experimental/SequenceNavigator/Source/SequenceNavigator/
Module Build Rules SequenceNavigator.Build.cs

Classes

Name Remarks
FNavigationToolActor Navigation Tool Item representing an AActor binding
FNavigationToolAddItem Item action responsible for adding an item to the tree under a given optional parent.
FNavigationToolBinding Navigation Tool Item representing a Sequence binding
FNavigationToolColorColumn  
FNavigationToolColumn Base Navigation Tool Column to extend from
FNavigationToolColumnExtender Extension Class to add Navigation Tool Columns
FNavigationToolCommentColumn  
FNavigationToolComponent Navigation Tool Item representing an Actor Component binding
FNavigationToolComponentProxy  
FNavigationToolDeactiveStateColumn  
FNavigationToolEditorSelection  
FNavigationToolExtender  
FNavigationToolFilter  
FNavigationToolFilter_CustomText  
FNavigationToolFilter_Dirty  
FNavigationToolFilter_ItemType Base filter for filtering items based on their item class
FNavigationToolFilter_Marks  
FNavigationToolFilter_Playhead  
FNavigationToolFilter_Sequence  
FNavigationToolFilter_Text  
FNavigationToolFilter_Track  
FNavigationToolFilter_Unbound  
FNavigationToolFilterBar Holds the Sequencer track filter collection, the current text filter, and hidden/isolated lists.
FNavigationToolFilterCollection Some of this classes functionality could be moved to the TFilterCollection base class so other places could take advantage
FNavigationToolFilterMenu  
FNavigationToolFilterTextExpressionContext  
FNavigationToolHBiasColumn  
FNavigationToolInTimeColumn  
FNavigationToolItem Base Implementation of INavigationToolItem
FNavigationToolItemDragDropOp Drag Drop Operation for Navigation Tool Items.
FNavigationToolItemDropHandler Base Class to Handle Dropping Navigation Tool Items into a Target Navigation Tool Item
FNavigationToolItemProxy Item Proxies are Navigation Tool Items that with the sole purpose to group and hold common items together.
FNavigationToolItemProxyRegistry Handles registering a Navigation Tool item type with a Navigation Tool item proxy factory that creates the respective INavigationToolItemProxy
FNavigationToolItemsColumn  
FNavigationToolItemTypeId  
FNavigationToolLabelColumn  
FNavigationToolLengthColumn  
FNavigationToolLockColumn  
FNavigationToolMarker Navigation Tool Item representing a sequence marker
FNavigationToolMarkerVisibilityColumn  
FNavigationToolOutTimeColumn  
FNavigationToolPlayheadColumn  
FNavigationToolProvider Base Navigation Tool Provider to extend from
FNavigationToolRemoveItem Item Action responsible for removing/unregistering items from the tree
FNavigationToolRevisionControlColumn  
FNavigationToolScopedSelection Handler to Sync Selection from Navigation Tool to the Sequencer
FNavigationToolSequence Item in Navigation Tool representing a Sequence.
FNavigationToolStartFrameOffsetColumn  
FNavigationToolStyle  
FNavigationToolSubTrack  
FNavigationToolTakeColumn  
FNavigationToolTrack  
SNavigationToolTreeRow  
TNavigationToolItemInherits Holds the direct super types of a given type T.
TNavigationToolItemProxyDefaultFactory  
TNavigationToolItemProxyDefaultFactoryBase Default Template Item Proxy Factory classes to create the Item Proxy without having to write it out for all classes that don't need special behavior or custom constructors
UNavigationToolFilterBarContext  
UNavigationToolFilterExtension Derive from this class to make additional filters available in the Navigation Tool.
UNavigationToolFilterMenuContext  
UNavigationToolFilterTextExpressionExtension Derive from this class to make additional track filter text expressions available in Sequencer.
UNavigationToolItemMenuContext  
UNavigationToolSettings  

Structs

Name Remarks
CNavigationToolItemInheritable Describes a type with a FNavigationToolItemInherits typedef or using declaration
CNavigationToolItemStaticTypeable Describes a type that has a GetStaticTypeId() static function that returns FNavigationToolItemTypeId
FNavigationToolAddItemParams  
FNavigationToolBuiltInFilterParams  
FNavigationToolCastableTypeTable  
FNavigationToolColumnView  
FNavigationToolFilterData Represents a cache between nodes for a filter operation.
FNavigationToolItemFlagGuard Adds Scoped Item Flags, removes them when out of scope.
FNavigationToolItemId Struct to identify an item in the Navigation Tool
FNavigationToolRemoveItemParams  
FNavigationToolViewModelTypeID  
TImplements  
TIsDerivedFromAll Returns true if InDerivedType is a derived type of ALL (And) the given InBaseTypes
TNavigationToolAutoRegisterViewModelTypeID  
TNavigationToolItemExternalType  
TNavigationToolItemType Helps retrieve the FNavigationToolItemTypeId for a given type T that satisfies the TIsValidNavigationToolItemType requirement If this is requirement is not satisfied, TNavigationToolItemType::GetTypeId will be undefined for T.
TNavigationToolViewModelTypeID  
TViewModelTypeID  

Interfaces

Name Remarks
IColorExtension  
IInTimeExtension  
IMarkerVisibilityExtension  
INavigationTool The Navigation Tool Object that is commonly instanced once per Sequencer (unless for advanced use where there are different Navigation Tool instances with different item ordering and behaviors).
INavigationToolAction Interface class for an Action in the Navigation Tool (e.g. Add/Delete/Move Tree Item)
INavigationToolColumn  
INavigationToolFilterBar  
INavigationToolIconCustomization  
INavigationToolItem An Navigation Tool Item is the class that represents a Single Element (i.e. Node) in the Navigation Tool Tree.
INavigationToolItemProxyFactory Item Proxy Factories are the classes that instance or get the existing Navigation Tool Item Proxies for a given Item
INavigationToolItemTypeCastable Interface Class to perform actions like IsA, or CastTo
INavigationToolProvider Provides the Navigation Tool with functionality it is not responsible for.
INavigationToolView  
IOutTimeExtension  
IPlayheadExtension  
IRenameableExtension  
IRevisionControlExtension  
ISequenceInactivableExtension  
ISequenceLockableExtension  
ISequenceMutableExtension  

Typedefs

Name Type Remarks Include Path
FNavigationToolFilterType TSharedPtr< INavigationToolItem >   Filters/NavigationToolFilterData.h
FNavigationToolItemPtr TSharedPtr< INavigationToolItem >   NavigationToolDefines.h
FNavigationToolItemRef TSharedRef< INavigationToolItem >   NavigationToolDefines.h
FNavigationToolItemWeakPtr TWeakPtr< INavigationToolItem >   NavigationToolDefines.h
FOnItemDragDropOpInitialized TMulticastDelegate_OneParam< void, FNavigationToolItemDragDropOp & > Called when the FNavigationToolItemDragDropOp has been created and Initialized in FNavigationToolItemDragDropOp::Init NavigationToolExtender.h
FOnNavigationToolProvidersChanged TMulticastDelegate_ThreeParams< void, const FName, const TSharedRef< FNavigationToolProvider > &, const ENavigationToolProvidersChangeType >   NavigationToolExtender.h
FOnPopulateFilterBarMenu TBaseDelegate_OneParam< void, UToolMenu * >   Menus/NavigationToolFilterBarContext.h
TIsValidNavigationToolItemType TOr< TModels< CNavigationToolItemStaticTypeable, T >, TModels< CNavigationToolItemStaticTypeable, TNavigationToolItemExternalType< T > > > Determines that a typename T is a valid "Navigation Tool Item Type" if a FNavigationToolItemTypeId can be retrieved by calling either T::GetStaticTypeId() (via UE_NAVIGATIONTOOL_TYPE) or TNavigationToolItemExternalType::GetStaticTypeId() (via UE_NAVIGATIONTOOL_TYPE_EXTERNAL) NavigationToolItemType.h

Enums

Public

Name Remarks
ENavigationToolDragDropActionType  
ENavigationToolExtensionPosition  
ENavigationToolFilterMode  
ENavigationToolIgnoreNotifyFlags  
ENavigationToolItemSelectionFlags Flags specifying how an Item should be Selected
ENavigationToolItemViewMode The type of visualization being done to the item
ENavigationToolRenameAction  
UE::SequenceNavigator::EItemContainsPlayhead  
UE::SequenceNavigator::EItemMarkerVisibility  
UE::SequenceNavigator::EItemRevisionControlState  
UE::SequenceNavigator::EItemSequenceInactiveState  
UE::SequenceNavigator::EItemSequenceLockState  
UE::SequenceNavigator::EItemSequenceMuteState  
UE::SequenceNavigator::ENavigationToolAddItemFlags  
UE::SequenceNavigator::ENavigationToolCompareState The result of an item comparison
UE::SequenceNavigator::ENavigationToolFilterChange  
UE::SequenceNavigator::ENavigationToolProvidersChangeType  
UE::SequenceNavigator::ENavigationToolScopedSelectionPurpose  
UE::SequenceNavigator::ENavigationToolSelectionSource  

Functions

Public

Name Remarks Include Path Unreal Specifiers

ENUM_CLASS_FLAGS ( ENavigationToolItemViewMode
)

   NavigationToolSettings.h  
  Filters/Filters/NavigationToolFilterBase.h  
  NavigationToolDefines.h  
  NavigationToolDefines.h  
  Filters/Filters/NavigationToolFilterBase.h  
  NavigationToolDefines.h  
  NavigationToolDefines.h  
  Filters/Filters/NavigationToolFilterBase.h  
  NavigationToolDefines.h  
  NavigationToolDefines.h  
  Filters/Filters/NavigationToolFilterBase.h  
  NavigationToolDefines.h  
  NavigationToolDefines.h  
  Filters/Filters/NavigationToolFilterBase.h  
  NavigationToolDefines.h  
  NavigationToolDefines.h  
  Filters/Filters/NavigationToolFilterBase.h  
  NavigationToolDefines.h  
  NavigationToolDefines.h  
  Filters/Filters/NavigationToolFilterBase.h  
  NavigationToolDefines.h  
  NavigationToolDefines.h  
  Filters/Filters/NavigationToolFilterBase.h  
  NavigationToolDefines.h  
  NavigationToolDefines.h  

ENavigationToolCompareState UE::SequenceNavigator::CompareArrayState ( const TArray< InItemType* >& InArray,
const TFunctionRef< bool(const InItemType*const)>& InTrueFunction,
const TFunctionRef< bool(const InItemType*const)>& InFalseFunction
)

 Evaluates the state of items in an array based on a predicate function and determines whether all, none, or some of the items match the condition. Items/NavigationToolItemUtils.h  

ENavigationToolCompareState UE::SequenceNavigator::CompareArrayStateSimple ( const TArray< InItemType* >& InArray,
const TFunctionRef< bool(const InItemType*const)>& InTrueFunction
)

 Evaluates the state of items in an array based on a predicate function and determines whether all, none, or some of the items match the condition. Items/NavigationToolItemUtils.h  

ENavigationToolCompareState UE::SequenceNavigator::CompareChildrenItemState ( const INavigationToolItem*const InItem,
const TFunctionRef< bool(const InItemType*const)>& InTrueFunction,
const TFunctionRef< bool(const InItemType*const)>& InFalseFunction,
const ENavigationToolCompareState InDefaultState
)

 Evaluates an items children based on a predicate function and determines whether all, none, or some of the children match the condition. Items/NavigationToolItemUtils.h  

ENavigationToolCompareState UE::SequenceNavigator::CompareChildrenItemStateSimple ( const INavigationToolItem*const InItem,
const TFunctionRef< bool(const InItemType*const)>& InTrueFunction
)

 Evaluates an items children based on a predicate function and determines whether all, none, or some of the children match the condition. Items/NavigationToolItemUtils.h  

UMovieSceneSubSection * UE::SequenceNavigator::GetSequenceItemSubSection ( const FNavigationToolItemPtr& InItem
)

   Items/NavigationToolItemUtils.h  
  Extensions/IMarkerVisibilityExtension.h  
  Extensions/IPlayheadExtension.h  
  Extensions/IRevisionControlExtension.h  
  Extensions/ISequenceInactivableExtension.h  
  Extensions/ISequenceLockableExtension.h  
  Extensions/ISequenceMutableExtension.h  
  Items/NavigationToolItemParameters.h  
  Items/NavigationToolItemUtils.h  
  Extensions/IMarkerVisibilityExtension.h  
  Extensions/IPlayheadExtension.h  
  Extensions/IRevisionControlExtension.h  
  Extensions/ISequenceInactivableExtension.h  
  Extensions/ISequenceLockableExtension.h  
  Extensions/ISequenceMutableExtension.h  
  Items/NavigationToolItemParameters.h  
  Items/NavigationToolItemUtils.h  
  Extensions/IMarkerVisibilityExtension.h  
  Extensions/IPlayheadExtension.h  
  Extensions/IRevisionControlExtension.h  
  Extensions/ISequenceInactivableExtension.h  
  Extensions/ISequenceLockableExtension.h  
  Extensions/ISequenceMutableExtension.h  
  Items/NavigationToolItemParameters.h  
  Items/NavigationToolItemUtils.h  
  Extensions/IMarkerVisibilityExtension.h  
  Extensions/IPlayheadExtension.h  
  Extensions/IRevisionControlExtension.h  
  Extensions/ISequenceInactivableExtension.h  
  Extensions/ISequenceLockableExtension.h  
  Extensions/ISequenceMutableExtension.h  
  Items/NavigationToolItemParameters.h  
  Items/NavigationToolItemUtils.h  
  Extensions/IMarkerVisibilityExtension.h  
  Extensions/IPlayheadExtension.h  
  Extensions/IRevisionControlExtension.h  
  Extensions/ISequenceInactivableExtension.h  
  Extensions/ISequenceLockableExtension.h  
  Extensions/ISequenceMutableExtension.h  
  Items/NavigationToolItemParameters.h  
  Items/NavigationToolItemUtils.h  
  Extensions/IMarkerVisibilityExtension.h  
  Extensions/IPlayheadExtension.h  
  Extensions/IRevisionControlExtension.h  
  Extensions/ISequenceInactivableExtension.h  
  Extensions/ISequenceLockableExtension.h  
  Extensions/ISequenceMutableExtension.h  
  Items/NavigationToolItemParameters.h  
  Items/NavigationToolItemUtils.h  
  Extensions/IMarkerVisibilityExtension.h  
  Extensions/IPlayheadExtension.h  
  Extensions/IRevisionControlExtension.h  
  Extensions/ISequenceInactivableExtension.h  
  Extensions/ISequenceLockableExtension.h  
  Extensions/ISequenceMutableExtension.h  
  Items/NavigationToolItemParameters.h  
  Items/NavigationToolItemUtils.h  
  Extensions/IMarkerVisibilityExtension.h  
  Extensions/IPlayheadExtension.h  
  Extensions/IRevisionControlExtension.h  
  Extensions/ISequenceInactivableExtension.h  
  Extensions/ISequenceLockableExtension.h  
  Extensions/ISequenceMutableExtension.h  
  Items/NavigationToolItemParameters.h  
  Items/NavigationToolItemUtils.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page