Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. UMovieSceneTrack

UMovieSceneTrack

Disable some VS warnings that are emitted by Add/RemoveSection functions hiding the private virtual methods in [IMovieSceneTrackVirtualAPI](API\Runtime\MovieScene\IMovieSceneTrackVirtualAPI) Base class for a track in a Movie Scene

API > API/Runtime > API/Runtime/MovieScene

Disable some VS warnings that are emitted by Add/RemoveSection functions hiding the private virtual methods in IMovieSceneTrackVirtualAPI Base class for a track in a Movie Scene

   
Name UMovieSceneTrack
Type class
Header File /Engine/Source/Runtime/MovieScene/Public/MovieSceneTrack.h
Include Path #include "MovieSceneTrack.h"

Syntax

UCLASS (Abstract, DefaultToInstanced, MinimalAPI, BlueprintType)  
class UMovieSceneTrack :  
    public UMovieSceneDecorationContainerObject ,  
    public IMovieSceneTrackVirtualAPI

Inheritance Hierarchy

Implements Interfaces

Derived Classes

UMovieSceneTrack derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieSceneTrack ( const FObjectInitializer& InInitializer
)

   MovieSceneTrack.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~UMovieSceneTrack()

   MovieSceneTrack.h  

Structs

Name Remarks
FSectionIndexParameter  
FSectionParameter Parameter structs that only exist to differentiate overloads from IMovieSceneTrackVirtualAPI.

Enums

Protected

Name Remarks
ETreePopulationMode  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ConditionContainer FMovieSceneConditionContainer Optional dynamic condition for whether this track/any of the sections on this track evaluates at runtime. MovieSceneTrack.h
  • EditAnywhere
  • Category="Track"
DisplayOptions FMovieSceneTrackDisplayOptions General display options for a given track MovieSceneTrack.h
  • EditAnywhere
  • Category="Track"
  • Meta=(ShowOnlyInnerProperties)
EvalOptions FMovieSceneTrackEvalOptions General evaluation options for a given track MovieSceneTrack.h
  • EditAnywhere
  • Category="Track"
  • Meta=(ShowOnlyInnerProperties)

Protected

Name Type Remarks Include Path Unreal Specifiers
EvaluationField FMovieSceneTrackEvaluationField An array of entries that define when specific sections should be evaluated on this track MovieSceneTrack.h  
EvaluationFieldGuid FGuid The guid of the object signature that the EvaluationField member relates to MovieSceneTrack.h  
EvaluationFieldVersion int8 The version of the logic in PopulateEvaluationTree when the EvaluationField was cached MovieSceneTrack.h  
TrackRowMetadata TMap< int32, FMovieSceneTrackRowMetadata > Optional extra metadata tied to specific track rows. MovieSceneTrack.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddSection ( FSectionParameter Section
)

 Add a section to this track. MovieSceneTrack.h  

virtual UMovieSceneSection * CreateNewSection()

 Generates a new section suitable for use with this track. MovieSceneTrack.h  

FGuid FindObjectBindingGuid()

   MovieSceneTrack.h  

FMovieSceneTrackRowMetadata & FindOrAddTrackRowMetadata ( int32 RowIndex
)

 Returns a pointer to optional track row metadata at the given RowIndex, or nullptr if none exists; MovieSceneTrack.h  

const FMovieSceneTrackRowMetadata * FindTrackRowMetadata ( int32 RowIndex
) const

 Returns a pointer to optional track row metadata at the given RowIndex, or nullptr if none exists. MovieSceneTrack.h  
Returns a pointer to optional track row metadata at the given RowIndex, or nullptr if none exists; MovieSceneTrack.h  

virtual bool FixRowIndices()

 Updates the row indices of sections owned by this track so that all row indices which are used are consecutive with no gaps. MovieSceneTrack.h  

TArray< UMovieSceneCondition * > GetAllConditions()

 Returns an array of all conditions on track, track row, or section MovieSceneTrack.h  

virtual const TArray< UMovieSceneSection * > & GetAllSections()

 Called when all the sections of the track need to be retrieved. MovieSceneTrack.h  

const FColor & GetColorTint()

 Get this track's color tint. MovieSceneTrack.h  

virtual ECookOptimizationFlags GetCookOptimizationFlags()

 Called when this track's movie scene is being cooked to determine if/how this track should be cooked. MovieSceneTrack.h  

virtual FText GetDisplayName()

 Get the track's display name. MovieSceneTrack.h  

virtual FText GetDisplayNameToolTipText ( const FMovieSceneLabelParams& LabelParams
) const

 Get the track's display tooltip text to be shown on the track's name. MovieSceneTrack.h  

const FMovieSceneTrackEvaluationField & GetEvaluationField()

 Retrieve a fully up-to-date evaluation field for this track. MovieSceneTrack.h  

virtual int8 GetEvaluationFieldVersion ()

 Retrieve a version number for the logic implemented in PopulateEvaluationTree. MovieSceneTrack.h  

virtual FSlateColor GetLabelColor ( const FMovieSceneLabelParams& LabelParams
) const

 Gets the track label's color. MovieSceneTrack.h  

int32 GetMaxRowIndex()

 Gets the greatest row index of all the sections owned by this track. MovieSceneTrack.h  

virtual FMovieSceneTrackRowSegmentBlenderPtr GetRowSegmentBlender ()

 Get compiler rules to use when compiling sections that overlap on the same row. MovieSceneTrack.h  

virtual UMovieSceneSection * GetSectionToKey()

 Get the section we want to key. If track doesn't support layered blends it will return nulltpr. MovieSceneTrack.h  

int32 GetSortingOrder()

 Get this folder's desired sorting order MovieSceneTrack.h  

FMovieSceneBlendTypeField GetSupportedBlendTypes()

 Gets what kind of blending is supported by this section MovieSceneTrack.h  

virtual FName GetTrackName()

   MovieSceneTrack.h  

virtual FText GetTrackRowDisplayName ( int32 RowIndex
) const

 Get the track row's display name. MovieSceneTrack.h  

virtual FMovieSceneTrackSegmentBlenderPtr GetTrackSegmentBlender ()

 Get compiler rules to use when compiling sections that overlap on different rows. MovieSceneTrack.h  

virtual bool HasSection ( const UMovieSceneSection& Section
) const

 Checks to see if the section is in this track. MovieSceneTrack.h  

virtual bool IsEmpty()

   MovieSceneTrack.h  

bool IsEvalDisabled ( const bool bInCheckLocal
) const

   MovieSceneTrack.h  

bool IsLocalEvalDisabled()

   MovieSceneTrack.h  

bool IsLocalRowEvalDisabled ( const int32 InRowIndex
) const

   MovieSceneTrack.h  

bool IsRowEvalDisabled ( const int32 InRowIndex,
const bool bInCheckLocal
) const

   MovieSceneTrack.h  

void OnAddedToMovieScene ( UMovieScene* MovieScene
)

   MovieSceneTrack.h  

void OnRemovedFromMovieScene()

   MovieSceneTrack.h  

virtual void OnRowIndicesChanged ( const TMap< int32, int32 >& NewToOldRowIndices
)

 Called when row indices have been fixed up MovieSceneTrack.h  

virtual EMovieSceneSectionMovedResult OnSectionMoved ( UMovieSceneSection& Section,
const FMovieSceneSectionMovedParams& Params
)

 Called if the section is moved in Sequencer. MovieSceneTrack.h  

void PreCompile ( FMovieSceneTrackPreCompileResult& OutPreCompileResult
)

 Run the pre-compilation step for this track. MovieSceneTrack.h  

virtual void RemoveAllAnimationData()

 Removes animation data. MovieSceneTrack.h  

virtual void RemoveForCook()

 Called when this track should be removed for cooking MovieSceneTrack.h  

void RemoveSection ( FSectionParameter Section
)

 Removes a section from this track. MovieSceneTrack.h  

void RemoveSectionAt ( FSectionIndexParameter SectionIndex
)

 Removes a section from this track at a particular index MovieSceneTrack.h  

void SetColorTint ( const FColor& InTrackTint
)

 Set this track's color tint. MovieSceneTrack.h  

void SetEvalDisabled ( const bool bInEvalDisabled
)

 Called by Sequencer to set whether evaluation of this track should be disabled due to deactive setting MovieSceneTrack.h  

void SetLocalEvalDisabled ( const bool bInEvalDisabled
)

 Called by Sequencer to set whether evaluation of this track should be disabled due to local muting/soloing (not serialized with the asset) MovieSceneTrack.h  

void SetLocalRowEvalDisabled ( const bool bInEvalDisabled,
int32 InRowIndex
)

   MovieSceneTrack.h  

void SetRowEvalDisabled ( const bool bInEvalDisabled,
const int32 InRowIndex
)

   MovieSceneTrack.h  

virtual void SetSectionToKey ( UMovieSceneSection* InSection
)

 Set This Section as the one to key. If track doesn't support layered blends then don't implement MovieSceneTrack.h  

void SetSortingOrder ( const int32 InSortingOrder
)

 Set this folder's desired sorting order. MovieSceneTrack.h  

virtual bool SupportsConditions()

   MovieSceneTrack.h  

virtual bool SupportsDefaultSections()

   MovieSceneTrack.h  

virtual EMovieSceneTrackEasingSupportFlags SupportsEasing ( FMovieSceneSupportsEasingParams& Params
) const

   MovieSceneTrack.h  

virtual bool SupportsMultipleRows()

   MovieSceneTrack.h  

virtual bool SupportsType ( TSubclassOf< UMovieSceneSection > SectionClass
) const

 Does this track support this section class type? MovieSceneTrack.h  

virtual void UpdateEasing()

 Update all auto-generated easing curves for all sections in this track MovieSceneTrack.h  

Protected

Name Remarks Include Path Unreal Specifiers
Forcibly update this evaluation tree without updating the signature. MovieSceneTrack.h  

Overridden from UMovieSceneDecorationContainerObject

Name Remarks Include Path Unreal Specifiers

virtual void OnDecorationAdded ( UObject* NewDecoration
)

   MovieSceneTrack.h  

virtual void OnDecorationRemoved ( UObject* Decoration
)

   MovieSceneTrack.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool IsPostLoadThreadSafe()

   MovieSceneTrack.h  

virtual void PostInitProperties()

   MovieSceneTrack.h  

virtual void PostLoad()

   MovieSceneTrack.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool RemoveMutedTracksOnCook()

   MovieSceneTrack.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page