1. Epic GamesDeveloper
  3. MovieSceneHelpers

MovieSceneHelpers

API > API/Runtime > API/Runtime/MovieScene

References

   
Module MovieScene
Header /Engine/Source/Runtime/MovieScene/Public/MovieSceneCommonHelpers.h
Include #include "MovieSceneCommonHelpers.h"

Syntax

class MovieSceneHelpers

Functions

  Type Name Description
Public function 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.
Public function Static UCameraComponent *

CameraComponentFromActor ( const AActor* InActor
)

 Get the active camera component from the actor
Public function Static UCameraComponent *

CameraComponentFromRuntimeObject ( UObject* RuntimeObject
)

 Find and return camera component from the runtime object
Public function 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
Public function Static TSharedRef< UE::MovieScene::FSharedPlaybackState >

CreateTransientSharedPlaybackState ( UObject* WorldContext,
UMovieSceneSequence* Sequence
)

 For cases where the user does not have a IMovieScenePlayer with a shared playback state, creates a transient one.
Public function 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.
Public function Static UMovieSceneSection *

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

 Finds the nearest section to the given time
Public function 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
Public function 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
Public function Static UMovieSceneSection *

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

 Finds a section that exists at a given time
Public function 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.
Public function Static bool

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

 Fix up consecutive sections so that there are no gaps
Public function Static const UClass *

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

 Returns the bound object class for the binding for the given ObjectId.
Public function Static void

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

 Gather up descendant movie scenes from the incoming sequence
Public function Static void

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

 Gather up descendant movie scene sub-sections from the incoming movie scene
Public function 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
Public function Static void

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

 Returns a sorted list of all custom binding type classes currently known.
Public function 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.
Public function 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.
Public function Static UObject *

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

 Returns the single bound object currently bound to the given objectid and binding index (optional).
Public function Static float

GetSoundDuration ( USoundBase* Sound
)

 Get the duration for the given sound
Public function 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.
Public function 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.
Public function Static bool  
Public function Static UObject *

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

 Return a copy of the source object, suitable for use as a spawnable template.
Public function Static FString

MakeUniqueBindingName ( UMovieScene* InMovieScene,
const FString& InName
)

 Return a name unique to the binding names in the given movie scene
Public function Static FString

MakeUniqueSpawnableName ( UMovieScene* InMovieScene,
const FString& InName
)

 Return a name unique to the spawnable names in the given movie scene
Public function Static UObject *

ResolveSceneComponentBoundObject ( UObject* Object
)

  
Public function Static USceneComponent *

SceneComponentFromRuntimeObject ( UObject* Object
)

 Get the scene component from the runtime object
Public function 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
Public function Static void

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

 Set the runtime object movable
Public function Static void

SortConsecutiveSections ( TArray< UMovieSceneSection* >& Sections
)

 Sort consecutive sections so that they are in order based on start time
Public function Static bool

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

 Sort predicate that sorts lower bounds of a range
Public function Static bool Sort predicate that sorts overlapping sections by row primarily, then by overlap priority
Public function Static bool

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

 Sort predicate that sorts upper bounds of a range
Public function 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
Public function Static FGuid

TryCreateCustomSpawnableBinding ( UMovieSceneSequence* Sequence,
UObject* CustomBindingObject
)

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

Classes

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page