Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

SColorGradingWheel

Implements the color wheel widget.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SLeafWidget

SColorGradingWheel

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Colors/SColorGradingWheel.h
Include	#include "Widgets/Colors/SColorGradingWheel.h"

Syntax

class SColorGradingWheel : public SLeafWidget

Remarks

Implements the color wheel widget.

Variables

	Name	Description
uint8: 1	bIsAttributeDesiredWheelSizeSet
uint8: 1	bIsAttributeExponentDisplacementSet
const FSlateBru...	Image	The color wheel image to show.
FOnColorGrading...	OnMouseCaptureBegin	Invoked when the mouse is pressed and a capture begins.
FOnColorGrading...	OnMouseCaptureEnd	Invoked when the mouse is let up and a capture ends.
FOnColorGrading...	OnValueChanged	Invoked when a new value is selected on the color wheel.
const FSlateBru...	SelectorImage	The color selector image to show.
uint8	Union_IsAttributeSet

Constructors

	Name	Description
	SColorGradingWheel()

Functions

	Name	Description
FVector2D	CalcRelativePositionFromCenter()	Calculates the position of the color selection indicator.
void	Construct ( const FArguments& InArgs )	Construct this widget.
TSlateAttrib...	GetDesiredWheelSizeAttribute()
TSlateAttrib...	GetExponentDisplacementAttribute()
TSlateAttrib...	GetSelectedColorAttribute()
bool	ProcessMouseAction ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, bool bProcessWhenOutsideColorWheel )	Performs actions according to mouse click / move
void	SetDesiredWheelSizeAttribute ( TAttribute< int32 > InDesiredWheelS... )
void	SetExponentDisplacementAttribute ( TAttribute< float > InExponentDispl... )
void	SetSelectedColorAttribute ( TAttribute< FLinearColor > InSelect... )
const FSlate...	StaticWidgetClass()

Overridden from SWidget

	Name	Description
FVector2D	ComputeDesiredSize ( float )	Overwritten from SWidget.
FReply	OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent )	Called when a mouse button is double clicked. Override this in derived classes.
FReply	OnMouseButtonDown ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
FReply	OnMouseButtonUp ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse button was release within it.
FReply	OnMouseMove ( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent )	The system calls this method to notify the widget that a mouse moved within it.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	Overwritten from SWidget.

Overridden from FSlateControlledConstruction

		Name	Description
	const FSlate...	GetWidgetClass()

Classes

	Name	Description
	FArguments

Typedefs

Name	Description
FOnColorGradingWheelMouseCapture
FOnColorGradingWheelValueChanged
PrivateParentType
PrivateThisType
Super
ThisClass

Deprecated Variables

	Name	Description
TSlateDeprecate...	DesiredWheelSize	Direct access to DesiredWheelSize is now deprecated. Use the setter or getter.
TSlateDeprecate...	ExponentDisplacement	Direct access to DesiredSizeOverride is now deprecated. Use the setter or getter.
TSlateDeprecate...	SelectedColor	Direct access to SelectedColor is now deprecated. Use the setter or getter.