MovieSceneVectorSection.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 "MovieSceneKeyStruct.h"
#include "Channels/MovieSceneFloatChannel.h"
#include "Channels/MovieSceneDoubleChannel.h"
#include "EntitySystem/IMovieSceneEntityProvider.h"
#include "MovieSceneVectorSection.generated.h"
 
class FStructOnScope;
struct FPropertyChangedEvent;
 
USTRUCT()
struct FMovieSceneFloatVectorKeyStructBase
    : public FMovieSceneKeyStruct
{
    GENERATED_BODY();
 
    UPROPERTY(EditAnywhere, Category=Key)
    FFrameNumber Time;
 
    FMovieSceneKeyStructHelper KeyStructInterop;
 
    virtual void PropagateChanges(const FPropertyChangedEvent& ChangeEvent) override;
 
    virtual float* GetPropertyChannelByIndex(int32 Index) PURE_VIRTUAL(FMovieSceneFloatVectorKeyStructBase::GetPropertyChannelByIndex, return nullptr; );
};
template<> struct TStructOpsTypeTraits<FMovieSceneFloatVectorKeyStructBase> : public TStructOpsTypeTraitsBase2<FMovieSceneFloatVectorKeyStructBase> { enum { WithCopy = false, WithPureVirtual = true, }; };
 
 
USTRUCT()
struct FMovieSceneVector2fKeyStruct
    : public FMovieSceneFloatVectorKeyStructBase
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=Key)
    FVector2f Vector = FVector2f::ZeroVector;
 
    //~ FMovieSceneFloatVectorKeyStructBase interface
    virtual float* GetPropertyChannelByIndex(int32 Index) override { return &Vector[Index]; }
};
template<> struct TStructOpsTypeTraits<FMovieSceneVector2fKeyStruct> : public TStructOpsTypeTraitsBase2<FMovieSceneVector2fKeyStruct> { enum { WithCopy = false }; };
 
USTRUCT()
struct FMovieSceneVector3fKeyStruct
    : public FMovieSceneFloatVectorKeyStructBase
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = Key)
    FVector3f Vector = FVector3f::ZeroVector;
 
    //~ FMovieSceneFloatVectorKeyStructBase interface
    virtual float* GetPropertyChannelByIndex(int32 Index) override { return &Vector[Index]; }
};
template<> struct TStructOpsTypeTraits<FMovieSceneVector3fKeyStruct> : public TStructOpsTypeTraitsBase2<FMovieSceneVector3fKeyStruct> { enum { WithCopy = false }; };
 
USTRUCT()
struct FMovieSceneVector4fKeyStruct
    : public FMovieSceneFloatVectorKeyStructBase
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = Key)
    FVector4f Vector = FVector4f(FVector3f::ZeroVector);
 
    //~ FMovieSceneFloatVectorKeyStructBase interface
    virtual float* GetPropertyChannelByIndex(int32 Index) override { return &Vector[Index]; }
};
template<> struct TStructOpsTypeTraits<FMovieSceneVector4fKeyStruct> : public TStructOpsTypeTraitsBase2<FMovieSceneVector4fKeyStruct> { enum { WithCopy = false }; };
 
 
USTRUCT()
struct FMovieSceneDoubleVectorKeyStructBase
    : public FMovieSceneKeyStruct
{
    GENERATED_BODY();
 
    UPROPERTY(EditAnywhere, Category=Key)
    FFrameNumber Time;
 
    FMovieSceneKeyStructHelper KeyStructInterop;
 
    virtual void PropagateChanges(const FPropertyChangedEvent& ChangeEvent) override;
 
    virtual double* GetPropertyChannelByIndex(int32 Index) PURE_VIRTUAL(FMovieSceneDoubleVectorKeyStructBase::GetPropertyChannelByIndex, return nullptr; );
};
template<> struct TStructOpsTypeTraits<FMovieSceneDoubleVectorKeyStructBase> : public TStructOpsTypeTraitsBase2<FMovieSceneDoubleVectorKeyStructBase> { enum { WithCopy = false, WithPureVirtual = true, }; };
 
USTRUCT()
struct FMovieSceneVector2DKeyStruct
    : public FMovieSceneDoubleVectorKeyStructBase
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category=Key)
    FVector2D Vector = FVector2D::ZeroVector;
 
    //~ FMovieSceneDoubleVectorKeyStructBase interface
    virtual double* GetPropertyChannelByIndex(int32 Index) override { return (double*)&Vector[Index]; }
};
template<> struct TStructOpsTypeTraits<FMovieSceneVector2DKeyStruct> : public TStructOpsTypeTraitsBase2<FMovieSceneVector2DKeyStruct> { enum { WithCopy = false }; };
 
USTRUCT()
struct FMovieSceneVector3dKeyStruct
    : public FMovieSceneDoubleVectorKeyStructBase
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = Key)
    FVector3d Vector = FVector3d::ZeroVector;
 
    //~ FMovieSceneDoubleVectorKeyStructBase interface
    virtual double* GetPropertyChannelByIndex(int32 Index) override { return &Vector[Index]; }
};
template<> struct TStructOpsTypeTraits<FMovieSceneVector3dKeyStruct> : public TStructOpsTypeTraitsBase2<FMovieSceneVector3dKeyStruct> { enum { WithCopy = false }; };
 
 
USTRUCT()
struct FMovieSceneVector4dKeyStruct
    : public FMovieSceneDoubleVectorKeyStructBase
{
    GENERATED_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = Key)
    FVector4d Vector = FVector4d(FVector3d::ZeroVector);
 
    //~ FMovieSceneDoubleVectorKeyStructBase interface
    virtual double* GetPropertyChannelByIndex(int32 Index) override { return &Vector[Index]; }
};
template<> struct TStructOpsTypeTraits<FMovieSceneVector4dKeyStruct> : public TStructOpsTypeTraitsBase2<FMovieSceneVector4dKeyStruct> { enum { WithCopy = false }; };
 
 
UCLASS(MinimalAPI)
class UMovieSceneFloatVectorSection
    : public UMovieSceneSection
    , public IMovieSceneEntityProvider
{
    GENERATED_UCLASS_BODY()
 
public:
 
    void SetChannelsUsed(int32 InChannelsUsed) 
    {
        checkf(InChannelsUsed >= 2 && InChannelsUsed <= 4, TEXT("Only 2-4 channels are supported."));
        ChannelsUsed = InChannelsUsed;
        RecreateChannelProxy();
    }
 
    int32 GetChannelsUsed() const { return ChannelsUsed; }
 
    const FMovieSceneFloatChannel& GetChannel(int32 Index) const
    {
        check(Index >= 0 && Index < GetChannelsUsed());
        return Curves[Index];
    }
 
protected:
 
    //~ UMovieSceneSection interface
    virtual void Serialize(FArchive& Ar) override;
    virtual void PostEditImport() override;
    virtual TSharedPtr<FStructOnScope> GetKeyStruct(TArrayView<const FKeyHandle> KeyHandles) override;
 
    MOVIESCENETRACKS_API void RecreateChannelProxy();
 
private:
 
    //~ IMovieSceneEntityProvider interface
    virtual void ImportEntityImpl(UMovieSceneEntitySystemLinker* EntityLinker, const FEntityImportParams& Params, FImportedEntity* OutImportedEntity) override;
    virtual bool PopulateEvaluationFieldImpl(const TRange<FFrameNumber>& EffectiveRange, const FMovieSceneEvaluationFieldEntityMetaData& InMetaData, FMovieSceneEntityComponentFieldBuilder* OutFieldBuilder) override;
 
private:
 
    UPROPERTY()
    FMovieSceneFloatChannel Curves[4];
 
    UPROPERTY()
    int32 ChannelsUsed;
};
 
 
UCLASS(MinimalAPI)
class UMovieSceneDoubleVectorSection
    : public UMovieSceneSection
    , public IMovieSceneEntityProvider
{
    GENERATED_UCLASS_BODY()
 
public:
 
    void SetChannelsUsed(int32 InChannelsUsed) 
    {
        checkf(InChannelsUsed >= 2 && InChannelsUsed <= 4, TEXT("Only 2-4 channels are supported."));
        ChannelsUsed = InChannelsUsed;
        RecreateChannelProxy();
    }
 
    int32 GetChannelsUsed() const { return ChannelsUsed; }
 
    const FMovieSceneDoubleChannel& GetChannel(int32 Index) const
    {
        check(Index >= 0 && Index < GetChannelsUsed());
        return Curves[Index];
    }
 
protected:
 
    //~ UMovieSceneSection interface
    virtual void Serialize(FArchive& Ar) override;
    virtual void PostEditImport() override;
    virtual TSharedPtr<FStructOnScope> GetKeyStruct(TArrayView<const FKeyHandle> KeyHandles) override;
 
    MOVIESCENETRACKS_API void RecreateChannelProxy();
 
private:
 
    //~ IMovieSceneEntityProvider interface
    virtual void ImportEntityImpl(UMovieSceneEntitySystemLinker* EntityLinker, const FEntityImportParams& Params, FImportedEntity* OutImportedEntity) override;
    virtual bool PopulateEvaluationFieldImpl(const TRange<FFrameNumber>& EffectiveRange, const FMovieSceneEvaluationFieldEntityMetaData& InMetaData, FMovieSceneEntityComponentFieldBuilder* OutFieldBuilder) override;
 
private:
 
    UPROPERTY()
    FMovieSceneDoubleChannel Curves[4];
 
    UPROPERTY()
    int32 ChannelsUsed;
};