MovieSceneParameterSection.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Curves/KeyHandle.h"
#include "Curves/RichCurve.h"
#include "MovieSceneSection.h"
#include "Channels/MovieSceneFloatChannel.h"
#include "Channels/MovieSceneBoolChannel.h"
#include "Sections/MovieScene3DTransformSection.h"
#include "EntitySystem/IMovieSceneEntityProvider.h"
#include "MovieSceneParameterSection.generated.h"
 
struct FMovieSceneParameterPropertyInterface;
struct FMovieSceneConstParameterPropertyInterface;
 
 
UINTERFACE(MinimalAPI)
class UMovieSceneParameterSectionExtender : public UInterface
{
public:
    GENERATED_BODY()
};
 
class IMovieSceneParameterSectionExtender
{
public:
 
    GENERATED_BODY()
 
    MOVIESCENETRACKS_API void ExtendEntity(UMovieSceneParameterSection* Section, UMovieSceneEntitySystemLinker* EntityLinker, const UE::MovieScene::FEntityImportParams& Params, UE::MovieScene::FImportedEntity* OutImportedEntity);
 
private:
 
    virtual void ExtendEntityImpl(UMovieSceneParameterSection* Section, UMovieSceneEntitySystemLinker* EntityLinker, const UE::MovieScene::FEntityImportParams& Params, UE::MovieScene::FImportedEntity* OutImportedEntity) = 0;
};
 
 
 
struct FScalarParameterNameAndValue
{
    FScalarParameterNameAndValue(FName InParameterName, float InValue)
    {
        ParameterName = InParameterName;
        Value = InValue;
    }
 
    FName ParameterName;
 
    float Value;
};
 
struct FBoolParameterNameAndValue
{
    FBoolParameterNameAndValue(FName InParameterName, bool InValue)
    {
        ParameterName = InParameterName;
        Value = InValue;
    }
 
    FName ParameterName;
 
    bool Value;
};
 
struct FVector2DParameterNameAndValue
{
    FVector2DParameterNameAndValue(FName InParameterName, FVector2D InValue)
    {
        ParameterName = InParameterName;
        Value = InValue;
    }
 
    FName ParameterName;
 
    FVector2D Value;
};
 
struct FVectorParameterNameAndValue
{
    FVectorParameterNameAndValue(FName InParameterName, FVector InValue)
    {
        ParameterName = InParameterName;
        Value = InValue;
    }
 
    FName ParameterName;
 
    FVector Value;
};
 
struct FColorParameterNameAndValue
{
    FColorParameterNameAndValue(FName InParameterName, FLinearColor InValue)
    {
        ParameterName = InParameterName;
        Value = InValue;
    }
 
    FName ParameterName;
 
    FLinearColor Value;
};
 
struct FTransformParameterNameAndValue
{
 
    FName ParameterName;
    FVector Translation;
    FRotator Rotation;
    FVector Scale;
 
    FTransformParameterNameAndValue(FName InParameterName,const FVector& InTranslation,
        const FRotator& InRotation, const FVector& InScale) : Translation(InTranslation),
        Rotation(InRotation), Scale(InScale)
    {
        ParameterName = InParameterName;    
    }
};
 
USTRUCT()
struct FBaseParameterNameAndValue
{
    GENERATED_USTRUCT_BODY()
 
    FBaseParameterNameAndValue()
    : ParameterName(NAME_None)
    {}
 
    FBaseParameterNameAndValue(FName InParameterName)
    : ParameterName(InParameterName)
    {}
 
    UPROPERTY()
    FName ParameterName;
};
 
USTRUCT()
struct FBoolParameterNameAndCurve : public FBaseParameterNameAndValue
{
    GENERATED_USTRUCT_BODY()
 
    FBoolParameterNameAndCurve()
    {}
 
    FBoolParameterNameAndCurve(FName InParameterName)
    : FBaseParameterNameAndValue(InParameterName)
    {}
 
    UPROPERTY()
    FMovieSceneBoolChannel ParameterCurve;
};
 
USTRUCT()
struct FScalarParameterNameAndCurve : public FBaseParameterNameAndValue
{
    GENERATED_USTRUCT_BODY()
 
    FScalarParameterNameAndCurve()
    {}
 
    FScalarParameterNameAndCurve(FName InParameterName)
    : FBaseParameterNameAndValue(InParameterName)
    {}
 
    UPROPERTY()
    FMovieSceneFloatChannel ParameterCurve;
};
 
USTRUCT()
struct FVector2DParameterNameAndCurves : public FBaseParameterNameAndValue
{
    GENERATED_USTRUCT_BODY()
 
    FVector2DParameterNameAndCurves()
    {}
 
    FVector2DParameterNameAndCurves(FName InParameterName)
    : FBaseParameterNameAndValue(InParameterName)
    {}
 
    UPROPERTY()
    FMovieSceneFloatChannel XCurve;
 
    UPROPERTY()
    FMovieSceneFloatChannel YCurve;
 
};
 
 
USTRUCT()
struct FVectorParameterNameAndCurves : public FBaseParameterNameAndValue
{
    GENERATED_USTRUCT_BODY()
 
    FVectorParameterNameAndCurves()
    {}
 
    FVectorParameterNameAndCurves(FName InParameterName)
    : FBaseParameterNameAndValue(InParameterName)
    {}
 
    UPROPERTY()
    FMovieSceneFloatChannel XCurve;
 
    UPROPERTY()
    FMovieSceneFloatChannel YCurve;
 
    UPROPERTY()
    FMovieSceneFloatChannel ZCurve;
};
 
 
USTRUCT()
struct FColorParameterNameAndCurves : public FBaseParameterNameAndValue
{
    GENERATED_USTRUCT_BODY()
 
    FColorParameterNameAndCurves()
    {}
 
    FColorParameterNameAndCurves(FName InParameterName)
    : FBaseParameterNameAndValue(InParameterName)
    {}
 
    UPROPERTY()
    FMovieSceneFloatChannel RedCurve;
 
    UPROPERTY()
    FMovieSceneFloatChannel GreenCurve;
 
    UPROPERTY()
    FMovieSceneFloatChannel BlueCurve;
 
    UPROPERTY()
    FMovieSceneFloatChannel AlphaCurve;
};
 
USTRUCT()
struct FTransformParameterNameAndCurves : public FBaseParameterNameAndValue
{
    GENERATED_USTRUCT_BODY()
 
    FTransformParameterNameAndCurves()
    {}
 
    FTransformParameterNameAndCurves(FName InParameterName)
    : FBaseParameterNameAndValue(InParameterName)
    {}
 
    UPROPERTY()
    FMovieSceneFloatChannel Translation[3];
 
    UPROPERTY()
    FMovieSceneFloatChannel Rotation[3];
 
    UPROPERTY()
    FMovieSceneFloatChannel Scale[3];
};
UCLASS(MinimalAPI)
class UMovieSceneParameterSection
    : public UMovieSceneSection
    , public IMovieSceneEntityProvider
{
    GENERATED_UCLASS_BODY()
 
public:
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API void AddScalarParameterKey(FName InParameterName, FFrameNumber InTime, float InValue, EMovieSceneKeyInterpolation DefaultInterpolation = EMovieSceneKeyInterpolation::Auto);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API void AddBoolParameterKey(FName InParameterName, FFrameNumber InTime, bool InValue);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API void AddVector2DParameterKey(FName InParameterName, FFrameNumber InTime, FVector2D InValue, EMovieSceneKeyInterpolation DefaultInterpolation = EMovieSceneKeyInterpolation::Auto);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API void AddVectorParameterKey(FName InParameterName, FFrameNumber InTime, FVector InValue, EMovieSceneKeyInterpolation DefaultInterpolation = EMovieSceneKeyInterpolation::Auto);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API void AddColorParameterKey(FName InParameterName, FFrameNumber InTime, FLinearColor InValue, EMovieSceneKeyInterpolation DefaultInterpolation = EMovieSceneKeyInterpolation::Auto);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API void AddTransformParameterKey(FName InParameterName, FFrameNumber InTime, const FTransform& InValue, EMovieSceneKeyInterpolation DefaultInterpolation = EMovieSceneKeyInterpolation::Auto);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API bool RemoveScalarParameter(FName InParameterName);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API bool RemoveBoolParameter(FName InParameterName);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API bool RemoveVector2DParameter(FName InParameterName);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API bool RemoveVectorParameter(FName InParameterName);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API bool RemoveColorParameter(FName InParameterName);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API bool RemoveTransformParameter(FName InParameterName);
 
    MOVIESCENETRACKS_API TArray<FScalarParameterNameAndCurve>& GetScalarParameterNamesAndCurves();
    MOVIESCENETRACKS_API const TArray<FScalarParameterNameAndCurve>& GetScalarParameterNamesAndCurves() const;
 
    MOVIESCENETRACKS_API TArray<FBoolParameterNameAndCurve>& GetBoolParameterNamesAndCurves();
    MOVIESCENETRACKS_API const TArray<FBoolParameterNameAndCurve>& GetBoolParameterNamesAndCurves() const;
 
    MOVIESCENETRACKS_API TArray<FVector2DParameterNameAndCurves>& GetVector2DParameterNamesAndCurves();
    MOVIESCENETRACKS_API const TArray<FVector2DParameterNameAndCurves>& GetVector2DParameterNamesAndCurves() const;
 
    MOVIESCENETRACKS_API TArray<FVectorParameterNameAndCurves>& GetVectorParameterNamesAndCurves();
    MOVIESCENETRACKS_API const TArray<FVectorParameterNameAndCurves>& GetVectorParameterNamesAndCurves() const;
 
    MOVIESCENETRACKS_API TArray<FColorParameterNameAndCurves>& GetColorParameterNamesAndCurves();
    MOVIESCENETRACKS_API const TArray<FColorParameterNameAndCurves>& GetColorParameterNamesAndCurves() const;
 
    MOVIESCENETRACKS_API TArray<FTransformParameterNameAndCurves>& GetTransformParameterNamesAndCurves();
    MOVIESCENETRACKS_API const TArray<FTransformParameterNameAndCurves>& GetTransformParameterNamesAndCurves() const;
 
    UFUNCTION(BlueprintPure, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API void GetParameterNames(TSet<FName>& ParameterNames) const;
 
    MOVIESCENETRACKS_API virtual void ImportEntityImpl(UMovieSceneEntitySystemLinker* EntityLinker, const FEntityImportParams& Params, FImportedEntity* OutImportedEntity) override;
    MOVIESCENETRACKS_API virtual bool PopulateEvaluationFieldImpl(const TRange<FFrameNumber>& EffectiveRange, const FMovieSceneEvaluationFieldEntityMetaData& InMetaData, FMovieSceneEntityComponentFieldBuilder* OutFieldBuilder) override;
 
    MOVIESCENETRACKS_API void ExternalPopulateEvaluationField(const TRange<FFrameNumber>& EffectiveRange, const FMovieSceneEvaluationFieldEntityMetaData& InMetaData, FMovieSceneEntityComponentFieldBuilder* OutFieldBuilder);
 
protected:
 
    //~ UMovieSceneSection interface
    MOVIESCENETRACKS_API virtual void Serialize(FArchive& Ar) override;
    MOVIESCENETRACKS_API virtual void PostEditImport() override;
    MOVIESCENETRACKS_API virtual void ReconstructChannelProxy();
 
protected:
    UPROPERTY()
    TArray<FBoolParameterNameAndCurve> BoolParameterNamesAndCurves;
 
    UPROPERTY()
    TArray<FScalarParameterNameAndCurve> ScalarParameterNamesAndCurves;
 
    UPROPERTY()
    TArray<FVector2DParameterNameAndCurves> Vector2DParameterNamesAndCurves;
 
    UPROPERTY()
    TArray<FVectorParameterNameAndCurves> VectorParameterNamesAndCurves;
 
    UPROPERTY()
    TArray<FColorParameterNameAndCurves> ColorParameterNamesAndCurves;
 
    UPROPERTY()
    TArray<FTransformParameterNameAndCurves> TransformParameterNamesAndCurves;
};