unreal.AudioRadialSlider

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

Bases: Widget

An audio radial slider widget.

C++ Source:

  • Plugin: AudioWidgets

  • Module: AudioWidgets

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

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

  • clipping (WidgetClipping): [Read-Write] Clipping

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

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

  • 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

  • is_units_text_read_only (bool): [Read-Write] Is Units Text Read Only: Whether to set the units part of the text label read only.

  • is_value_text_read_only (bool): [Read-Write] Is Value Text Read Only: Whether to set the value part of the text label read only.

  • 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_value_changed (OnAudioRadialSliderValueChangedEvent): [Read-Write] On Value Changed: Called when the value is changed by slider or typing.

  • output_range (Vector2D): [Read-Write] Output Range: Output range

  • 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

  • show_label_only_on_hover (bool): [Read-Write] Show Label Only on Hover: If true, show text label only on hover; if false always show label.

  • show_units_text (bool): [Read-Write] Show Units Text: Whether to show the units part of the text label.

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

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

  • slider_thickness (float): [Read-Write] Slider Thickness: The slider thickness.

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

  • text_label_background_color (LinearColor): [Read-Write] Text Label Background Color: The color to draw the text label background.

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

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

  • units_text (Text): [Read-Write] Units Text: The text label units

  • value (float): [Read-Write] Value: The normalized linear (0 - 1) slider value position.

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

  • widget_layout (AudioRadialSliderLayout): [Read-Write] Widget Layout: The layout of the widget (position of text label).

get_output_value(slider_value) → float

Get output value from normalized linear (0 - 1) based on internal lin to output mapping.

Parameters:

slider_value (float) –

Return type:

float

get_slider_value(output_value) → float

Get normalized linear (0 - 1) slider value from output based on internal lin to output mapping.

Parameters:

output_value (float) –

Return type:

float

property on_value_changed: OnAudioRadialSliderValueChangedEvent

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

Type:

(OnAudioRadialSliderValueChangedEvent)

set_center_background_color(value) → None

Sets the label background color

Parameters:

value (LinearColor) –

set_hand_start_end_ratio(hand_start_end_ratio) → 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:

hand_start_end_ratio (Vector2D) –

set_output_range(output_range) → None

Sets the output range

Parameters:

output_range (Vector2D) –

set_show_label_only_on_hover(show_label_only_on_hover) → None

If true, show text label only on hover; if false always show label.

Parameters:

show_label_only_on_hover (bool) –

set_show_units_text(show_units_text) → None

Sets whether to show the units text

Parameters:

show_units_text (bool) –

set_slider_bar_color(value) → None

Sets the slider bar color

Parameters:

value (LinearColor) –

set_slider_progress_color(value) → None

Sets the slider progress color

Parameters:

value (LinearColor) –

set_slider_thickness(thickness) → None

Sets the slider thickness

Parameters:

thickness (float) –

set_text_label_background_color(color) → None

Sets the label background color

Parameters:

color (SlateColor) –

set_units_text(units) → None

Sets the units text

Parameters:

units (Text) –

set_units_text_read_only(is_read_only) → None

Sets whether the units text is read only

Parameters:

is_read_only (bool) –

set_value_text_read_only(is_read_only) → None

Sets whether the value text is read only

Parameters:

is_read_only (bool) –

set_widget_layout(layout) → None

Sets the widget layout

Parameters:

layout (AudioRadialSliderLayout) –