unreal.Image

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

Bases: Widget

The image widget allows you to display a Slate Brush, or texture or material in the UI.

  • No Children

C++ Source:

  • Module: UMG

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

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

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

  • 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

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

  • 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

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

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

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

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

property brush: SlateBrush

[Read-Only] Brush: Image to draw

Type:

(SlateBrush)

property color_and_opacity: LinearColor

[Read-Only] Color and Opacity: Color and opacity

Type:

(LinearColor)

get_dynamic_material() → MaterialInstanceDynamic

Get Dynamic Material

Return type:

MaterialInstanceDynamic

set_brush(brush) → None

Set Brush

Parameters:

brush (SlateBrush) –

set_brush_from_asset(asset) → None

Set Brush from Asset

Parameters:

asset (SlateBrushAsset) –

set_brush_from_atlas_interface(atlas_region, match_size=False) → None

Sets the Brush to the specified Atlas Region.

Parameters:

  • atlas_region (SlateTextureAtlasInterface) – Region of the Atlas to use to set on Brush.

  • match_size (bool) – If true, image will change its size to atlas region size. If false, atlas region will be stretched to image size.

set_brush_from_material(material) → None

Set Brush from Material

Parameters:

material (MaterialInterface) –

set_brush_from_soft_material(soft_material) → None

Set Brush from Soft Material

Parameters:

soft_material (MaterialInterface) –

set_brush_from_soft_texture(soft_texture, match_size=False) → None

Sets the Brush to the specified Soft Texture.

Parameters:

  • soft_texture (Texture2D) – Soft Texture to use to set on Brush.

  • match_size (bool) – If true, image will change its size to texture size. If false, texture will be stretched to image size.

set_brush_from_texture(texture, match_size=False) → None

Sets the Brush to the specified Texture.

Parameters:

  • texture (Texture2D) – Texture to use to set on Brush.

  • match_size (bool) – If true, image will change its size to texture size. If false, texture will be stretched to image size.

set_brush_from_texture_dynamic(texture, match_size=False) → None

Sets the Brush to the specified Dynamic Texture.

Parameters:

  • texture (Texture2DDynamic) – Dynamic Texture to use to set on Brush.

  • match_size (bool) – If true, image will change its size to texture size. If false, texture will be stretched to image size.

set_brush_resource_object(resource_object) → None

Set Brush Resource Object

Parameters:

resource_object (Object) –

set_brush_size(desired_size: Vector2D) → None

deprecated: ‘set_brush_size’ was renamed to ‘set_desired_size_override’.

set_brush_tint_color(tint_color) → None

Set Brush Tint Color

Parameters:

tint_color (SlateColor) –

set_color_and_opacity(color_and_opacity) → None

Set Color and Opacity

Parameters:

color_and_opacity (LinearColor) –

set_desired_size_override(desired_size) → None

Set Desired Size Override

Parameters:

desired_size (Vector2D) –

set_opacity(opacity) → None

Set Opacity

Parameters:

opacity (float) –