FMathStructCustomization

Base class for math struct customization (e.g, vector, rotator, color)

Unreal Engine C++ API Reference > Editor > DetailCustomizations > Customizations

Inheritance Hierarchy

References

   
Module DetailCustomizations
Header /Engine/Source/Editor/DetailCustomizations/Public/Customizations/MathStructCustomizations.h
Include #include "Customizations/MathStructCustomizations.h"

Syntax

class FMathStructCustomization : public [IPropertyTypeCustomization](API\Editor\PropertyEditor\IPropertyTypeCustomization)  

Remarks

Base class for math struct customization (e.g, vector, rotator, color)

Variables

Type Name Description
bool bIsUsingSlider True if a value is being changed by dragging a slider
bool bPreserveScaleRatio True if the ratio is locked when scaling occurs (uniform scaling)
TArray< TWeakPt... NumericEntryBoxWidgetList All created numeric entry box widget for this customization
FOnNumericEntry... OnNumericEntryBoxDynamicSliderMaxValueChanged  
FOnNumericEntry... OnNumericEntryBoxDynamicSliderMinValueChanged  
TArray< TShared... SortedChildHandles All the sorted children of the struct that should be displayed

Constructors

Type Name Description
  FMathStructCustomization ()  

Destructors

Type Name Description
  ~FMathStructCustomization ()  

Functions

Type Name Description
void ExtractNumericMetadata ( TSharedRef< IPropertyHandle >& Pro..., FNumericMetadata< NumericType >& M... ) Utility function that will extract common Math related numeric metadata
FOnNumericEn... GetOnNumericEntryBoxDynamicSliderMaxValueChangedDelegate () Return max/min slider value changed delegate (only apply if SupportDynamicSliderMaxValue or SupportDynamicSliderMinValue are true)
FOnNumericEn... GetOnNumericEntryBoxDynamicSliderMinValueChangedDelegate ()  
void GetSortedChildren ( TSharedRef< IPropertyHandle > Struc..., TArray< TSharedRef< IPropertyHandle... ) Gets the sorted children for the struct
bool IsValueEnabled ( TWeakPtr< IPropertyHandle > WeakHan... ) Called to see if the value is enabled for editing
TSharedRef< ... MakeChildWidget ( TSharedRef< IPropertyHandle >& Str..., TSharedRef< IPropertyHandle >& Pro... ) Constructs a widget for the property handle
void MakeHeaderRow ( TSharedRef< IPropertyHandle >& Str..., FDetailWidgetRow& Row ) Makes the header row for the customization
TSharedRef< ... MakeInstance ()  
void OnDynamicSliderMaxValueChanged ( NumericType NewMaxSliderValue, TWeakPtr< SWidget > InValueChangedS..., bool IsOriginator, bool UpdateOnlyIfHigher ) Callback when the max/min spinner value are changed (only apply if SupportDynamicSliderMaxValue or SupportDynamicSliderMinValue are true)
void OnDynamicSliderMinValueChanged ( NumericType NewMinSliderValue, TWeakPtr< SWidget > InValueChangedS..., bool IsOriginator, bool UpdateOnlyIfLower )  
TOptional< N... OnGetValue ( TWeakPtr< IPropertyHandle > WeakHan... ) Gets the value as a float for the provided property handle
FText OnGetValueToolTip ( TWeakPtr< IPropertyHandle > WeakHan... ) Gets the tooltip for the value.
void OnValueChanged ( NumericType NewValue, TWeakPtr< IPropertyHandle > WeakHan... ) Called when the value is changed in the property editor
void OnValueCommitted ( NumericType NewValue, ETextCommit::Type CommitType, TWeakPtr< IPropertyHandle > WeakHan... ) Called when the value is committed from the property editor
void SetValue ( NumericType NewValue, EPropertyValueSetFlags::Type Flags, TWeakPtr< IPropertyHandle > WeakHan... ) Called to set the value of the property handle.

Overridden from IPropertyTypeCustomization

Type Name Description
void CustomizeChildren ( TSharedRef< IPropertyHandle > Prope..., IDetailChildrenBuilder& ChildBuild..., IPropertyTypeCustomizationUtils& C... ) Called when the children of the property should be customized or extra rows added
void CustomizeHeader ( TSharedRef< IPropertyHandle > Struc..., FDetailWidgetRow& HeaderRow, IPropertyTypeCustomizationUtils& S... ) IPropertyTypeCustomization instance

Classes

Type Name Description
Public struct FNumericMetadata Argument struct for ExtractNumericMetadata, to make it easier to add new metadata to extract.

Typedefs

Name Description
FOnNumericEntryBoxDynamicSliderMinMaxValueChanged Notification when the max/min slider values are changed (only apply if SupportDynamicSliderMaxValue or SupportDynamicSliderMinValue are true)

Deprecated Functions

Type Name Description
void ExtractNumericMetadata ( TSharedRef< IPropertyHandle >& Pro..., TOptional< NumericType >& MinValue, TOptional< NumericType >& MaxValue, TOptional< NumericType >& SliderMi..., TOptional< NumericType >& SliderMa..., NumericType& SliderExponent, NumericType& Delta, int32& ShiftMouseMovePixelPerDelta, bool& bSupportDynamicSliderMaxValu..., bool& bSupportDynamicSliderMinValu... ) Use ExtractNumericMetadata overload with struct argument instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library