1. Epic GamesDeveloper
  3. FMLDeformerModelDetails

FMLDeformerModelDetails

The ML Deformer model detail customization base class.

API > API/Plugins > API/Plugins/MLDeformerFrameworkEditor

Inheritance Hierarchy

References

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

Syntax

class FMLDeformerModelDetails : public IDetailCustomization

Remarks

The ML Deformer model detail customization base class. This adds the shared properties, inserts error messages, creates some groups, etc. Model detail customizations should all inherit from this class. If you use a geometry cache based model however, you will likely inherit from other classes such as FMLDeformerGeomCacheModelDetails or FMLDeformerMorphModelDetails. Those classes are also inherited from this one though.

Variables

  Type Name Description
Protected variable IDetailCategoryBuilder * BaseMeshCategoryBuilder The category related to the base mesh.
Protected variable IDetailLayoutBuilder * DetailLayoutBuilder Associated detail layout builder.
Protected variable FMLDeformerEditorModel * EditorModel A pointer to the editor model of the runtime model.
Protected variable IDetailCategoryBuilder * InputOutputCategoryBuilder The category related to the inputs and outputs.
Protected variable IDetailCategoryBuilder * LODSettingsCategoryBuilder The LOD generation category.
Protected variable TObjectPtr< UMLDeformerModel > Model A pointer to the model we are customizing details for.
Protected variable IDetailCategoryBuilder * TrainingSettingsCategoryBuilder The training settings category. You most likely add your model properties to this.

Functions

  Type Name Description
Public function Virtual void Add additional errors related to the training animation sequence.
Public function Virtual void Add additional errors related to the base mesh.
Public function Virtual void Add additional errors related to bone inputs.
Public function Virtual void Add additional errors related to curve inputs.
Public function Virtual void Show errors about skeletons being incompatible.
Public function Virtual void Add the target mesh property.
Public function Virtual void Add the property that shows the input animations.
Public function Virtual void Add additional training input errors.
Public function Virtual void Add additional training input filters. Filters are things like a list of bones, or curves.
Public function Virtual void Add training input flags, which basically are things like the check boxes that specify whether bones or curves (or both) should be included.
Public function Virtual void Add training settings errors.
Public function Virtual void Create the categories that we can add properties to. This will update the category member pointers.
Protected function bool

FilterAnimSequences ( const FAssetData& AssetData,
USkeleton* Skeleton
)

 The filter that only shows anim sequences that are compatible with the given skeleton.
Public function Virtual Const bool Is the "include bones" checkbox visible?
Public function Virtual Const bool Is the "include curves" checkbox visible?
Protected function Const FReply Executed when we press the Animated Bones Only button.
Protected function Const FReply Executed when we press the Animated Curves Only button.
Public function Virtual bool Update the class member pointers, which includes the pointer to the model, and its editor model.

Overridden from IDetailCustomization

  Type Name Description
Public function Virtual void Called when details should be customized

Deprecated Variables

  Type Name Description
Protected variable IDetailCategoryBuilder * TargetMeshCategoryBuilder_DEPRECATED The category related to the target mesh.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page