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 > UMG > Components > UScaleBox

Light Theme

Dark Theme

UScaleBox

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UContentWidget

UScaleBox

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Components/ScaleBox.h
Include	#include "Components/ScaleBox.h"

Syntax

class UScaleBox : public UContentWidget

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.

Single Child Aspect Ratio

Variables

	Name	Description
TOptional< FVec...	DesignerSize
bool	IgnoreInheritedScale	Optional bool to ignore the inherited scale.
TSharedPtr< SSc...	MyScaleBox
TEnumAsByte< ES...	Stretch	The stretching rule to apply when content is stretched
TEnumAsByte< ES...	StretchDirection	Controls in what direction content can be scaled
float	UserSpecifiedScale	Optional scale that can be specified by the User. Used only for UserSpecified stretching.

Constructors

	Name	Description
	UScaleBox ( const FObjectInitializer& ObjectIn... )

Functions

		Name	Description
	void	SetIgnoreInheritedScale ( bool bInIgnoreInheritedScale )
	void	SetStretch ( EStretch::Type InStretch )
	void	SetStretchDirection ( EStretchDirection::Type InStretchDi... )
	void	SetUserSpecifiedScale ( float InUserSpecifiedScale )

Overridden from UPanelWidget

	Name	Description
UClass *	GetSlotClass()	UPanelWidget.
void	OnSlotAdded ( UPanelSlot* Slot )
void	OnSlotRemoved ( UPanelSlot* Slot )

Overridden from UWidget

	Name	Description
const FText	GetPaletteCategory()	Gets the palette category of the widget
void	OnDesignerChanged ( const FDesignerChangedEventArgs& E... )
TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
void	SynchronizeProperties()	Applies all properties to the native widget if possible.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Overridden from UObject

		Name	Description
	bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
	void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.