unreal.CommonLazyImage

class unreal.CommonLazyImage(outer=None, name='None')

Bases: unreal.Image

A special Image widget that can show unloaded images and takes care of the loading for you!

UCommonLazyImage is another wrapper for SLoadGuard, but it only handles image loading and a throbber during loading.

If this class changes to show any text, by default it will have CoreStyle styling

C++ Source:

  • Plugin: CommonUI

  • Module: CommonUI

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

  • brush (SlateBrush): [Read-Write] Brush: Image to draw

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

  • color_and_opacity (LinearColor): [Read-Write] Color and Opacity: Color and opacity

  • cursor (MouseCursor): [Read-Write] Cursor: The cursor to show when the mouse is over the widget

  • flip_for_right_to_left_flow_direction (bool): [Read-Write] Flip for Right to Left Flow Direction: Flips the image if the localization’s flow direction is RightToLeft

  • flow_direction_preference (FlowDirectionPreference): [Read-Write] Flow Direction Preference: Allows you to set a new flow direction

  • is_enabled (bool): [Read-Write] Is Enabled: Sets whether this widget can be modified interactively by the user

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

  • loading_background_brush (SlateBrush): [Read-Write] Loading Background Brush

  • material_texture_param_name (Name): [Read-Write] Material Texture Param Name: If this image uses a material that a texture should be applied to, this is the name of the material param to use. I.e. if this property is not blank, the resource object of our brush is a material, and we are given a lazy texture, that texture will be assigned to the texture param on the material instead of replacing the material outright on the brush.

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

  • on_loading_state_changed (OnLoadGuardStateChangedDynamic): [Read-Write] BP on Loading State Changed

  • on_mouse_button_down_event (OnPointerEvent): [Read-Write] On Mouse Button Down Event

  • 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: The opacity of the widget

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

  • show_loading (bool): [Read-Write] Show Loading

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

  • tool_tip_widget (Widget): [Read-Only] Tool Tip Widget: Tooltip widget to show when the user hovers over the widget with the mouse

  • visibility (SlateVisibility): [Read-Write] Visibility: The visibility of the widget

is_loading() → bool

Is Loading

Return type

bool

property on_loading_state_changed

[Read-Write] BP on Loading State Changed

Type

(OnLoadGuardStateChangedDynamic)

set_brush_from_lazy_display_asset(lazy_object, match_texture_size=False) → None

Set the brush from a string asset ref only - expects the referenced asset to be a texture or material.

Parameters

  • lazy_object (Object) –

  • match_texture_size (bool) –

set_brush_from_lazy_material(lazy_material) → None

Set the brush from a lazy material asset pointer - will load the material as needed.

Parameters

lazy_material (MaterialInterface) –

set_brush_from_lazy_texture(lazy_texture, match_size=False) → None

Set the brush from a lazy texture asset pointer - will load the texture as needed.

Parameters
set_material_texture_param_name(texture_param_name) → None

Establishes the name of the texture parameter on the currently applied brush material to which textures should be applied. Does nothing if the current brush resource object is not a material.

Note: that this is cleared out automatically if/when a new material is established on the brush. You must call this function again after doing so if the new material has a texture param.

Parameters

texture_param_name (Name) –