1. Epic GamesDeveloper
  3. MovieSceneHelpers

MovieSceneHelpers

API > API/Runtime > API/Runtime/MovieScene

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

Syntax

class MovieSceneHelpers

Structs

Name Remarks
FMovieSceneScopedPackageDirtyGuard Helper struct to cache the package dirty state and then to restore it after this leaves scope.

Functions

Static

Name Remarks Include Path Unreal Specifiers

static float CalculateWeightForBlending ( UMovieSceneSection* SectionToKey,
FFrameNumber Time
)

 Get weight needed to modify the global difference in order to correctly key this section due to it possibly being blended by other sections. MovieSceneCommonHelpers.h  

static UCameraComponent * CameraComponentFromActor ( const AActor* InActor
)

 Get the active camera component from the actor MovieSceneCommonHelpers.h  

static UCameraComponent * CameraComponentFromRuntimeObject ( UObject* RuntimeObject
)

 Find and return camera component from the runtime object MovieSceneCommonHelpers.h  

static bool CopyObjectTemplate ( UMovieSceneSequence* Sequence,
const FGuid& ObjectId,
UObject* InSourceObject,
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState,
int32 BindingIndex
)

 If the binding for the given ObjectId supports object templates, copies the object template into the binding and returns true, otherwise returns false MovieSceneCommonHelpers.h  
For cases where the user does not have a IMovieScenePlayer with a shared playback state, creates a transient one. MovieSceneCommonHelpers.h  

static bool EvaluateSequenceCondition ( const FGuid& BindingID,
const FMovieSceneSequenceID& SequenceID,
const UMovieSceneCondition* Condition,
UObject* ConditionOwnerObject,
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState
)

 Helper function for evaluating a condition in a movie scene, taking advantage of any cacheing that may apply. MovieSceneCommonHelpers.h  

static UMovieSceneSection * FindNearestSectionAtTime ( TArrayView< UMovieSceneSection*const > Sections,
FFrameNumber Time,
int32 RowIndex
)

 Finds the nearest section to the given time MovieSceneCommonHelpers.h  

static UMovieSceneSection * FindNextSection ( TArrayView< UMovieSceneSection*const > Sections,
FFrameNumber Time
)

 Find the next section that doesn't overlap - the section that has the next closest start time to the requested start time MovieSceneCommonHelpers.h  

static UMovieSceneSection * FindPreviousSection ( TArrayView< UMovieSceneSection*const > Sections,
FFrameNumber Time
)

 Find the previous section that doesn't overlap - the section that has the previous closest start time to the requested start time MovieSceneCommonHelpers.h  

static UMovieSceneSection * FindSectionAtTime ( TArrayView< UMovieSceneSection*const > Sections,
FFrameNumber Time,
int32 RowIndex
)

 Finds a section that exists at a given time MovieSceneCommonHelpers.h  

static bool FixupConsecutiveBlendingSections ( TArray< UMovieSceneSection* >& Sections,
UMovieSceneSection& Section,
bool bDelete,
bool bCleanUp
)

 Fix up consecutive sections so that there are no gaps, but there can be overlaps, in which case the sections blend together. MovieSceneCommonHelpers.h  

static bool FixupConsecutiveSections ( TArray< UMovieSceneSection* >& Sections,
UMovieSceneSection& Section,
bool bDelete,
bool bCleanUp
)

 Fix up consecutive sections so that there are no gaps MovieSceneCommonHelpers.h  

static const UClass * GetBoundObjectClass ( UMovieSceneSequence* Sequence,
const FGuid& ObjectId,
int32 BindingIndex
)

 Returns the bound object class for the binding for the given ObjectId. MovieSceneCommonHelpers.h  

static TArray< UObject * > GetBoundObjects ( const FMovieSceneSequenceID& SequenceID,
const FGuid& ObjectId,
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState,
int32 BindingIndex
)

 Returns the objects currently bound to the given objectid and binding index (optional). MovieSceneCommonHelpers.h  

static void GetDescendantMovieScenes ( UMovieSceneSequence* InSequence,
TArray< UMovieScene* >& InMovieScenes
)

 Gather up descendant movie scenes from the incoming sequence MovieSceneCommonHelpers.h  

static void GetDescendantSubSections ( const UMovieScene* InMovieScene,
TArray< UMovieSceneSubSection* >& InSubSections
)

 Gather up descendant movie scene sub-sections from the incoming movie scene MovieSceneCommonHelpers.h  

static FText GetDisplayPathName ( const UMovieSceneTrack* Track
)

 Get displayable names MovieSceneCommonHelpers.h  

static FText GetDisplayPathName ( const UMovieSceneSection* Section
)

   MovieSceneCommonHelpers.h  

static FText GetDisplayPathName ( const UMovieSceneSection* Section,
const FMovieSceneChannel* Channel,
const FMovieSceneChannelMetaData& ChannelMetaData
)

   MovieSceneCommonHelpers.h  

static UObject * GetObjectTemplate ( UMovieSceneSequence* Sequence,
const FGuid& ObjectId,
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState,
int32 BindingIndex
)

 If the binding for the given ObjectId supports object templates, returns the template, otherwise returns nullptr MovieSceneCommonHelpers.h  

static void GetPrioritySortedCustomBindingTypes ( TArray< const TSubclassOf< UMovieSceneCustomBinding > >& OutCustomBindingTypes
)

 Returns a sorted list of all custom binding type classes currently known. MovieSceneCommonHelpers.h  

static UObject * GetResolutionContext ( UMovieSceneSequence* Sequence,
const FGuid& ObjectId,
const FMovieSceneSequenceID& SequenceID,
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState
)

 Finds the resolution context to use to resolve the given guid. MovieSceneCommonHelpers.h  

static const UMovieSceneCondition * GetSequenceCondition ( const UMovieSceneTrack* Track,
const UMovieSceneSection* Section,
bool bFromCompilation
)

 Given a movie scene track and an optional section inside it, returns an optional single condition that needs to be evaluated. MovieSceneCommonHelpers.h  

static UObject * GetSingleBoundObject ( UMovieSceneSequence* Sequence,
const FGuid& ObjectId,
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState,
int32 BindingIndex
)

   MovieSceneCommonHelpers.h  

static float GetSoundDuration ( USoundBase* Sound
)

 Get the duration for the given sound MovieSceneCommonHelpers.h  

static bool IsBoundToAnySpawnable ( UMovieSceneSequence* Sequence,
const FGuid& ObjectId,
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState
)

 Returns whether the given ObjectId is valid and is currently bound to at least 1 spawnable give the current context. MovieSceneCommonHelpers.h  

static bool IsBoundToSpawnable ( UMovieSceneSequence* Sequence,
const FGuid& ObjectId,
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState,
int32 BindingIndex
)

 Returns whether the given ObjectId is valid and is the given bindingindex is currently bound to a spawnable give the current context. MovieSceneCommonHelpers.h  

static bool IsSectionKeyable ( const UMovieSceneSection*
)

   MovieSceneCommonHelpers.h  

static UObject * MakeSpawnableTemplateFromInstance ( UObject& InSourceObject,
UMovieScene* InMovieScene,
FName InName
)

 Return a copy of the source object, suitable for use as a spawnable template. MovieSceneCommonHelpers.h  

static FString MakeUniqueBindingName ( UMovieScene* InMovieScene,
const FString& InName
)

 Return a name unique to the binding names in the given movie scene MovieSceneCommonHelpers.h  

static FString MakeUniqueSpawnableName ( UMovieScene* InMovieScene,
const FString& InName
)

 Return a name unique to the spawnable names in the given movie scene MovieSceneCommonHelpers.h  

static UObject * ResolveSceneComponentBoundObject ( UObject* Object
)

   MovieSceneCommonHelpers.h  

static USceneComponent * SceneComponentFromRuntimeObject ( UObject* Object
)

 Get the scene component from the runtime object MovieSceneCommonHelpers.h  

static bool SetObjectTemplate ( UMovieSceneSequence* Sequence,
const FGuid& ObjectId,
UObject* InSourceObject,
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState,
int32 BindingIndex
)

 If the binding for the given ObjectId supports object templates, sets the template and returns true, otherwise returns false MovieSceneCommonHelpers.h  

static void SetRuntimeObjectMobility ( UObject* Object,
EComponentMobility::Type ComponentMobility
)

 Set the runtime object movable MovieSceneCommonHelpers.h  

static void SortConsecutiveSections ( TArray< UMovieSceneSection* >& Sections
)

 Sort consecutive sections so that they are in order based on start time MovieSceneCommonHelpers.h  

static bool SortLowerBounds ( TRangeBound< FFrameNumber > A,
TRangeBound< FFrameNumber > B
)

 Sort predicate that sorts lower bounds of a range MovieSceneCommonHelpers.h  

static bool SortOverlappingSections ( const UMovieSceneSection* A,
const UMovieSceneSection* B
)

 Sort predicate that sorts overlapping sections by row primarily, then by overlap priority MovieSceneCommonHelpers.h  

static bool SortUpperBounds ( TRangeBound< FFrameNumber > A,
TRangeBound< FFrameNumber > B
)

 Sort predicate that sorts upper bounds of a range MovieSceneCommonHelpers.h  

static bool SupportsObjectTemplate ( UMovieSceneSequence* Sequence,
const FGuid& ObjectId,
TSharedRef< const UE::MovieScene::FSharedPlaybackState > SharedPlaybackState,
int32 BindingIndex
)

 Returns whether the binding for the given ObjectId supports object templates MovieSceneCommonHelpers.h  

static FGuid TryCreateCustomSpawnableBinding ( UMovieSceneSequence* Sequence,
UObject* CustomBindingObject
)

 Attempts to create a new custom spawnable binding for the passed in UObject*. MovieSceneCommonHelpers.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page