Navigation
API > API/Runtime > API/Runtime/Slate
Implements the color wheel widget.
| Name | SColorWheel |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Colors/SColorWheel.h |
| Include Path | #include "Widgets/Colors/SColorWheel.h" |
Syntax
class SColorWheel : public SLeafWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SLeafWidget → SColorWheel
- FSlateControlledConstruction → SWidget → SLeafWidget → SColorWheel
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
SColorWheel() |
Widgets/Colors/SColorWheel.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~SColorWheel() |
Widgets/Colors/SColorWheel.h |
Structs
| Name | Remarks |
|---|---|
| FArguments |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDragging | bool | Whether the user is dragging the slider | Widgets/Colors/SColorWheel.h | |
| bShouldDrawSelector | bool | Flag to show/hide color selector | Widgets/Colors/SColorWheel.h | |
| CtrlMultiplier | TAttribute< float > | Mouse sensitivity multiplier to use when dragging the selector on the color wheel, applied when the ctrl modifier key is pressed | Widgets/Colors/SColorWheel.h | |
| Image | const FSlateBrush * | The color wheel image to show. | Widgets/Colors/SColorWheel.h | |
| LastWheelPosition | FVector2f | Cached mouse position to restore after dragging. | Widgets/Colors/SColorWheel.h | |
| OnMouseCaptureBegin | FSimpleDelegate | Invoked when the mouse is pressed and a capture begins. | Widgets/Colors/SColorWheel.h | |
| OnMouseCaptureEnd | FSimpleDelegate | Invoked when the mouse is let up and a capture ends. | Widgets/Colors/SColorWheel.h | |
| OnValueChanged | FOnLinearColorValueChanged | Invoked when a new value is selected on the color wheel. | Widgets/Colors/SColorWheel.h | |
| SelectedColor | TSlateAttribute< FLinearColor, EInvalidateWidgetReason::Paint > | The current color selected by the user. | Widgets/Colors/SColorWheel.h | |
| SelectorImage | const FSlateBrush * | The color selector image to show. | Widgets/Colors/SColorWheel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Construct this widget. | Widgets/Colors/SColorWheel.h | |
virtual int32 OnPaint
(
const FPaintArgs& Args, |
Widgets/Colors/SColorWheel.h | ||
void ShowSelector
(
bool bShow |
Set selector visibility. | Widgets/Colors/SColorWheel.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float |
Widgets/Colors/SColorWheel.h | ||
virtual FCursorReply OnCursorQuery
(
const FGeometry& MyGeometry, |
Widgets/Colors/SColorWheel.h | ||
virtual FReply OnMouseButtonDoubleClick
(
const FGeometry& InMyGeometry, |
Widgets/Colors/SColorWheel.h | ||
virtual FReply OnMouseButtonDown
(
const FGeometry& MyGeometry, |
Widgets/Colors/SColorWheel.h | ||
virtual FReply OnMouseButtonUp
(
const FGeometry& MyGeometry, |
Widgets/Colors/SColorWheel.h | ||
virtual FReply OnMouseMove
(
const FGeometry& MyGeometry, |
Widgets/Colors/SColorWheel.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UE::Slate::FDeprecateVector2DResult CalcRelativePositionFromCenter() |
Calculates the position of the color selection indicator. | Widgets/Colors/SColorWheel.h | |
bool ProcessMouseAction
(
const FGeometry& MyGeometry, |
Performs actions according to mouse click / move | Widgets/Colors/SColorWheel.h |