Navigation
API > API/Runtime > API/Runtime/UMG
This is a class for a Component that wraps the Owner widget with a Scale Box
| Name | UScaleBoxComponent |
| Type | class |
| Header File | /Engine/Source/Runtime/UMG/Public/Components/ScaleBoxComponent.h |
| Include Path | #include "Components/ScaleBoxComponent.h" |
Syntax
UCLASS (MinimalAPI, Experimental)
class UScaleBoxComponent : public UUIComponent
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UUIComponent → UScaleBoxComponent
Implements Interfaces
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| HorizontalAlignment | TEnumAsByte< EHorizontalAlignment > | This property is for the Widget that owns this Component. The alignment of the object horizontally. | Components/ScaleBoxComponent.h |
|
| IgnoreInheritedScale | bool | Optional bool to ignore the inherited scale. | Components/ScaleBoxComponent.h |
|
| MyScaleBox | TWeakPtr< SScaleBox > | Components/ScaleBoxComponent.h | ||
| Stretch | TEnumAsByte< EStretch::Type > | The stretching rule to apply when content is stretched | Components/ScaleBoxComponent.h |
|
| StretchDirection | TEnumAsByte< EStretchDirection::Type > | Controls in what direction content can be scaled | Components/ScaleBoxComponent.h |
|
| UserSpecifiedScale | float | Optional scale that can be specified by the User. Used only for UserSpecified stretching. | Components/ScaleBoxComponent.h |
|
| VerticalAlignment | TEnumAsByte< EVerticalAlignment > | This property is for the Widget that owns this Component. The alignment of the object vertically. | Components/ScaleBoxComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EHorizontalAlignment GetHorizontalAlignment() |
Components/ScaleBoxComponent.h | ||
EStretch::Type GetStretch() |
Components/ScaleBoxComponent.h | ||
EStretchDirection::Type GetStretchDirection() |
Components/ScaleBoxComponent.h | ||
float GetUserSpecifiedScale() |
Components/ScaleBoxComponent.h | ||
EVerticalAlignment GetVerticalAlignment() |
Components/ScaleBoxComponent.h | ||
bool IsIgnoreInheritedScale() |
Components/ScaleBoxComponent.h | ||
void SetHorizontalAlignment
(
EHorizontalAlignment InHorizontalAlignment |
Components/ScaleBoxComponent.h | ||
void SetIgnoreInheritedScale
(
bool bInIgnoreInheritedScale |
Components/ScaleBoxComponent.h | ||
void SetStretch
(
EStretch::Type InStretch |
Components/ScaleBoxComponent.h | ||
void SetStretchDirection
(
EStretchDirection::Type InStretchDirection |
Components/ScaleBoxComponent.h | ||
void SetUserSpecifiedScale
(
float InUserSpecifiedScale |
Components/ScaleBoxComponent.h | ||
void SetVerticalAlignment
(
EVerticalAlignment InVerticalAlignment |
Components/ScaleBoxComponent.h |
Overridden from UUIComponent
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< SWidget > RebuildWidgetWithContent
(
const TSharedRef< SWidget > Content |
Called when the OwnerWidget is Rebuilt to allow to build a more complex hierarchy between the owner parents and the Owner widget. | Components/ScaleBoxComponent.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanEditChange
(
const FProperty* InProperty |
Components/ScaleBoxComponent.h | ||
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
TODO vinz: Implement OnDesignerChanged to work for Components. | Components/ScaleBoxComponent.h |