SColorGradingPicker

Class for placing a color picker.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

AppFramework

Header

/Engine/Source/Runtime/AppFramework/Public/Widgets/Colors/SColorGradingPicker.h

Include

#include "Widgets/Colors/SColorGradingPicker.h"

Syntax

class SColorGradingPicker : public SCompoundWidget

Remarks

Class for placing a color picker. If all you need is a standalone color picker, use the functions OpenColorGradingWheel and DestroyColorGradingWheel, since they hold a static instance of the color picker.

Variables

Name Description

Protected variable

bool

 

bIsMouseDragging

Protected variable

EColorGradingMo...

 

ColorGradingModes

Protected variable

FSimpleDelegate

 

ExternalBeginMouseCaptureDelegate

Protected variable

FSimpleDelegate

 

ExternalBeginSliderMovementDelegate

Protected variable

FSimpleDelegate

 

ExternalEndMouseCaptureDelegate

Protected variable

FSimpleDelegate

 

ExternalEndSliderMovementDelegate

Protected variable

float

 

MainDelta

Protected variable

int32

 

MainShiftMouseMovePixelPerDelta

Protected variable

TSharedPtr< SNu...

 

NumericEntryBoxWidget

Protected variable

FOnColorGrading...

 

OnColorCommitted

Invoked when a new value is selected on the color wheel

Protected variable

FOnNumericEntry...

 

OnNumericEntryBoxDynamicSliderMaxValueChanged

Protected variable

FOnNumericEntry...

 

OnNumericEntryBoxDynamicSliderMinValueChanged

Protected variable

FOnGetCurrentVe...

 

OnQueryCurrentColor

Protected variable

float

 

SliderValueMax

Protected variable

float

 

SliderValueMin

Protected variable

FVector4

 

StartDragRatio

Destructors

Name Description

Public function

~SColorGradingPicker()

Destructor.

Functions

Name Description

Protected function

void

 

AdjustRatioValue

(
    FVector4& NewValue
)

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Construct the widget

Protected function

FLinearColor

 

GetCurrentLinearColor()

Public function

FOnNumericEn...

 

GetOnNumericEntryBoxDynamicSliderMaxValueChangedDelegate()

Public function

FOnNumericEn...

 

GetOnNumericEntryBoxDynamicSliderMinValueChangedDelegate()

Protected function

void

 

HandleColorWheelMouseCaptureBegin

(
    const FLinearColor& InValue
)

Protected function

void

 

HandleColorWheelMouseCaptureEnd

(
    const FLinearColor& InValue
)

Protected function

void

 

HandleCurrentColorValueChanged

(
    const FLinearColor& NewValue,
    bool ShouldCommitValueChanges
)

Callback for value changes in the color spectrum picker.

Protected function Const

bool

 

IsEntryBoxEnabled()

Protected function

void

 

OnBeginSliderMovement()

Public function

void

 

OnDynamicSliderMaxValueChanged

(
    float NewMaxSliderValue,
    TWeakPtr< SWidget > InValueChangedS...,
    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

(
    float NewMinSliderValue,
    TWeakPtr< SWidget > InValueChangedS...,
    bool IsOriginator,
    bool UpdateOnlyIfLower
)

Protected function

void

 

OnEndSliderMovement

(
    float NewValue
)

Protected function Const

TOptional< f...

 

OnGetMainValue()

Protected function

void

 

OnMainValueChanged

(
    float InValue,
    bool ShouldCommitValueChanges
)

Protected function

void

 

OnMainValueCommitted

(
    float InValue,
    ETextCommit::Type CommitType
)

Protected function Const

void

 

TransformColorGradingRangeToLinearColorRange

(
    FVector4& VectorValue
)

Protected function

void

 

TransformColorGradingRangeToLinearColorRange

(
    float& FloatValue
)

Protected function Const

void

 

TransformLinearColorRangeToColorGradingRange

(
    FVector4& VectorValue
)

Classes

Name

Description

Public struct

FArguments

Typedefs

Name

Description

FOnColorGradingPickerValueChanged

Delegate called when the widget Color Data changed.

FOnNumericEntryBoxDynamicSliderMinMaxValueChanged

Notification when the max/min spinner values are changed (only apply if SupportDynamicSliderMaxValue or SupportDynamicSliderMinValue are true)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss