SlateColor.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Class.h"
#include "Styling/WidgetStyle.h"
#include "SlateColor.generated.h"
 
UENUM(BlueprintType)
enum class ESlateColorStylingMode : uint8
{
    UseColor_Specified UMETA(DisplayName = "Specified Color"),
 
    UseColor_ColorTable UMETA(Hidden),
 
    UseColor_Foreground UMETA(DisplayName = "Foreground Color"),
 
    UseColor_Foreground_Subdued UMETA(Hidden),
 
    UseColor_UseStyle UMETA(Hidden),
};
 
enum class EStyleColor : uint8;
 
USTRUCT(BlueprintType)
struct FSlateColor
{
    GENERATED_USTRUCT_BODY()
 
public:
 
    FSlateColor()
        : SpecifiedColor(FLinearColor(1.0f, 0.0f, 1.0f))
        , ColorUseRule(ESlateColorStylingMode::UseColor_Specified)
    { }
 
    FSlateColor(const FLinearColor& InColor)
        : SpecifiedColor(InColor)
        , ColorUseRule(ESlateColorStylingMode::UseColor_Specified)
    { }
 
 
    FSlateColor(const FColor InColor)
        : SpecifiedColor(InColor.ReinterpretAsLinear())
        , ColorUseRule(ESlateColorStylingMode::UseColor_Specified)
    { }
 
 
    /*
     * Creates a new Slate color that is linked to the given values.
     *
     * @param InColor The color value to assign.
     */
    FSlateColor(const TSharedRef< FLinearColor >& InColor)
        : SpecifiedColor(*InColor)
        , ColorUseRule(ESlateColorStylingMode::UseColor_Specified)
    { }
 
    FSlateColor(EStyleColor InColorTableId)
        : SpecifiedColor()
        , ColorUseRule(ESlateColorStylingMode::UseColor_ColorTable)
        , ColorTableId(InColorTableId)
    { }
 
public:
 
    const FLinearColor& GetColor( const FWidgetStyle& InWidgetStyle ) const
    {
        switch(ColorUseRule)
        {
        default:
        case ESlateColorStylingMode::UseColor_Foreground:
        case ESlateColorStylingMode::UseColor_UseStyle:
            return InWidgetStyle.GetForegroundColor();
            break;
 
        case ESlateColorStylingMode::UseColor_Specified:
            return SpecifiedColor;
            break;
 
        case ESlateColorStylingMode::UseColor_ColorTable:
            return GetColorFromTable();
            break;
 
        case ESlateColorStylingMode::UseColor_Foreground_Subdued:
            return InWidgetStyle.GetSubduedForegroundColor();
            break;
        };
    }
 
    FLinearColor GetSpecifiedColor( ) const
    {
        if (ColorUseRule == ESlateColorStylingMode::UseColor_ColorTable)
        {
            return GetColorFromTable();
        }
 
        return SpecifiedColor;
    }
 
    bool IsColorSpecified( ) const
    {
        return (ColorUseRule == ESlateColorStylingMode::UseColor_Specified) || (ColorUseRule == ESlateColorStylingMode::UseColor_ColorTable);
    }
 
    void Unlink()
    {
        if (ColorUseRule == ESlateColorStylingMode::UseColor_ColorTable)
        {
            SpecifiedColor = GetColorFromTable();
            ColorUseRule = ESlateColorStylingMode::UseColor_Specified;
        }
    }
 
    bool operator==( const FSlateColor& Other ) const 
    {
        return SpecifiedColor == Other.SpecifiedColor
            && ColorUseRule == Other.ColorUseRule
            && (ColorUseRule != ESlateColorStylingMode::UseColor_ColorTable || ColorTableId == Other.ColorTableId);
    }
 
    bool operator!=( const FSlateColor& Other ) const 
    {
        return !(*this == Other);
    }
 
public:
 
    static FSlateColor UseForeground( )
    {
        return FSlateColor( ESlateColorStylingMode::UseColor_Foreground );
    }
 
    static FSlateColor UseSubduedForeground( )
    {
        return FSlateColor( ESlateColorStylingMode::UseColor_Foreground_Subdued );
    }
 
    static FSlateColor UseStyle()
    {
        return FSlateColor(ESlateColorStylingMode::UseColor_UseStyle);
    }
 
 
    SLATECORE_API bool SerializeFromMismatchedTag(const struct FPropertyTag& Tag, FStructuredArchive::FSlot Slot);
 
protected:
    
    // Private constructor to prevent construction of invalid FSlateColors
    FSlateColor(ESlateColorStylingMode InColorUseRule)
        : SpecifiedColor(FLinearColor(1.0f, 0.0f, 1.0f))
        , ColorUseRule(InColorUseRule)
        , ColorTableId()
    { }
 
    SLATECORE_API const FLinearColor& GetColorFromTable() const;
protected:
 
    // The current specified color; only meaningful when ColorToUse == UseColor_Specified.
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Color)
    FLinearColor SpecifiedColor;
 
    // The rule for which color to pick.
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category=Color)
    ESlateColorStylingMode ColorUseRule;
 
private:
    // Id to a color in a color table to be used with ESlateColorStylingMode::UseColor_ColorTable
    EStyleColor ColorTableId;
};
 
template<>
struct TStructOpsTypeTraits<FSlateColor>
    : public TStructOpsTypeTraitsBase2<FSlateColor>
{
    enum 
    {
        WithStructuredSerializeFromMismatchedTag = true,
    };
};