AnimNode_CustomProperty.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 "Templates/SubclassOf.h"
#include "Animation/AnimNodeBase.h"
#include "Animation/AnimStats.h"
#include "AnimNode_CustomProperty.generated.h"
 
USTRUCT()
struct FAnimNode_CustomProperty : public FAnimNode_Base
{
    GENERATED_BODY()
 
public:
 
    ENGINE_API FAnimNode_CustomProperty();
    ENGINE_API FAnimNode_CustomProperty(const FAnimNode_CustomProperty&);
    ENGINE_API ~FAnimNode_CustomProperty();
 
    /* Set Target Instance */
    ENGINE_API void SetTargetInstance(UObject* InInstance);
 
    /* Get Target Instance by type for convenience */
    template<class T>
    T* GetTargetInstance() const
    {
        if (IsValid(TargetInstance))
        {
            return Cast<T>(TargetInstance);
        }
 
        return nullptr;
    }
 
    // We only subscribe to the OnInitializeAnimInstance path because we need to cache our source object, so we only
    // override these methods in editor at the moment
#if WITH_EDITOR 
    // FAnimNode_Base interface
    ENGINE_API virtual void OnInitializeAnimInstance(const FAnimInstanceProxy* InProxy, const UAnimInstance* InAnimInstance) override;
    virtual bool NeedsOnInitializeAnimInstance() const override { return true; }
 
    // Handle object reinstancing in editor
    ENGINE_API void HandleObjectsReinstanced(const TMap<UObject*, UObject*>& OldToNewInstanceMap);
#endif
 
protected:
    UPROPERTY(meta=(BlueprintCompilerGeneratedDefaults))
    TArray<FName> SourcePropertyNames;
 
    UPROPERTY(meta=(BlueprintCompilerGeneratedDefaults))
    TArray<FName> DestPropertyNames;
 
    UPROPERTY(Transient)
    TObjectPtr<UObject> TargetInstance;
 
    TArray<FProperty*> SourceProperties;
 
    TArray<FProperty*> DestProperties;
    
    /* Initialize property links from the source instance, in this case AnimInstance 
     * Compiler creates those properties during compile time */
    ENGINE_API virtual void InitializeProperties(const UObject* InSourceInstance, UClass* InTargetClass);
 
    /* Propagate the Source Instances' properties to Target Instance*/
    ENGINE_API virtual void PropagateInputProperties(const UObject* InSourceInstance);
 
    virtual UClass* GetTargetClass() const PURE_VIRTUAL(FAnimNode_CustomProperty::GetTargetClass, return nullptr;);
 
#if WITH_EDITOR
    ENGINE_API virtual void HandleObjectsReinstanced_Impl(UObject* InSourceObject, UObject* InTargetObject, const TMap<UObject*, UObject*>& OldToNewInstanceMap);
#endif // WITH_EDITOR
 
#if WITH_EDITORONLY_DATA
protected:
    UPROPERTY(Transient)
    TObjectPtr<UObject> SourceInstance;
#endif
 
    // Stats
#if ANIMNODE_STATS_VERBOSE
    // Cached StatID for this node
    TStatId StatID;
    virtual void InitializeStatID() { StatID = FDynamicStats::CreateStatId<FStatGroup_STATGROUP_Anim>(FString(TEXT("Unknown"))); }
#endif // ANIMNODE_STATS_VERBOSE
 
    friend class UAnimGraphNode_CustomProperty;
    friend class UAnimInstance;
    friend class UControlRigLayerInstance;
};
 
template<>
struct TStructOpsTypeTraits<FAnimNode_CustomProperty> : public TStructOpsTypeTraitsBase2<FAnimNode_CustomProperty>
{
    enum
    {
        WithPureVirtual = true,
    };
};