Widget Studio
UWidgetStudioModernCard Class Reference

A rounded card for background usage. More...

#include <WSModernCard.h>

Inheritance diagram for UWidgetStudioModernCard:
UWidgetStudioBase

Public Member Functions

EPalette GetColor () const
 Returns the color of the background.
 
bool IsShadowHoverAnimationEnabled () const
 Returns true if the shadow hover animation is enabled.
 
EShadowStyle GetDropShadowStyle () const
 Returns the current drop shadow style.
 
void SetColor (EPalette NewColor)
 Set the color used for the background. More...
 
void SetShadowHoverAnimationEnabled (bool NewState)
 If enabled, the shadow length will increase when the card is hovered. More...
 
void SetShadowStyle (EShadowStyle NewStyle)
 Establish the styling of the drop shadow. More...
 
- Public Member Functions inherited from UWidgetStudioBase
FVector2D GetDimensions () const
 Returns the current X and Y dimensions of the Widget. More...
 
int32 GetBorderRadius () const
 Returns the current border radius of the Widget. More...
 
void ForceStyleUpdate ()
 Refresh the dynamic styling of the Widget Studio widget.
 
void SetSizeModifier (ESizeModifier InSizeModifier)
 Set the size modifier of the Widget Studio widget.
 

Protected Member Functions

virtual TSharedRef< SWidget > RebuildWidget () override
 
virtual int32 NativePaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
 
virtual void SynchronizeProperties () override
 
virtual void InitializeStyling () override
 
virtual void UpdateStyling () override
 
- Protected Member Functions inherited from UWidgetStudioBase
virtual void NativeOnMouseEnter (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent) override
 
virtual void NativeOnMouseLeave (const FPointerEvent &InMouseEvent) override
 
virtual void NativeOnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent) override
 

Protected Attributes

const float BaseDropShadowOpacity = .5
 
float ShadowLength
 
USizeBox * SizeBox = nullptr
 
UScaleBox * ScaleBox = nullptr
 
UOverlay * Overlay = nullptr
 
UImage * DropShadow = nullptr
 
UImage * Background = nullptr
 

Additional Inherited Members

- Public Attributes inherited from UWidgetStudioBase
FWSBaseHoverStateDelegate OnHoverStateChanged
 Called when the hover state has been changed.
 
bool bCanOverrideDimensions = true
 Used to enable or disable dimension override's.
 
bool bCanOverrideBorderRadius = true
 Used to enable or disable dimension override's.
 
FVector2D MinimumDimensions = FVector2D(50, 7)
 The minimum dimensions of the widget. More...
 
bool bDisablePainting = false
 Used for debugging. More...
 
float AnimationTime = 7
 The animation interpolation speed. More...
 
ESizeModifier SizeModifier = ESizeModifier::Regular
 Quickly modify the overall size of the widget. More...
 
FVector2D OverrideDimensions = FVector2D(0, 0)
 Manually adjust the X and Y dimensions of the widget. More...
 
int32 OverrideBorderRadius = -1
 Manually adjust the border radius of the widget. More...
 

Detailed Description

A rounded card for background usage.

Ideal to combine with an overlay panel.

Member Function Documentation

◆ InitializeStyling()

void UWidgetStudioModernCard::InitializeStyling ( )
overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.

◆ SetColor()

void UWidgetStudioModernCard::SetColor ( EPalette  NewColor)

Set the color used for the background.

Parameters
NewColorThe color to apply to the card.

◆ SetShadowHoverAnimationEnabled()

void UWidgetStudioModernCard::SetShadowHoverAnimationEnabled ( bool  NewState)

If enabled, the shadow length will increase when the card is hovered.

Parameters
NewStateEnable or disable the hover animation.

◆ SetShadowStyle()

void UWidgetStudioModernCard::SetShadowStyle ( EShadowStyle  NewStyle)

Establish the styling of the drop shadow.

Parameters
NewStyleSet which drop shadow style to utilize.

◆ UpdateStyling()

void UWidgetStudioModernCard::UpdateStyling ( )
overrideprotectedvirtual

Reimplemented from UWidgetStudioBase.


The documentation for this class was generated from the following files: