1. Epic GamesDeveloper
  3. FEvaluationVM

FEvaluationVM

Evaluation VM

API > API/Plugins > API/Plugins/UAFAnimGraph

Evaluation VM

This struct holds the internal state when we execute and FEvaluationProgram. Our virtual machine is stack based, values are generally pushed and popped.

   
Name FEvaluationVM
Type struct
Header File /Engine/Plugins/Experimental/UAF/UAFAnimGraph/Source/UAFAnimGraph/Public/EvaluationVM/EvaluationVM.h
Include Path #include "EvaluationVM/EvaluationVM.h"

Syntax

struct FEvaluationVM

Constructors

Name Remarks Include Path Unreal Specifiers

FEvaluationVM ( EEvaluationFlags InEvaluationFlags,
const UE::UAF::FReferencePose& InReferencePose,
int32 InCurrentLOD
)

   EvaluationVM/EvaluationVM.h  
Disallow copy. EvaluationVM/EvaluationVM.h  
Allow move. EvaluationVM/EvaluationVM.h  
  EvaluationVM/EvaluationVM.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
CurrentLOD int32 Current LOD we are evaluating at. EvaluationVM/EvaluationVM.h  
CurveFilter UE::Anim::FCurveFilter Default curve filter. EvaluationVM/EvaluationVM.h  
EvaluationFlags EEvaluationFlags Flags that control what we wish to evaluate. EvaluationVM/EvaluationVM.h  
InternalStacks TMap< FName, FEvaluationVMStack > Various internal stacks that tasks can use (e.g. keyframe state) EvaluationVM/EvaluationVM.h  
ReferencePose const UE::UAF::FReferencePose * Reference pose. EvaluationVM/EvaluationVM.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 GetCurrentLOD()

   EvaluationVM/EvaluationVM.h  

EEvaluationFlags GetFlags()

 Returns the evaluation flags. EvaluationVM/EvaluationVM.h  

bool IsValid()

 Returns true if we are fully initialized. EvaluationVM/EvaluationVM.h  

FKeyframeState MakeReferenceKeyframe ( bool bAdditiveKeyframe
) const

 Returns a reference keyframe (bind pose or additive identity) EvaluationVM/EvaluationVM.h  

FKeyframeState MakeUninitializedKeyframe ( bool bAdditiveKeyframe
) const

 Returns an uninitialized keyframe with memory pre-allocated. EvaluationVM/EvaluationVM.h  

const ValueType * PeekValue ( const FEvaluationVMStackName& StackName,
uint32 Offset
) const

 Returns an immutable pointer to a value at some offset from the top of the evaluation stack An offset of 0 means the top of the stack Returns valid pointer if an entry exists, nullptr otherwise EvaluationVM/EvaluationVM.h  

ValueType * PeekValueMutable ( const FEvaluationVMStackName& StackName,
uint32 Offset
)

 Returns a mutable pointer to a value at some offset from the top of the evaluation stack An offset of 0 means the top of the stack Returns valid pointer if an entry exists, nullptr otherwise EvaluationVM/EvaluationVM.h  

bool PopValue ( const FEvaluationVMStackName& StackName,
ValueType& OutValue
)

 Pops the top value from the evaluation stack Returns true if the stack was not empty and a value is returned, false otherwise EvaluationVM/EvaluationVM.h  

void PushValue ( const FEvaluationVMStackName& StackName,
ValueType&& Value
)

 Pushes and moves the specified value on its evaluation stack. EvaluationVM/EvaluationVM.h  

void Shrink()

 Trims internal containers to only use as much memory as required to avoid slack. EvaluationVM/EvaluationVM.h  

Operators

Name Remarks Include Path Unreal Specifiers
  EvaluationVM/EvaluationVM.h  
  EvaluationVM/EvaluationVM.h  

See Also

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page