/* * This source file is part of RmlUi, the HTML/CSS Interface Middleware * * For the latest information, see http://github.com/mikke89/RmlUi * * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd * Copyright (c) 2019-2023 The RmlUi Team, and contributors * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * */ #include "WidgetSlider.h" #include "../../../Include/RmlUi/Core/ComputedValues.h" #include "../../../Include/RmlUi/Core/Context.h" #include "../../../Include/RmlUi/Core/ElementUtilities.h" #include "../../../Include/RmlUi/Core/Elements/ElementFormControl.h" #include "../../../Include/RmlUi/Core/Factory.h" #include "../../../Include/RmlUi/Core/Input.h" #include "../../../Include/RmlUi/Core/Profiling.h" #include "../Clock.h" namespace Rml { static const float DEFAULT_REPEAT_DELAY = 0.5f; static const float DEFAULT_REPEAT_PERIOD = 0.1f; WidgetSlider::WidgetSlider(ElementFormControl* _parent) { parent = _parent; orientation = HORIZONTAL; track = nullptr; bar = nullptr; progress = nullptr; arrows[0] = nullptr; arrows[1] = nullptr; bar_position = 0; bar_drag_anchor = 0; arrow_timers[0] = -1; arrow_timers[1] = -1; last_update_time = 0; value = 0; min_value = 0; max_value = 100; step = 1; } WidgetSlider::~WidgetSlider() { if (bar) parent->RemoveChild(bar); if (track && progress) track->RemoveChild(progress); if (track) parent->RemoveChild(track); parent->RemoveEventListener(EventId::Blur, this); parent->RemoveEventListener(EventId::Focus, this); parent->RemoveEventListener(EventId::Keydown, this, true); parent->RemoveEventListener(EventId::Mousedown, this); parent->RemoveEventListener(EventId::Mouseup, this); parent->RemoveEventListener(EventId::Mouseout, this); parent->RemoveEventListener(EventId::Drag, this); parent->RemoveEventListener(EventId::Dragstart, this); parent->RemoveEventListener(EventId::Dragend, this); for (int i = 0; i < 2; i++) { if (arrows[i]) parent->RemoveChild(arrows[i]); } } bool WidgetSlider::Initialise() { // Create all of our child elements as standard elements, and abort if we can't create them. ElementPtr track_element = Factory::InstanceElement(parent, "*", "slidertrack", XMLAttributes()); ElementPtr bar_element = Factory::InstanceElement(parent, "*", "sliderbar", XMLAttributes()); ElementPtr progress_element = Factory::InstanceElement(parent, "*", "sliderprogress", XMLAttributes()); ElementPtr arrow0_element = Factory::InstanceElement(parent, "*", "sliderarrowdec", XMLAttributes()); ElementPtr arrow1_element = Factory::InstanceElement(parent, "*", "sliderarrowinc", XMLAttributes()); if (!track_element || !bar_element || !progress_element || !arrow0_element || !arrow1_element) return false; // Add them as non-DOM elements. track = parent->AppendChild(std::move(track_element), false); progress = track->AppendChild(std::move(progress_element), false); bar = parent->AppendChild(std::move(bar_element), false); arrows[0] = parent->AppendChild(std::move(arrow0_element), false); arrows[1] = parent->AppendChild(std::move(arrow1_element), false); const Property drag_property = Property(Style::Drag::Drag); track->SetProperty(PropertyId::Drag, drag_property); progress->SetProperty(PropertyId::Drag, drag_property); bar->SetProperty(PropertyId::Drag, drag_property); // Attach the listeners // All listeners are attached to parent, ensuring that we don't get duplicate events when it bubbles from child to parent parent->AddEventListener(EventId::Blur, this); parent->AddEventListener(EventId::Focus, this); parent->AddEventListener(EventId::Keydown, this, true); parent->AddEventListener(EventId::Mousedown, this); parent->AddEventListener(EventId::Mouseup, this); parent->AddEventListener(EventId::Mouseout, this); parent->AddEventListener(EventId::Drag, this); parent->AddEventListener(EventId::Dragstart, this); parent->AddEventListener(EventId::Dragend, this); return true; } void WidgetSlider::Update() { if (!std::any_of(std::begin(arrow_timers), std::end(arrow_timers), [](float timer) { return timer > 0; })) return; const double current_time = Clock::GetElapsedTime(); const float delta_time = float(current_time - last_update_time); last_update_time = current_time; for (int i = 0; i < 2; i++) { if (arrow_timers[i] > 0) { arrow_timers[i] -= delta_time; while (arrow_timers[i] <= 0) { arrow_timers[i] += DEFAULT_REPEAT_PERIOD; SetBarPosition(i == 0 ? OnLineDecrement() : OnLineIncrement()); } if (Context* ctx = parent->GetContext()) ctx->RequestNextUpdate(arrow_timers[i]); } } } void WidgetSlider::SetBarPosition(float _bar_position) { bar_position = Math::Clamp(_bar_position, 0.0f, 1.0f); PositionBar(); ResizeProgress(); } float WidgetSlider::GetBarPosition() { return bar_position; } void WidgetSlider::SetOrientation(Orientation _orientation) { orientation = _orientation; } WidgetSlider::Orientation WidgetSlider::GetOrientation() const { return orientation; } void WidgetSlider::GetDimensions(Vector2f& dimensions) const { switch (orientation) { case VERTICAL: dimensions.x = 16; dimensions.y = 256; break; case HORIZONTAL: dimensions.x = 256; dimensions.y = 16; break; } } void WidgetSlider::SetValue(float target_value) { float num_steps = (target_value - min_value) / step; float new_value = min_value + Math::Round(num_steps) * step; if (new_value != value) SetBarPosition(SetValueInternal(new_value)); } float WidgetSlider::GetValue() const { return value; } void WidgetSlider::SetMinValue(float _min_value) { if (_min_value != min_value) { min_value = _min_value; SetBarPosition(SetValueInternal(value, false)); } } void WidgetSlider::SetMaxValue(float _max_value) { if (_max_value != max_value) { max_value = _max_value; SetBarPosition(SetValueInternal(value, false)); } } void WidgetSlider::SetStep(float _step) { // Can't have a zero step! if (_step == 0) return; step = _step; } void WidgetSlider::FormatElements() { RMLUI_ZoneScopedNC("RangeOnResize", 0x228044); Vector2f box = GetParent()->GetBox().GetSize(); WidgetSlider::FormatElements(box, GetOrientation() == VERTICAL ? box.y : box.x); } void WidgetSlider::FormatElements(const Vector2f containing_block, float slider_length) { int length_axis = orientation == VERTICAL ? 1 : 0; // Build the box for the containing slider element. Box parent_box; ElementUtilities::BuildBox(parent_box, containing_block, parent); // Set the length of the slider. Vector2f content = parent_box.GetSize(); content[length_axis] = slider_length; parent_box.SetContent(content); // Generate the initial dimensions for the track. It'll need to be cut down to fit the arrows. Box track_box; ElementUtilities::BuildBox(track_box, parent_box.GetSize(), track); content = track_box.GetSize(); content[length_axis] = slider_length -= orientation == VERTICAL ? (track_box.GetCumulativeEdge(BoxArea::Content, BoxEdge::Top) + track_box.GetCumulativeEdge(BoxArea::Content, BoxEdge::Bottom)) : (track_box.GetCumulativeEdge(BoxArea::Content, BoxEdge::Left) + track_box.GetCumulativeEdge(BoxArea::Content, BoxEdge::Right)); // If no height has been explicitly specified for the track, it'll be initialised to -1 as per normal block // elements. We'll fix that up here. if (orientation == HORIZONTAL && content.y < 0) content.y = parent_box.GetSize().y; // Now we size the arrows. for (int i = 0; i < 2; i++) { Box arrow_box; ElementUtilities::BuildBox(arrow_box, parent_box.GetSize(), arrows[i]); // Clamp the size to (0, 0). Vector2f arrow_size = arrow_box.GetSize(); if (arrow_size.x < 0 || arrow_size.y < 0) arrow_box.SetContent(Vector2f(0, 0)); arrows[i]->SetBox(arrow_box); // Shrink the track length by the arrow size. content[length_axis] -= arrow_box.GetSize(BoxArea::Margin)[length_axis]; } // Now the track has been sized, we can fix everything into position. track_box.SetContent(content); track->SetBox(track_box); if (orientation == VERTICAL) { Vector2f offset(arrows[0]->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Left), arrows[0]->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Top)); arrows[0]->SetOffset(offset, parent); offset.x = track->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Left); offset.y += arrows[0]->GetBox().GetSize(BoxArea::Border).y + arrows[0]->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Bottom) + track->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Top); track->SetOffset(offset, parent); offset.x = arrows[1]->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Left); offset.y += track->GetBox().GetSize(BoxArea::Border).y + track->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Bottom) + arrows[1]->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Top); arrows[1]->SetOffset(offset, parent); } else { Vector2f offset(arrows[0]->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Left), arrows[0]->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Top)); arrows[0]->SetOffset(offset, parent); offset.x += arrows[0]->GetBox().GetSize(BoxArea::Border).x + arrows[0]->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Right) + track->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Left); offset.y = track->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Top); track->SetOffset(offset, parent); offset.x += track->GetBox().GetSize(BoxArea::Border).x + track->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Right) + arrows[1]->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Left); offset.y = arrows[1]->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Top); arrows[1]->SetOffset(offset, parent); } FormatBar(); FormatProgress(); if (parent->IsDisabled()) { // Propagate disabled state to child elements bar->SetPseudoClass("disabled", true); track->SetPseudoClass("disabled", true); progress->SetPseudoClass("disabled", true); arrows[0]->SetPseudoClass("disabled", true); arrows[1]->SetPseudoClass("disabled", true); } } void WidgetSlider::FormatBar() { Box bar_box; ElementUtilities::BuildBox(bar_box, parent->GetBox().GetSize(), bar); auto& computed = bar->GetComputedValues(); Vector2f bar_box_content = bar_box.GetSize(); if (orientation == HORIZONTAL) { if (computed.height().type == Style::Height::Auto) bar_box_content.y = parent->GetBox().GetSize().y; } // Set the new dimensions on the bar to re-decorate it. bar_box.SetContent(bar_box_content); bar->SetBox(bar_box); // Now that it's been resized, re-position it. PositionBar(); } void WidgetSlider::FormatProgress() { Box progress_box; ElementUtilities::BuildBox(progress_box, parent->GetBox().GetSize(), progress); auto& computed = progress->GetComputedValues(); Vector2f progress_box_content = progress_box.GetSize(); if (orientation == HORIZONTAL) { if (computed.height().type == Style::Height::Auto) progress_box_content.y = track->GetBox().GetSize().y; } // Set the new dimensions on the progress element to re-decorate it. progress_box.SetContent(progress_box_content); progress->SetBox(progress_box); Vector2f offset = track->GetRelativeOffset(); offset.x += progress->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Left); offset.y += progress->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Top); progress->SetOffset(offset, parent); ResizeProgress(); } Element* WidgetSlider::GetParent() const { return parent; } void WidgetSlider::ProcessEvent(Event& event) { if (parent->IsDisabled()) return; switch (event.GetId()) { case EventId::Mousedown: { // Only respond to primary mouse button. if (event.GetParameter("button", -1) != 0) break; if (event.GetTargetElement() == track || event.GetTargetElement() == progress) { float mouse_position, bar_halfsize; if (orientation == HORIZONTAL) { mouse_position = event.GetParameter("mouse_x", 0); bar_halfsize = 0.5f * bar->GetBox().GetSize(BoxArea::Border).x; } else { mouse_position = event.GetParameter("mouse_y", 0); bar_halfsize = 0.5f * bar->GetBox().GetSize(BoxArea::Border).y; } float new_bar_position = AbsolutePositionToBarPosition(mouse_position - bar_halfsize); SetBarPosition(OnBarChange(new_bar_position)); } else if (event.GetTargetElement() == arrows[0]) { arrow_timers[0] = DEFAULT_REPEAT_DELAY; last_update_time = Clock::GetElapsedTime(); SetBarPosition(OnLineDecrement()); } else if (event.GetTargetElement() == arrows[1]) { arrow_timers[1] = DEFAULT_REPEAT_DELAY; last_update_time = Clock::GetElapsedTime(); SetBarPosition(OnLineIncrement()); } } break; case EventId::Mouseup: case EventId::Mouseout: { if (event.GetTargetElement() == arrows[0]) arrow_timers[0] = -1; else if (event.GetTargetElement() == arrows[1]) arrow_timers[1] = -1; } break; case EventId::Dragstart: { if (event.GetTargetElement() == bar || event.GetTargetElement() == track || event.GetTargetElement() == progress) { bar->SetPseudoClass("active", true); if (orientation == HORIZONTAL) bar_drag_anchor = event.GetParameter("mouse_x", 0) - bar->GetAbsoluteOffset().x; else bar_drag_anchor = event.GetParameter("mouse_y", 0) - bar->GetAbsoluteOffset().y; } } break; case EventId::Drag: { if (event.GetTargetElement() == bar || event.GetTargetElement() == track || event.GetTargetElement() == progress) { float new_bar_offset = event.GetParameter((orientation == HORIZONTAL ? "mouse_x" : "mouse_y"), 0) - bar_drag_anchor; float new_bar_position = AbsolutePositionToBarPosition(new_bar_offset); SetBarPosition(OnBarChange(new_bar_position)); } } break; case EventId::Dragend: { if (event.GetTargetElement() == bar || event.GetTargetElement() == track || event.GetTargetElement() == progress) { bar->SetPseudoClass("active", false); } } break; case EventId::Keydown: { const Input::KeyIdentifier key_identifier = (Input::KeyIdentifier)event.GetParameter("key_identifier", 0); const bool increment = (key_identifier == Input::KI_RIGHT && orientation == HORIZONTAL) || (key_identifier == Input::KI_DOWN && orientation == VERTICAL); const bool decrement = (key_identifier == Input::KI_LEFT && orientation == HORIZONTAL) || (key_identifier == Input::KI_UP && orientation == VERTICAL); if (increment || decrement) { SetBarPosition(decrement ? OnLineDecrement() : OnLineIncrement()); event.StopPropagation(); } } break; case EventId::Focus: { if (event.GetTargetElement() == parent) bar->SetPseudoClass("focus", true); } break; case EventId::Blur: { if (event.GetTargetElement() == parent) bar->SetPseudoClass("focus", false); } break; default: break; } } float WidgetSlider::OnBarChange(float bar_position) { float new_value = min_value + bar_position * (max_value - min_value); int num_steps = Math::RoundToInteger((new_value - value) / step); return SetValueInternal(value + num_steps * step); } float WidgetSlider::OnLineIncrement() { return SetValueInternal(value + step); } float WidgetSlider::OnLineDecrement() { return SetValueInternal(value - step); } float WidgetSlider::AbsolutePositionToBarPosition(float absolute_position) const { float new_bar_position = bar_position; if (orientation == HORIZONTAL) { const float edge_left = bar->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Left); const float edge_right = bar->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Right); float traversable_track_length = track->GetBox().GetSize(BoxArea::Content).x - bar->GetBox().GetSize(BoxArea::Border).x - edge_left - edge_right; if (traversable_track_length > 0) { float traversable_track_origin = track->GetAbsoluteOffset().x + edge_left; new_bar_position = (absolute_position - traversable_track_origin) / traversable_track_length; new_bar_position = Math::Clamp(new_bar_position, 0.0f, 1.0f); } } else { const float edge_top = bar->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Top); const float edge_bottom = bar->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Bottom); float traversable_track_length = track->GetBox().GetSize(BoxArea::Content).y - bar->GetBox().GetSize(BoxArea::Border).y - edge_top - edge_bottom; if (traversable_track_length > 0) { float traversable_track_origin = track->GetAbsoluteOffset().y + edge_top; new_bar_position = (absolute_position - traversable_track_origin) / traversable_track_length; new_bar_position = Math::Clamp(new_bar_position, 0.0f, 1.0f); } } return new_bar_position; } void WidgetSlider::PositionBar() { const Vector2f track_dimensions = track->GetBox().GetSize(); const Vector2f bar_dimensions = bar->GetBox().GetSize(BoxArea::Border); if (orientation == VERTICAL) { const float edge_top = bar->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Top); const float edge_bottom = bar->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Bottom); const float traversable_track_length = track_dimensions.y - bar_dimensions.y - edge_top - edge_bottom; const Vector2f offset = { bar->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Left), track->GetRelativeOffset().y + edge_top + traversable_track_length * bar_position, }; bar->SetOffset(offset.Round(), parent); } else { const float edge_left = bar->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Left); const float edge_right = bar->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Right); const float traversable_track_length = track_dimensions.x - bar_dimensions.x - edge_left - edge_right; const Vector2f offset = { track->GetRelativeOffset().x + edge_left + traversable_track_length * bar_position, bar->GetBox().GetEdge(BoxArea::Margin, BoxEdge::Top), }; bar->SetOffset(offset.Round(), parent); } } void WidgetSlider::ResizeProgress() { Box progress_box = progress->GetBox(); Vector2f new_size = progress_box.GetSize(); if (orientation == VERTICAL) { new_size.y = bar->GetOffsetTop(); } else { new_size.x = bar->GetOffsetLeft(); } progress_box.SetContent(new_size); progress->SetBox(progress_box); } float WidgetSlider::SetValueInternal(float new_value, bool force_submit_change_event) { if (min_value < max_value) { value = Math::Clamp(new_value, min_value, max_value); } else if (min_value > max_value) { value = Math::Clamp(new_value, max_value, min_value); } else { value = min_value; return 0; } const bool value_changed = (value != GetParent()->GetAttribute("value", 0.0f)); if (force_submit_change_event || value_changed) { Dictionary parameters; parameters["value"] = value; GetParent()->DispatchEvent(EventId::Change, parameters); } if (value_changed) GetParent()->SetAttribute("value", value); return (value - min_value) / (max_value - min_value); } } // namespace Rml