Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Widgets > Layout > SScaleBox

Light Theme

Dark Theme

SScaleBox

Allows you to place content with a desired size and have it scale to meet the constraints placed on this box's alloted area.

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SScaleBox

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Layout/SScaleBox.h
Include	#include "Widgets/Layout/SScaleBox.h"

Syntax

class SScaleBox : public SCompoundWidget

Remarks

Allows you to place content with a desired size and have it scale to meet the constraints placed on this box's alloted area. If you needed to have a background image scale to fill an area but not become distorted with different aspect ratios, or if you need to auto fit some text to an area, this is the control for you.

Variables

	Name	Description
TOptional< floa...	ComputedContentScale
TAttribute< boo...	IgnoreInheritedScale	Optional bool to ignore the inherited scale
TOptional< FVec...	LastAllocatedArea
FVector2D	LastFinalOffset
TOptional< FGeo...	LastPaintGeometry
FVector2D	LastSlotWidgetDesiredSize
TOptional< FVec...	NormalizedContentDesiredSize
FDelegateHandle	OnSafeFrameChangedHandle	Delegate handle to unhook the safe frame changed.
TOptional< FVec...	OverrideScreenSize
float	SafeZoneScale	Computed scale when scaled by safe zone padding
TAttribute< ESt...	Stretch	The method of scaling that is applied to the content.
TAttribute< ESt...	StretchDirection	The allowed direction of stretching of the content
TAttribute< flo...	UserSpecifiedScale	Optional scale that can be specified by the User

Constructors

	Name	Description
	SScaleBox()	Constructor

Destructors

	Name	Description
	~SScaleBox()

Functions

	Name	Description
float	ComputeContentScale ( const FGeometry& PaintGeometry )
void	Construct ( const FArguments& InArgs )
void	DebugSafeAreaUpdated ( const FMargin& NewSafeZone, bool bShouldRecacheMetrics )
bool	DoesScaleRequireNormalizingPrepassOrLocalGeometry()
bool	IsDesiredSizeDependentOnAreaAndScale()
void	RefreshSafeZoneScale()
void	SetContent ( TSharedRef< SWidget > InContent )	See Content slot
void	SetHAlign ( EHorizontalAlignment HAlign )	See HAlign argument
void	SetIgnoreInheritedScale ( bool InIgnoreInheritedScale )	Set IgnoreInheritedScale argument
void	SetOverrideScreenInformation ( TOptional< FVector2D > InScreenSize )
void	SetStretch ( EStretch::Type InStretch )	See Stretch argument
void	SetStretchDirection ( EStretchDirection::Type InStretchDi... )	See StretchDirection argument
void	SetUserSpecifiedScale ( float InUserSpecifiedScale )	See UserSpecifiedScale argument
void	SetVAlign ( EVerticalAlignment VAlign )	See VAlign argument

Overridden from SWidget

	Name	Description
FVector2D	ComputeDesiredSize ( float LayoutScaleMultiplier )	Compute the ideal size necessary to display this widget.
bool	CustomPrepass ( float LayoutScaleMultiplier )
float	GetRelativeLayoutScale ( int32 ChildIndex, float LayoutScaleMultiplier )	What is the Child's scale relative to this widget.
void	OnArrangeChildren ( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildre... )	Compute the Geometry of all the children and add populate the ArrangedChildren list with their values.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.

Classes

	Name	Description
	FArguments

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

Take our survey

Dismiss