IMovieSceneObjectSpawner.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "MovieSceneSequenceID.h"
#include "Templates/ValueOrError.h"
 
struct FMovieSceneSpawnable;
class IMovieScenePlayer;
class UMovieScene;
class IMovieSceneObjectSpawner;
class ISequencer;
class USequencerSettings;
class UActorFactory;
struct FTransformData;
 
namespace UE::MovieScene
{
    struct FSharedPlaybackState;
}
 
DECLARE_DELEGATE_RetVal(TSharedRef<IMovieSceneObjectSpawner>, FOnCreateMovieSceneObjectSpawner);
 
struct FNewSpawnable
{
    FNewSpawnable() : ObjectTemplate(nullptr) {}
    FNewSpawnable(UObject* InObjectTemplate, FString InName) : ObjectTemplate(InObjectTemplate), Name(MoveTemp(InName)) {}
 
    UObject* ObjectTemplate;
 
    FString Name;
};
 
 
class IMovieSceneObjectSpawner
{
public:
    virtual UClass* GetSupportedTemplateType() const = 0;
 
    virtual UObject* SpawnObject(FMovieSceneSpawnable& Spawnable, FMovieSceneSequenceIDRef TemplateID, TSharedRef<const UE::MovieScene::FSharedPlaybackState> SharedPlaybackState) = 0;
 
    virtual void DestroySpawnedObject(UObject& Object) = 0;
 
    virtual bool IsEditor() const { return false; }
 
    virtual int32 GetSpawnerPriority() const { return 0; }
 
#if WITH_EDITOR
    
    virtual TValueOrError<FNewSpawnable, FText> CreateNewSpawnableType(UObject& SourceObject, UMovieScene& OwnerMovieScene, UActorFactory* ActorFactory = nullptr) { return MakeError(NSLOCTEXT("IMovieSceneObjectSpawner", "NotSupported", "Not supported")); }
 
    virtual void SetupDefaultsForSpawnable(UObject* SpawnedObject, const FGuid& Guid, const TOptional<FTransformData>& TransformData, TSharedRef<ISequencer> Sequencer, USequencerSettings* Settings) {}
 
    /*
     * Whether this spawner can set up defaults
     *
     * @param   SpawnedObject   The newly spawned object. This may be NULL in the case of a spawnable that has not yet been spawned.
     * @return whether this spawned can set up defaults
     */
    virtual bool CanSetupDefaultsForSpawnable(UObject* SpawnedObject) const { return SpawnedObject ? SpawnedObject->IsA(GetSupportedTemplateType()) : false; }
 
    virtual bool CanConvertSpawnableToPossessable(FMovieSceneSpawnable& Spawnable) const { return true; }
 
#endif
 
public:
 
    virtual ~IMovieSceneObjectSpawner() { }
};