TransformableHandle.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/Object.h"
#include "Engine/EngineBaseTypes.h"
#include "MovieSceneObjectBindingID.h"
#include "TransformableHandle.generated.h"
 
class UMovieSceneSection;
class USceneComponent;
enum class EMovieSceneTransformChannel : uint32;
struct FFRameNumber;
struct FFrameRate;
struct FMovieSceneDoubleChannel;
struct FMovieSceneFloatChannel;
struct FMovieSceneSequenceHierarchy;
struct FMovieSceneSequenceID;
struct FTickFunction;
 
namespace UE::MovieScene
{
    struct FFixedObjectBindingID;
    struct FSharedPlaybackState;
}
 
UENUM()
enum class EHandleEvent : uint8
{
    LocalTransformUpdated,
    GlobalTransformUpdated,
    ComponentUpdated,
    UpperDependencyUpdated,
 
    Max UMETA(Hidden),
};
 
UCLASS(Abstract, Blueprintable, MinimalAPI)
class UTransformableHandle : public UObject 
{
    GENERATED_BODY()
    
public:
 
    DECLARE_EVENT_TwoParams(UTransformableHandle, FHandleModifiedEvent, UTransformableHandle*, EHandleEvent);
    
    CONSTRAINTS_API virtual ~UTransformableHandle();
    
    virtual bool IsValid(const bool bDeepCheck = true) const PURE_VIRTUAL(IsValid, return false;);
    
    virtual void SetGlobalTransform(const FTransform& InGlobal) const PURE_VIRTUAL(SetGlobalTransform, );
    virtual void SetLocalTransform(const FTransform& InLocal) const PURE_VIRTUAL(SetLocalTransform, );
    virtual FTransform GetGlobalTransform() const PURE_VIRTUAL(GetGlobalTransform, return FTransform::Identity;);
    virtual FTransform GetLocalTransform() const PURE_VIRTUAL(GetLocalTransform, return FTransform::Identity;);
 
    CONSTRAINTS_API virtual bool HasBoundObjects() const;
 
    virtual void ResolveBoundObjects(FMovieSceneSequenceID LocalSequenceID, TSharedRef<UE::MovieScene::FSharedPlaybackState> SharedPlaybackState, UObject* SubObject = nullptr) PURE_VIRTUAL(ResolveBoundObjects);
 
    virtual UTransformableHandle* Duplicate(UObject* NewOuter) const PURE_VIRTUAL(Duplicate, return nullptr;);
 
 
    CONSTRAINTS_API void OnBindingIDsUpdated(const TMap<UE::MovieScene::FFixedObjectBindingID, UE::MovieScene::FFixedObjectBindingID>& OldFixedToNewFixedMap, FMovieSceneSequenceID LocalSequenceID, TSharedRef<UE::MovieScene::FSharedPlaybackState> SharedPlaybackState);
    
    virtual void TickTarget() const {};
 
    virtual void PreEvaluate(const bool bTick = false) const;
    
    virtual TArrayView<FMovieSceneFloatChannel*>  GetFloatChannels(const UMovieSceneSection* InSection) const PURE_VIRTUAL(GetFloatChannels, return TArrayView<FMovieSceneFloatChannel*>(); );
    virtual TArrayView<FMovieSceneDoubleChannel*>  GetDoubleChannels(const UMovieSceneSection * InSection) const PURE_VIRTUAL(GetDoubleChannels, return TArrayView<FMovieSceneDoubleChannel*>(); );
    virtual bool AddTransformKeys(const TArray<FFrameNumber>& InFrames,
        const TArray<FTransform>& InTransforms,
        const EMovieSceneTransformChannel& InChannels,
        const FFrameRate& InTickResolution,
        UMovieSceneSection* InSection,
        const bool bLocal = true) const PURE_VIRTUAL(AddTransformKeys, return false;);
 
    virtual UObject* GetPrerequisiteObject() const PURE_VIRTUAL(GetPrerequisiteObject, return nullptr;);
    virtual FTickFunction* GetTickFunction() const PURE_VIRTUAL(GetTickFunction, return nullptr;);
 
    virtual uint32 GetHash() const PURE_VIRTUAL(GetHash, return 0;);
 
    virtual TWeakObjectPtr<UObject> GetTarget() const PURE_VIRTUAL(GetTarget, return nullptr;);
 
    virtual bool HasDirectDependencyWith(const UTransformableHandle& InOther) const PURE_VIRTUAL(HasDirectDependencyWith, return false;);
 
    virtual FTickPrerequisite GetPrimaryPrerequisite(const bool bAllowThis = true) const PURE_VIRTUAL(GetPrimaryPrerequisite, return FTickPrerequisite(););
    
    CONSTRAINTS_API FHandleModifiedEvent& HandleModified();
    CONSTRAINTS_API void Notify(EHandleEvent InEvent, const bool bPreTickTarget = false) const;
    mutable bool bNotifying = false;
 
#if WITH_EDITOR
    virtual FString GetLabel() const PURE_VIRTUAL(GetLabel, return FString(););
    virtual FString GetFullLabel() const PURE_VIRTUAL(GetFullLabel, return FString(););
#endif
 
    //possible bindingID
    UPROPERTY(BlueprintReadOnly, Category = "Binding")
    FMovieSceneObjectBindingID ConstraintBindingID;
 
private:
    FHandleModifiedEvent OnHandleModified;
};
 
struct FComponentEvaluationGraphBinding
{
    void OnActorMoving(AActor* InActor);
    bool bPendingFlush = false;
};
 
UCLASS(Blueprintable, MinimalAPI)
class UTransformableComponentHandle : public UTransformableHandle 
{
    GENERATED_BODY()
    
public:
    
    CONSTRAINTS_API virtual ~UTransformableComponentHandle();
 
    CONSTRAINTS_API virtual void PostLoad() override;
    
    CONSTRAINTS_API virtual bool IsValid(const bool bDeepCheck = true) const override;
    
    CONSTRAINTS_API virtual void SetGlobalTransform(const FTransform& InGlobal) const override;
    CONSTRAINTS_API virtual void SetLocalTransform(const FTransform& InLocal) const override;
    CONSTRAINTS_API virtual FTransform GetGlobalTransform() const override;
    CONSTRAINTS_API virtual FTransform GetLocalTransform() const override;
    CONSTRAINTS_API virtual void TickTarget() const override;
 
    CONSTRAINTS_API virtual void PreEvaluate(const bool bTickSkeletalMeshes = false) const override;
    
    CONSTRAINTS_API virtual UObject* GetPrerequisiteObject() const override;
    CONSTRAINTS_API virtual FTickFunction* GetTickFunction() const override;
 
    CONSTRAINTS_API virtual uint32 GetHash() const override;
 
    CONSTRAINTS_API virtual TWeakObjectPtr<UObject> GetTarget() const override;
 
    CONSTRAINTS_API virtual bool HasDirectDependencyWith(const UTransformableHandle& InOther) const override;
 
    CONSTRAINTS_API virtual FTickPrerequisite GetPrimaryPrerequisite(const bool bAllowThis = true) const override;
 
    CONSTRAINTS_API virtual TArrayView<FMovieSceneFloatChannel*>  GetFloatChannels(const UMovieSceneSection* InSection) const override;
    CONSTRAINTS_API virtual TArrayView<FMovieSceneDoubleChannel*>  GetDoubleChannels(const UMovieSceneSection* InSection) const override;
    CONSTRAINTS_API virtual bool AddTransformKeys(const TArray<FFrameNumber>& InFrames,
        const TArray<FTransform>& InTransforms,
        const EMovieSceneTransformChannel& InChannels,
        const FFrameRate& InTickResolution,
        UMovieSceneSection* InSection,
        const bool bLocal = true) const override;
 
    CONSTRAINTS_API virtual void ResolveBoundObjects(FMovieSceneSequenceID LocalSequenceID, TSharedRef<UE::MovieScene::FSharedPlaybackState> SharedPlaybackState, UObject* SubObject = nullptr) override;
 
    CONSTRAINTS_API virtual UTransformableHandle* Duplicate(UObject* NewOuter) const override;
 
#if WITH_EDITOR
    CONSTRAINTS_API virtual FString GetLabel() const override;
    CONSTRAINTS_API virtual FString GetFullLabel() const override;
#endif
    
    UPROPERTY(BlueprintReadOnly, Category = "Object")
    TWeakObjectPtr<USceneComponent> Component;
 
    UPROPERTY(BlueprintReadOnly, Category = "Object")
    FName SocketName = NAME_None;
 
    CONSTRAINTS_API void UnregisterDelegates() const;
    CONSTRAINTS_API void RegisterDelegates();
    
#if WITH_EDITOR
    CONSTRAINTS_API void OnActorMoving(AActor* InActor);
    CONSTRAINTS_API void OnPostPropertyChanged(UObject* InObject, FPropertyChangedEvent& InPropertyChangedEvent);
    CONSTRAINTS_API void OnObjectsReplaced(const TMap<UObject*, UObject*>& InOldToNewInstances);
#endif
 
protected:
 
    static FComponentEvaluationGraphBinding& GetEvaluationBinding();
};