1. Epic GamesDeveloper
  3. FMathStructCustomization

FMathStructCustomization

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

API > API/Editor > API/Editor/DetailCustomizations

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

   
Name FMathStructCustomization
Type class
Header File /Engine/Source/Editor/DetailCustomizations/Public/Customizations/MathStructCustomizations.h
Include Path #include "Customizations/MathStructCustomizations.h"

Syntax

class FMathStructCustomization : public IPropertyTypeCustomization

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FMathStructCustomization()

   Customizations/MathStructCustomizations.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FMathStructCustomization()

   Customizations/MathStructCustomizations.h  

Structs

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

Typedefs

Name Type Remarks Include Path
FOnNumericEntryBoxDynamicSliderMinMaxValueChanged TMulticastDelegate_FourParams< void, float, TWeakPtr< SWidget >, bool, bool > Notification when the max/min slider values are changed (only apply if SupportDynamicSliderMaxValue or SupportDynamicSliderMinValue are true) Customizations/MathStructCustomizations.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void CustomizeChildren ( TSharedRef< IPropertyHandle > StructPropertyHandle,
IDetailChildrenBuilder& StructBuilder,
IPropertyTypeCustomizationUtils& StructCustomizationUtils
)

   Customizations/MathStructCustomizations.h  

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

 IPropertyTypeCustomization instance Customizations/MathStructCustomizations.h  

FOnNumericEntryBoxDynamicSliderMinMaxValueChanged & GetOnNumericEntryBoxDynamicSliderMaxValueChangedDelegate()

 Return max/min slider value changed delegate (only apply if SupportDynamicSliderMaxValue or SupportDynamicSliderMinValue are true) Customizations/MathStructCustomizations.h  

FOnNumericEntryBoxDynamicSliderMinMaxValueChanged & GetOnNumericEntryBoxDynamicSliderMinValueChangedDelegate()

   Customizations/MathStructCustomizations.h  

bool IsValueEnabled ( TWeakPtr< IPropertyHandle > WeakHandlePtr
) const

 Called to see if the value is enabled for editing Customizations/MathStructCustomizations.h  

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) Customizations/MathStructCustomizations.h  

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

   Customizations/MathStructCustomizations.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

 Gets the sorted children for the struct Customizations/MathStructCustomizations.h  

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

 Constructs a widget for the property handle Customizations/MathStructCustomizations.h  

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

 Makes the header row for the customization Customizations/MathStructCustomizations.h  

TOptional< NumericType > OnGetValue ( TWeakPtr< IPropertyHandle > WeakHandlePtr
) const

 Gets the value as a float for the provided property handle Customizations/MathStructCustomizations.h  

FText OnGetValueToolTip ( TWeakPtr< IPropertyHandle > WeakHandlePtr
) const

 Gets the tooltip for the value. Customizations/MathStructCustomizations.h  

void OnValueChanged ( NumericType NewValue,
TWeakPtr< IPropertyHandle > WeakHandlePtr
)

 Called when the value is changed in the property editor Customizations/MathStructCustomizations.h  

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

 Called when the value is committed from the property editor Customizations/MathStructCustomizations.h  

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

 Called to set the value of the property handle. Customizations/MathStructCustomizations.h  

Static

Name Remarks Include Path Unreal Specifiers

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

 Utility function that will extract common Math related numeric metadata Customizations/MathStructCustomizations.h  

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
)

   Customizations/MathStructCustomizations.h  

static TSharedRef< IPropertyTypeCustomization > MakeInstance()

   Customizations/MathStructCustomizations.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page