1. Epic GamesDeveloper
  3. USizeBox

USizeBox

A widget that allows you to specify the size it reports to have and desire.

Unreal Engine C++ API Reference > Runtime > UMG > Components

Inheritance Hierarchy

References

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

Syntax

class USizeBox : public UContentWidget

Remarks

A widget that allows you to specify the size it reports to have and desire. Not all widgets report a desired size that you actually desire. Wrapping them in a SizeBox lets you have the Size Box force them to be a particular size.

  • Single Child
  • Fixed Size

Variables

  Type Name Description
Protected variable TSharedPtr< SBox > MySizeBox  

Constructors

  Type Name Description
Public function  

USizeBox ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function Const float  
Public function void

SetHeightOverride ( float InHeightOverride
)

 When specified, ignore the content's desired size and report the HeightOverride as the Box's desired height.
Public function void

SetMaxAspectRatio ( float InMaxAspectRatio
)

  
Public function void

SetMaxDesiredHeight ( float InMaxDesiredHeight
)

 When specified, will report the MaxDesiredHeight if smaller than the content's desired height.
Public function void

SetMaxDesiredWidth ( float InMaxDesiredWidth
)

 When specified, will report the MaxDesiredWidth if smaller than the content's desired width.
Public function void

SetMinAspectRatio ( float InMinAspectRatio
)

  
Public function void

SetMinDesiredHeight ( float InMinDesiredHeight
)

 When specified, will report the MinDesiredHeight if larger than the content's desired height.
Public function void

SetMinDesiredWidth ( float InMinDesiredWidth
)

 When specified, will report the MinDesiredWidth if larger than the content's desired width.
Public function void

SetWidthOverride ( float InWidthOverride
)

 When specified, ignore the content's desired size and report the WidthOverride as the Box's desired width.

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
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
)

  

Deprecated Variables

  Type Name Description
Public variable uint8: 1 bOverride_HeightOverride Direct access to bOverride_HeightOverride is deprecated. Please use the SetHeightOverride or ClearHeightOverride.
Public variable uint8: 1 bOverride_MaxAspectRatio Direct access to bOverride_MaxAspectRatio is deprecated. Please use the SetMaxAspectRatio or ClearMaxAspectRatio .
Public variable uint8: 1 bOverride_MaxDesiredHeight Direct access to bOverride_MaxDesiredHeight is deprecated. Please use the SetMaxDesiredHeight or ClearMaxDesiredHeight.
Public variable uint8: 1 bOverride_MaxDesiredWidth Direct access to bOverride_MaxDesiredWidth is deprecated. Please use the SetMaxDesiredWidth or ClearMaxDesiredWidth.
Public variable uint8: 1 bOverride_MinAspectRatio Direct access to bOverride_MinAspectRatio is deprecated. Please use the SetMinAspectRatio or ClearMinAspectRatio.
Public variable uint8: 1 bOverride_MinDesiredHeight Direct access to bOverride_MinDesiredHeight is deprecated. Please use the SetMinDesiredHeight or ClearMinDesiredHeight.
Public variable uint8: 1 bOverride_MinDesiredWidth Direct access to bOverride_MinDesiredWidth is deprecated. Please use the SetMinDesiredWidth or ClearMinDesiredWidth.
Public variable uint8: 1 bOverride_WidthOverride Direct access to bOverride_WidthOverride is deprecated. Please use the SetWidthOverride or ClearWidthOverride.
Public variable float HeightOverride Direct access to HeightOverride is deprecated. Please use the getter or setter.
Public variable float MaxAspectRatio Direct access to MaxAspectRatio is deprecated. Please use the getter or setter.
Public variable float MaxDesiredHeight Direct access to MaxDesiredHeight is deprecated. Please use the getter or setter.
Public variable float MaxDesiredWidth Direct access to MaxDesiredWidth is deprecated. Please use the getter or setter.
Public variable float MinAspectRatio Direct access to MinAspectRatio is deprecated. Please use the getter or setter.
Public variable float MinDesiredHeight Direct access to MinDesiredHeight is deprecated. Please use the getter or setter.
Public variable float MinDesiredWidth Direct access to MinDesiredWidth is deprecated. Please use the getter or setter.
Public variable float WidthOverride Direct access to WidthOverride is deprecated. Please use the getter or setter.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page