FMLDeformerVizSettingsDetails | Unreal Engine 5.2 Documentation

API > API/Plugins > API/Plugins/MLDeformerFrameworkEditor

Inheritance Hierarchy

References


Module	MLDeformerFrameworkEditor
Header	/Engine/Plugins/Animation/MLDeformer/MLDeformerFramework/Source/MLDeformerFrameworkEditor/Public/MLDeformerVizSettingsDetails.h
Include	#include "MLDeformerVizSettingsDetails.h"

Syntax

class FMLDeformerVizSettingsDetails : public IDetailCustomization

Remarks

The detail customization base class for any UMLDeformerVizSettings inherited object. This automatically adds the settings of the UMLDeformerVizSettings class to the UI and creates some groups, inserts error messages when needed, etc.

Variables

Type	Name	Description
IDetailLayoutBuilder *	DetailLayoutBuilder	Associated detail layout builder.
FMLDeformerEditorModel *	EditorModel	The editor model of the runtime model.
IDetailCategoryBuilder *	LiveSettingsCategory	A pointer to the live settings category.
FNumberFormattingOptions	MemUsageMetricFormat	Number format used for memory usage numbers.
TObjectPtr< UMLDeformerModel >	Model	The ML deformer model that these visualization settings belong to.
FNumberFormattingOptions	PerformanceMetricFormat	Number format used for performance numbers.
IDetailCategoryBuilder *	SharedCategoryBuilder	A pointer to the shared settings category.
IDetailCategoryBuilder *	StatsCategoryBuilder	A pointer to the statistics category.
IDetailGroup *	StatsGPUMemUsageGroup	GPU memory usage subgroup.
IDetailGroup *	StatsMainMemUsageGroup	Main memory usage subgroup.
IDetailGroup *	StatsMemUsageGroup	The memory usage group inside the statistics category.
IDetailGroup *	StatsPerformanceGroup	The performance group inside the statistics category.
IDetailCategoryBuilder *	TestAssetsCategory	A pointer to the test assets category.
IDetailCategoryBuilder *	TrainingMeshesCategoryBuilder	A pointer to the training mesh category. This is only visible in training mode.
TObjectPtr< UMLDeformerVizSettings >	VizSettings	The visualization settings we are viewing.

Functions

Type	Name	Description
void	AddAdditionalSettings ()	Add any additional settings.
void	AddDeformerGraphErrors ()	Add some error related to the deformer graph.
void	AddGroundTruth ()	Add the ground truth test sequence property.
void	AddStatistics ()	Add any statistics.
void	AddStatsPerfRow ( IDetailGroup& Group, const FText& Label, const FMLDeformerEditorModel* InEditorModel, const FNumberFormattingOptions& Format, bool bHighlight, TFunctionRef< int32(const FMLDeformerEditorModel*)> GetCyclesFunction )
void	AddTestSequenceErrors ()	Add some error message related to the test animation sequence.
void	CreateCategories ()	Create the categories to which we can add properties. Update the member category pointers to those.
bool	FilterAnimSequences ( const FAssetData& AssetData, USkeleton* Skeleton )	The filter that only shows anim sequences that are compatible with the given skeleton.
IDetailLayoutBuilder *	GetDetailLayoutBuilder ()	Get a pointer to the detail layout builder.
bool	IsResetToDefaultDeformerGraphVisible ( TSharedPtr< IPropertyHandle > PropertyHandle )	Check if the reset to default button next to the deformer graph property should be visible or not.
void	OnResetToDefaultDeformerGraph ( TSharedPtr< IPropertyHandle > PropertyHandle )	When we click the reset to default button next to the deformer graph property.
bool	UpdateMemberPointers ( const TArray< TWeakObjectPtr< UObject >>& Objects )	Update the class member pointers, which includes the pointer to the model, its editor model, and the viz settings.