unreal.CommonVisibilitySwitcher

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

Bases: unreal.Overlay

Basic switcher that toggles visibility on its children to only show one widget at a time. Activates visible widget if possible.

C++ Source:

  • Plugin: CommonUI

  • Module: CommonUI

  • File: CommonVisibilitySwitcher.h

Editor Properties: (see get_editor_property/set_editor_property)

  • accessible_behavior (SlateAccessibleBehavior): [Read-Write] 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] 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] When AccessibleSummaryBehavior is set to Custom, this is the text that will be used to describe the widget.

  • accessible_text (Text): [Read-Write] When AccessibleBehavior is set to Custom, this is the text that will be used to describe the widget.

  • activate_first_slot_on_adding (bool): [Read-Write] Whether or not to activate the first slot if one is added dynamically

  • active_widget_index (int32): [Read-Write] Active Widget Index

  • auto_activate_slot (bool): [Read-Write] Whether or not to automatically activate a slot when it becomes visible

  • can_children_be_accessible (bool): [Read-Write] Whether or not children of this widget can appear as distinct accessible widgets.

  • clipping (WidgetClipping): [Read-Write] 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] The cursor to show when the mouse is over the widget

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

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

  • is_volatile (bool): [Read-Write] 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] 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 all of the default accessibility behavior and text for this widget.

  • override_cursor (bool): [Read-Write] Override Cursor

  • render_opacity (float): [Read-Write] The opacity of the widget

  • render_transform (WidgetTransform): [Read-Write] The render transform of the widget allows for arbitrary 2D transforms to be applied to the widget.

  • render_transform_pivot (Vector2D): [Read-Write] 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.

  • shown_visibility (SlateVisibility): [Read-Write] Shown Visibility

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

  • tool_tip_text (Text): [Read-Write] Tooltip text to show when the user hovers over the widget with the mouse

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

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

activate_visible_slot() → None

Activate Visible Slot

deactivate_visible_slot() → None

Deactivate Visible Slot

decrement_active_widget_index(allow_wrapping=True) → None

Decrement Active Widget Index

Parameters

allow_wrapping (bool) –

get_active_widget() → Widget

Get Active Widget

Returns

Return type

Widget

get_active_widget_index() → int32

Get Active Widget Index

Returns

Return type

int32

increment_active_widget_index(allow_wrapping=True) → None

Increment Active Widget Index

Parameters

allow_wrapping (bool) –

set_active_widget(widget) → None

Set Active Widget

Parameters

widget (Widget) –

set_active_widget_index(index) → None

Set Active Widget Index

Parameters

index (int32) –