UnrealEngine/Engine/Source/Runtime/MovieScene/Private/Tests/MovieSceneTestObjects.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "MovieScene.h"
#include "MovieSceneTrack.h"
#include "MovieSceneSection.h"
#include "MovieSceneSequence.h"
#include "Evaluation/MovieSceneEvalTemplate.h"
#include "GameFramework/Actor.h"
#include "Sections/MovieSceneSubSection.h"
#include "Sections/MovieSceneHookSection.h"
#include "Tracks/MovieSceneSubTrack.h"
#include "Compilation/IMovieSceneTrackTemplateProducer.h"

#include "MovieSceneTestObjects.generated.h"

USTRUCT()
struct FTestMovieSceneEvalTemplate : public FMovieSceneEvalTemplate
{
	GENERATED_BODY()

	virtual UScriptStruct& GetScriptStructImpl() const { return *StaticStruct(); }
};

UCLASS(MinimalAPI)
class UTestMovieSceneTrack : public UMovieSceneTrack, public IMovieSceneTrackTemplateProducer
{
public:

	GENERATED_BODY()

	virtual const TArray<UMovieSceneSection*>& GetAllSections() const override { return SectionArray; }
	virtual FMovieSceneEvalTemplatePtr CreateTemplateForSection(const UMovieSceneSection& InSection) const override;

	virtual bool IsEmpty() const override;
	virtual bool SupportsType(TSubclassOf<UMovieSceneSection> SectionClass) const override;
	virtual void AddSection(UMovieSceneSection& Section) override;
	virtual class UMovieSceneSection* CreateNewSection() override;
	virtual bool HasSection(const UMovieSceneSection& Section) const override;
	virtual void RemoveSection(UMovieSceneSection& Section) override;
	virtual void RemoveSectionAt(int32 SectionIndex) override;

#if WITH_EDITORONLY_DATA
	virtual FText GetDisplayName() const override { return FText::FromString(TEXT("Unnamed Track")); }
#endif

	UPROPERTY()
	bool bHighPassFilter;

	UPROPERTY()
	TArray<TObjectPtr<UMovieSceneSection>> SectionArray;
};

UCLASS(MinimalAPI)
class UTestMovieSceneSection : public UMovieSceneSection
{
public:
	GENERATED_BODY()
};

UCLASS(MinimalAPI)
class UTestMovieSceneSequence : public UMovieSceneSequence
{
public:
	GENERATED_BODY()

	UTestMovieSceneSequence(const FObjectInitializer& ObjInit)
		: Super(ObjInit)
	{
		if (!HasAnyFlags(RF_ClassDefaultObject))
		{
			MovieScene = ObjInit.CreateDefaultSubobject<UMovieScene>(this, "MovieScene");
		}
	}

	//~ UMovieSceneSequence interface
	virtual void BindPossessableObject(const FGuid& ObjectId, UObject& PossessedObject, UObject* Context) override {}
	virtual bool CanPossessObject(UObject& Object, UObject* InPlaybackContext) const override { return false; }
	virtual void LocateBoundObjects(const FGuid& ObjectId, UObject* Context, TArray<UObject*, TInlineAllocator<1>>& OutObjects) const override {}
	virtual UObject* GetParentObject(UObject* Object) const override { return nullptr; }
	virtual void UnbindPossessableObjects(const FGuid& ObjectId) override {}
	virtual void UnbindObjects(const FGuid& ObjectId, const TArray<UObject*>& InObjects, UObject* Context) override {}
	virtual void UnbindInvalidObjects(const FGuid& ObjectId, UObject* Context) override {}
	virtual UMovieScene* GetMovieScene() const override { return MovieScene; }

	UPROPERTY()
	TObjectPtr<UMovieScene> MovieScene;
};

UCLASS(MinimalAPI)
class UTestMovieSceneSubTrack : public UMovieSceneSubTrack
{
public:
	GENERATED_BODY()

	virtual const TArray<UMovieSceneSection*>& GetAllSections() const override { return SectionArray; }

	UPROPERTY()
	TArray<TObjectPtr<UMovieSceneSection>> SectionArray;
};

UCLASS(MinimalAPI)
class UTestMovieSceneSubSection : public UMovieSceneSubSection
{
	GENERATED_BODY()
};

UCLASS(MinimalAPI)
class UTestMovieSceneEvalHookTrack : public UMovieSceneTrack
{
public:
	GENERATED_BODY()

	virtual const TArray<UMovieSceneSection*>& GetAllSections() const override { return SectionArray; }

	virtual bool IsEmpty() const override;
	virtual bool SupportsType(TSubclassOf<UMovieSceneSection> SectionClass) const override;
	virtual void AddSection(UMovieSceneSection& Section) override;
	virtual UMovieSceneSection* CreateNewSection() override;
	virtual bool HasSection(const UMovieSceneSection& Section) const override;
	virtual void RemoveSection(UMovieSceneSection& Section) override;
	virtual void RemoveSectionAt(int32 SectionIndex) override;
#if WITH_EDITORONLY_DATA
	virtual FText GetDisplayName() const override { return FText(); }
#endif

	UPROPERTY()
	TArray<TObjectPtr<UMovieSceneSection>> SectionArray;
};

UCLASS(MinimalAPI)
class UTestMovieSceneEvalHookSection : public UMovieSceneHookSection
{
public:
	GENERATED_BODY()

	UTestMovieSceneEvalHookSection(const FObjectInitializer& ObjInit)
		: Super(ObjInit)
	{
		bRequiresRangedHook = true;
		bRequiresTriggerHooks = true;
		EvalOptions.CompletionMode = EMovieSceneCompletionMode::RestoreState;
	}

	int32 StartValue = 1000;
	int32 EndValue   = 2000;

	TArray<FFrameNumber> TriggerTimes;

	virtual void Begin(TSharedRef<FSharedPlaybackState> SharedPlaybackState, const UE::MovieScene::FEvaluationHookParams& Params) const override;
	virtual void Update(TSharedRef<FSharedPlaybackState> SharedPlaybackState, const UE::MovieScene::FEvaluationHookParams& Params) const override;
	virtual void End(TSharedRef<FSharedPlaybackState> SharedPlaybackState, const UE::MovieScene::FEvaluationHookParams& Params) const override;
	virtual void Trigger(TSharedRef<FSharedPlaybackState> SharedPlaybackState, const UE::MovieScene::FEvaluationHookParams& Params) const override;

	virtual TArrayView<const FFrameNumber> GetTriggerTimes() const
	{
		return TriggerTimes;
	}
};

USTRUCT(BlueprintType)
struct FTestMovieSceneStruct
{
	GENERATED_BODY()

	UPROPERTY(EditAnywhere, BlueprintReadWrite, Interp, Category="Test")
	float First = 0.f;

	UPROPERTY(EditAnywhere, BlueprintReadWrite, Interp, Category="Test")
	float Second = 0.f;

	UPROPERTY(EditAnywhere, BlueprintReadWrite, Interp, Category="Test")
	FVector Vector = FVector::ZeroVector;
};

UCLASS(MinimalAPI, BlueprintType)
class ATestMovieSceneArrayPropertiesActor : public AActor
{
	GENERATED_BODY()

public:

	UPROPERTY(EditAnywhere, BlueprintReadWrite, Interp, Category="Test")
	FVector TestVector;

	UPROPERTY(EditAnywhere, BlueprintReadWrite, Interp, Category="Test")
	TArray<float> MultipleFloats;

	UPROPERTY(EditAnywhere, BlueprintReadWrite, Interp, Category="Test")
	FTestMovieSceneStruct SingleStruct;

	UPROPERTY(EditAnywhere, BlueprintReadWrite, Interp, Category="Test")
	TArray<FTestMovieSceneStruct> MultipleStructs;

	ATestMovieSceneArrayPropertiesActor(const FObjectInitializer& ObjInit)
		: AActor(ObjInit)
	{}
};