unreal.ScaleBox

class unreal.ScaleBox(outer: Optional[Object] = None, name: Union[Name, str] = 'None')

Bases: ContentWidget

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

C++ Source:

  • Module: UMG

  • File: ScaleBox.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

  • cursor (MouseCursor): [Read-Write] Cursor

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference

  • ignore_inherited_scale (bool): [Read-Write] Ignore Inherited Scale: Optional bool to ignore the inherited scale. Applies inverse scaling to counteract parents before applying the local scale operation.

  • is_enabled (bool): [Read-Write] Is Enabled

  • is_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.

  • 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 Cursor

  • render_opacity (float): [Read-Write] Render Opacity

  • render_transform (WidgetTransform): [Read-Write] Render Transform

  • render_transform_pivot (Vector2D): [Read-Write] Render Transform Pivot

  • slot (PanelSlot): [Read-Write] Slot: The parent slot of the UWidget. Allows us to easily inline edit the layout controlling this widget.

  • stretch (Stretch): [Read-Write] Stretch: The stretching rule to apply when content is stretched

  • stretch_direction (StretchDirection): [Read-Write] Stretch Direction: Controls in what direction content can be scaled

  • tool_tip_text (Text): [Read-Write] Tool Tip Text

  • tool_tip_widget (Widget): [Read-Only] Tool Tip Widget

  • user_specified_scale (float): [Read-Write] User Specified Scale: Optional scale that can be specified by the User. Used only for UserSpecified stretching.

  • visibility (SlateVisibility): [Read-Write] Visibility

property ignore_inherited_scale: bool

[Read-Only] Ignore Inherited Scale: Optional bool to ignore the inherited scale. Applies inverse scaling to counteract parents before applying the local scale operation.

Type:

(bool)

set_ignore_inherited_scale(ignore_inherited_scale) → None

Set Ignore Inherited Scale

Parameters:

ignore_inherited_scale (bool) –

set_stretch(stretch) → None

Set Stretch

Parameters:

stretch (Stretch) –

set_stretch_direction(stretch_direction) → None

Set Stretch Direction

Parameters:

stretch_direction (StretchDirection) –

set_user_specified_scale(user_specified_scale) → None

Set User Specified Scale

Parameters:

user_specified_scale (float) –

property stretch: Stretch

[Read-Only] Stretch: The stretching rule to apply when content is stretched

Type:

(Stretch)

property stretch_direction: StretchDirection

[Read-Only] Stretch Direction: Controls in what direction content can be scaled

Type:

(StretchDirection)

property user_specified_scale: float

[Read-Only] User Specified Scale: Optional scale that can be specified by the User. Used only for UserSpecified stretching.

Type:

(float)