CachedAnimData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Animation/AnimInstance.h"
#include "CachedAnimData.generated.h"
 
class UAnimInstance;
 
USTRUCT(BlueprintType)
struct FCachedAnimStateData
{
    GENERATED_USTRUCT_BODY()
 
    FCachedAnimStateData()
        : MachineIndex(INDEX_NONE)
        , StateIndex(INDEX_NONE)
        , bInitialized(false)
    {}
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = "State Machine")
    FName StateMachineName;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = "State Machine")
    FName StateName;
 
    ENGINE_API bool IsValid(UAnimInstance& InAnimInstance) const;
    
    ENGINE_API float IsMachineRelevant(UAnimInstance& InAnimInstance) const;
    
    ENGINE_API float GetGlobalWeight(UAnimInstance& InAnimInstance) const;
 
    ENGINE_API float GetWeight(UAnimInstance& InAnimInstance) const;
 
    ENGINE_API bool IsFullWeight(UAnimInstance& InAnimInstance) const;
 
    ENGINE_API bool IsRelevant(UAnimInstance& InAnimInstance) const;
 
    ENGINE_API bool IsActiveState(class UAnimInstance& InAnimInstance) const;
 
    ENGINE_API bool WasAnimNotifyStateActive(UAnimInstance& InAnimInstance, TSubclassOf<UAnimNotifyState> AnimNotifyStateType) const;
        
private:
    mutable int32 MachineIndex;
    mutable int32 StateIndex;
    mutable bool bInitialized;
};
 
USTRUCT(BlueprintType)
struct FCachedAnimStateArray
{
    GENERATED_USTRUCT_BODY()
 
    FCachedAnimStateArray()
        : bCheckedValidity(false)
        , bCachedIsValid(true)
        , bHasMultipleStateMachineEntries(false)
    {}
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = "State Machine")
    TArray<FCachedAnimStateData> States;
 
    ENGINE_API float GetTotalWeight(UAnimInstance& InAnimInstance) const;
    ENGINE_API bool IsFullWeight(UAnimInstance& InAnimInstance) const;
    ENGINE_API bool IsRelevant(UAnimInstance& InAnimInstance) const;
 
private:
    ENGINE_API bool IsValid(UAnimInstance& InAnimInstance) const;
    mutable bool bCheckedValidity;
    mutable bool bCachedIsValid;
    mutable bool bHasMultipleStateMachineEntries;
};
 
USTRUCT(BlueprintType)
struct FCachedAnimAssetPlayerData
{
    GENERATED_USTRUCT_BODY()
 
    FCachedAnimAssetPlayerData()
        : Index(INDEX_NONE)
        , bInitialized(false)
    {}
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = "State Machine")
    FName StateMachineName;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = "State Machine")
    FName StateName;
 
    ENGINE_API float GetAssetPlayerTime(UAnimInstance& InAnimInstance) const;
 
    ENGINE_API float GetAssetPlayerTimeRatio(UAnimInstance& InAnimInstance) const;
 
private:
    ENGINE_API void CacheIndices(UAnimInstance& InAnimInstance) const;
 
    mutable int32 Index;
    mutable bool bInitialized;
};
 
USTRUCT(BlueprintType)
struct FCachedAnimRelevancyData
{
    GENERATED_USTRUCT_BODY()
 
    FCachedAnimRelevancyData()
        : MachineIndex(INDEX_NONE)
        , StateIndex(INDEX_NONE)
        , bInitialized(false)
    {}
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = "State Machine")
    FName StateMachineName;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = "State Machine")
    FName StateName;
 
    ENGINE_API float GetRelevantAnimTime(UAnimInstance& InAnimInstance) const;
    ENGINE_API float GetRelevantAnimTimeRemaining(UAnimInstance& InAnimInstance) const;
    ENGINE_API float GetRelevantAnimTimeRemainingFraction(UAnimInstance& InAnimInstance) const;
 
private:
    ENGINE_API void CacheIndices(UAnimInstance& InAnimInstance) const;
 
private:
    mutable int32 MachineIndex;
    mutable int32 StateIndex;
    mutable bool bInitialized;
};
 
USTRUCT(BlueprintType)
struct FCachedAnimTransitionData
{
    GENERATED_USTRUCT_BODY()
 
    FCachedAnimTransitionData()
        : MachineIndex(INDEX_NONE)
        , TransitionIndex(INDEX_NONE)
        , bInitialized(false)
    {}
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = "State Machine")
    FName StateMachineName;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = "State Machine")
    FName FromStateName;
 
    UPROPERTY(BlueprintReadOnly, EditAnywhere, Category = "State Machine")
    FName ToStateName;
 
    ENGINE_API float GetCrossfadeDuration(UAnimInstance& InAnimInstance) const;
    ENGINE_API float GetTimeElapsed(UAnimInstance& InAnimInstance) const;
    ENGINE_API float GetTimeElapsedFraction(UAnimInstance& InAnimInstance) const;
 
private:
    ENGINE_API void CacheIndices(UAnimInstance& InAnimInstance) const;
 
private:
    mutable int32 MachineIndex;
    mutable int32 TransitionIndex;
    mutable bool bInitialized;
};