SkeletalControlLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
 
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Animation/AnimNodeReference.h"
#include "SkeletalControlLibrary.generated.h"
 
struct FAnimNode_SkeletalControlBase;
 
USTRUCT(BlueprintType)
struct FSkeletalControlReference : public FAnimNodeReference
{
    GENERATED_BODY()
 
    typedef FAnimNode_SkeletalControlBase FInternalNodeType;
};
 
// Exposes operations to be performed on a skeletal control anim node
// Note: Experimental and subject to change!
UCLASS(Experimental, MinimalAPI)
class USkeletalControlLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_BODY()
 
public:
    UFUNCTION(BlueprintCallable, Category = "Animation|Skeletal Controls", meta=(BlueprintThreadSafe, ExpandEnumAsExecs = "Result"))
    static ANIMGRAPHRUNTIME_API FSkeletalControlReference ConvertToSkeletalControl(const FAnimNodeReference& Node, EAnimNodeReferenceConversionResult& Result);
 
    UFUNCTION(BlueprintPure, Category = "Animation|Skeletal Controls", meta=(BlueprintThreadSafe, DisplayName = "Convert to Skeletal Control"))
    static void ConvertToSkeletalControlPure(const FAnimNodeReference& Node, FSkeletalControlReference& SkeletalControl, bool& Result)
    {
        EAnimNodeReferenceConversionResult ConversionResult;
        SkeletalControl = ConvertToSkeletalControl(Node, ConversionResult);
        Result = (ConversionResult == EAnimNodeReferenceConversionResult::Succeeded);
    }
    
    UFUNCTION(BlueprintCallable, Category = "Animation|Skeletal Controls", meta=(BlueprintThreadSafe))
    static ANIMGRAPHRUNTIME_API FSkeletalControlReference SetAlpha(const FSkeletalControlReference& SkeletalControl, float Alpha);
 
    UFUNCTION(BlueprintPure, Category = "Animation|Skeletal Controls", meta=(BlueprintThreadSafe))
    static ANIMGRAPHRUNTIME_API float GetAlpha(const FSkeletalControlReference& SkeletalControl);
};