mirror of
https://github.com/orange-cpp/omath.git
synced 2026-08-07 21:42:05 +00:00
improved angle class
This commit is contained in:
+12
-10
@@ -3,8 +3,8 @@
|
||||
> Header: `omath/trigonometry/angle.hpp`
|
||||
> Namespace: `omath`
|
||||
> Template: `Angle<Type = float, min = 0, max = 360, flags = AngleFlags::Normalized>`
|
||||
> Requires: `std::is_arithmetic_v<Type>`
|
||||
> Formatters: `std::formatter` for `char`, `wchar_t`, `char8_t` → `"{}deg"`
|
||||
> Requires: `std::is_floating_point_v<Type>`
|
||||
> Formatters: `std::formatter` for `char` and `wchar_t` → `"{}deg"`
|
||||
|
||||
---
|
||||
|
||||
@@ -14,7 +14,7 @@
|
||||
|
||||
Two behaviors via `AngleFlags`:
|
||||
|
||||
* `AngleFlags::Normalized` (default): values are wrapped into `[min, max]` using `angles::wrap_angle`.
|
||||
* `AngleFlags::Normalized` (default): values are wrapped into `[min, max)` using `angles::wrap_angle`.
|
||||
* `AngleFlags::Clamped`: values are clamped to `[min, max]` using `std::clamp`.
|
||||
|
||||
---
|
||||
@@ -28,12 +28,16 @@ enum class AngleFlags { Normalized = 0, Clamped = 1 };
|
||||
|
||||
template<class Type = float, Type min = Type(0), Type max = Type(360),
|
||||
AngleFlags flags = AngleFlags::Normalized>
|
||||
requires std::is_arithmetic_v<Type>
|
||||
requires std::is_floating_point_v<Type>
|
||||
class Angle {
|
||||
public:
|
||||
// Construction
|
||||
static constexpr Angle from_degrees(const Type& deg) noexcept;
|
||||
static constexpr Angle from_radians(const Type& rad) noexcept;
|
||||
static constexpr Angle from_asin(const Type& value) noexcept;
|
||||
static constexpr Angle from_acos(const Type& value) noexcept;
|
||||
static constexpr Angle from_atan(const Type& value) noexcept;
|
||||
static constexpr Angle from_atan2(const Type& y, const Type& x) noexcept;
|
||||
constexpr Angle() noexcept; // 0 deg, adjusted by flags/range
|
||||
|
||||
// Accessors / conversions (degrees stored internally)
|
||||
@@ -45,10 +49,9 @@ public:
|
||||
Type sin() const noexcept;
|
||||
Type cos() const noexcept;
|
||||
Type tan() const noexcept;
|
||||
Type atan() const noexcept; // atan(as_radians()) (rarely used)
|
||||
Type cot() const noexcept; // cos()/sin() (watch sin≈0)
|
||||
|
||||
// Arithmetic (wraps or clamps per flags and [min,max])
|
||||
// Arithmetic (wraps or clamps per flags and configured range)
|
||||
constexpr Angle& operator+=(const Angle&) noexcept;
|
||||
constexpr Angle& operator-=(const Angle&) noexcept;
|
||||
constexpr Angle operator+(const Angle&) noexcept;
|
||||
@@ -68,7 +71,7 @@ public:
|
||||
std::format("{}", Angle<float>::from_degrees(45)); // "45deg"
|
||||
```
|
||||
|
||||
Formatters exist for `char`, `wchar_t`, and `char8_t`.
|
||||
Formatters exist for `char` and `wchar_t`.
|
||||
|
||||
---
|
||||
|
||||
@@ -116,10 +119,9 @@ float deg = *yaw; // same as yaw.as_degrees()
|
||||
## Semantics & notes
|
||||
|
||||
* **Storage & units:** Internally stores **degrees** (`Type m_angle`). `as_radians()`/`from_radians()` use the project helpers in `omath::angles`.
|
||||
* **Arithmetic honors policy:** `operator+=`/`-=` and the binary `+`/`-` apply **wrap** or **clamp** in `[min,max]`, mirroring construction behavior.
|
||||
* **`atan()`**: returns `std::atan(as_radians())` (the arctangent of the *radian value*). This is mathematically unusual for an angle type and is rarely useful; prefer `tan()`/`atan2` in client code when solving geometry problems.
|
||||
* **Arithmetic honors policy:** `operator+=`/`-=` and the binary `+`/`-` apply **wrap** or **clamp**, mirroring construction behavior.
|
||||
* **`cot()` / `tan()` singularities:** Near multiples where `sin() ≈ 0` or `cos() ≈ 0`, results blow up. Guard in your usage if inputs can approach these points.
|
||||
* **Comparison:** `operator<=>` is defaulted. With normalization, distinct representatives can compare as expected (e.g., `-180` vs `180` in signed ranges are distinct endpoints).
|
||||
* **Comparison:** `operator<=>` is defaulted. Normalization canonicalizes the maximum endpoint to the minimum endpoint.
|
||||
* **No implicit numeric conversion:** There’s **no `operator Type()`**. Use `as_degrees()`/`as_radians()` (or `*angle`) explicitly—this intentional friction avoids unit mistakes.
|
||||
|
||||
---
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
> Namespace: `omath::angles`
|
||||
> All functions are `[[nodiscard]]` and `noexcept` where applicable.
|
||||
|
||||
A small set of constexpr-friendly utilities for converting between degrees/radians, converting horizontal/vertical field of view, and wrapping angles into a closed interval.
|
||||
A small set of constexpr-friendly utilities for converting between degrees/radians, converting horizontal/vertical field of view, and wrapping angles into a half-open interval.
|
||||
|
||||
---
|
||||
|
||||
@@ -29,9 +29,9 @@ template<class Type>
|
||||
requires std::is_floating_point_v<Type>
|
||||
Type vertical_fov_to_horizontal(const Type& vertical_fov, const Type& aspect) noexcept;
|
||||
|
||||
// Wrap angle into [min, max] (any arithmetic type)
|
||||
// Wrap angle into [min, max) (floating-point types)
|
||||
template<class Type>
|
||||
requires std::is_arithmetic_v<Type>
|
||||
requires std::is_floating_point_v<Type>
|
||||
Type wrap_angle(const Type& angle, const Type& min, const Type& max) noexcept;
|
||||
```
|
||||
|
||||
@@ -66,10 +66,10 @@ Formulas (in radians):
|
||||
|
||||
### Wrapping angles (or any periodic value)
|
||||
|
||||
Wrap any numeric `angle` into `[min, max]`:
|
||||
Wrap any floating-point `angle` into `[min, max)`:
|
||||
|
||||
```cpp
|
||||
// Wrap degrees into [0, 360]
|
||||
// Wrap degrees into [0, 360)
|
||||
float a = omath::angles::wrap_angle( 370.0f, 0.0f, 360.0f); // 10
|
||||
float b = omath::angles::wrap_angle( -15.0f, 0.0f, 360.0f); // 345
|
||||
// Signed range [-180,180]
|
||||
@@ -83,10 +83,10 @@ float c = omath::angles::wrap_angle( 200.0f, -180.0f, 180.0f); // -160
|
||||
* **Type requirements**
|
||||
|
||||
* Converters & FOV helpers require **floating-point** `Type`.
|
||||
* `wrap_angle` accepts any arithmetic `Type` (floats or integers).
|
||||
* `wrap_angle` accepts floating-point types.
|
||||
* **Aspect ratio** must be **positive** and finite. For `aspect == 0` the FOV helpers are undefined.
|
||||
* **Units**: FOV functions accept/return **degrees** but compute internally in radians.
|
||||
* **Wrapping interval**: Behavior assumes `max > min`. The result lies in the **closed interval** `[min, max]` with modulo arithmetic; if you need half-open behavior (e.g., `[min,max)`), adjust your range or post-process endpoint cases.
|
||||
* **Wrapping interval**: Behavior assumes `max > min`. The result lies in the half-open interval `[min, max)`.
|
||||
* **constexpr**: Converters are `constexpr`; FOV helpers are runtime constexpr-compatible except for `std::atan/std::tan` constraints on some standard libraries.
|
||||
|
||||
---
|
||||
@@ -103,5 +103,5 @@ float v = horizontal_fov_to_vertical(90.0f, 16.0f/9.0f);
|
||||
float h = vertical_fov_to_horizontal(v, 16.0f/9.0f);
|
||||
assert(std::abs(h - 90.0f) < 1e-5f);
|
||||
|
||||
assert(wrap_angle(360.0f, 0.0f, 360.0f) == 0.0f || wrap_angle(360.0f, 0.0f, 360.0f) == 360.0f);
|
||||
assert(wrap_angle(360.0f, 0.0f, 360.0f) == 0.0f);
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user