1. Epic GamesDeveloper
  3. FMovieSceneSpawnRegister

FMovieSceneSpawnRegister

Class responsible for managing spawnables in a movie scene

API > API/Runtime > API/Runtime/MovieScene

Class responsible for managing spawnables in a movie scene

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

Syntax

class FMovieSceneSpawnRegister : public TSharedFromThis< FMovieSceneSpawnRegister >

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  MovieSceneSpawnRegister.h  
  MovieSceneSpawnRegister.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FMovieSceneSpawnRegister()

 Virtual destructor MovieSceneSpawnRegister.h  

Structs

Name Remarks
FMovieSceneSpawnRegisterKey Helper key type for mapping a guid and sequence instance to a specific value
FSpawnedObject Structure holding information pertaining to a spawned object

Typedefs

Name Type Remarks Include Path
FSharedPlaybackState UE::MovieScene::FSharedPlaybackState   MovieSceneSpawnRegister.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool CanConvertSpawnableToPossessable ( FMovieSceneSpawnable& Spawnable
) const

   MovieSceneSpawnRegister.h  

virtual bool CanConvertToPossessable ( const FGuid& Guid,
FMovieSceneSequenceIDRef TemplateID,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
int32 BindingIndex
) const

 Check whether the specified binding can become a Possessable. MovieSceneSpawnRegister.h  

virtual bool CanSpawnObject ( UClass* InClass
) const

 Whether this class is supported as a spawnable MovieSceneSpawnRegister.h  

void CleanUp ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Called to indiscriminately clean up any spawned objects MovieSceneSpawnRegister.h  

void CleanUp ( IMovieScenePlayer& Player
)

   MovieSceneSpawnRegister.h  

void CleanUpSequence ( FMovieSceneSequenceIDRef TemplateID,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Called to clean up any non-externally owned spawnables that were spawned from the specified instance MovieSceneSpawnRegister.h  

void CleanUpSequence ( FMovieSceneSequenceIDRef TemplateID,
IMovieScenePlayer& Player
)

   MovieSceneSpawnRegister.h  

virtual TValueOrError< FNewSpawnable, FText > CreateNewSpawnableType ( UObject& SourceObject,
UMovieScene& OwnerMovieScene,
UActorFactory* ActorFactory
)

 Create a new spawnable type from the given source object MovieSceneSpawnRegister.h  

void DestroyObjectDirectly ( UObject& InObject
)

 Destroy a specific previously spawned object, where its binding ID and sequence ID is not known. MovieSceneSpawnRegister.h  

void DestroyObjectsByPredicate ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
const TFunctionRef< bool(const FGuid&, ESpawnOwnership, FMovieSceneSequenceIDRef, int32)>& Predica...
)

 Destroy spawned objects using a custom predicate MovieSceneSpawnRegister.h  

void DestroyObjectsByPredicate ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
const TFunctionRef< bool(const FGuid&, ESpawnOwnership, FMovieSceneSequenceIDRef)>& Predicate
)

   MovieSceneSpawnRegister.h  

void DestroyObjectsByPredicate ( IMovieScenePlayer& Player,
const TFunctionRef< bool(const FGuid&, ESpawnOwnership, FMovieSceneSequenceIDRef)>& Predicate
)

   MovieSceneSpawnRegister.h  

bool DestroySpawnedObject ( const FGuid& BindingId,
FMovieSceneSequenceIDRef TemplateID,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
int32 BindingIndex
)

 Destroy a specific previously spawned object MovieSceneSpawnRegister.h  

bool DestroySpawnedObject ( const FGuid& BindingId,
FMovieSceneSequenceIDRef TemplateID,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

   MovieSceneSpawnRegister.h  

bool DestroySpawnedObject ( const FGuid& BindingId,
FMovieSceneSequenceIDRef TemplateID,
IMovieScenePlayer& Player
)

   MovieSceneSpawnRegister.h  

TWeakObjectPtr FindSpawnedObject ( const FGuid& BindingId,
FMovieSceneSequenceIDRef TemplateID,
int BindingIndex
) const

 Attempt to find a previously spawned object represented by the specified object and template IDs MovieSceneSpawnRegister.h  

TWeakObjectPtr FindSpawnedObject ( const FGuid& BindingId,
FMovieSceneSequenceIDRef TemplateID
) const

   MovieSceneSpawnRegister.h  

void ForgetExternallyOwnedSpawnedObjects ( TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Purge any memory of any objects that are considered externally owned MovieSceneSpawnRegister.h  
  MovieSceneSpawnRegister.h  

virtual void HandleConvertPossessableToSpawnable ( UObject* OldObject,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
TOptional< FTransformData >& OutTransformData
)

 Called to handle cleanup of objects when we convert a possessable to a spawnable object MovieSceneSpawnRegister.h  

void HandleConvertPossessableToSpawnable ( UObject* OldObject,
IMovieScenePlayer& Player,
TOptional< FTransformData >& OutTransformData
)

   MovieSceneSpawnRegister.h  

void OnSequenceExpired ( FMovieSceneSequenceIDRef TemplateID,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Called when the current time has moved beyond the specified sequence's play range MovieSceneSpawnRegister.h  

void OnSequenceExpired ( FMovieSceneSequenceIDRef TemplateID,
IMovieScenePlayer& Player
)

   MovieSceneSpawnRegister.h  

virtual void SaveDefaultSpawnableState ( const FGuid& Guid,
int32 BindingIndex,
FMovieSceneSequenceIDRef TemplateID,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Called to save the default state of the specified spawnable MovieSceneSpawnRegister.h  

virtual void SaveDefaultSpawnableState ( const FGuid& Guid,
FMovieSceneSequenceIDRef TemplateID,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Backwards compatible API, to be deprecated later. MovieSceneSpawnRegister.h  

virtual void SaveDefaultSpawnableState ( FMovieSceneSpawnable& Spawnable,
FMovieSceneSequenceIDRef TemplateID,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

   MovieSceneSpawnRegister.h  

void SaveDefaultSpawnableState ( FMovieSceneSpawnable& Spawnable,
FMovieSceneSequenceIDRef TemplateID,
IMovieScenePlayer& Player
)

   MovieSceneSpawnRegister.h  

virtual void SetupDefaultsForSpawnable ( UObject* SpawnedObject,
const FGuid& Guid,
const TOptional< FTransformData >& TransformData,
TSharedRef< ISequencer > Sequencer,
USequencerSettings* Settings
)

 Setup a new spawnable object with some default tracks and keys MovieSceneSpawnRegister.h  

virtual UObject * SpawnObject ( const FGuid& BindingId,
UMovieScene& MovieScene,
FMovieSceneSequenceIDRef Template,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

   MovieSceneSpawnRegister.h  

UObject * SpawnObject ( const FGuid& BindingId,
UMovieScene& MovieScene,
FMovieSceneSequenceIDRef Template,
IMovieScenePlayer& Player
)

   MovieSceneSpawnRegister.h  

UObject * SpawnObject ( FMovieSceneSpawnable& Spawnable,
FMovieSceneSequenceIDRef TemplateID,
IMovieScenePlayer& Player
)

   MovieSceneSpawnRegister.h  

virtual UObject * SpawnObject ( const FGuid& BindingId,
UMovieScene& MovieScene,
FMovieSceneSequenceIDRef Template,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState,
int32 BindingIndex
)

 Spawn an object for the specified GUID, from the specified sequence instance. MovieSceneSpawnRegister.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void DestroySpawnedObject ( UObject& Object
)

   MovieSceneSpawnRegister.h  

void DestroySpawnedObject ( UObject& Object,
UMovieSceneSpawnableBindingBase* CustomSpawnableBinding
)

 Destroy a specific previously spawned object MovieSceneSpawnRegister.h  

virtual void PreDestroyObject ( UObject& Object,
const FGuid& BindingId,
int32 BindingIndex,
FMovieSceneSequenceIDRef TemplateID
)

   MovieSceneSpawnRegister.h  

virtual void PreDestroyObject ( UObject& Object,
const FGuid& BindingId,
FMovieSceneSequenceIDRef TemplateID
)

 Called right before a spawned object with the specified ID and template ID is destroyed MovieSceneSpawnRegister.h  

UObject * SpawnObject ( FMovieSceneSpawnable& Spawnable,
FMovieSceneSequenceIDRef TemplateID,
TSharedRef< const FSharedPlaybackState > SharedPlaybackState
)

 Spawn an object for the specified GUID, from the specified sequence instance. MovieSceneSpawnRegister.h  

Static

Name Remarks Include Path Unreal Specifiers

static MOVIESCENE_APIUE::MovieScene::TPlaybackCapabilityID< FMovieSceneSpawnRegister > GetPlaybackCapabilityID()

   MovieSceneSpawnRegister.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page