#include <MovieSceneCommonHelpers.h>

Classes
struct	FMovieSceneScopedPackageDirtyGuard

Static Public Member Functions
static MOVIESCENE_API FText	GetDisplayPathName (const UMovieSceneTrack *Track)

static MOVIESCENE_API FText	GetDisplayPathName (const UMovieSceneSection *Section)

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

static MOVIESCENE_API bool	IsSectionKeyable (const UMovieSceneSection *)

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

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

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

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

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

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

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

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

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

static MOVIESCENE_API USceneComponent *	SceneComponentFromRuntimeObject (UObject *Object)

static MOVIESCENE_API UObject *	ResolveSceneComponentBoundObject (UObject *Object)

static MOVIESCENE_API UCameraComponent *	CameraComponentFromActor (const AActor *InActor)

static MOVIESCENE_API UCameraComponent *	CameraComponentFromRuntimeObject (UObject *RuntimeObject)

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

static MOVIESCENE_API float	GetSoundDuration (USoundBase *Sound)

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

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

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

static MOVIESCENE_API float	CalculateWeightForBlending (UMovieSceneSection *SectionToKey, FFrameNumber Time)

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

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

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

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

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

static MOVIESCENE_API FGuid	TryCreateCustomSpawnableBinding (UMovieSceneSequence Sequence, UObject CustomBindingObject)

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

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

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

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

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

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

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

static TSharedRef< UE::MovieScene::FSharedPlaybackState > MOVIESCENE_API	CreateTransientSharedPlaybackState (UObject WorldContext, UMovieSceneSequence Sequence)

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

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

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

Member Function Documentation

◆ CalculateWeightForBlending()

float MovieSceneHelpers::CalculateWeightForBlending	(	UMovieSceneSection *	SectionToKey,
		FFrameNumber	Time
	)

static

◆ CameraComponentFromActor()

UCameraComponent * MovieSceneHelpers::CameraComponentFromActor ( const AActor * InActor )

static

Get the active camera component from the actor

Parameters

InActor The actor to look for the camera component on

Returns: The active camera component

◆ CameraComponentFromRuntimeObject()

UCameraComponent * MovieSceneHelpers::CameraComponentFromRuntimeObject ( UObject * RuntimeObject )

static

Find and return camera component from the runtime object

Parameters

Object The object to get the camera component for

Returns: The found camera component

◆ CopyObjectTemplate()

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

static

◆ CreateTransientSharedPlaybackState()

TSharedRef< UE::MovieScene::FSharedPlaybackState > MovieSceneHelpers::CreateTransientSharedPlaybackState	(	UObject *	WorldContext,
		UMovieSceneSequence *	Sequence
	)

static

◆ EvaluateSequenceCondition()

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

static

◆ FindNearestSectionAtTime()

UMovieSceneSection * MovieSceneHelpers::FindNearestSectionAtTime	(	TArrayView< UMovieSceneSection *const >	Sections,
		FFrameNumber	Time,
		int32	RowIndex = `INDEX_NONE`
	)

static

Finds the nearest section to the given time

Parameters

Time	The time to find a section at
RowIndex	Limit the search to a given row index

Returns: The found section or null

◆ FindNextSection()

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

static

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

◆ FindPreviousSection()

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

static

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

◆ FindSectionAtTime()

UMovieSceneSection * MovieSceneHelpers::FindSectionAtTime	(	TArrayView< UMovieSceneSection *const >	Sections,
		FFrameNumber	Time,
		int32	RowIndex = `INDEX_NONE`
	)

static

Finds a section that exists at a given time

Parameters

Time	The time to find a section at
RowIndex	Limit the search to a given row index

Returns: The found section or null

◆ FixupConsecutiveBlendingSections()

bool MovieSceneHelpers::FixupConsecutiveBlendingSections	(	TArray< UMovieSceneSection * > &	Sections,
		UMovieSceneSection &	Section,
		bool	bDelete,
		bool	bCleanUp = `false`
	)

static

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

Parameters

Sections	All the sections
Section	The section that was modified
bDelete	Was this a deletion?
bCleanUp	Should we cleanup any invalid sections?

Returns: Whether the list of sections was modified as part of the clean-up

◆ FixupConsecutiveSections()

bool MovieSceneHelpers::FixupConsecutiveSections	(	TArray< UMovieSceneSection * > &	Sections,
		UMovieSceneSection &	Section,
		bool	bDelete,
		bool	bCleanUp = `false`
	)

static

◆ GetBoundObjects()

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

static

◆ GetDescendantMovieScenes()

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

static

◆ GetDescendantSubSections()

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

static

◆ GetDisplayPathName() [1/3]

FText MovieSceneHelpers::GetDisplayPathName ( const UMovieSceneSection * Section )

static

◆ GetDisplayPathName() [2/3]

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

static

◆ GetDisplayPathName() [3/3]

FText MovieSceneHelpers::GetDisplayPathName ( const UMovieSceneTrack * Track )

static

Get displayable names

◆ GetObjectTemplate()

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

static

◆ GetPrioritySortedCustomBindingTypes()

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

static

◆ GetResolutionContext()

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

static

◆ GetSequenceCondition()

const UMovieSceneCondition * MovieSceneHelpers::GetSequenceCondition	(	const UMovieSceneTrack *	Track,
		const UMovieSceneSection *	Section,
		bool	bFromCompilation = `false`
	)

static

◆ GetSingleBoundObject()

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

static

◆ GetSoundDuration()

float MovieSceneHelpers::GetSoundDuration ( USoundBase * Sound )

static

◆ IsBoundToAnySpawnable()

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

static

◆ IsBoundToSpawnable()

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

static

◆ IsSectionKeyable()

bool MovieSceneHelpers::IsSectionKeyable ( const UMovieSceneSection * Section )

static

Returns: Whether the section is keyable (active, on a track that is not muted, etc

◆ MakeSpawnableTemplateFromInstance()

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

static

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

Parameters

InSourceObject	The source object to convert into a spawnable template
InMovieScene	The movie scene the spawnable template will be associated with
InName	The name to use for the spawnable template

Returns: The spawnable template

◆ MakeUniqueBindingName()

FString MovieSceneHelpers::MakeUniqueBindingName	(	UMovieScene *	InMovieScene,
		const FString &	InName
	)

static

◆ MakeUniqueSpawnableName()

FString MovieSceneHelpers::MakeUniqueSpawnableName	(	UMovieScene *	InMovieScene,
		const FString &	InName
	)

static

◆ ResolveSceneComponentBoundObject()

UObject * MovieSceneHelpers::ResolveSceneComponentBoundObject ( UObject * Object )

static

◆ SceneComponentFromRuntimeObject()

USceneComponent * MovieSceneHelpers::SceneComponentFromRuntimeObject ( UObject * Object )

static

Get the scene component from the runtime object

Parameters

Object The object to get the scene component for

Returns: The found scene component

◆ SetObjectTemplate()

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

static

◆ SetRuntimeObjectMobility()

static MOVIESCENE_API void MovieSceneHelpers::SetRuntimeObjectMobility	(	UObject *	Object,
		EComponentMobility::Type	ComponentMobility = `EComponentMobility::Movable`
	)

static

Set the runtime object movable

Parameters

Object	The object to set the mobility for
Mobility	The mobility of the runtime object

◆ SortConsecutiveSections()

void MovieSceneHelpers::SortConsecutiveSections ( TArray< UMovieSceneSection * > & Sections )

static

◆ SortLowerBounds()

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

inlinestatic

Sort predicate that sorts lower bounds of a range

◆ SortOverlappingSections()

bool MovieSceneHelpers::SortOverlappingSections	(	const UMovieSceneSection *	A,
		const UMovieSceneSection *	B
	)

static

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

◆ SortUpperBounds()

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

inlinestatic

Sort predicate that sorts upper bounds of a range

◆ SupportsObjectTemplate()

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

static

◆ TryCreateCustomSpawnableBinding()

FGuid MovieSceneHelpers::TryCreateCustomSpawnableBinding	(	UMovieSceneSequence *	Sequence,
		UObject *	CustomBindingObject
	)

static

The documentation for this class was generated from the following files:

Engine/Source/Runtime/MovieScene/Public/MovieSceneCommonHelpers.h
Engine/Source/Runtime/MovieScene/Private/MovieSceneCommonHelpers.cpp

Classes

Static Public Member Functions

Member Function Documentation

◆ CalculateWeightForBlending()

◆ CameraComponentFromActor()

◆ CameraComponentFromRuntimeObject()

◆ CopyObjectTemplate()

◆ CreateTransientSharedPlaybackState()

◆ EvaluateSequenceCondition()

◆ FindNearestSectionAtTime()

◆ FindNextSection()

◆ FindPreviousSection()

◆ FindSectionAtTime()

◆ FixupConsecutiveBlendingSections()

◆ FixupConsecutiveSections()

◆ GetBoundObjects()

◆ GetDescendantMovieScenes()

◆ GetDescendantSubSections()

◆ GetDisplayPathName() [1/3]

◆ GetDisplayPathName() [2/3]

◆ GetDisplayPathName() [3/3]

◆ GetObjectTemplate()

◆ GetPrioritySortedCustomBindingTypes()

◆ GetResolutionContext()

◆ GetSequenceCondition()

◆ GetSingleBoundObject()

◆ GetSoundDuration()

◆ IsBoundToAnySpawnable()

◆ IsBoundToSpawnable()

◆ IsSectionKeyable()

◆ MakeSpawnableTemplateFromInstance()

◆ MakeUniqueBindingName()

◆ MakeUniqueSpawnableName()

◆ ResolveSceneComponentBoundObject()

◆ SceneComponentFromRuntimeObject()

◆ SetObjectTemplate()

◆ SetRuntimeObjectMobility()

◆ SortConsecutiveSections()

◆ SortLowerBounds()

◆ SortOverlappingSections()

◆ SortUpperBounds()

◆ SupportsObjectTemplate()

◆ TryCreateCustomSpawnableBinding()