SLayeredImage.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Widgets/Images/SImage.h"
 
struct FSlateIcon;
 
template <>
struct TWidgetTypeTraits<class SLayeredImage>
{
    static constexpr bool SupportsInvalidation() { return true; }
};
 
class SLayeredImage : public SImage
{
public:
    typedef TTuple<TAttribute<const FSlateBrush*>, TAttribute<FSlateColor> > ImageLayer;
 
    SLATECORE_API void Construct(const FArguments& InArgs, const TArray<ImageLayer>& InLayers);
    
    SLATECORE_API void Construct(const FArguments& InArgs, TArray<ImageLayer>&& InLayers);
 
    SLATECORE_API void Construct(const FArguments& InArgs, TAttribute<const FSlateBrush*> Brush, TAttribute<FSlateColor> Color);
 
    SLATECORE_API void Construct(const FArguments& InArgs, int32 NumLayers = 0);
 
    SLATECORE_API void Construct(const FArguments& InArgs, const FSlateIcon& InIcon);
 
    //~ Begin SWidget Interface
    SLATECORE_API virtual int32 OnPaint(const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled) const override;
    //~ End SWidget Interface
 
    SLATECORE_API void AddLayer(TAttribute<const FSlateBrush*> Brush);
 
    SLATECORE_API void AddLayer(TAttribute<const FSlateBrush*> Brush, TAttribute<FSlateColor> Color);
 
    SLATECORE_API void SetFromSlateIcon(const FSlateIcon& InIcon);
 
    SLATECORE_API void RemoveAllLayers();
 
    SLATECORE_API int32 GetNumLayers() const;
 
    SLATECORE_API bool IsValidIndex(int32 Index) const;
 
    SLATECORE_API void SetLayerBrush(int32 Index, TAttribute<const FSlateBrush*> Brush);
 
    SLATECORE_API void SetLayerColor(int32 Index, TAttribute<FSlateColor> Color);
 
private:
    typedef TSlateManagedAttribute<const FSlateBrush*, EInvalidateWidgetReason::Paint> BrushAttributeType;
    typedef TSlateManagedAttribute<FSlateColor, EInvalidateWidgetReason::Paint> ColorAttributeType;
    typedef TTuple<BrushAttributeType, ColorAttributeType> InnerImageLayerType;
        
    TArray<InnerImageLayerType,TInlineAllocator<2>> Layers;
};