1. Epic GamesDeveloper
  3. UNearestNeighborModelSection

UNearestNeighborModelSection

The section of 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 UNearestNeighborModelSection : public UObject

Remarks

The section of the nearest neighbor model. Each section contains a set of vertices in the original skeletal mesh. The nearest neighbor search is performed on each section separately. For example, if a character asset has both shirt and pants mesh, user can define sperate two separate sections for shirt and pants, and the nearest neighbor search will be performed separately on those two sections.

Variables

  Type Name Description
Protected variable UProperty TArray< float > AssetNeighborCoeffs Flattened array of neighbor coefficients before excluding frames.
Protected variable UProperty TArray< int32 > AssetNeighborIndexMap The index into the original nearest neighbor ROM asset after frames are excluded.
Protected variable UProperty TArray< float > AssetNeighborOffsets Flattened array of neighbor offsets before excluding frames.
Protected variable UProperty Category, EditAnywhere, Meta FName AttributeName A float vertex attribute that is used to compute weight maps
Protected variable UProperty TArray< float > Basis Flattened array of basis. The shape of basis is (CoeffNum, NumVertices * 3)
Protected variable UProperty TArray< FName > BoneNames Bone names used to create weight map.
Protected variable UProperty Category, EditAnywhere TArray< int32 > ExcludedFrames Frames to be excluded from the nearest neighbor ROM
Protected variable UProperty Category visibleanywhere FString ExternalTxtFile The path to the txt file containing vertex weights.
Protected variable UProperty int32 MeshIndex The mesh index in SkeletalMeshRenderData
Protected variable UProperty TObjectPtr< UNearestNeighborModel > Model The parent nearest neighbor model
Protected variable UProperty Category, EditAnywhere, Meta TObjectPtr< UGeometryCache > NeighborMeshes Geometry cache of the nearest neighbor ROM.
Protected variable UProperty Category, EditAnywhere, Meta TObjectPtr< UAnimSequence > NeighborPoses Poses of the nearest neighbor ROM.
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite displayname int32 NumPCACoeffs Number of PCA coefficients for this section.
Protected variable UProperty Category BlueprintReadOnly visibleanywhere int32 NumVertices Number of vertices in this section
Protected variable UProperty TArray< float > RuntimeNeighborCoeffs Flattened array of neighbor offsets after excluding frames.
Protected variable UProperty Category BlueprintReadOnly visibleanywhere int32 RuntimeNumNeighbors Number of neighbors in this section after excluding frames
Protected variable UProperty TArray< int32 > VertexMap Vertex indices for this section. VertexMap.Num() == NumVertices
Protected variable UProperty Category, EditAnywhere, Meta FString VertexMapString A string containing vertex indices for this section, e.g. "2, 3, 5-8, 9, 11-20"
Protected variable UProperty TArray< float > VertexMean The vertex mean on the shape. This array has a size of NumVertices * 3
Protected variable UProperty TArray< float > VertexWeights The vertex weights for this section. VertexWeights.Num() == NumVertices.
Protected variable UProperty Category, EditAnywhere ENearestNeighborModelSectionWeightMapCreationMethod WeightMapCreationMethod Method to create weight map for this section.

Functions

  Type Name Description
Public function void  
Public function Const UFunction BlueprintPure, Category bool  
Public function void  
Public function Const UFunction BlueprintPure, Category const TArray< float > &  
Public function Const const TArray< int32 > &  
Public function Const const TArray< float > &  
Public function Const UFunction BlueprintPure, Category int32  
Public function Static FName  
Public function Const UFunction BlueprintPure, Category const TArray< float > &  
Public function Const const TArray< FName > &  
Public function Const FString  
Public function Const const TArray< int32 > &  
Public function Static FName  
Public function Const FString  
Public function Static FName  
Public function Const FMLDeformerGeomCacheTrainingInputAnim *  
Public function Const int32  
Public function Const const UNearestNeighborModel *  
Public function Const UGeometryCache *  
Public function Const UAnimSequence * Avoid mutable getters. Changing NeighborPoses or NeighborMeshes may cause unexpected errors.
Public function Const const TArray< float > &  
Public function Const const UGeometryCache *  
Public function Static FName  
Public function Const const UAnimSequence *  
Public function Static FName  
Public function Const UFunction BlueprintPure, Category int32  
Public function Static FName  
Public function Const int32  
Public function Const bool

GetRuntimeNeighborOffsets ( TArray< float >& OutNeighborOffsets
)

  
Public function Const int32  
Public function Const UFunction BlueprintPure, Category const TArray< int32 > &  
Public function Static FName  
Public function Const UFunction BlueprintPure, Category const TArray< float > &  
Public function Const UFunction BlueprintPure, Category const TArray< float > &  
Public function Const ENearestNeighborModelSectionWeightMapCreationMethod  
Public function Static FName  
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS void

InitFromClothPartData ( FClothPartData& InPart
)

  
Public function void  
Public function void  
Public function Const bool  
Public function Const bool  
Public function EOpFlag Do not call this function directly. Call UNearestNeighborModel::NormalizeVertexWeights() instead.
Public function void

SetBoneNames ( const TArray< FName >& InBoneNames
)

  
Public function void

SetExternalTxtFile ( const FString& InFile
)

  
Public function void

SetMeshIndex ( int32 Index
)

  
Public function void  
Public function void

SetNumBasis ( const int32 InNumBasis
)

  
Public function void

SetVertexMapString ( const FString& InString
)

  
Public function EOpFlag  
Public function EOpFlag  
Public function bool  
Public function EOpFlag  

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Typedefs

Name Description
EOpFlag  
FPropertyChangedDelegate  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page