mirror of
https://github.com/obsqrbtz/egui_knob.git
synced 2026-04-09 12:37:52 +03:00
Compare commits
17 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| fa7dd9e181 | |||
| a637ff4bca | |||
| e3a378cc6e | |||
|
|
6decbfdca1 | ||
|
|
9facd0fdfd | ||
|
|
37d0792175 | ||
|
|
969ba9bcb5 | ||
| fb3f9d75dc | |||
| 45ce317879 | |||
| 15021b8cfa | |||
|
|
ad468ae18a | ||
|
|
2c5b209571 | ||
| c1db9a2e5b | |||
| 750d8afb25 | |||
| 4e8975c955 | |||
|
|
824b492b92 | ||
| a70b57e62b |
27
.github/workflows/publish.yml
vendored
Normal file
27
.github/workflows/publish.yml
vendored
Normal file
@@ -0,0 +1,27 @@
|
||||
name: Publish to crates.io
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*'
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
|
||||
- name: Install Rust
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
|
||||
- name: Check if version matches tag
|
||||
run: |
|
||||
TAG=${GITHUB_REF#refs/tags/v}
|
||||
CARGO_VERSION=$(grep '^version' Cargo.toml | head -1 | cut -d'"' -f2)
|
||||
if [ "$TAG" != "$CARGO_VERSION" ]; then
|
||||
echo "Tag version ($TAG) doesn't match Cargo.toml version ($CARGO_VERSION)"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
- name: Publish to crates.io
|
||||
run: cargo publish --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
|
||||
24
CHANGELOG.md
24
CHANGELOG.md
@@ -2,6 +2,30 @@
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## [0.3.10] - 2026-01-23
|
||||
|
||||
### 🚀 Features
|
||||
|
||||
- added support for logarithmic scaling ([#PR9](https://github.com/obsqrbtz/egui_knob/pull/9) by [bratorange](https://github.com/bratorange))
|
||||
|
||||
## [0.3.9] - 2026-01-13
|
||||
|
||||
### 🚀 Features
|
||||
|
||||
- added support for using mouse scroll wheel to change values ([#PR7](https://github.com/obsqrbtz/egui_knob/pull/7) by [maor1993](https://github.com/maor1993))
|
||||
|
||||
## [0.3.8] - 2026-01-12
|
||||
|
||||
### 🚀 Features
|
||||
|
||||
- added `with_double_click_reset` option ([#PR6](https://github.com/obsqrbtz/egui_knob/pull/6) by [maor1993](https://github.com/maor1993))
|
||||
|
||||
## [0.3.7] - 2026-01-06
|
||||
|
||||
### 🛠 Maintenance
|
||||
|
||||
- expose egui types
|
||||
|
||||
## [0.3.6] - 2025-07-15
|
||||
|
||||
### 🛠 Maintenance
|
||||
|
||||
1156
Cargo.lock
generated
1156
Cargo.lock
generated
File diff suppressed because it is too large
Load Diff
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "egui_knob"
|
||||
version = "0.3.6"
|
||||
version = "0.3.10"
|
||||
edition = "2024"
|
||||
authors = ["Daniel Dada"]
|
||||
description = "A simple knob widget for egui"
|
||||
|
||||
10
README.md
10
README.md
@@ -18,6 +18,7 @@ A simple, customizable knob widget for egui.
|
||||
- Configurable sweep range
|
||||
- Background arc with filled segments
|
||||
- Adjustable drag sensitivity
|
||||
- Logarithmic scaling
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -27,7 +28,7 @@ To use the Knob widget in your project, add the following to your `Cargo.toml`:
|
||||
[dependencies]
|
||||
egui = "0.33"
|
||||
eframe = "0.33"
|
||||
egui_knob = "0.3.6"
|
||||
egui_knob = "0.3.10"
|
||||
```
|
||||
|
||||
## Usage
|
||||
@@ -104,6 +105,13 @@ Knob::new(&mut value, 0.0, 1.0, KnobStyle::Wiper)
|
||||
.with_label_format(|v| format!("{:.0}%", v * 100.0));
|
||||
```
|
||||
|
||||
#### Logarithmic Knobs
|
||||
```rust
|
||||
// Enable logarithmic scaling
|
||||
Knob::new(&mut value, 0.0, 1.0, KnobStyle::Wiper)
|
||||
.with_logarithmic_scaling();
|
||||
```
|
||||
|
||||
## Running demo app
|
||||
|
||||
```bash
|
||||
|
||||
@@ -21,6 +21,7 @@ struct KnobDemo {
|
||||
show_bg_arc: bool,
|
||||
show_filled: bool,
|
||||
use_step: bool,
|
||||
logarithmic_scaling: bool,
|
||||
knob_color: egui::Color32,
|
||||
line_color: egui::Color32,
|
||||
text_color: egui::Color32,
|
||||
@@ -33,6 +34,7 @@ impl Default for KnobDemo {
|
||||
show_bg_arc: true,
|
||||
show_filled: true,
|
||||
use_step: false,
|
||||
logarithmic_scaling: false,
|
||||
knob_color: egui::Color32::DARK_GRAY,
|
||||
line_color: egui::Color32::LIGHT_BLUE,
|
||||
text_color: egui::Color32::WHITE,
|
||||
@@ -51,6 +53,8 @@ impl eframe::App for KnobDemo {
|
||||
ui.checkbox(&mut self.show_bg_arc, "Background arc");
|
||||
ui.checkbox(&mut self.show_filled, "Filled segment");
|
||||
ui.checkbox(&mut self.use_step, "Step (0.02)");
|
||||
ui.checkbox(&mut self.logarithmic_scaling, "Logarithmic");
|
||||
|
||||
});
|
||||
|
||||
ui.horizontal(|ui| {
|
||||
@@ -82,12 +86,18 @@ impl eframe::App for KnobDemo {
|
||||
.enumerate()
|
||||
{
|
||||
ui.vertical(|ui| {
|
||||
let mut knob = Knob::new(&mut self.values[i], 0.0, 1.0, *config)
|
||||
let mut knob = Knob::new(&mut self.values[i], 0., 1., *config)
|
||||
.with_label(*label, LabelPosition::Bottom)
|
||||
.with_background_arc(self.show_bg_arc)
|
||||
.with_show_filled_segments(self.show_filled)
|
||||
.with_colors(self.knob_color, self.line_color, self.text_color)
|
||||
.with_step(self.use_step.then_some(0.02));
|
||||
.with_step(self.use_step.then_some(0.02))
|
||||
.with_double_click_reset(0.5)
|
||||
.with_middle_scroll();
|
||||
|
||||
if self.logarithmic_scaling {
|
||||
knob = knob.with_logarithmic_scaling();
|
||||
}
|
||||
|
||||
if *label == "Wiper, Sweep" {
|
||||
knob = knob.with_sweep_range(0.25, 0.75).with_size(50.0);
|
||||
|
||||
BIN
scrot.png
BIN
scrot.png
Binary file not shown.
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 112 KiB |
@@ -16,6 +16,9 @@ pub struct KnobConfig {
|
||||
pub(crate) show_filled_segments: bool,
|
||||
pub(crate) min_angle: f32,
|
||||
pub(crate) max_angle: f32,
|
||||
pub(crate) reset_value: Option<f32>,
|
||||
pub(crate) allow_scroll: bool,
|
||||
pub(crate) logarithmic_scaling: bool,
|
||||
}
|
||||
|
||||
impl KnobConfig {
|
||||
@@ -36,6 +39,9 @@ impl KnobConfig {
|
||||
drag_sensitivity: 0.005,
|
||||
show_background_arc: true,
|
||||
show_filled_segments: true,
|
||||
reset_value: None,
|
||||
allow_scroll:false,
|
||||
logarithmic_scaling: false,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,5 +3,7 @@ mod render;
|
||||
mod style;
|
||||
mod widget;
|
||||
|
||||
pub use egui;
|
||||
|
||||
pub use style::{KnobStyle, LabelPosition};
|
||||
pub use widget::Knob;
|
||||
|
||||
@@ -6,27 +6,28 @@ use crate::style::{KnobStyle, LabelPosition};
|
||||
pub(crate) struct KnobRenderer<'a> {
|
||||
config: &'a KnobConfig,
|
||||
value: f32,
|
||||
raw: f32,
|
||||
min: f32,
|
||||
max: f32,
|
||||
}
|
||||
|
||||
impl<'a> KnobRenderer<'a> {
|
||||
pub fn new(config: &'a KnobConfig, value: f32, min: f32, max: f32) -> Self {
|
||||
pub fn new(config: &'a KnobConfig, value: f32, raw: f32, min: f32, max: f32) -> Self {
|
||||
Self {
|
||||
config,
|
||||
value,
|
||||
raw,
|
||||
min,
|
||||
max,
|
||||
}
|
||||
}
|
||||
|
||||
pub fn compute_angle(&self) -> f32 {
|
||||
if self.min == self.max || self.value.is_nan() {
|
||||
if self.min == self.max || self.raw.is_nan() {
|
||||
self.config.min_angle
|
||||
} else {
|
||||
self.config.min_angle
|
||||
+ (self.value - self.min) / (self.max - self.min)
|
||||
* (self.config.max_angle - self.config.min_angle)
|
||||
+ self.raw * (self.config.max_angle - self.config.min_angle)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -99,7 +100,7 @@ impl<'a> KnobRenderer<'a> {
|
||||
|
||||
if self.config.show_filled_segments {
|
||||
let filled_segments = (segments as f32
|
||||
* ((self.value - self.min) / (self.max - self.min)).clamp(0.0, 1.0))
|
||||
* self.raw.clamp(0.0, 1.0))
|
||||
as usize;
|
||||
|
||||
if filled_segments > 0 {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
use egui::{Color32, Response, Sense, Ui, Widget};
|
||||
use egui::{remap, Color32, Response, Sense, Ui, Widget};
|
||||
|
||||
use crate::config::KnobConfig;
|
||||
use crate::render::KnobRenderer;
|
||||
@@ -53,7 +53,7 @@ impl<'a> Knob<'a> {
|
||||
return self;
|
||||
}
|
||||
|
||||
self.config.min_angle =
|
||||
self.config.min_angle =
|
||||
start_angle_normalized.rem_euclid(1.0) * std::f32::consts::TAU + std::f32::consts::PI / 2.0;
|
||||
self.config.max_angle = self.config.min_angle + range.max(0.0) * std::f32::consts::TAU;
|
||||
self
|
||||
@@ -156,6 +156,22 @@ impl<'a> Knob<'a> {
|
||||
self
|
||||
}
|
||||
|
||||
/// Sets a reset value to return to on doubleclick event.
|
||||
pub fn with_double_click_reset(mut self, reset_value: f32) -> Self {
|
||||
self.config.reset_value = Some(reset_value);
|
||||
self
|
||||
}
|
||||
|
||||
/// Allows user to use scroll wheel to change knob value
|
||||
/// Uses config.step for the increment value
|
||||
pub fn with_middle_scroll(mut self) -> Self {
|
||||
self.config.allow_scroll = true;
|
||||
self
|
||||
}
|
||||
pub fn with_logarithmic_scaling(mut self) -> Self {
|
||||
self.config.logarithmic_scaling = true;
|
||||
self
|
||||
}
|
||||
}
|
||||
|
||||
impl Widget for Knob<'_> {
|
||||
@@ -164,39 +180,65 @@ impl Widget for Knob<'_> {
|
||||
*self.value = self.min;
|
||||
}
|
||||
|
||||
let current_value = *self.value;
|
||||
let renderer = KnobRenderer::new(&self.config, current_value, self.min, self.max);
|
||||
let mut raw = if self.config.logarithmic_scaling {
|
||||
remap(*self.value, self.min..=self.max, 1.0..=10.0).log(10.0)
|
||||
} else {
|
||||
remap(*self.value, self.min..=self.max, 0.0..=1.0)
|
||||
};
|
||||
|
||||
let renderer = KnobRenderer::new(&self.config, *self.value, raw, self.min, self.max);
|
||||
let adjusted_size = renderer.calculate_size(ui);
|
||||
|
||||
let (rect, response) = ui.allocate_exact_size(adjusted_size, Sense::drag());
|
||||
let (rect, response) = ui.allocate_exact_size(adjusted_size, Sense::click_and_drag());
|
||||
|
||||
let mut response = response;
|
||||
if response.dragged() {
|
||||
let delta = response.drag_delta().y;
|
||||
let range = self.max - self.min;
|
||||
let step = self.config.step.unwrap_or(range * self.config.drag_sensitivity);
|
||||
let new_value = (*self.value - delta * step).clamp(self.min, self.max);
|
||||
let step = self.config.step.unwrap_or(self.config.drag_sensitivity);
|
||||
raw = (raw - delta * step).clamp(0.0,1.0);
|
||||
|
||||
*self.value = if let Some(step) = self.config.step {
|
||||
let steps = ((new_value - self.min) / step).round();
|
||||
(self.min + steps * step).clamp(self.min, self.max)
|
||||
raw = if let Some(step) = self.config.step {
|
||||
let steps = (raw / step).round();
|
||||
(steps * step).clamp(0.0, 1.0)
|
||||
} else {
|
||||
new_value
|
||||
raw
|
||||
};
|
||||
|
||||
if self.value.is_nan() {
|
||||
*self.value = self.min;
|
||||
*self.value = 0.0;
|
||||
}
|
||||
|
||||
response.mark_changed();
|
||||
} else if response.hovered() & self.config.allow_scroll {
|
||||
if let Some(scoll) = ui.input(|input| {
|
||||
input.events.iter().find_map(|e| match e {
|
||||
egui::Event::MouseWheel { delta, .. } => Some(*delta),
|
||||
_ => None,
|
||||
})
|
||||
}) {
|
||||
raw = (raw
|
||||
+ scoll.y * self.config.step.unwrap_or(self.config.drag_sensitivity))
|
||||
.clamp(0.0, 1.0);
|
||||
}
|
||||
}
|
||||
|
||||
*self.value = if self.config.logarithmic_scaling {
|
||||
remap(10f32.powf(raw), 1.0..=10.0, self.min..=self.max)
|
||||
}else {
|
||||
remap(raw, 0.0..=1.0, self.min..=self.max)
|
||||
};
|
||||
|
||||
if response.double_clicked() {
|
||||
if let Some(reset_value) = self.config.reset_value {
|
||||
*self.value = reset_value
|
||||
}
|
||||
}
|
||||
|
||||
let knob_rect = renderer.calculate_knob_rect(rect);
|
||||
let center = knob_rect.center();
|
||||
let radius = self.config.size / 2.0;
|
||||
|
||||
let updated_value = *self.value;
|
||||
let updated_renderer = KnobRenderer::new(&self.config, updated_value, self.min, self.max);
|
||||
let updated_renderer = KnobRenderer::new(&self.config, *self.value, raw, self.min, self.max);
|
||||
updated_renderer.render_knob(ui.painter(), center, radius, response.hovered());
|
||||
updated_renderer.render_label(ui, rect);
|
||||
|
||||
|
||||
Reference in New Issue
Block a user