1. Epic GamesDeveloper
  3. UScaleBox

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.

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

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

Syntax

UCLASS (Config=Engine, MinimalAPI)  
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

  Type Name Description
Protected variable TOptional< FVector2D > DesignerSize  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter bool IgnoreInheritedScale Optional bool to ignore the inherited scale.
Protected variable TSharedPtr< SScaleBox > MyScaleBox  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EStretch::Type > Stretch The stretching rule to apply when content is stretched
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EStretchDirection::Type > StretchDirection Controls in what direction content can be scaled
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter float UserSpecifiedScale Optional scale that can be specified by the User. Used only for UserSpecified stretching.

Constructors

  Type Name Description
Public function  

UScaleBox ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

  
Public function Const EStretch::Type  
Public function Const EStretchDirection::Type  
Public function Const float  
Public function Const bool  
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function UFunction BlueprintCallable, Category void

SetIgnoreInheritedScale ( bool bInIgnoreInheritedScale
)

  
Public function UFunction BlueprintCallable, Category void

SetStretch ( EStretch::Type InStretch
)

  
Public function UFunction BlueprintCallable, Category void

SetStretchDirection ( EStretchDirection::Type InStretchDirection
)

  
Public function UFunction BlueprintCallable, Category void

SetUserSpecifiedScale ( float InUserSpecifiedScale
)

  

Overridden from UPanelWidget

  Type Name Description
Protected function Virtual Const UClass * UPanelWidget.
Protected function Virtual void  
Protected function Virtual void  

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Public function Virtual void  
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page