Files
UnrealEngineUWP/Engine/Source/Runtime/AnimGraphRuntime/Public/SequencePlayerLibrary.h
thomas sarkanen 8dd75d3cc0 Added pure conversion functions for anim node references
#rb Jurre.deBaare

#ROBOMERGE-SOURCE: CL 16757174 in //UE5/Main/...
#ROBOMERGE-BOT: STARSHIP (Main -> Release-Engine-Test) (v835-16672529)

[CL 16757191 by thomas sarkanen in ue5-release-engine-test branch]
2021-06-23 10:59:16 -04:00

63 lines
2.9 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "CoreMinimal.h"
#include "Animation/AnimExecutionContext.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Animation/AnimNodeReference.h"
#include "SequencePlayerLibrary.generated.h"
struct FAnimNode_SequencePlayer;
USTRUCT(BlueprintType)
struct FSequencePlayerReference : public FAnimNodeReference
{
GENERATED_BODY()
typedef FAnimNode_SequencePlayer FInternalNodeType;
};
// Exposes operations to be performed on a sequence player anim node
// Note: Experimental and subject to change!
UCLASS(Experimental)
class ANIMGRAPHRUNTIME_API USequencePlayerLibrary : public UBlueprintFunctionLibrary
{
GENERATED_BODY()
public:
/** Get a sequence player context from an anim node context */
UFUNCTION(BlueprintCallable, Category = "Sequence Player", meta=(BlueprintThreadSafe, ExpandEnumAsExecs = "Result"))
static FSequencePlayerReference ConvertToSequencePlayer(const FAnimNodeReference& Node, EAnimNodeReferenceConversionResult& Result);
/** Get a sequence player context from an anim node context (pure) */
UFUNCTION(BlueprintPure, Category = "Sequence Player", meta=(BlueprintThreadSafe, DisplayName = "Convert to Sequence Player"))
static void ConvertToSequencePlayerPure(const FAnimNodeReference& Node, FSequencePlayerReference& SequencePlayer, bool& Result)
{
EAnimNodeReferenceConversionResult ConversionResult;
SequencePlayer = ConvertToSequencePlayer(Node, ConversionResult);
Result = (ConversionResult == EAnimNodeReferenceConversionResult::Succeeded);
}
/** Set the current accumulated time of the sequence player */
UFUNCTION(BlueprintCallable, Category = "Sequence Player", meta=(BlueprintThreadSafe))
static FSequencePlayerReference SetAccumulatedTime(const FSequencePlayerReference& SequencePlayer, float Time);
/** Set the start position of the sequence player */
UFUNCTION(BlueprintCallable, Category = "Sequence Player", meta=(BlueprintThreadSafe))
static FSequencePlayerReference SetStartPosition(const FSequencePlayerReference& SequencePlayer, float StartPosition);
/** Set the play rate of the sequence player */
UFUNCTION(BlueprintCallable, Category = "Sequence Player", meta=(BlueprintThreadSafe))
static FSequencePlayerReference SetPlayRate(const FSequencePlayerReference& SequencePlayer, float PlayRate);
/** Set the current sequence of the sequence player */
UFUNCTION(BlueprintCallable, Category = "Sequence Player", meta=(BlueprintThreadSafe))
static FSequencePlayerReference SetSequence(const FSequencePlayerReference& SequencePlayer, UAnimSequenceBase* Sequence);
/** Set the current sequence of the sequence player with an inertial blend time */
UFUNCTION(BlueprintCallable, Category = "Sequence Player", meta=(BlueprintThreadSafe))
static FSequencePlayerReference SetSequenceWithInertialBlending(const FAnimUpdateContext& UpdateContext, const FSequencePlayerReference& SequencePlayer, UAnimSequenceBase* Sequence, float BlendTime = 0.2f);
};