Navigation
API > API/Editor > API/Editor/DetailCustomizations
Base class for color struct customization (FColor,FLinearColor).
| Name | FColorStructCustomization |
| Type | class |
| Header File | /Engine/Source/Editor/DetailCustomizations/Public/Customizations/ColorStructCustomization.h |
| Include Path | #include "Customizations/ColorStructCustomization.h" |
Syntax
class FColorStructCustomization : public FMathStructCustomization
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FColorStructCustomization() |
Customizations/ColorStructCustomization.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FColorStructCustomization() |
Customizations/ColorStructCustomization.h |
Structs
| Name | Remarks |
|---|---|
| FLinearOrSrgbColor | Stores a linear or srb color without converting between the two. Only one is valid at a time |
Functions
Public
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArray< FString > ConvertToPerObjectColors
(
const TArray< FLinearOrSrgbColor >& Colors |
Converts Colors into strings | Customizations/ColorStructCustomization.h | |
void CreateColorPicker
(
bool bUseAlpha |
Creates a new color picker for interactively selecting the color | Customizations/ColorStructCustomization.h | |
TSharedRef< SWidget > CreateColorWidget
(
TWeakPtr< IPropertyHandle > |
Creates the color widget that when clicked spawns the color picker window. | Customizations/ColorStructCustomization.h | |
TSharedRef< SColorPicker > CreateInlineColorPicker
(
TWeakPtr< IPropertyHandle > |
Creates a new color picker for interactively selecting color | Customizations/ColorStructCustomization.h | |
virtual void GatherSavedPreColorPickerColors() |
Stores the colors from the property into SavedPreColorPickerColors | Customizations/ColorStructCustomization.h | |
virtual FPropertyAccess::Result GetColorAsLinear
(
FLinearColor& InColor |
Get the color used by this struct as a linear color value | Customizations/ColorStructCustomization.h | |
FSlateColor GetColorWidgetBorderColor() |
Customizations/ColorStructCustomization.h | ||
EVisibility GetMultipleValuesTextVisibility() |
Does this struct have multiple values? | Customizations/ColorStructCustomization.h | |
void OnColorPickerCancelled
(
FLinearColor OriginalColor |
Called when the user clicks cancel in the color picker The values are reset to their original state when this happens | Customizations/ColorStructCustomization.h | |
void OnColorPickerInteractiveBegin() |
Called when the user enters an interactive color change (dragging something in the picker) | Customizations/ColorStructCustomization.h | |
void OnColorPickerInteractiveEnd() |
Called when the user completes an interactive color change (dragging something in the picker) | Customizations/ColorStructCustomization.h | |
void OnColorPickerWindowClosed
(
const TSharedRef< SWindow >& Window |
Called when the color picker window is clsoed | Customizations/ColorStructCustomization.h | |
FLinearColor OnGetColorForColorBlock() |
Customizations/ColorStructCustomization.h | ||
FSlateColor OnGetSlateColorForBlock() |
Customizations/ColorStructCustomization.h | ||
FReply OnMouseButtonDownColorBlock
(
const FGeometry& MyGeometry, |
Called when the user clicks in the color block (opens inline color picker) | Customizations/ColorStructCustomization.h | |
FReply OnOpenFullColorPickerClicked() |
Called when the user clicks on the the button to get the full color picker | Customizations/ColorStructCustomization.h | |
void OnSetColorFromColorPicker
(
FLinearColor NewColor |
Called when the property is set from the color picker | Customizations/ColorStructCustomization.h | |
void ResetColors() |
Called to reset all colors to before the color picker spawned | Customizations/ColorStructCustomization.h | |
virtual void SetLastPickerColorString
(
const FLinearColor NewColor |
Stores the color as a string in LastPickerColorString | Customizations/ColorStructCustomization.h | |
virtual bool TypeSupportsAlpha() |
Does the type have Alpha Support | Customizations/ColorStructCustomization.h |
Overridden from FMathStructCustomization
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetSortedChildren
(
TSharedRef< IPropertyHandle > StructPropertyHandle, |
Gets the sorted children for the struct | Customizations/ColorStructCustomization.h | |
virtual void MakeHeaderRow
(
TSharedRef< IPropertyHandle >& StructPropertyHandle, |
Makes the header row for the customization | Customizations/ColorStructCustomization.h |
Overridden from IPropertyTypeCustomization
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CustomizeHeader
(
TSharedRef< IPropertyHandle > StructPropertyHandle, |
IPropertyTypeCustomization instance | Customizations/ColorStructCustomization.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< IPropertyTypeCustomization > MakeInstance() |
Customizations/ColorStructCustomization.h |