1. Epic GamesDeveloper
  3. FMathStructCustomization

FMathStructCustomization

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

API > API/Editor > API/Editor/DetailCustomizations > API/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

Remarks

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

Variables

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Static void

ExtractNumericMetadata ( TSharedRef< IPropertyHandle >& PropertyHandle,
FNumericMetadata< NumericType >& MetadataOut
)

 Utility function that will extract common Math related numeric metadata
Public function FOnNumericEntryBoxDynamicSliderMinMaxValueChanged & Return max/min slider value changed delegate (only apply if SupportDynamicSliderMaxValue or SupportDynamicSliderMinValue are true)
Public function FOnNumericEntryBoxDynamicSliderMinMaxValueChanged &  
Protected function Virtual void

GetSortedChildren ( TSharedRef< IPropertyHandle > StructPropertyHandle,
TArray< TSharedRef< IPropertyHandle > >& OutChildren
)

 Gets the sorted children for the struct
Public function Const bool

IsValueEnabled ( TWeakPtr< IPropertyHandle > WeakHandlePtr
)

 Called to see if the value is enabled for editing
Protected function Virtual TSharedRef< SWidget >

MakeChildWidget ( TSharedRef< IPropertyHandle >& StructurePropertyHandle,
TSharedRef< IPropertyHandle >& PropertyHandle
)

 Constructs a widget for the property handle
Protected function Virtual void

MakeHeaderRow ( TSharedRef< IPropertyHandle >& StructPropertyHandle,
FDetailWidgetRow& Row
)

 Makes the header row for the customization
Public function Static TSharedRef< IPropertyTypeCustomization >  
Public function void

OnDynamicSliderMaxValueChanged ( NumericType NewMaxSliderValue,
TWeakPtr< SWidget > InValueChangedSourceWidget,
bool IsOriginator,
bool UpdateOnlyIfHigher
)

 Callback when the max/min spinner value are changed (only apply if SupportDynamicSliderMaxValue or SupportDynamicSliderMinValue are true)
Public function void

OnDynamicSliderMinValueChanged ( NumericType NewMinSliderValue,
TWeakPtr< SWidget > InValueChangedSourceWidget,
bool IsOriginator,
bool UpdateOnlyIfLower
)

  
Protected function Const TOptional< NumericType >

OnGetValue ( TWeakPtr< IPropertyHandle > WeakHandlePtr
)

 Gets the value as a float for the provided property handle
Protected function Const FText Gets the tooltip for the value.
Protected function void

OnValueChanged ( NumericType NewValue,
TWeakPtr< IPropertyHandle > WeakHandlePtr
)

 Called when the value is changed in the property editor
Protected function void

OnValueCommitted ( NumericType NewValue,
ETextCommit::Type CommitType,
TWeakPtr< IPropertyHandle > WeakHandlePtr
)

 Called when the value is committed from the property editor
Protected function void

SetValue ( NumericType NewValue,
EPropertyValueSetFlags::Type Flags,
TWeakPtr< IPropertyHandle > WeakHandlePtr
)

 Called to set the value of the property handle.

Overridden from IPropertyTypeCustomization

  Type Name Description
Public function Virtual void

CustomizeChildren ( TSharedRef< IPropertyHandle > PropertyHandle,
IDetailChildrenBuilder& ChildBuilder,
IPropertyTypeCustomizationUtils& CustomizationUtils
)

 Called when the children of the property should be customized or extra rows added
Public function Virtual void

CustomizeHeader ( TSharedRef< IPropertyHandle > StructPropertyHandle,
FDetailWidgetRow& HeaderRow,
IPropertyTypeCustomizationUtils& StructCustomizationUtils
)

 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
Public function Static void

ExtractNumericMetadata ( TSharedRef< IPropertyHandle >& PropertyHandle,
TOptional< NumericType >& MinValue,
TOptional< NumericType >& MaxValue,
TOptional< NumericType >& SliderMinValue,
TOptional< NumericType >& SliderMaxValue,
NumericType& SliderExponent,
NumericType& Delta,
int32& ShiftMouseMovePixelPerDelta,
bool& bSupportDynamicSliderMaxValue,
bool& bSupportDynamicSliderMinValue
)

 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

On this page