MovieSceneTrackInstance.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "EntitySystem/MovieSceneEntitySystemLinker.h"
#include "EntitySystem/MovieSceneInstanceRegistry.h"
#include "EntitySystem/MovieSceneSequenceInstanceHandle.h"
#include "HAL/Platform.h"
#include "HAL/PlatformMisc.h"
#include "Serialization/Archive.h"
#include "Templates/UnrealTemplate.h"
#include "UObject/Class.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ObjectPtr.h"
#include "UObject/UObjectGlobals.h"
 
#include "MovieSceneTrackInstance.generated.h"
 
class UMovieSceneEntitySystemLinker;
class UMovieSceneSection;
class UWorld;
struct FMovieSceneTrackInstanceComponent;
 
namespace UE
{
namespace MovieScene
{
 
struct FPreAnimatedTrackInstanceInputCaptureSources;
 
}
}
 
USTRUCT()
struct FMovieSceneTrackInstanceInput
{
    GENERATED_BODY()
 
    
    UPROPERTY()
    TObjectPtr<UMovieSceneSection> Section = nullptr;
 
    UE::MovieScene::FInstanceHandle InstanceHandle;
 
    bool bInputHasBeenProcessed = false;
 
    bool IsSameInput(const FMovieSceneTrackInstanceInput& OtherInput) const
    {
        return Section == OtherInput.Section && InstanceHandle == OtherInput.InstanceHandle;
    }
 
    friend bool operator==(const FMovieSceneTrackInstanceInput& A, const FMovieSceneTrackInstanceInput& B)
    {
        return A.Section == B.Section && A.InstanceHandle == B.InstanceHandle && A.bInputHasBeenProcessed == B.bInputHasBeenProcessed;
    }
 
    friend bool operator<(const FMovieSceneTrackInstanceInput& A, const FMovieSceneTrackInstanceInput& B)
    {
        // bInputHasBeenProcessed is not considered for sorting
        if (A.Section == B.Section)
        {
            return A.InstanceHandle < B.InstanceHandle;
        }
        return A.Section < B.Section;
    }
 
    friend uint32 GetTypeHash(const FMovieSceneTrackInstanceInput& Input)
    {
        // Use arbitrary primes to salt this thing.
        uint32 hash = 7211;
        hash = (hash * 307) + GetTypeHash(Input.Section);
        hash = (hash * 307) + GetTypeHash(Input.InstanceHandle);
        return hash;
    }
 
    bool Serialize(FArchive& Ar)
    {
        Ar << (UObject*&)Section << InstanceHandle.InstanceID << InstanceHandle.InstanceSerial << bInputHasBeenProcessed;
        return true;
    }
};
 
template<>
struct TStructOpsTypeTraits<FMovieSceneTrackInstanceInput> : public TStructOpsTypeTraitsBase2<FMovieSceneTrackInstanceInput>
{
    enum
    {
        WithIdenticalViaEquality       = true,
        WithSerializer                 = true,
    };
};
 
 
UCLASS(transient, MinimalAPI)
class UMovieSceneTrackInstance : public UObject
{
public:
    GENERATED_BODY()
 
    
    MOVIESCENE_API void Initialize(UObject* InAnimatedObject, UMovieSceneEntitySystemLinker* InLinker);
 
 
    MOVIESCENE_API void Animate();
 
 
    MOVIESCENE_API void UpdateInputs(TArray<FMovieSceneTrackInstanceInput>&& InNewInputs);
 
 
    MOVIESCENE_API void Destroy();
 
 
public:
 
 
    UObject* GetAnimatedObject() const
    {
        return WeakAnimatedObject.Get();
    }
 
 
    UMovieSceneEntitySystemLinker* GetLinker() const
    {
        return PrivateLinker;
    }
 
 
    TArrayView<const FMovieSceneTrackInstanceInput> GetInputs() const
    {
        return Inputs;
    }
 
    MOVIESCENE_API virtual UWorld* GetWorld() const override;
#if WITH_EDITOR
    virtual bool ImplementsGetWorld() const override { return true; }
#endif
 
private:
 
    virtual void OnInitialize() {}
 
    virtual void OnAnimate() {}
 
    virtual void OnBeginUpdateInputs() {}
 
    virtual void OnInputAdded(const FMovieSceneTrackInstanceInput& InInput) {}
 
    virtual void OnInputRemoved(const FMovieSceneTrackInstanceInput& InInput) {}
 
    virtual void OnEndUpdateInputs() {}
 
    virtual void OnDestroyed() {}
 
private:
 
    UPROPERTY()
    TWeakObjectPtr<UObject> WeakAnimatedObject;
 
    UPROPERTY()
    bool bIsRootTrackInstance;
 
    UPROPERTY()
    TObjectPtr<UMovieSceneEntitySystemLinker> PrivateLinker;
 
    UPROPERTY()
    TArray<FMovieSceneTrackInstanceInput> Inputs;
};