UWidgetStudioBase Class Reference

The base User Widget class for Widget Studio. More...

#include <WSBase.h>

Inheritance diagram for UWidgetStudioBase:

Public Member Functions
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.

Public Attributes
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...

Protected Member Functions
virtual void	InitializeStyling ()
virtual void	UpdateStyling ()
virtual void	NativeOnMouseEnter (const FGeometry &InGeometry, const FPointerEvent &InMouseEvent) override
virtual void	NativeOnMouseLeave (const FPointerEvent &InMouseEvent) override
virtual void	NativeOnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent) override

Detailed Description

The base User Widget class for Widget Studio.

Contains logic that propagates to all other Widget Studio widget classes.

Member Function Documentation

GetBorderRadius()

int32 UWidgetStudioBase::GetBorderRadius

(

)

const

Returns the current border radius of the Widget.

Derived from Widget Studio Subsystem, or from the Overriden Border Radius.

GetDimensions()

FVector2D UWidgetStudioBase::GetDimensions

(

)

const

Returns the current X and Y dimensions of the Widget.

Derived from Widget Studio Subsystem, or from the Overriden Dimensions.

Member Data Documentation

AnimationTime

float UWidgetStudioBase::AnimationTime = 7

The animation interpolation speed.

The lower the value, the slower the speed. Set to 0 to disable animations.

bDisablePainting

bool UWidgetStudioBase::bDisablePainting = false

Used for debugging.

Disables the OnPaint event in many of the widgets, thus disabling all animations and smooth transitions. May cause graphical inconsistencies.

MinimumDimensions

FVector2D UWidgetStudioBase::MinimumDimensions = FVector2D(50, 7)

The minimum dimensions of the widget.

The global and custom overrides will not go below these values.

OverrideBorderRadius

int32 UWidgetStudioBase::OverrideBorderRadius = -1

Manually adjust the border radius of the widget.

This overrides the Border Radius from the Widget Studio Subsystem.

• The Border Radius is overriden if above -1.
• Enabled only on select visual widgets.

OverrideDimensions

FVector2D UWidgetStudioBase::OverrideDimensions = FVector2D(0, 0)

Manually adjust the X and Y dimensions of the widget.

This overrides the Control Dimensions from the Widget Studio Subsystem.

• Dimensions are overriden if above 0 and above widgets minimum default dimensions.
• Enabled only on select visual widgets.

SizeModifier

ESizeModifier UWidgetStudioBase::SizeModifier = ESizeModifier::Regular

Quickly modify the overall size of the widget.

• Mini: 55%
• Tiny: 70%
• Small: 85%
• Regular: 100%
• Large: 115%
• Big: 130%
• Huge: 145%
• Massive: 160%

---

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

• src/WidgetStudio/Source/WidgetStudioRuntime/Public/Widgets/WSBase.h
• src/WidgetStudio/Source/WidgetStudioRuntime/Private/Widgets/WSBase.cpp