summaryrefslogtreecommitdiffstats
path: root/graphics/src/geometry
diff options
context:
space:
mode:
authorLibravatar Kxie <56177821+ua-kxie@users.noreply.github.com>2023-08-07 17:35:26 +0800
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2023-08-15 07:52:30 +0200
commit76ffbbd06e53e2793cba7f7e640279b1f6ef1b12 (patch)
tree8761a0ac27f7849ee2ae10af5f92579edfd3bae4 /graphics/src/geometry
parentf5b95629009ecde8c6f6388c8f33ec43d30d17d1 (diff)
downloadiced-76ffbbd06e53e2793cba7f7e640279b1f6ef1b12.tar.gz
iced-76ffbbd06e53e2793cba7f7e640279b1f6ef1b12.tar.bz2
iced-76ffbbd06e53e2793cba7f7e640279b1f6ef1b12.zip
Update arc.rs with improved documentation
added units and improved description to field comments of Arc and Ellipse structs.
Diffstat (limited to 'graphics/src/geometry')
-rw-r--r--graphics/src/geometry/path/arc.rs12
1 files changed, 6 insertions, 6 deletions
diff --git a/graphics/src/geometry/path/arc.rs b/graphics/src/geometry/path/arc.rs
index 2cdebb66..dd4fcf33 100644
--- a/graphics/src/geometry/path/arc.rs
+++ b/graphics/src/geometry/path/arc.rs
@@ -8,9 +8,9 @@ pub struct Arc {
pub center: Point,
/// The radius of the arc.
pub radius: f32,
- /// The start of the segment's angle, clockwise rotation.
+ /// The start of the segment's angle in radians, clockwise rotation from positive x-axis.
pub start_angle: f32,
- /// The end of the segment's angle, clockwise rotation.
+ /// The end of the segment's angle in radians, clockwise rotation from positive x-axis.
pub end_angle: f32,
}
@@ -19,13 +19,13 @@ pub struct Arc {
pub struct Elliptical {
/// The center of the arc.
pub center: Point,
- /// The radii of the arc's ellipse, defining its axes.
+ /// The radii of the arc's ellipse. The horizontal and vertical half-dimensions of the ellipse will match the x and y values of the radii vector.
pub radii: Vector,
- /// The rotation of the arc's ellipse.
+ /// The clockwise rotation of the arc's ellipse.
pub rotation: f32,
- /// The start of the segment's angle, clockwise rotation.
+ /// The start of the segment's angle in radians, clockwise rotation from positive x-axis.
pub start_angle: f32,
- /// The end of the segment's angle, clockwise rotation.
+ /// The end of the segment's angle in radians, clockwise rotation from positive x-axis.
pub end_angle: f32,
}