1. Epic GamesDeveloper
  3. UNearestNeighborModel

UNearestNeighborModel

The nearest neighbor model.

API > API/Plugins > API/Plugins/NearestNeighborModel

Inheritance Hierarchy

References

   
Module NearestNeighborModel
Header /Engine/Plugins/Animation/MLDeformer/NearestNeighborModel/Source/NearestNeighborModel/Public/NearestNeighborModel.h
Include #include "NearestNeighborModel.h"

Syntax

UCLASS ()  
class UNearestNeighborModel : public UMLDeformerMorphModel

Remarks

The nearest neighbor model. This model contains the linear basis of the vertex deltas and a small set of meshes for nearest neighbor search. Given a new pose, the pre-trained neural network first predicts the coefficients of the vertex deltas. Then this model uses the predicted coeffcients to find a nearest neighbor in the small dataset. The total vertex delta is computed by vertex_delta = mean_delta + basis * coeff + nearest_neighbor_delta To prevent popping, a time filtering is applied on predicted vertex deltas. The vertex delta at time t is computed by vertex_delta(t) = decay_factor * vertex_delta(t-1) + (1 - decay_factor) * vertex_delta The mesh can be separated into several sections (e.g. shirt, pants...). The nearest neighbor search is carried out separately for each section. The basis and the nearest neighbor data are compressed into morph targets.

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite int32 BatchSize Number of data samples processed together as a group in a single pass.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite bool bUseDualQuaternionDeltas Whether to use dual quaternion deltas. If false, LBS deltas will be used.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite bool bUseFileCache Whether to cache intermediate results on disk.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite bool bUseInputMultipliers Whether to use input multipliers. This can be used to debug bad network input.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite bool bUsePCA Whether to use pre-computed PCA basis. If false, basis will be learned at training time.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite bool bUseRBF Whether to use radial basis function to blend multiple nearest neighbors to produce smoother result.
Protected variable TOptional< FDateTime > CachedDeltasTimestamp  
Protected variable TOptional< FDateTime > CachedNetworkTimestamp  
Protected variable TOptional< FDateTime > CachedPCATimestamp  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float DecayFactor The ratio of previous frame deltas added into the current frame deltas.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite int32 EarlyStopEpochs The number of epochs to stop training if there is no improvement in accuracy.
Protected variable UProperty Category, Meta BlueprintReadOnly visibleanywhere FString FileCacheDirectory Directory to save the intermediate results.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< int32 > HiddenLayerDims Dimension of hidden layers in the network. This cannot be empty.
Protected variable UProperty Category BlueprintReadOnly visibleanywhere int32 InputDim Network input dimensions.
Protected variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FVector3f > InputMultipliers Values to be multiplied to the input. This can be used to debug bad network input.
Protected variable UProperty Category BlueprintReadWrite TArray< float > InputsMax The max input values observed throughout the entire training set.
Protected variable UProperty Category BlueprintReadWrite TArray< float > InputsMin The min input values observed throughout the entire training set.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite float LearningRate The size of the step when optimizing the network.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float NearestNeighborOffsetWeight The weight multiplied to nearest neighbor deltas.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int32 NumBasisPerSection The number of basis used in each section.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int32 NumIterations The number of iterations to train the model for.
Protected variable UProperty Category BlueprintReadOnly visibleanywhere int32 OutputDim Network output dimensions.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float RBFSigma Range to blend nearest neighbors.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite float RegularizationFactor The regularization factor.
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite float SmoothLossBeta The beta parameter in the smooth L1 loss function, which describes below which absolute error to use a squared term.

Constructors

  Type Name Description
Public function  

UNearestNeighborModel ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void  
Public function void  
Public function void  
Public function Const void

ClipInputs ( TArrayView< float > Inputs
)

  
Public function Virtual UMLDeformerInputInfo *  
Public function Const bool  
Public function Const bool  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const bool  
Public function Const UFunction BlueprintPure, Category int32  
Public function Static FName  
Public function Const UFunction BlueprintPure, Category TArray< FString >  
Public function Const TOptional< FDateTime >  
Public function Const UFunction BlueprintPure, Category TArray< FString >  
Public function Const TOptional< FDateTime >  
Public function Const UFunction BlueprintPure, Category TArray< FString >  
Public function Const TOptional< FDateTime >  
Public function Const float  
Public function Static FName  
Public function Virtual Const FString  
Public function Virtual Const FString  
Public function Const UFunction BlueprintPure, Category int32  
Public function Static FName  
Public function Const const FString &  
Public function Static FName  
Public function Const UFunction BlueprintPure, Category TArray< int32 >  
Public function Static FName  
Public function Const UFunction BlueprintPure, Category int32  
Public function Static FName  
Public function Const UFunction BlueprintPure, Category float  
Public function Static FName  
Public function TArray< FInt32Range >

GetMeshVertRanges ( const USkeletalMesh& SkelMesh
)

  
Public function Const UFunction BlueprintPure, Category FString  
Public function Const FDateTime  
Public function FMLDeformerGeomCacheTrainingInputAnim *

GetNearestNeighborAnim ( int32 SectionIndex
)

  
Public function Const const FMLDeformerGeomCacheTrainingInputAnim *

GetNearestNeighborAnim ( int32 SectionIndex
)

  
Public function Const float  
Public function Static FName  
Public function Const FString  
Public function Const FDateTime  
Public function Const UFunction BlueprintPure, Category int32  
Public function Static FName  
Public function Const UFunction Meta int32  
Public function Virtual Const int32  
Public function Virtual Const int32  
Public function Const UFunction BlueprintPure, Category int32  
Public function Static FName  
Public function Const int32  
Public function Const UFunction BlueprintPure, Category int32  
Public function Const TWeakObjectPtr< const UNetwork >  
Public function Const UFunction BlueprintPure, Category int32  
Public function Static FName  
Public function Const UFunction BlueprintPure, Category const TArray< int32 > &  
Public function Const float  
Public function Static FName  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category const UNearestNeighborModelSection &

GetSection ( int32 Index
)

  
Public function UNearestNeighborModelSection &

GetSection ( int32 Index
)

  
Public function Const UFunction BlueprintPure, Category const UNearestNeighborModelSection *

GetSectionPtr ( int32 Index
)

 GetSectionPtr is reserved for python. Use GetSection for C++.
Public function Static FName  
Public function Const UFunction BlueprintPure, Category float  
Public function Const UFunction BlueprintPure, Category int32  
Public function Const int32  
Public function Static FName  
Public function Static FName  
Public function Static FName  
Public function Static FName  
Public function Const const TArray< float > &  
Public function void  
Public function void  
Public function void  
Public function void  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const UFunction BlueprintPure, Category bool  
Public function Const UFunction BlueprintPure, Category bool  
Public function Virtual Const bool  
Public function bool  
Public function UNearestNeighborModelSection *

OnSectionAdded ( int32 NewIndex
)

  
Public function Virtual void  
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function void  
Public function void

SetFileCacheDirectory ( const FString& InFileCacheDirectory
)

  
Public function void  
Public function EOpFlag  
Public function EOpFlag  
Public function void Make sure to call this function after changing the morph targets.
Public function void  
Public function void  

Overridden from UMLDeformerMorphModel

  Type Name Description
Public function Virtual UMLDeformerModelInstance *  
Public function Virtual Const bool  
Public function Virtual void  
Public function Virtual void

Serialize ( FArchive& Archive
)

  

Overridden from UMLDeformerGeomCacheModel

  Type Name Description
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual Const void  
Public function Virtual void  

Typedefs

Name Description
EOpFlag  
FSection  
UNetwork  

Constants

Name Description
NearestNeighborNumFloatsPerBone  
NearestNeighborNumFloatsPerCurve  

Deprecated Variables

  Type Name Description
Protected variable UProperty PRAGMA_DISABLE_DEPRECATION_WARNINGSTArray< FClothPartData > ClothPartData_DEPRECATED  
Protected variable UProperty Meta int32 NumEpochs_DEPRECATED Max number of cycles iterated through the training set.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page