1. Epic GamesDeveloper
  3. FNavigationToolItemId

FNavigationToolItemId

Struct to identify an item in the Navigation Tool

API > API/Plugins > API/Plugins/SequenceNavigator

Struct to identify an item in the Navigation Tool

   
Name FNavigationToolItemId
Type struct
Header File /Engine/Plugins/Experimental/SequenceNavigator/Source/SequenceNavigator/Public/Items/NavigationToolItemId.h
Include Path #include "Items/NavigationToolItemId.h"

Syntax

struct FNavigationToolItemId

Constructors

Name Remarks Include Path Unreal Specifiers

FNavigationToolItemId ( const FNavigationToolViewModelPtr& InParentItem,
const UMovieSceneSequence*const InSequence,
const UMovieSceneSection*const InSection,
const int32 InSectionIndex,
const FString& InReferenceId
)

 Ctor used for making the Item Id for most sequence items Items/NavigationToolItemId.h  

FNavigationToolItemId ( const UObject* InObject,
const FNavigationToolViewModelPtr& InReferencingItem,
const FString& InReferencingId
)

 Ctor used for Objects that are expected to appear multiple times in the Navigation Tool (e.g. a Material Ref) Items/NavigationToolItemId.h  

FNavigationToolItemId ( const FNavigationToolViewModelPtr& InParentItem,
const FNavigationToolViewModelPtr& InItemProxy
)

 Ctor used for making the Item Id for an Item Proxy under the given Parent Item. Items/NavigationToolItemId.h  

FNavigationToolItemId ( const FNavigationToolViewModelPtr& InParentItem,
const INavigationToolItemProxyFactory& InItemProxyFactory
)

 Ctor used for making the Item Id for an item proxy that will be under the given Parent Item. Items/NavigationToolItemId.h  
  Items/NavigationToolItemId.h  
  Items/NavigationToolItemId.h  

FNavigationToolItemId ( const FString& InUniqueId
)

 More flexible option to just specify the string directly. Items/NavigationToolItemId.h  
Default Ctor. Does not run any CalculateTypeHash so this instance remains invalid Items/NavigationToolItemId.h  

FNavigationToolItemId ( const UE::Sequencer::FViewModelPtr& InViewModel
)

 Ctor used for making the Item Id from a Sequencer view model Items/NavigationToolItemId.h  

Constants

Name Type Remarks Include Path
RootId FNavigationToolItemId   Items/NavigationToolItemId.h
Separator const TCHAR *   Items/NavigationToolItemId.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bHasCachedHash bool   Items/NavigationToolItemId.h  
CachedHash uint32   Items/NavigationToolItemId.h  
Id FString   Items/NavigationToolItemId.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString GetStringId()

   Items/NavigationToolItemId.h  

bool IsValidId()

 Returns whether this Id has a cached hash (i.e. ran any ctor except the default one) Items/NavigationToolItemId.h  

Static

Name Remarks Include Path Unreal Specifiers

static void AddSeparatedSegment ( FString& OutString,
const FString& InSegment
)

   Items/NavigationToolItemId.h  

static FString GetObjectPath ( const UObject*const InObject
)

   Items/NavigationToolItemId.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Items/NavigationToolItemId.h  
  Items/NavigationToolItemId.h  

bool operator== ( const FNavigationToolItemId& Other
) const

   Items/NavigationToolItemId.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page