AnimLinkableElement.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 "AnimLinkableElement.generated.h"
 
class UAnimMontage;
class UAnimSequenceBase;
struct FAnimSegment;
 
UENUM()
namespace EAnimLinkMethod
{
    enum Type : int
    {
        Absolute,
        Relative,
        Proportional
    };
}
 
USTRUCT()
struct FAnimLinkableElement
{
    GENERATED_USTRUCT_BODY()
 
    FAnimLinkableElement()
    : LinkedMontage(nullptr)
    , SlotIndex(0)
    , SegmentIndex(INDEX_NONE)
    , LinkMethod(EAnimLinkMethod::Absolute)
    , CachedLinkMethod(LinkMethod)
    , SegmentBeginTime(0.f)
    , SegmentLength(0.f)
    , LinkValue(0.f)
    , LinkedSequence(nullptr)
    {
    }
 
    virtual ~FAnimLinkableElement()
    {
    }
 
    ENGINE_API void Update();
 
    ENGINE_API void Link(UAnimSequenceBase* AnimSequenceBase, float AbsTime, int32 InSlotIndex = 0);
 
    UE_DEPRECATED(5.1, "LinkMontage has been deprecated, use Link instead")
    ENGINE_API void LinkMontage(UAnimMontage* Montage, float AbsMontageTime, int32 InSlotIndex = 0);
 
    UE_DEPRECATED(5.1, "LinkSequence has been deprecated, use Link instead")
    ENGINE_API void LinkSequence(UAnimSequenceBase* Sequence, float AbsSequenceTime);
 
    ENGINE_API void Clear();
 
    ENGINE_API void OnChanged(float NewMontageTime);
 
    ENGINE_API float GetTime(EAnimLinkMethod::Type ReferenceFrame = EAnimLinkMethod::Absolute) const;
 
    ENGINE_API virtual void SetTime(float NewTime, EAnimLinkMethod::Type ReferenceFrame = EAnimLinkMethod::Absolute);
 
    const UAnimSequenceBase* GetLinkedSequence() const {return LinkedSequence;}
 
    const UAnimMontage* GetLinkedMontage() const { return LinkedMontage; }
 
    ENGINE_API void ChangeLinkMethod(EAnimLinkMethod::Type NewLinkMethod);
 
    ENGINE_API void ChangeSlotIndex(int32 NewSlotIndex);
 
    EAnimLinkMethod::Type GetLinkMethod() const {return LinkMethod;}
 
    int32 GetSlotIndex() const {return SlotIndex;}
    
    int32 GetSegmentIndex() const {return SegmentIndex;}
 
    void SetSegmentIndex(int32 NewSegmentIndex) {SegmentIndex = NewSegmentIndex;}
 
    ENGINE_API bool ConditionalRelink();
 
    ENGINE_API void RefreshSegmentOnLoad();
 
protected:
 
    FAnimSegment* GetSegmentAtCurrentTime();
 
    UPROPERTY()
    TObjectPtr<UAnimMontage> LinkedMontage;
 
    UPROPERTY(EditAnywhere, Category=AnimLink)
    int32 SlotIndex;
 
    UPROPERTY()
    int32 SegmentIndex;
 
    UPROPERTY(EditAnywhere, Category=AnimLink)
    TEnumAsByte<EAnimLinkMethod::Type> LinkMethod;
 
    UPROPERTY()
    TEnumAsByte<EAnimLinkMethod::Type> CachedLinkMethod;
 
    UPROPERTY()
    float SegmentBeginTime;
 
    UPROPERTY()
    float SegmentLength;
 
    UPROPERTY()
    float LinkValue;
 
    UPROPERTY(VisibleAnywhere, AdvancedDisplay, Category=AnimLink)
    TObjectPtr<UAnimSequenceBase> LinkedSequence;
 
private:
 
    float GetTimeFromAbsolute(EAnimLinkMethod::Type ReferenceFrame) const ;
 
    float GetTimeFromRelative(EAnimLinkMethod::Type ReferenceFrame) const ;
 
    float GetTimeFromProportional(EAnimLinkMethod::Type ReferenceFrame) const;
 
    void SetTimeFromAbsolute(float NewTime, EAnimLinkMethod::Type ReferenceFrame);
 
    void SetTimeFromRelative(float NewTime, EAnimLinkMethod::Type ReferenceFrame);
 
    void SetTimeFromProportional(float NewTime, EAnimLinkMethod::Type ReferenceFrame);
 
    void SetTime_Internal(float NewTime, EAnimLinkMethod::Type ReferenceFrame = EAnimLinkMethod::Absolute);
};