unreal.SizeBox
¶
- class unreal.SizeBox(outer=None, name='None')¶
Bases:
unreal.ContentWidget
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
C++ Source:
Module: UMG
File: SizeBox.h
Editor Properties: (see get_editor_property/set_editor_property)
accessible_behavior
(SlateAccessibleBehavior): [Read-Write] Accessible Behavior: Whether or not the widget is accessible, and how to describe it. If set to custom, additional customization options will appear.accessible_summary_behavior
(SlateAccessibleBehavior): [Read-Write] Accessible Summary Behavior: How to describe this widget when it’s being presented through a summary of a parent widget. If set to custom, additional customization options will appear.accessible_summary_text
(Text): [Read-Write] Accessible Summary Text: When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.accessible_text
(Text): [Read-Write] Accessible Text: When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.can_children_be_accessible
(bool): [Read-Write] Can Children be Accessible: Whether or not children of this widget can appear as distinct accessible widgets.clipping
(WidgetClipping): [Read-Write] Clipping: Controls how the clipping behavior of this widget. Normally content that overflows the bounds of the widget continues rendering. Enabling clipping prevents that overflowing content from being seen.NOTE: Elements in different clipping spaces can not be batched together, and so there is a performance cost to clipping. Do not enable clipping unless a panel actually needs to prevent content from showing up outside its bounds.
cursor
(MouseCursor): [Read-Write] Cursor: The cursor to show when the mouse is over the widgetflow_direction_preference
(FlowDirectionPreference): [Read-Write] Flow Direction Preference: Allows you to set a new flow directionheight_override
(float): [Read-Write] Height Override: When specified, ignore the content’s desired size and report the HeightOverride as the Box’s desired height.is_enabled
(bool): [Read-Write] Is Enabled: Sets whether this widget can be modified interactively by the useris_volatile
(bool): [Read-Write] Is Volatile: If true prevents the widget or its child’s geometry or layout information from being cached. If this widget changes every frame, but you want it to still be in an invalidation panel you should make it as volatile instead of invalidating it every frame, which would prevent the invalidation panel from actually ever caching anything.max_aspect_ratio
(float): [Read-Write] Max Aspect Ratiomax_desired_height
(float): [Read-Write] Max Desired Height: When specified, will report the MaxDesiredHeight if smaller than the content’s desired height.max_desired_width
(float): [Read-Write] Max Desired Width: When specified, will report the MaxDesiredWidth if smaller than the content’s desired width.min_aspect_ratio
(float): [Read-Write] Min Aspect Ratiomin_desired_height
(float): [Read-Write] Min Desired Height: When specified, will report the MinDesiredHeight if larger than the content’s desired height.min_desired_width
(float): [Read-Write] Min Desired Width: When specified, will report the MinDesiredWidth if larger than the content’s desired width.navigation
(WidgetNavigation): [Read-Write] Navigation: The navigation object for this widget is optionally created if the user has configured custom navigation rules for this widget in the widget designer. Those rules determine how navigation transitions can occur between widgets.override_accessible_defaults
(bool): [Read-Write] Override Accessible Defaults: Override all of the default accessibility behavior and text for this widget.override_cursor
(bool): [Read-Write] Override Cursoroverride_height_override
(bool): [Read-Write] Override Height Overrideoverride_max_aspect_ratio
(bool): [Read-Write] Override Max Aspect Ratiooverride_max_desired_height
(bool): [Read-Write] Override Max Desired Heightoverride_max_desired_width
(bool): [Read-Write] Override Max Desired Widthoverride_min_aspect_ratio
(bool): [Read-Write] Override Min Aspect Ratiooverride_min_desired_height
(bool): [Read-Write] Override Min Desired Heightoverride_min_desired_width
(bool): [Read-Write] Override Min Desired Widthoverride_width_override
(bool): [Read-Write] Override Width Overriderender_opacity
(float): [Read-Write] Render Opacity: The opacity of the widgetrender_transform
(WidgetTransform): [Read-Write] Render Transform: The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.render_transform_pivot
(Vector2D): [Read-Write] Render Transform Pivot: The render transform pivot controls the location about which transforms are applied. This value is a normalized coordinate about which things like rotations will occur.slot
(PanelSlot): [Read-Write] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.tool_tip_text
(Text): [Read-Write] Tool Tip Text: Tooltip text to show when the user hovers over the widget with the mousetool_tip_widget
(Widget): [Read-Only] Tool Tip Widget: Tooltip widget to show when the user hovers over the widget with the mousevisibility
(SlateVisibility): [Read-Write] Visibility: The visibility of the widgetwidth_override
(float): [Read-Write] Width Override: When specified, ignore the content’s desired size and report the WidthOverride as the Box’s desired width.
- property height_override¶
[Read-Only] Height Override: When specified, ignore the content’s desired size and report the HeightOverride as the Box’s desired height.
- Type
(float)
- property max_desired_height¶
[Read-Only] Max Desired Height: When specified, will report the MaxDesiredHeight if smaller than the content’s desired height.
- Type
(float)
- property max_desired_width¶
[Read-Only] Max Desired Width: When specified, will report the MaxDesiredWidth if smaller than the content’s desired width.
- Type
(float)
- property min_desired_height¶
[Read-Only] Min Desired Height: When specified, will report the MinDesiredHeight if larger than the content’s desired height.
- Type
(float)
- property min_desired_width¶
[Read-Only] Min Desired Width: When specified, will report the MinDesiredWidth if larger than the content’s desired width.
- Type
(float)
- set_height_override(height_override) None ¶
When specified, ignore the content’s desired size and report the HeightOverride as the Box’s desired height.
- Parameters
height_override (float) –
- set_max_aspect_ratio(max_aspect_ratio) None ¶
Set Max Aspect Ratio
- Parameters
max_aspect_ratio (float) –
- set_max_desired_height(max_desired_height) None ¶
When specified, will report the MaxDesiredHeight if smaller than the content’s desired height.
- Parameters
max_desired_height (float) –
- set_max_desired_width(max_desired_width) None ¶
When specified, will report the MaxDesiredWidth if smaller than the content’s desired width.
- Parameters
max_desired_width (float) –
- set_min_aspect_ratio(min_aspect_ratio) None ¶
Set Min Aspect Ratio
- Parameters
min_aspect_ratio (float) –
- set_min_desired_height(min_desired_height) None ¶
When specified, will report the MinDesiredHeight if larger than the content’s desired height.
- Parameters
min_desired_height (float) –
- set_min_desired_width(min_desired_width) None ¶
When specified, will report the MinDesiredWidth if larger than the content’s desired width.
- Parameters
min_desired_width (float) –