MovieSceneActorReferenceSection.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Channels/MovieSceneChannel.h"
#include "Channels/MovieSceneChannelData.h"
#include "Channels/MovieSceneChannelTraits.h"
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "Containers/Map.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "Curves/IntegralCurve.h"
#include "Curves/KeyHandle.h"
#include "HAL/Platform.h"
#include "HAL/PlatformCrt.h"
#include "Math/Range.h"
#include "Misc/AssertionMacros.h"
#include "Misc/FrameNumber.h"
#include "Misc/FrameRate.h"
#include "Misc/FrameTime.h"
#include "Misc/Guid.h"
#include "MovieSceneFwd.h"
#include "MovieSceneObjectBindingID.h"
#include "MovieSceneSection.h"
#include "UObject/NameTypes.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
 
#include "MovieSceneActorReferenceSection.generated.h"
 
class IMovieScenePlayer;
class UObject;
struct FKeyHandle;
struct FMovieSceneSequenceHierarchy;
struct FMovieSceneSequenceID;
 
USTRUCT()
struct FMovieSceneActorReferenceKey
{
    GENERATED_BODY()
 
    FMovieSceneActorReferenceKey()
    {}
 
    FMovieSceneActorReferenceKey(const FMovieSceneObjectBindingID& InBindingID)
        : Object(InBindingID)
    {}
 
    friend bool operator==(const FMovieSceneActorReferenceKey& A, const FMovieSceneActorReferenceKey& B)
    {
        return A.Object == B.Object && A.ComponentName == B.ComponentName && A.SocketName == B.SocketName;
    }
 
    friend bool operator!=(const FMovieSceneActorReferenceKey& A, const FMovieSceneActorReferenceKey& B)
    {
        return A.Object != B.Object || A.ComponentName != B.ComponentName || A.SocketName != B.SocketName;
    }
 
    UPROPERTY(EditAnywhere, Category="Key")
    FMovieSceneObjectBindingID Object;
 
    UPROPERTY(EditAnywhere, Category="Key")
    FName ComponentName;
 
    UPROPERTY(EditAnywhere, Category="Key")
    FName SocketName;
};
 
USTRUCT()
struct FMovieSceneActorReferenceData : public FMovieSceneChannel
{
    GENERATED_BODY()
 
    typedef FMovieSceneActorReferenceKey CurveValueType;
 
    FMovieSceneActorReferenceData()
        : DefaultValue()
    {}
 
    inline TMovieSceneChannelData<FMovieSceneActorReferenceKey> GetData()
    {
        return TMovieSceneChannelData<FMovieSceneActorReferenceKey>(&KeyTimes, &KeyValues, this, &KeyHandles);
    }
 
    inline TMovieSceneChannelData<const FMovieSceneActorReferenceKey> GetData() const
    {
        return TMovieSceneChannelData<const FMovieSceneActorReferenceKey>(&KeyTimes, &KeyValues);
    }
 
    MOVIESCENETRACKS_API bool Evaluate(FFrameTime InTime, FMovieSceneActorReferenceKey& OutValue) const;
 
public:
 
    // ~ FMovieSceneChannel Interface
    MOVIESCENETRACKS_API virtual void GetKeys(const TRange<FFrameNumber>& WithinRange, TArray<FFrameNumber>* OutKeyTimes, TArray<FKeyHandle>* OutKeyHandles) override;
    MOVIESCENETRACKS_API virtual void GetKeyTimes(TArrayView<const FKeyHandle> InHandles, TArrayView<FFrameNumber> OutKeyTimes) override;
    MOVIESCENETRACKS_API virtual void SetKeyTimes(TArrayView<const FKeyHandle> InHandles, TArrayView<const FFrameNumber> InKeyTimes) override;
    MOVIESCENETRACKS_API virtual void DuplicateKeys(TArrayView<const FKeyHandle> InHandles, TArrayView<FKeyHandle> OutNewHandles) override;
    MOVIESCENETRACKS_API virtual void DeleteKeys(TArrayView<const FKeyHandle> InHandles) override;
    MOVIESCENETRACKS_API virtual void DeleteKeysFrom(FFrameNumber InTime, bool bDeleteKeysBefore) override;
    MOVIESCENETRACKS_API virtual void RemapTimes(const UE::MovieScene::IRetimingInterface& Retimer) override;
    MOVIESCENETRACKS_API virtual TRange<FFrameNumber> ComputeEffectiveRange() const override;
    MOVIESCENETRACKS_API virtual int32 GetNumKeys() const override;
    MOVIESCENETRACKS_API virtual void Reset() override;
    MOVIESCENETRACKS_API virtual void Offset(FFrameNumber DeltaPosition) override;
    MOVIESCENETRACKS_API virtual void ClearDefault() override;
    MOVIESCENETRACKS_API virtual FKeyHandle GetHandle(int32 Index) override;
    MOVIESCENETRACKS_API virtual int32 GetIndex(FKeyHandle Handle) override;
 
public:
 
    inline void SetDefault(FMovieSceneActorReferenceKey InDefaultValue)
    {
        DefaultValue = InDefaultValue;
    }
 
    inline const FMovieSceneActorReferenceKey& GetDefault() const
    {
        return DefaultValue;
    }
 
    void UpgradeLegacyTime(UObject* Context, double Time, FMovieSceneActorReferenceKey Value)
    {
        FFrameRate LegacyFrameRate = GetLegacyConversionFrameRate();
        FFrameNumber KeyTime = UpgradeLegacyMovieSceneTime(nullptr, LegacyFrameRate, Time);
 
        check(KeyTimes.Num() == 0 || KeyTime >= KeyTimes.Last());
 
        KeyTimes.Add(KeyTime);
        KeyValues.Add(Value);
    }
 
private:
 
    UPROPERTY(meta=(KeyTimes))
    TArray<FFrameNumber> KeyTimes;
 
    UPROPERTY()
    FMovieSceneActorReferenceKey DefaultValue;
 
    UPROPERTY(meta=(KeyValues))
    TArray<FMovieSceneActorReferenceKey> KeyValues;
 
    UPROPERTY(Transient)
    FMovieSceneKeyHandleMap KeyHandles;
};
 
UCLASS(MinimalAPI)
class UMovieSceneActorReferenceSection
    : public UMovieSceneSection
{
    GENERATED_UCLASS_BODY()
 
public:
 
    //~ UObject interface
    virtual void PostLoad() override;
 
    //~ UMovieSceneSection interface
    virtual void OnBindingIDsUpdated(const TMap<UE::MovieScene::FFixedObjectBindingID, UE::MovieScene::FFixedObjectBindingID>& OldFixedToNewFixedMap, FMovieSceneSequenceID LocalSequenceID, TSharedRef<UE::MovieScene::FSharedPlaybackState> SharedPlaybackState) override;
 
    const FMovieSceneActorReferenceData& GetActorReferenceData() const { return ActorReferenceData; }
 
private:
 
    UPROPERTY()
    FMovieSceneActorReferenceData ActorReferenceData;
 
private:
 
    UPROPERTY()
    FIntegralCurve ActorGuidIndexCurve_DEPRECATED;
 
    UPROPERTY()
    TArray<FString> ActorGuidStrings_DEPRECATED;
};
 
inline bool EvaluateChannel(const FMovieSceneActorReferenceData* InChannel, FFrameTime InTime, FMovieSceneActorReferenceKey& OutValue)
{
    return InChannel->Evaluate(InTime, OutValue);
}
 
inline bool GetChannelDefault(const FMovieSceneActorReferenceData* Channel, FMovieSceneActorReferenceKey& OutDefaultValue)
{
    OutDefaultValue = Channel->GetDefault();
    return true;
}