UAnimationBlueprintLibrary::EvaluateRootBoneTimecodeSubframeAttributeAtTime

Evaluates the subframe timecode attribute (e.g. "TCSubframe") of the root bone and returns the resulting value.

Unreal Engine C++ API Reference > Editor > AnimationBlueprintLibrary > UAnimationBlueprintLibrary

References

   
Module AnimationBlueprintLibrary
Header /Engine/Source/Editor/AnimationBlueprintLibrary/Public/AnimationBlueprintLibrary.h
Include #include "AnimationBlueprintLibrary.h"
Source /Engine/Source/Editor/AnimationBlueprintLibrary/Private/AnimationBlueprintLibrary.cpp
static bool EvaluateRootBoneTimecodeSubframeAttributeAtTime
(
    const [UAnimSequenceBase](API\Runtime\Engine\Animation\UAnimSequenceBase) * AnimationSequenceBase,
    const float EvalTime,
    float & OutSubframe
)

Remarks

Evaluates the subframe timecode attribute (e.g. "TCSubframe") of the root bone and returns the resulting value.

Since the subframe component of FFrameTime is clamped to the range [0.0, 1.0), it cannot accurately represent the use case where the timecode metadata represents subframe values as whole numbered subframes instead of as a percentage of a frame the way the engine does. The subframe component of the FQualifiedFrameTime returned by EvaluateRootBoneTimecodeAttributesAtTime() may not reflect the authored subframe metadata in that case.

This function allows access to the subframe values that were actually authored in the timecode metadata.
true if the root bone had a subframe timecode attribute that could be evaluated and a value was set, or false otherwise.

Parameters

Name Description
AnimationSequenceBase Anim sequence for which to evaluate the root bone subframe attribute.
EvalTime Time (in seconds) at which to evaluate the subframe timecode bone attribute.
OutSubframe Resulting subframe value from evaluation. If no subframe timecode attribute is present on the bone or if it cannot be evaluated, the output parameter will not be modified.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library