unreal.RadialSlider

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

Bases: unreal.Widget

A simple widget that shows a sliding bar with a handle that allows you to control the value between 0..1.

  • No Children

C++ Source:

  • Module: AdvancedWidgets

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

  • angular_offset (float): [Read-Write] Angular Offset: Rotates radial slider by arbitrary offset to support full gamut of configurations.

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

  • center_background_color (LinearColor): [Read-Write] Center Background Color: The color to draw the center background in.

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

  • custom_default_value (float): [Read-Write] Custom Default Value: The value where the slider should draw it’s progress bar from, independent of direction

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

  • hand_start_end_ratio (Vector2D): [Read-Write] Hand Start End Ratio: Start and end of the hand as a ratio to the slider radius (so 0.0 to 1.0 is from the slider center to the handle).

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

  • is_focusable (bool): [Read-Write] Is Focusable: Should the slider be focusable?

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

  • locked (bool): [Read-Write] Locked: Whether the handle is interactive or fixed.

  • mouse_uses_step (bool): [Read-Write] Mouse Uses Step: Sets new value if mouse position is greater/less than half the step size.

  • 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_controller_capture_begin (OnControllerCaptureBeginEvent): [Read-Write] On Controller Capture Begin: Invoked when the controller capture begins.

  • on_controller_capture_end (OnControllerCaptureEndEvent): [Read-Write] On Controller Capture End: Invoked when the controller capture ends.

  • on_mouse_capture_begin (OnMouseCaptureBeginEvent): [Read-Write] On Mouse Capture Begin: Invoked when the mouse is pressed and a capture begins.

  • on_mouse_capture_end (OnMouseCaptureEndEvent): [Read-Write] On Mouse Capture End: Invoked when the mouse is released and a capture ends.

  • on_value_changed (OnFloatValueChangedEvent): [Read-Write] On Value Changed: Called when the value is changed by slider or typing.

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

  • requires_controller_lock (bool): [Read-Write] Requires Controller Lock: Sets whether we have to lock input to change the slider value.

  • show_slider_hand (bool): [Read-Write] Show Slider Hand: Whether to show the slider hand.

  • show_slider_handle (bool): [Read-Write] Show Slider Handle: Whether to show the slider handle (thumb).

  • slider_bar_color (LinearColor): [Read-Write] Slider Bar Color: The color to draw the slider bar in.

  • slider_handle_color (LinearColor): [Read-Write] Slider Handle Color: The color to draw the slider handle in.

  • slider_handle_end_angle (float): [Read-Write] Slider Handle End Angle: The angle at which the Slider Handle will end.

  • slider_handle_start_angle (float): [Read-Write] Slider Handle Start Angle: The angle at which the Slider Handle will start.

  • slider_progress_color (LinearColor): [Read-Write] Slider Progress Color: The color to draw the completed progress of the slider bar in.

  • slider_range (RuntimeFloatCurve): [Read-Write] Slider Range: A curve that defines how the slider should be sampled. Default is linear.

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

  • step_size (float): [Read-Write] Step Size: The amount to adjust the value by, when using a controller or keyboard

  • 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

  • use_custom_default_value (bool): [Read-Write] Use Custom Default Value: Whether the slider should draw it’s progress bar from a custom value on the slider

  • use_vertical_drag (bool): [Read-Write] Use Vertical Drag: Whether the value is changed when dragging vertically as opposed to along the radial curve.

  • value (float): [Read-Write] Value: The slider value to display.

  • value_tags (Array(float)): [Read-Write] Value Tags: Adds text tags to the radial slider at the value’s position.

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

  • widget_style (SliderStyle): [Read-Write] Widget Style: The progress bar style

property angular_offset

[Read-Only] Angular Offset: Rotates radial slider by arbitrary offset to support full gamut of configurations.

Type

(float)

property center_background_color

[Read-Only] Center Background Color: The color to draw the center background in.

Type

(LinearColor)

get_custom_default_value() → float

Gets the current custom default value of the slider.

Return type

float

get_normalized_slider_handle_position() → float

Get the current raw slider alpha from 0 to 1

Return type

float

get_value() → float

Gets the current value of the slider.

Return type

float

property hand_start_end_ratio

[Read-Only] Hand Start End Ratio: Start and end of the hand as a ratio to the slider radius (so 0.0 to 1.0 is from the slider center to the handle).

Type

(Vector2D)

property is_focusable

[Read-Only] Is Focusable: Should the slider be focusable?

Type

(bool)

property locked

[Read-Only] Locked: Whether the handle is interactive or fixed.

Type

(bool)

property mouse_uses_step

[Read-Only] Mouse Uses Step: Sets new value if mouse position is greater/less than half the step size.

Type

(bool)

property on_controller_capture_begin

[Read-Write] On Controller Capture Begin: Invoked when the controller capture begins.

Type

(OnControllerCaptureBeginEvent)

property on_controller_capture_end

[Read-Write] On Controller Capture End: Invoked when the controller capture ends.

Type

(OnControllerCaptureEndEvent)

property on_mouse_capture_begin

[Read-Write] On Mouse Capture Begin: Invoked when the mouse is pressed and a capture begins.

Type

(OnMouseCaptureBeginEvent)

property on_mouse_capture_end

[Read-Write] On Mouse Capture End: Invoked when the mouse is released and a capture ends.

Type

(OnMouseCaptureEndEvent)

property on_value_changed

[Read-Write] On Value Changed: Called when the value is changed by slider or typing.

Type

(OnFloatValueChangedEvent)

property requires_controller_lock

[Read-Only] Requires Controller Lock: Sets whether we have to lock input to change the slider value.

Type

(bool)

set_angular_offset(value) → None

Sets the Angular Offset for the slider.

Parameters

value (float) –

set_center_background_color(value) → None

Sets the color of the slider bar

Parameters

value (LinearColor) –

set_custom_default_value(value) → None

Sets the current custom default value of the slider.

Parameters

value (float) –

set_hand_start_end_ratio(value) → None

Sets the start and end of the hand as a ratio to the slider radius (so 0.0 to 1.0 is from the slider center to the handle).

Parameters

value (Vector2D) –

set_locked(value) → None

Sets the handle to be interactive or fixed

Parameters

value (bool) –

set_show_slider_hand(show_slider_hand) → None

Whether to show the slider hand.

Parameters

show_slider_hand (bool) –

set_show_slider_handle(show_slider_handle) → None

Whether to show the slider handle (thumb).

Parameters

show_slider_handle (bool) –

set_slider_bar_color(value) → None

Sets the color of the slider bar

Parameters

value (LinearColor) –

set_slider_handle_color(value) → None

Sets the color of the handle bar

Parameters

value (LinearColor) –

set_slider_handle_end_angle(value) → None

Sets the maximum angle of the slider.

Parameters

value (float) –

set_slider_handle_start_angle(value) → None

Sets the minimum angle of the slider.

Parameters

value (float) –

set_slider_progress_color(value) → None

Sets the progress color of the slider bar

Parameters

value (LinearColor) –

set_slider_range(slider_range) → None

Sets the curve for the slider range

Parameters

slider_range (RuntimeFloatCurve) –

set_step_size(value) → None

Sets the amount to adjust the value by, when using a controller or keyboard

Parameters

value (float) –

set_use_vertical_drag(use_vertical_drag) → None

Set whether the value is changed when dragging vertically as opposed to along the radial curve.

Parameters

use_vertical_drag (bool) –

set_value(value) → None

Sets the current value of the slider.

Parameters

value (float) –

set_value_tags(value_tags) → None

Adds value tags to the slider.

Parameters

value_tags (Array(float)) –

property show_slider_hand

[Read-Write] Show Slider Hand: Whether to show the slider hand.

Type

(bool)

property show_slider_handle

[Read-Write] Show Slider Handle: Whether to show the slider handle (thumb).

Type

(bool)

property slider_bar_color

[Read-Only] Slider Bar Color: The color to draw the slider bar in.

Type

(LinearColor)

property slider_handle_color

[Read-Only] Slider Handle Color: The color to draw the slider handle in.

Type

(LinearColor)

property slider_handle_end_angle

[Read-Only] Slider Handle End Angle: The angle at which the Slider Handle will end.

Type

(float)

property slider_handle_start_angle

[Read-Only] Slider Handle Start Angle: The angle at which the Slider Handle will start.

Type

(float)

property slider_progress_color

[Read-Only] Slider Progress Color: The color to draw the completed progress of the slider bar in.

Type

(LinearColor)

property slider_range

[Read-Only] Slider Range: A curve that defines how the slider should be sampled. Default is linear.

Type

(RuntimeFloatCurve)

property step_size

[Read-Only] Step Size: The amount to adjust the value by, when using a controller or keyboard

Type

(float)

property use_vertical_drag

[Read-Write] Use Vertical Drag: Whether the value is changed when dragging vertically as opposed to along the radial curve.

Type

(bool)

property value

[Read-Write] Value: The slider value to display.

Type

(float)

property value_tags

[Read-Only] Value Tags: Adds text tags to the radial slider at the value’s position.

Type

(Array(float))

property widget_style

[Read-Write] Widget Style: The progress bar style

Type

(SliderStyle)