Navigation
API > API/Plugins > API/Plugins/MLDeformerFrameworkEditor
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.
| Name | FMLDeformerModelDetails |
| Type | class |
| Header File | /Engine/Plugins/Animation/MLDeformer/MLDeformerFramework/Source/MLDeformerFrameworkEditor/Public/MLDeformerModelDetails.h |
| Include Path | #include "MLDeformerModelDetails.h" |
Syntax
class FMLDeformerModelDetails : public IDetailCustomization
Implements Interfaces
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddAnimSequenceErrors() |
Add additional errors related to the training animation sequence. | MLDeformerModelDetails.h | |
virtual void AddBaseMeshErrors() |
Add additional errors related to the base mesh. | MLDeformerModelDetails.h | |
virtual void AddBoneInputErrors() |
Add additional errors related to bone inputs. | MLDeformerModelDetails.h | |
virtual void AddCurveInputErrors() |
Add additional errors related to curve inputs. | MLDeformerModelDetails.h | |
virtual void AddIncompatibleSkeletonErrors() |
Show errors about skeletons being incompatible. | MLDeformerModelDetails.h | |
virtual void AddTargetMesh () |
Add the target mesh property. | MLDeformerModelDetails.h | |
virtual void AddTrainingInputAnims() |
Add the property that shows the input animations. | MLDeformerModelDetails.h | |
virtual void AddTrainingInputErrors() |
Add additional training input errors. | MLDeformerModelDetails.h | |
virtual void AddTrainingInputFilters() |
Add additional training input filters. Filters are things like a list of bones, or curves. | MLDeformerModelDetails.h | |
virtual void AddTrainingInputFlags() |
Add training input flags, which basically are things like the check boxes that specify whether bones or curves (or both) should be included. | MLDeformerModelDetails.h | |
virtual void AddTrainingSettingsErrors() |
Add training settings errors. | MLDeformerModelDetails.h | |
virtual void CreateCategories() |
Create the categories that we can add properties to. This will update the category member pointers. | MLDeformerModelDetails.h | |
virtual void CustomizeDetails
(
IDetailLayoutBuilder& DetailBuilder |
MLDeformerModelDetails.h | ||
virtual bool IsBonesFlagVisible() |
Is the "include bones" checkbox visible? | MLDeformerModelDetails.h | |
virtual bool IsCurvesFlagVisible() |
Is the "include curves" checkbox visible? | MLDeformerModelDetails.h | |
virtual bool UpdateMemberPointers
(
const TArray< TWeakObjectPtr< UObject > >& Objects |
Update the class member pointers, which includes the pointer to the model, and its editor model. | MLDeformerModelDetails.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool FilterAnimSequences
(
const FAssetData& AssetData, |
The filter that only shows anim sequences that are compatible with the given skeleton. | MLDeformerModelDetails.h | |
FReply OnFilterAnimatedBonesOnly() |
Executed when we press the Animated Bones Only button. | MLDeformerModelDetails.h | |
FReply OnFilterAnimatedCurvesOnly() |
Executed when we press the Animated Curves Only button. | MLDeformerModelDetails.h |
Deprecated Variables
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| TargetMeshCategoryBuilder_DEPRECATED | IDetailCategoryBuilder * | The category related to the target mesh. | MLDeformerModelDetails.h |