MovieSceneComponentMaterialParameterSection.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "UObject/ObjectMacros.h"
#include "Curves/KeyHandle.h"
#include "Curves/RichCurve.h"
#include "MovieSceneSection.h"
#include "Channels/MovieSceneFloatChannel.h"
#include "EntitySystem/IMovieSceneEntityProvider.h"
#include "Materials/MaterialParameters.h"
#include "MovieSceneComponentMaterialParameterSection.generated.h"
 
USTRUCT()
struct FScalarMaterialParameterInfoAndCurve
{
    GENERATED_USTRUCT_BODY()
 
        FScalarMaterialParameterInfoAndCurve()
    {}
 
    MOVIESCENETRACKS_API FScalarMaterialParameterInfoAndCurve(const FMaterialParameterInfo& InParameterInfo);
 
    UPROPERTY()
    FMaterialParameterInfo ParameterInfo;
 
    UPROPERTY()
    FMovieSceneFloatChannel ParameterCurve;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    FString ParameterLayerName;
 
    UPROPERTY()
    FString ParameterAssetName;
#endif
};
 
USTRUCT()
struct FColorMaterialParameterInfoAndCurves
{
    GENERATED_USTRUCT_BODY()
 
    FColorMaterialParameterInfoAndCurves()
    {}
 
    MOVIESCENETRACKS_API FColorMaterialParameterInfoAndCurves(const FMaterialParameterInfo& InParameterInfo);
 
    UPROPERTY()
    FMaterialParameterInfo ParameterInfo;
 
    UPROPERTY()
    FMovieSceneFloatChannel RedCurve;
 
    UPROPERTY()
    FMovieSceneFloatChannel GreenCurve;
 
    UPROPERTY()
    FMovieSceneFloatChannel BlueCurve;
 
    UPROPERTY()
    FMovieSceneFloatChannel AlphaCurve;
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    FString ParameterLayerName;
 
    UPROPERTY()
    FString ParameterAssetName;
 
    /* Optional UI names for parameter channels, if applicable */
    UPROPERTY()
    FParameterChannelNames ParameterChannelNames;
#endif
};
 
UCLASS(MinimalAPI)
class UMovieSceneComponentMaterialParameterSection
    : public UMovieSceneSection
    , public IMovieSceneEntityProvider
{
    GENERATED_UCLASS_BODY()
 
public:
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API void AddScalarParameterKey(const FMaterialParameterInfo& InParameterInfo, FFrameNumber InTime, float InValue, const FString& InLayerName, const FString& InAssetName, EMovieSceneKeyInterpolation DefaultInterpolation = EMovieSceneKeyInterpolation::Auto);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API void AddColorParameterKey(const FMaterialParameterInfo& InParameterInfo, FFrameNumber InTime, FLinearColor InValue, const FString& InLayerName, const FString& InAssetName, const FParameterChannelNames& InChannelNames=FParameterChannelNames(), EMovieSceneKeyInterpolation DefaultInterpolation = EMovieSceneKeyInterpolation::Auto);
 
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API bool RemoveScalarParameter(const FMaterialParameterInfo& InParameterInfo);
    
    UFUNCTION(BlueprintCallable, Category = "Sequencer|Section")
    MOVIESCENETRACKS_API bool RemoveColorParameter(const FMaterialParameterInfo& InParameterInfo);
 
 
#if WITH_EDITOR
    MOVIESCENETRACKS_API bool RemoveScalarParameter(FName InParameterPath);
 
    MOVIESCENETRACKS_API bool RemoveColorParameter(FName InParameterPath);
#endif
 
    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);
 
 
public:
    
    UPROPERTY()
    TArray<FScalarMaterialParameterInfoAndCurve> ScalarParameterInfosAndCurves;
 
    UPROPERTY()
    TArray<FColorMaterialParameterInfoAndCurves> ColorParameterInfosAndCurves;
 
protected:
 
    //~ UMovieSceneSection interface
    virtual EMovieSceneChannelProxyType CacheChannelProxy() override;
    MOVIESCENETRACKS_API virtual void PostEditImport() override;
#if WITH_EDITOR
    MOVIESCENETRACKS_API virtual void PostEditUndo() override;
#endif
};