DreamGUI
类参考

UDreamLayoutContainerSizeBox

UMG Size Box

本页由 DreamGUIReferenceDocs commandlet 从反射生成,正文是头文件注释的原文(英文),所以不翻译——这样它永远和代码一致。概念讲解见核心概念。

Inherits from UDreamPanelLayoutBase.

Declared in Public/Core/Components/DreamPanelLayouts.h.

UMG Size Box

Properties

NameTypeCategoryIn the details panelFrom BlueprintDescription
PaddingFMarginSizeBoxyesSetPadding
bOverrideWidthboolSizeBoxyesSetOverrideWidth
WidthOverridefloatSizeBoxyesSetWidthOverride
bOverrideHeightboolSizeBoxyesSetOverrideHeight
HeightOverridefloatSizeBoxyesSetHeightOverride
MinDesiredSizeFVector2DSizeBoxyesSetMinDesiredSize
MaxDesiredSizeFVector2DSizeBoxyesSetMaxDesiredSize
MinAspectRatiofloatSizeBoxyesSetMinAspectRatioWidth-over-height bounds on the CONTENT's rect, as SBox applies them: the box itself is sized by the rules above, and a content rect whose ratio falls outside these is shrunk on one axis until it does not, then re-aligned inside the space it was offered.
MaxAspectRatiofloatSizeBoxyesSetMaxAspectRatio

Functions

FunctionKindDescription
void ClearHeightOverride()callableClear Height Override
void ClearMaxAspectRatio()callableClear Max Aspect Ratio
void ClearMaxDesiredHeight()callableClear Max Desired Height
void ClearMaxDesiredWidth()callableClear Max Desired Width
void ClearMinAspectRatio()callableClear Min Aspect Ratio
void ClearMinDesiredHeight()callableClear Min Desired Height
void ClearMinDesiredWidth()callableClear Min Desired Width
void ClearWidthOverride()callableUSizeBox's per-axis accessors. The two bounds are stored as one FVector2D apiece here, which is the same four numbers with half the fields; these name the axis the way UMG does, and Clear is "put that axis back to zero", which is how this class already spells "no opinion".
float GetMaxDesiredHeight()pureGet Max Desired Height
float GetMaxDesiredWidth()pureGet Max Desired Width
float GetMinDesiredHeight()pureGet Min Desired Height
float GetMinDesiredWidth()pureGet Min Desired Width
bool IsMaxAspectRatioOverride()pureIs Max Aspect Ratio Override
bool IsMinAspectRatioOverride()pureIs Min Aspect Ratio Override
void SetHeightOverride(float Value)callableSet Height Override
void SetMaxAspectRatio(float Value)callableSet Max Aspect Ratio
void SetMaxDesiredHeight(float InMaxDesiredHeight)callableSet Max Desired Height
void SetMaxDesiredSize(FVector2D Value)callableSet Max Desired Size
void SetMaxDesiredWidth(float InMaxDesiredWidth)callableSet Max Desired Width
void SetMinAspectRatio(float Value)callableSet Min Aspect Ratio
void SetMinDesiredHeight(float InMinDesiredHeight)callableSet Min Desired Height
void SetMinDesiredSize(FVector2D Value)callableSet Min Desired Size
void SetMinDesiredWidth(float InMinDesiredWidth)callableSet Min Desired Width
void SetOverrideHeight(bool Value)callableSet Override Height
void SetOverrideWidth(bool Value)callableSet Override Width
void SetPadding(FMargin Value)callableSet Padding
void SetWidthOverride(float Value)callableSet Width Override

Compared with UMG

Every Blueprint-facing member of the UMG class, and where it went. adopt: same name, same meaning. map: here under another name or on another type. reject: deliberately absent, with the reason.

UMGMemberStatusHereNote
USizeBoxWidthOverrideadoptWidthOverrideIts override bit is bOverrideWidth here; UMG spells it bOverride_WidthOverride.
USizeBoxHeightOverrideadoptHeightOverride
USizeBoxMinDesiredWidthmapMinDesiredSizeOne FVector2D holds both axes; zero on an axis is that axis's 'no opinion', where UMG spends a separate bOverride_ bit. GetMinDesiredWidth/SetMinDesiredWidth/ClearMinDesiredWidth exist under UMG's names.
USizeBoxMinDesiredHeightmapMinDesiredSizeThe y of the same pair.
USizeBoxMaxDesiredWidthmapMaxDesiredSizeAs MinDesiredWidth.
USizeBoxMaxDesiredHeightmapMaxDesiredSizeThe y of the same pair.
USizeBoxMinAspectRatioadoptMinAspectRatioZero means not set, the convention the two size bounds on this class already use. Applied to the CONTENT's rect in arrange, as SBox does, not to the box's own measured size.
USizeBoxMaxAspectRatioadoptMaxAspectRatioTested before the minimum, so a pair that crosses resolves to the maximum.
USizeBoxSetWidthOverrideadoptSetWidthOverride
USizeBoxClearWidthOverrideadoptClearWidthOverride
USizeBoxSetHeightOverrideadoptSetHeightOverride
USizeBoxClearHeightOverrideadoptClearHeightOverride
USizeBoxSetMinDesiredWidthadoptSetMinDesiredWidth
USizeBoxClearMinDesiredWidthadoptClearMinDesiredWidth
USizeBoxSetMinDesiredHeightadoptSetMinDesiredHeight
USizeBoxClearMinDesiredHeightadoptClearMinDesiredHeight
USizeBoxSetMaxDesiredWidthadoptSetMaxDesiredWidth
USizeBoxClearMaxDesiredWidthadoptClearMaxDesiredWidth
USizeBoxSetMaxDesiredHeightadoptSetMaxDesiredHeight
USizeBoxClearMaxDesiredHeightadoptClearMaxDesiredHeight
USizeBoxSetMinAspectRatioadoptSetMinAspectRatio
USizeBoxClearMinAspectRatioadoptClearMinAspectRatio
USizeBoxSetMaxAspectRatioadoptSetMaxAspectRatio
USizeBoxClearMaxAspectRatioadoptClearMaxAspectRatio

本页目录