unreal.Synth2DSlider
¶
- class unreal.Synth2DSlider(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:
Plugin: Synthesis
Module: Synthesis
File: Synth2DSlider.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.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 widgetflow_direction_preference
(FlowDirectionPreference): [Read-Write] Flow Direction Preference: Allows you to set a new flow directionindent_handle
(bool): [Read-Write] Indent Handle: Whether the slidable area should be indented to fit the handle.is_enabled
(bool): [Read-Write] Is Enabled: Sets whether this widget can be modified interactively by the useris_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.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
(OnControllerCaptureBeginEventSynth2D): [Read-Write] On Controller Capture Begin: Invoked when the controller capture begins.on_controller_capture_end
(OnControllerCaptureEndEventSynth2D): [Read-Write] On Controller Capture End: Invoked when the controller capture ends.on_mouse_capture_begin
(OnMouseCaptureBeginEventSynth2D): [Read-Write] On Mouse Capture Begin: Invoked when the mouse is pressed and a capture begins.on_mouse_capture_end
(OnMouseCaptureEndEventSynth2D): [Read-Write] On Mouse Capture End: Invoked when the mouse is released and a capture ends.on_value_changed_x
(OnFloatValueChangedEventSynth2D): [Read-Write] On Value Changed X: Called when the value is changed by slider or typing.on_value_changed_y
(OnFloatValueChangedEventSynth2D): [Read-Write] On Value Changed Y: 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 Cursorrender_opacity
(float): [Read-Write] Render Opacity: The opacity of the widgetrender_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.slider_handle_color
(LinearColor): [Read-Write] Slider Handle Color: The color to draw the slider handle in.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 keyboardtool_tip_text
(Text): [Read-Write] Tool Tip Text: Tooltip text to show when the user hovers over the widget with the mousetool_tip_widget
(Widget): [Read-Only] Tool Tip Widget: Tooltip widget to show when the user hovers over the widget with the mousevalue_x
(float): [Read-Write] Value Xvalue_y
(float): [Read-Write] Value Yvisibility
(SlateVisibility): [Read-Write] Visibility: The visibility of the widgetwidget_style
(Synth2DSliderStyle): [Read-Write] Widget Style: The progress bar style
- property indent_handle¶
[Read-Only] Indent Handle: Whether the slidable area should be indented to fit the handle.
- Type
(bool)
- property on_controller_capture_begin¶
[Read-Write] On Controller Capture Begin: Invoked when the controller capture begins.
- property on_controller_capture_end¶
[Read-Write] On Controller Capture End: Invoked when the controller capture ends.
- property on_mouse_capture_begin¶
[Read-Write] On Mouse Capture Begin: Invoked when the mouse is pressed and a capture begins.
- property on_mouse_capture_end¶
[Read-Write] On Mouse Capture End: Invoked when the mouse is released and a capture ends.
- property on_value_changed_x¶
[Read-Write] On Value Changed X: Called when the value is changed by slider or typing.
- property on_value_changed_y¶
[Read-Write] On Value Changed Y: Called when the value is changed by slider or typing.
- set_indent_handle(value) None ¶
Sets if the slidable area should be indented to fit the handle
- Parameters
value (bool) –
- set_slider_handle_color(value) None ¶
Sets the color of the handle bar
- Parameters
value (LinearColor) –
- set_step_size(value) None ¶
Sets the amount to adjust the value by, when using a controller or keyboard
- Parameters
value (float) –
- property slider_handle_color¶
[Read-Only] Slider Handle Color: The color to draw the slider handle in.
- Type
- property step_size¶
[Read-Only] Step Size: The amount to adjust the value by, when using a controller or keyboard
- Type
(float)
- property widget_style¶
[Read-Write] Widget Style: The progress bar style
- Type