MovieSceneObjectPathChannel.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Misc/FrameNumber.h"
#include "MovieSceneChannel.h"
#include "MovieSceneChannelData.h"
#include "MovieSceneChannelTraits.h"
#include "MovieSceneObjectPathChannel.generated.h"
 
USTRUCT()
struct FMovieSceneObjectPathChannelKeyValue
{
    GENERATED_BODY()
 
    
    FMovieSceneObjectPathChannelKeyValue()
        : HardPtr(nullptr)
    {}
 
    MOVIESCENE_API FMovieSceneObjectPathChannelKeyValue(UObject* InObject);
 
    MOVIESCENE_API FMovieSceneObjectPathChannelKeyValue& operator=(UObject* NewObject);
 
    friend bool operator==(const FMovieSceneObjectPathChannelKeyValue& A, const FMovieSceneObjectPathChannelKeyValue& B)
    {
        return A.SoftPtr == B.SoftPtr;
    }
 
public:
 
    MOVIESCENE_API bool SerializeFromMismatchedTag(FPropertyTag const& Tag, FStructuredArchive::FSlot Slot);
    
    const TSoftObjectPtr<>& GetSoftPtr() const
    {
        return SoftPtr;
    }
 
    MOVIESCENE_API UObject* Get() const;
 
    UObject* GetValue() const
    {
        return Get();
    }
 
private:
 
    UPROPERTY()
    TSoftObjectPtr<UObject> SoftPtr;
 
    UPROPERTY()
    mutable TObjectPtr<UObject> HardPtr;
};
 
template<>
struct TStructOpsTypeTraits<FMovieSceneObjectPathChannelKeyValue> : public TStructOpsTypeTraitsBase2<FMovieSceneObjectPathChannelKeyValue>
{
    enum { WithStructuredSerializeFromMismatchedTag = true };
};
 
USTRUCT()
struct FMovieSceneObjectPathChannel : public FMovieSceneChannel
{
    GENERATED_BODY()
 
    typedef FMovieSceneObjectPathChannelKeyValue CurveValueType;
 
    FMovieSceneObjectPathChannel()
        : PropertyClass(nullptr)
    {}
 
    inline void SetPropertyClass(UClass* InPropertyClass)
    {
        PropertyClass = InPropertyClass;
    }
 
    inline UClass* GetPropertyClass() const
    {
        return PropertyClass;
    }
 
    inline TMovieSceneChannelData<FMovieSceneObjectPathChannelKeyValue> GetData()
    {
        return TMovieSceneChannelData<FMovieSceneObjectPathChannelKeyValue>(&Times, &Values, this, &KeyHandles);
    }
 
    inline TMovieSceneChannelData<const FMovieSceneObjectPathChannelKeyValue> GetData() const
    {
        return TMovieSceneChannelData<const FMovieSceneObjectPathChannelKeyValue>(&Times, &Values);
    }
 
    MOVIESCENE_API bool Evaluate(FFrameTime InTime, UObject*& OutValue) const;
 
public:
 
    //~ FMovieSceneChannel Interface
    MOVIESCENE_API virtual void GetKeys(const TRange<FFrameNumber>& WithinRange, TArray<FFrameNumber>* OutKeyTimes, TArray<FKeyHandle>* OutKeyHandles) override;
    MOVIESCENE_API virtual void GetKeyTimes(TArrayView<const FKeyHandle> InHandles, TArrayView<FFrameNumber> OutKeyTimes) override;
    MOVIESCENE_API virtual void SetKeyTimes(TArrayView<const FKeyHandle> InHandles, TArrayView<const FFrameNumber> InKeyTimes) override;
    MOVIESCENE_API virtual void DuplicateKeys(TArrayView<const FKeyHandle> InHandles, TArrayView<FKeyHandle> OutNewHandles) override;
    MOVIESCENE_API virtual void DeleteKeys(TArrayView<const FKeyHandle> InHandles) override;
    MOVIESCENE_API virtual void DeleteKeysFrom(FFrameNumber InTime, bool bDeleteKeysBefore) override;
    MOVIESCENE_API virtual void RemapTimes(const UE::MovieScene::IRetimingInterface& Retimer) override;
    MOVIESCENE_API virtual TRange<FFrameNumber> ComputeEffectiveRange() const override;
    MOVIESCENE_API virtual int32 GetNumKeys() const override;
    MOVIESCENE_API virtual void Reset() override;
    MOVIESCENE_API virtual void Offset(FFrameNumber DeltaPosition) override;
    MOVIESCENE_API virtual void Optimize(const FKeyDataOptimizationParams& InParameters) override;
    MOVIESCENE_API virtual void ClearDefault() override;
    MOVIESCENE_API virtual FKeyHandle GetHandle(int32 Index) override;
    MOVIESCENE_API virtual int32 GetIndex(FKeyHandle Handle) override;
 
public:
 
    inline void SetDefault(UObject* InDefaultValue)
    {
        DefaultValue = InDefaultValue;
    }
    MOVIESCENE_API void SetDefault(const FMovieSceneObjectPathChannelKeyValue& InDefaultValue);
 
    inline const FMovieSceneObjectPathChannelKeyValue& GetDefault() const
    {
        return DefaultValue;
    }
 
    inline void RemoveDefault()
    {
        DefaultValue = nullptr;
    }
 
private:
 
    UPROPERTY()
    TObjectPtr<UClass> PropertyClass;
 
    UPROPERTY(meta=(KeyTimes))
    TArray<FFrameNumber> Times;
 
    UPROPERTY(meta=(KeyValues))
    TArray<FMovieSceneObjectPathChannelKeyValue> Values;
 
    UPROPERTY()
    FMovieSceneObjectPathChannelKeyValue DefaultValue;
 
    UPROPERTY(Transient)
    FMovieSceneKeyHandleMap KeyHandles;
};
 
inline bool GetChannelDefault(const FMovieSceneObjectPathChannel* Channel, FMovieSceneObjectPathChannelKeyValue& OutDefaultValue)
{
    OutDefaultValue = Channel->GetDefault();
    return true;
}
inline bool EvaluateChannel(const FMovieSceneObjectPathChannel* InChannel, FFrameTime InTime, FMovieSceneObjectPathChannelKeyValue& OutValue)
{
    UObject* Object = nullptr;
    if (InChannel->Evaluate(InTime, Object))
    {
        OutValue = Object;
        return true;
    }
    return false;
}
 
template<>
struct TMovieSceneChannelTraits<FMovieSceneObjectPathChannel> : TMovieSceneChannelTraitsBase<FMovieSceneObjectPathChannel>
{
#if WITH_EDITOR
 
    typedef TMovieSceneExternalValue<UObject*> ExtendedEditorDataType;
 
#endif
};