Navigation
API > API/Plugins > API/Plugins/NearestNeighborModel
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.
| Name | UNearestNeighborModelSection |
| Type | class |
| Header File | /Engine/Plugins/Animation/MLDeformer/NearestNeighborModel/Source/NearestNeighborModel/Public/NearestNeighborModel.h |
| Include Path | #include "NearestNeighborModel.h" |
Syntax
UCLASS (MinimalAPI)
class UNearestNeighborModelSection : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UNearestNeighborModelSection
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| EOpFlag | UE::NearestNeighborModel::EOpFlag | NearestNeighborModel.h | |
| FPropertyChangedDelegate | TMulticastDelegate_TwoParams< void, FPropertyChangedEvent &, UNearestNeighborModelSection & > | NearestNeighborModel.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsReadyForInference | bool | Whether the section is ready for inference | NearestNeighborModel.h | |
| bIsReadyForTraining | bool | Whether the section is ready for training | NearestNeighborModel.h | |
| InputAnim | TUniquePtr< FMLDeformerGeomCacheTrainingInputAnim > | A temporary InputAnim used by GetInputAnim() function. | NearestNeighborModel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ClearReferences() |
NearestNeighborModel.h | ||
bool DoesUsePCA() |
NearestNeighborModel.h |
|
|
void FinalizeMorphTargets() |
NearestNeighborModel.h | ||
const TArray< float > & GetAssetNeighborCoeffs() |
NearestNeighborModel.h |
|
|
const TArray< int32 > & GetAssetNeighborIndexMap() |
NearestNeighborModel.h | ||
const TArray< float > & GetAssetNeighborOffsets() |
NearestNeighborModel.h | ||
int32 GetAssetNumNeighbors() |
NearestNeighborModel.h |
|
|
const TArray< float > & GetBasis() |
NearestNeighborModel.h |
|
|
| NearestNeighborModel.h | |||
FString GetBoneNamesString() |
NearestNeighborModel.h | ||
const TArray< int32 > & GetExcludedFrames() |
NearestNeighborModel.h | ||
FString GetExternalTxtFile() |
NearestNeighborModel.h | ||
FMLDeformerGeomCacheTrainingInputAnim * GetInputAnim() |
NearestNeighborModel.h | ||
int32 GetMeshIndex() |
NearestNeighborModel.h | ||
const UNearestNeighborModel * GetModel() |
NearestNeighborModel.h | ||
UGeometryCache * GetMutableNeighborMeshes() |
NearestNeighborModel.h | ||
UAnimSequence * GetMutableNeighborPoses() |
Avoid mutable getters. Changing NeighborPoses or NeighborMeshes may cause unexpected errors. | NearestNeighborModel.h | |
const TArray< float > & GetNeighborCoeffs() |
NearestNeighborModel.h | ||
const UGeometryCache * GetNeighborMeshes() |
NearestNeighborModel.h | ||
const UAnimSequence * GetNeighborPoses() |
NearestNeighborModel.h | ||
int32 GetNumBasis() |
NearestNeighborModel.h |
|
|
int32 GetNumVertices() |
NearestNeighborModel.h | ||
bool GetRuntimeNeighborOffsets
(
TArray< float >& OutNeighborOffsets |
NearestNeighborModel.h | ||
int32 GetRuntimeNumNeighbors() |
NearestNeighborModel.h | ||
const TArray< int32 > & GetVertexMap() |
NearestNeighborModel.h |
|
|
const TArray< float > & GetVertexMean() |
NearestNeighborModel.h |
|
|
const TArray< float > & GetVertexWeights() |
NearestNeighborModel.h |
|
|
ENearestNeighborModelSectionWeightMapCreationMethod GetWeightMapCreationMethod() |
NearestNeighborModel.h | ||
PRAGMA_DISABLE_DEPRECATION_WARNINGS void InitFromClothPartData
(
FClothPartData& InPart |
NearestNeighborModel.h | ||
void InvalidateInference() |
NearestNeighborModel.h | ||
void InvalidateTraining() |
NearestNeighborModel.h | ||
bool IsReadyForInference() |
NearestNeighborModel.h | ||
bool IsReadyForTraining() |
NearestNeighborModel.h | ||
EOpFlag NormalizeVertexWeights() |
Do not call this function directly. Call UNearestNeighborModel::NormalizeVertexWeights() instead. | NearestNeighborModel.h | |
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
NearestNeighborModel.h | ||
| NearestNeighborModel.h | |||
void SetExternalTxtFile
(
const FString& InFile |
NearestNeighborModel.h | ||
void SetMeshIndex
(
int32 Index |
NearestNeighborModel.h | ||
void SetModel
(
UNearestNeighborModel* InModel |
NearestNeighborModel.h | ||
void SetNumBasis
(
const int32 InNumBasis |
NearestNeighborModel.h | ||
void SetVertexMapString
(
const FString& InString |
NearestNeighborModel.h | ||
EOpFlag UpdateForInference() |
NearestNeighborModel.h | ||
EOpFlag UpdateForTraining() |
NearestNeighborModel.h | ||
bool UpdateRuntimeNeighbors() |
NearestNeighborModel.h | ||
EOpFlag UpdateVertexWeights() |
NearestNeighborModel.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetAttributeNamePropertyName() |
NearestNeighborModel.h | ||
static FName GetExcludedFramesPropertyName() |
NearestNeighborModel.h | ||
static FName GetExternalTxtFilePropertyName() |
NearestNeighborModel.h | ||
static FName GetNeighborMeshesPropertyName() |
NearestNeighborModel.h | ||
static FName GetNeighborPosesPropertyName() |
NearestNeighborModel.h | ||
static FName GetNumBasisPropertyName() |
NearestNeighborModel.h | ||
static FName GetVertexMapStringPropertyName() |
NearestNeighborModel.h | ||
static FName GetWeightMapCreationMethodPropertyName() |
NearestNeighborModel.h |