devela::num::geom

Struct Angle

Source 
#[repr(transparent)]
pub struct Angle<T>(pub T);
Available on crate feature geom only.
Expand description

A generic angle.

It’s unit-agnostic over radians or degrees, and respects directionality.

When T is an integer primitive the angle is considered to be always normalized. By virtue of the range from [0..T::MAX] representing a full positive (counterclockwise) turn. And in the case of signed primitives, the range from [0..T::MIN] represents a full negative (clockwise) turn.

For floating-point primitives the range from -1 to 1 (non-inclusive) represents the normalized full turn, and anything beyond that are non-normalied angles.

§Features

It will be implemented for primitive floating point types when either the std or _float_f[32|64] features are enabled. And it will implemented for primitive integer types when its corresponding feature capability is enabled (e.g. _int_i32).

§Methods

Methods are implemented the same for each main angle representation, using:

§Methods for f32

Tuple Fields§

§0: T

Implementations§

Source§

impl Angle<i8>

§Methods for angles represented using i8.

Source

pub const fn new_full() -> Self

Available on crate feature _int_i8 only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _int_i8 only.

Creates a normalized right positive angle at 90 degrees.

Source

pub const fn new_straight() -> Self

Available on crate feature _int_i8 only.

Creates a normalized straight positive angle at 180 degrees.

Source

pub fn from_rad(radians: f32) -> Self

Available on crate feature _int_i8 and (crate features std or _float_f32) only.

Creates a new angle from a floating-point radians value.

Source

pub fn from_deg(degrees: f32) -> Self

Available on crate feature _int_i8 and (crate features std or _float_f32) only.

Creates a new angle from a floating-point degrees value.

Source

pub fn from_custom(value: f32, custom_unit: f32) -> Self

Available on crate feature _int_i8 and (crate features std or _float_f32) only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> f32 ⓘ

Available on crate feature _int_i8 and (crate feature std or _float··) only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> f32 ⓘ

Available on crate feature _int_i8 only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: f32) -> f32 ⓘ

Available on crate feature _int_i8 only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate feature _int_i8 only.

Always returns true since integer representations are always normalized.

Source

pub const fn normalize(self) -> Self

Available on crate feature _int_i8 only.

Returns the angle normalized (no-op for integer representation).

Source

pub fn set_normalized(&mut self)

Available on crate feature _int_i8 only.

Sets the angle normalized (no-op for integer representation).

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _int_i8 only.

Returns true if the angle has the given direction.

Source

pub const fn kind(self) -> AngleKind

Available on crate feature _int_i8 only.

Returns the kind of the normalized angle.

Source

pub const fn is_kind(self, kind: AngleKind) -> bool

Available on crate feature _int_i8 only.

Returns true if the angle is of the given kind.

Source§

impl Angle<i8>

§Methods for angles represented using i8, signed.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _int_i8 only.

Returns the angle direction.

The direction will be Undefined if the angle kind is Full.

Source

pub const fn with_direction(self, direction: AngleDirection) -> Self

Available on crate feature _int_i8 only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub fn set_direction(&mut self, direction: AngleDirection)

Available on crate feature _int_i8 only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _int_i8 only.

Returns a version of the angle with inverted direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _int_i8 only.

Returns the negative version of the angle.

Source

pub fn set_negative(&mut self)

Available on crate feature _int_i8 only.

Sets the angle as negative.

Source

pub const fn positive(self) -> Self

Available on crate feature _int_i8 only.

Returns the positive version of the angle.

Source

pub fn set_positive(&mut self)

Available on crate feature _int_i8 only.

Sets the angle as positive.

Source§

impl Angle<i16>

§Methods for angles represented using i16.

Source

pub const fn new_full() -> Self

Available on crate feature _int_i16 only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _int_i16 only.

Creates a normalized right positive angle at 90 degrees.

Source

pub const fn new_straight() -> Self

Available on crate feature _int_i16 only.

Creates a normalized straight positive angle at 180 degrees.

Source

pub fn from_rad(radians: f32) -> Self

Available on crate feature _int_i16 and (crate features std or _float_f32) only.

Creates a new angle from a floating-point radians value.

Source

pub fn from_deg(degrees: f32) -> Self

Available on crate feature _int_i16 and (crate features std or _float_f32) only.

Creates a new angle from a floating-point degrees value.

Source

pub fn from_custom(value: f32, custom_unit: f32) -> Self

Available on crate feature _int_i16 and (crate features std or _float_f32) only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> f32 ⓘ

Available on crate feature _int_i16 and (crate feature std or _float··) only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> f32 ⓘ

Available on crate feature _int_i16 only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: f32) -> f32 ⓘ

Available on crate feature _int_i16 only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate feature _int_i16 only.

Always returns true since integer representations are always normalized.

Source

pub const fn normalize(self) -> Self

Available on crate feature _int_i16 only.

Returns the angle normalized (no-op for integer representation).

Source

pub fn set_normalized(&mut self)

Available on crate feature _int_i16 only.

Sets the angle normalized (no-op for integer representation).

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _int_i16 only.

Returns true if the angle has the given direction.

Source

pub const fn kind(self) -> AngleKind

Available on crate feature _int_i16 only.

Returns the kind of the normalized angle.

Source

pub const fn is_kind(self, kind: AngleKind) -> bool

Available on crate feature _int_i16 only.

Returns true if the angle is of the given kind.

Source§

impl Angle<i16>

§Methods for angles represented using i16, signed.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _int_i16 only.

Returns the angle direction.

The direction will be Undefined if the angle kind is Full.

Source

pub const fn with_direction(self, direction: AngleDirection) -> Self

Available on crate feature _int_i16 only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub fn set_direction(&mut self, direction: AngleDirection)

Available on crate feature _int_i16 only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _int_i16 only.

Returns a version of the angle with inverted direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _int_i16 only.

Returns the negative version of the angle.

Source

pub fn set_negative(&mut self)

Available on crate feature _int_i16 only.

Sets the angle as negative.

Source

pub const fn positive(self) -> Self

Available on crate feature _int_i16 only.

Returns the positive version of the angle.

Source

pub fn set_positive(&mut self)

Available on crate feature _int_i16 only.

Sets the angle as positive.

Source§

impl Angle<i32>

§Methods for angles represented using i32.

Source

pub const fn new_full() -> Self

Available on crate feature _int_i32 only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _int_i32 only.

Creates a normalized right positive angle at 90 degrees.

Source

pub const fn new_straight() -> Self

Available on crate feature _int_i32 only.

Creates a normalized straight positive angle at 180 degrees.

Source

pub fn from_rad(radians: f32) -> Self

Available on crate feature _int_i32 and (crate features std or _float_f32) only.

Creates a new angle from a floating-point radians value.

Source

pub fn from_deg(degrees: f32) -> Self

Available on crate feature _int_i32 and (crate features std or _float_f32) only.

Creates a new angle from a floating-point degrees value.

Source

pub fn from_custom(value: f32, custom_unit: f32) -> Self

Available on crate feature _int_i32 and (crate features std or _float_f32) only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> f32 ⓘ

Available on crate feature _int_i32 and (crate feature std or _float··) only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> f32 ⓘ

Available on crate feature _int_i32 only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: f32) -> f32 ⓘ

Available on crate feature _int_i32 only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate feature _int_i32 only.

Always returns true since integer representations are always normalized.

Source

pub const fn normalize(self) -> Self

Available on crate feature _int_i32 only.

Returns the angle normalized (no-op for integer representation).

Source

pub fn set_normalized(&mut self)

Available on crate feature _int_i32 only.

Sets the angle normalized (no-op for integer representation).

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _int_i32 only.

Returns true if the angle has the given direction.

Source

pub const fn kind(self) -> AngleKind

Available on crate feature _int_i32 only.

Returns the kind of the normalized angle.

Source

pub const fn is_kind(self, kind: AngleKind) -> bool

Available on crate feature _int_i32 only.

Returns true if the angle is of the given kind.

Source§

impl Angle<i32>

§Methods for angles represented using i32, signed.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _int_i32 only.

Returns the angle direction.

The direction will be Undefined if the angle kind is Full.

Source

pub const fn with_direction(self, direction: AngleDirection) -> Self

Available on crate feature _int_i32 only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub fn set_direction(&mut self, direction: AngleDirection)

Available on crate feature _int_i32 only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _int_i32 only.

Returns a version of the angle with inverted direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _int_i32 only.

Returns the negative version of the angle.

Source

pub fn set_negative(&mut self)

Available on crate feature _int_i32 only.

Sets the angle as negative.

Source

pub const fn positive(self) -> Self

Available on crate feature _int_i32 only.

Returns the positive version of the angle.

Source

pub fn set_positive(&mut self)

Available on crate feature _int_i32 only.

Sets the angle as positive.

Source§

impl Angle<i64>

§Methods for angles represented using i64.

Source

pub const fn new_full() -> Self

Available on crate feature _int_i64 only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _int_i64 only.

Creates a normalized right positive angle at 90 degrees.

Source

pub const fn new_straight() -> Self

Available on crate feature _int_i64 only.

Creates a normalized straight positive angle at 180 degrees.

Source

pub fn from_rad(radians: f64) -> Self

Available on crate feature _int_i64 and (crate features std or _float_f64) only.

Creates a new angle from a floating-point radians value.

Source

pub fn from_deg(degrees: f64) -> Self

Available on crate feature _int_i64 and (crate features std or _float_f64) only.

Creates a new angle from a floating-point degrees value.

Source

pub fn from_custom(value: f64, custom_unit: f64) -> Self

Available on crate feature _int_i64 and (crate features std or _float_f64) only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> f64 ⓘ

Available on crate feature _int_i64 and (crate feature std or _float··) only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> f64 ⓘ

Available on crate feature _int_i64 only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: f64) -> f64 ⓘ

Available on crate feature _int_i64 only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate feature _int_i64 only.

Always returns true since integer representations are always normalized.

Source

pub const fn normalize(self) -> Self

Available on crate feature _int_i64 only.

Returns the angle normalized (no-op for integer representation).

Source

pub fn set_normalized(&mut self)

Available on crate feature _int_i64 only.

Sets the angle normalized (no-op for integer representation).

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _int_i64 only.

Returns true if the angle has the given direction.

Source

pub const fn kind(self) -> AngleKind

Available on crate feature _int_i64 only.

Returns the kind of the normalized angle.

Source

pub const fn is_kind(self, kind: AngleKind) -> bool

Available on crate feature _int_i64 only.

Returns true if the angle is of the given kind.

Source§

impl Angle<i64>

§Methods for angles represented using i64, signed.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _int_i64 only.

Returns the angle direction.

The direction will be Undefined if the angle kind is Full.

Source

pub const fn with_direction(self, direction: AngleDirection) -> Self

Available on crate feature _int_i64 only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub fn set_direction(&mut self, direction: AngleDirection)

Available on crate feature _int_i64 only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _int_i64 only.

Returns a version of the angle with inverted direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _int_i64 only.

Returns the negative version of the angle.

Source

pub fn set_negative(&mut self)

Available on crate feature _int_i64 only.

Sets the angle as negative.

Source

pub const fn positive(self) -> Self

Available on crate feature _int_i64 only.

Returns the positive version of the angle.

Source

pub fn set_positive(&mut self)

Available on crate feature _int_i64 only.

Sets the angle as positive.

Source§

impl Angle<i128>

§Methods for angles represented using i128.

Source

pub const fn new_full() -> Self

Available on crate feature _int_i128 only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _int_i128 only.

Creates a normalized right positive angle at 90 degrees.

Source

pub const fn new_straight() -> Self

Available on crate feature _int_i128 only.

Creates a normalized straight positive angle at 180 degrees.

Source

pub fn from_rad(radians: f64) -> Self

Available on crate feature _int_i128 and (crate features std or _float_f64) only.

Creates a new angle from a floating-point radians value.

Source

pub fn from_deg(degrees: f64) -> Self

Available on crate feature _int_i128 and (crate features std or _float_f64) only.

Creates a new angle from a floating-point degrees value.

Source

pub fn from_custom(value: f64, custom_unit: f64) -> Self

Available on crate feature _int_i128 and (crate features std or _float_f64) only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> f64 ⓘ

Available on crate feature _int_i128 and (crate feature std or _float··) only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> f64 ⓘ

Available on crate feature _int_i128 only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: f64) -> f64 ⓘ

Available on crate feature _int_i128 only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate feature _int_i128 only.

Always returns true since integer representations are always normalized.

Source

pub const fn normalize(self) -> Self

Available on crate feature _int_i128 only.

Returns the angle normalized (no-op for integer representation).

Source

pub fn set_normalized(&mut self)

Available on crate feature _int_i128 only.

Sets the angle normalized (no-op for integer representation).

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _int_i128 only.

Returns true if the angle has the given direction.

Source

pub const fn kind(self) -> AngleKind

Available on crate feature _int_i128 only.

Returns the kind of the normalized angle.

Source

pub const fn is_kind(self, kind: AngleKind) -> bool

Available on crate feature _int_i128 only.

Returns true if the angle is of the given kind.

Source§

impl Angle<i128>

§Methods for angles represented using i128, signed.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _int_i128 only.

Returns the angle direction.

The direction will be Undefined if the angle kind is Full.

Source

pub const fn with_direction(self, direction: AngleDirection) -> Self

Available on crate feature _int_i128 only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub fn set_direction(&mut self, direction: AngleDirection)

Available on crate feature _int_i128 only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _int_i128 only.

Returns a version of the angle with inverted direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _int_i128 only.

Returns the negative version of the angle.

Source

pub fn set_negative(&mut self)

Available on crate feature _int_i128 only.

Sets the angle as negative.

Source

pub const fn positive(self) -> Self

Available on crate feature _int_i128 only.

Returns the positive version of the angle.

Source

pub fn set_positive(&mut self)

Available on crate feature _int_i128 only.

Sets the angle as positive.

Source§

impl Angle<isize>

§Methods for angles represented using isize.

Source

pub const fn new_full() -> Self

Available on crate feature _int_isize only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _int_isize only.

Creates a normalized right positive angle at 90 degrees.

Source

pub const fn new_straight() -> Self

Available on crate feature _int_isize only.

Creates a normalized straight positive angle at 180 degrees.

Source

pub fn from_rad(radians: fsize) -> Self

Available on crate feature _int_isize and (crate features std or _float_f64) only.

Creates a new angle from a floating-point radians value.

Source

pub fn from_deg(degrees: fsize) -> Self

Available on crate feature _int_isize and (crate features std or _float_f64) only.

Creates a new angle from a floating-point degrees value.

Source

pub fn from_custom(value: fsize, custom_unit: fsize) -> Self

Available on crate feature _int_isize and (crate features std or _float_f64) only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> fsize

Available on crate feature _int_isize and (crate feature std or _float··) only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> fsize

Available on crate feature _int_isize only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: fsize) -> fsize

Available on crate feature _int_isize only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate feature _int_isize only.

Always returns true since integer representations are always normalized.

Source

pub const fn normalize(self) -> Self

Available on crate feature _int_isize only.

Returns the angle normalized (no-op for integer representation).

Source

pub fn set_normalized(&mut self)

Available on crate feature _int_isize only.

Sets the angle normalized (no-op for integer representation).

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _int_isize only.

Returns true if the angle has the given direction.

Source

pub const fn kind(self) -> AngleKind

Available on crate feature _int_isize only.

Returns the kind of the normalized angle.

Source

pub const fn is_kind(self, kind: AngleKind) -> bool

Available on crate feature _int_isize only.

Returns true if the angle is of the given kind.

Source§

impl Angle<isize>

§Methods for angles represented using isize, signed.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _int_isize only.

Returns the angle direction.

The direction will be Undefined if the angle kind is Full.

Source

pub const fn with_direction(self, direction: AngleDirection) -> Self

Available on crate feature _int_isize only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub fn set_direction(&mut self, direction: AngleDirection)

Available on crate feature _int_isize only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _int_isize only.

Returns a version of the angle with inverted direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _int_isize only.

Returns the negative version of the angle.

Source

pub fn set_negative(&mut self)

Available on crate feature _int_isize only.

Sets the angle as negative.

Source

pub const fn positive(self) -> Self

Available on crate feature _int_isize only.

Returns the positive version of the angle.

Source

pub fn set_positive(&mut self)

Available on crate feature _int_isize only.

Sets the angle as positive.

Source§

impl Angle<u8>

§Methods for angles represented using u8.

Source

pub const fn new_full() -> Self

Available on crate feature _int_u8 only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _int_u8 only.

Creates a normalized right positive angle at 90 degrees.

Source

pub const fn new_straight() -> Self

Available on crate feature _int_u8 only.

Creates a normalized straight positive angle at 180 degrees.

Source

pub fn from_rad(radians: f32) -> Self

Available on crate feature _int_u8 and (crate features std or _float_f32) only.

Creates a new angle from a floating-point radians value.

Source

pub fn from_deg(degrees: f32) -> Self

Available on crate feature _int_u8 and (crate features std or _float_f32) only.

Creates a new angle from a floating-point degrees value.

Source

pub fn from_custom(value: f32, custom_unit: f32) -> Self

Available on crate feature _int_u8 and (crate features std or _float_f32) only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> f32 ⓘ

Available on crate feature _int_u8 and (crate feature std or _float··) only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> f32 ⓘ

Available on crate feature _int_u8 only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: f32) -> f32 ⓘ

Available on crate feature _int_u8 only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate feature _int_u8 only.

Always returns true since integer representations are always normalized.

Source

pub const fn normalize(self) -> Self

Available on crate feature _int_u8 only.

Returns the angle normalized (no-op for integer representation).

Source

pub fn set_normalized(&mut self)

Available on crate feature _int_u8 only.

Sets the angle normalized (no-op for integer representation).

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _int_u8 only.

Returns true if the angle has the given direction.

Source

pub const fn kind(self) -> AngleKind

Available on crate feature _int_u8 only.

Returns the kind of the normalized angle.

Source

pub const fn is_kind(self, kind: AngleKind) -> bool

Available on crate feature _int_u8 only.

Returns true if the angle is of the given kind.

Source§

impl Angle<u8>

§Methods for angles represented using u8, unsigned.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _int_u8 only.

Returns the angle direction.

For unsigned integers the direction is always CounterClockwise.

Source

pub const fn with_direction(self, _direction: AngleDirection) -> Self

Available on crate feature _int_u8 only.

Returns a version of the angle with the given direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn set_direction(self, _direction: AngleDirection)

Available on crate feature _int_u8 only.

Returns a version of the angle with the given direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _int_u8 only.

Returns a version of the angle with inverted direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _int_u8 only.

Returns the negative version of the angle (no-op for unsigned).

Source

pub fn set_negative(&mut self)

Available on crate feature _int_u8 only.

Sets the angle as negative (no-op for unsigned).

Source

pub const fn positive(self) -> Self

Available on crate feature _int_u8 only.

Returns the positive version of the angle (no-op for unsigned).

Source

pub fn set_positive(&mut self)

Available on crate feature _int_u8 only.

Sets the angle as positive (no-op for unsigned).

Source§

impl Angle<u16>

§Methods for angles represented using u16.

Source

pub const fn new_full() -> Self

Available on crate feature _int_u16 only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _int_u16 only.

Creates a normalized right positive angle at 90 degrees.

Source

pub const fn new_straight() -> Self

Available on crate feature _int_u16 only.

Creates a normalized straight positive angle at 180 degrees.

Source

pub fn from_rad(radians: f32) -> Self

Available on crate feature _int_u16 and (crate features std or _float_f32) only.

Creates a new angle from a floating-point radians value.

Source

pub fn from_deg(degrees: f32) -> Self

Available on crate feature _int_u16 and (crate features std or _float_f32) only.

Creates a new angle from a floating-point degrees value.

Source

pub fn from_custom(value: f32, custom_unit: f32) -> Self

Available on crate feature _int_u16 and (crate features std or _float_f32) only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> f32 ⓘ

Available on crate feature _int_u16 and (crate feature std or _float··) only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> f32 ⓘ

Available on crate feature _int_u16 only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: f32) -> f32 ⓘ

Available on crate feature _int_u16 only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate feature _int_u16 only.

Always returns true since integer representations are always normalized.

Source

pub const fn normalize(self) -> Self

Available on crate feature _int_u16 only.

Returns the angle normalized (no-op for integer representation).

Source

pub fn set_normalized(&mut self)

Available on crate feature _int_u16 only.

Sets the angle normalized (no-op for integer representation).

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _int_u16 only.

Returns true if the angle has the given direction.

Source

pub const fn kind(self) -> AngleKind

Available on crate feature _int_u16 only.

Returns the kind of the normalized angle.

Source

pub const fn is_kind(self, kind: AngleKind) -> bool

Available on crate feature _int_u16 only.

Returns true if the angle is of the given kind.

Source§

impl Angle<u16>

§Methods for angles represented using u16, unsigned.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _int_u16 only.

Returns the angle direction.

For unsigned integers the direction is always CounterClockwise.

Source

pub const fn with_direction(self, _direction: AngleDirection) -> Self

Available on crate feature _int_u16 only.

Returns a version of the angle with the given direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn set_direction(self, _direction: AngleDirection)

Available on crate feature _int_u16 only.

Returns a version of the angle with the given direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _int_u16 only.

Returns a version of the angle with inverted direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _int_u16 only.

Returns the negative version of the angle (no-op for unsigned).

Source

pub fn set_negative(&mut self)

Available on crate feature _int_u16 only.

Sets the angle as negative (no-op for unsigned).

Source

pub const fn positive(self) -> Self

Available on crate feature _int_u16 only.

Returns the positive version of the angle (no-op for unsigned).

Source

pub fn set_positive(&mut self)

Available on crate feature _int_u16 only.

Sets the angle as positive (no-op for unsigned).

Source§

impl Angle<u32>

§Methods for angles represented using u32.

Source

pub const fn new_full() -> Self

Available on crate feature _int_u32 only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _int_u32 only.

Creates a normalized right positive angle at 90 degrees.

Source

pub const fn new_straight() -> Self

Available on crate feature _int_u32 only.

Creates a normalized straight positive angle at 180 degrees.

Source

pub fn from_rad(radians: f32) -> Self

Available on crate feature _int_u32 and (crate features std or _float_f32) only.

Creates a new angle from a floating-point radians value.

Source

pub fn from_deg(degrees: f32) -> Self

Available on crate feature _int_u32 and (crate features std or _float_f32) only.

Creates a new angle from a floating-point degrees value.

Source

pub fn from_custom(value: f32, custom_unit: f32) -> Self

Available on crate feature _int_u32 and (crate features std or _float_f32) only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> f32 ⓘ

Available on crate feature _int_u32 and (crate feature std or _float··) only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> f32 ⓘ

Available on crate feature _int_u32 only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: f32) -> f32 ⓘ

Available on crate feature _int_u32 only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate feature _int_u32 only.

Always returns true since integer representations are always normalized.

Source

pub const fn normalize(self) -> Self

Available on crate feature _int_u32 only.

Returns the angle normalized (no-op for integer representation).

Source

pub fn set_normalized(&mut self)

Available on crate feature _int_u32 only.

Sets the angle normalized (no-op for integer representation).

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _int_u32 only.

Returns true if the angle has the given direction.

Source

pub const fn kind(self) -> AngleKind

Available on crate feature _int_u32 only.

Returns the kind of the normalized angle.

Source

pub const fn is_kind(self, kind: AngleKind) -> bool

Available on crate feature _int_u32 only.

Returns true if the angle is of the given kind.

Source§

impl Angle<u32>

§Methods for angles represented using u32, unsigned.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _int_u32 only.

Returns the angle direction.

For unsigned integers the direction is always CounterClockwise.

Source

pub const fn with_direction(self, _direction: AngleDirection) -> Self

Available on crate feature _int_u32 only.

Returns a version of the angle with the given direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn set_direction(self, _direction: AngleDirection)

Available on crate feature _int_u32 only.

Returns a version of the angle with the given direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _int_u32 only.

Returns a version of the angle with inverted direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _int_u32 only.

Returns the negative version of the angle (no-op for unsigned).

Source

pub fn set_negative(&mut self)

Available on crate feature _int_u32 only.

Sets the angle as negative (no-op for unsigned).

Source

pub const fn positive(self) -> Self

Available on crate feature _int_u32 only.

Returns the positive version of the angle (no-op for unsigned).

Source

pub fn set_positive(&mut self)

Available on crate feature _int_u32 only.

Sets the angle as positive (no-op for unsigned).

Source§

impl Angle<u64>

§Methods for angles represented using u64.

Source

pub const fn new_full() -> Self

Available on crate feature _int_u64 only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _int_u64 only.

Creates a normalized right positive angle at 90 degrees.

Source

pub const fn new_straight() -> Self

Available on crate feature _int_u64 only.

Creates a normalized straight positive angle at 180 degrees.

Source

pub fn from_rad(radians: f64) -> Self

Available on crate feature _int_u64 and (crate features std or _float_f64) only.

Creates a new angle from a floating-point radians value.

Source

pub fn from_deg(degrees: f64) -> Self

Available on crate feature _int_u64 and (crate features std or _float_f64) only.

Creates a new angle from a floating-point degrees value.

Source

pub fn from_custom(value: f64, custom_unit: f64) -> Self

Available on crate feature _int_u64 and (crate features std or _float_f64) only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> f64 ⓘ

Available on crate feature _int_u64 and (crate feature std or _float··) only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> f64 ⓘ

Available on crate feature _int_u64 only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: f64) -> f64 ⓘ

Available on crate feature _int_u64 only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate feature _int_u64 only.

Always returns true since integer representations are always normalized.

Source

pub const fn normalize(self) -> Self

Available on crate feature _int_u64 only.

Returns the angle normalized (no-op for integer representation).

Source

pub fn set_normalized(&mut self)

Available on crate feature _int_u64 only.

Sets the angle normalized (no-op for integer representation).

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _int_u64 only.

Returns true if the angle has the given direction.

Source

pub const fn kind(self) -> AngleKind

Available on crate feature _int_u64 only.

Returns the kind of the normalized angle.

Source

pub const fn is_kind(self, kind: AngleKind) -> bool

Available on crate feature _int_u64 only.

Returns true if the angle is of the given kind.

Source§

impl Angle<u64>

§Methods for angles represented using u64, unsigned.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _int_u64 only.

Returns the angle direction.

For unsigned integers the direction is always CounterClockwise.

Source

pub const fn with_direction(self, _direction: AngleDirection) -> Self

Available on crate feature _int_u64 only.

Returns a version of the angle with the given direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn set_direction(self, _direction: AngleDirection)

Available on crate feature _int_u64 only.

Returns a version of the angle with the given direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _int_u64 only.

Returns a version of the angle with inverted direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _int_u64 only.

Returns the negative version of the angle (no-op for unsigned).

Source

pub fn set_negative(&mut self)

Available on crate feature _int_u64 only.

Sets the angle as negative (no-op for unsigned).

Source

pub const fn positive(self) -> Self

Available on crate feature _int_u64 only.

Returns the positive version of the angle (no-op for unsigned).

Source

pub fn set_positive(&mut self)

Available on crate feature _int_u64 only.

Sets the angle as positive (no-op for unsigned).

Source§

impl Angle<u128>

§Methods for angles represented using u128.

Source

pub const fn new_full() -> Self

Available on crate feature _int_u128 only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _int_u128 only.

Creates a normalized right positive angle at 90 degrees.

Source

pub const fn new_straight() -> Self

Available on crate feature _int_u128 only.

Creates a normalized straight positive angle at 180 degrees.

Source

pub fn from_rad(radians: f64) -> Self

Available on crate feature _int_u128 and (crate features std or _float_f64) only.

Creates a new angle from a floating-point radians value.

Source

pub fn from_deg(degrees: f64) -> Self

Available on crate feature _int_u128 and (crate features std or _float_f64) only.

Creates a new angle from a floating-point degrees value.

Source

pub fn from_custom(value: f64, custom_unit: f64) -> Self

Available on crate feature _int_u128 and (crate features std or _float_f64) only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> f64 ⓘ

Available on crate feature _int_u128 and (crate feature std or _float··) only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> f64 ⓘ

Available on crate feature _int_u128 only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: f64) -> f64 ⓘ

Available on crate feature _int_u128 only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate feature _int_u128 only.

Always returns true since integer representations are always normalized.

Source

pub const fn normalize(self) -> Self

Available on crate feature _int_u128 only.

Returns the angle normalized (no-op for integer representation).

Source

pub fn set_normalized(&mut self)

Available on crate feature _int_u128 only.

Sets the angle normalized (no-op for integer representation).

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _int_u128 only.

Returns true if the angle has the given direction.

Source

pub const fn kind(self) -> AngleKind

Available on crate feature _int_u128 only.

Returns the kind of the normalized angle.

Source

pub const fn is_kind(self, kind: AngleKind) -> bool

Available on crate feature _int_u128 only.

Returns true if the angle is of the given kind.

Source§

impl Angle<u128>

§Methods for angles represented using u128, unsigned.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _int_u128 only.

Returns the angle direction.

For unsigned integers the direction is always CounterClockwise.

Source

pub const fn with_direction(self, _direction: AngleDirection) -> Self

Available on crate feature _int_u128 only.

Returns a version of the angle with the given direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn set_direction(self, _direction: AngleDirection)

Available on crate feature _int_u128 only.

Returns a version of the angle with the given direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _int_u128 only.

Returns a version of the angle with inverted direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _int_u128 only.

Returns the negative version of the angle (no-op for unsigned).

Source

pub fn set_negative(&mut self)

Available on crate feature _int_u128 only.

Sets the angle as negative (no-op for unsigned).

Source

pub const fn positive(self) -> Self

Available on crate feature _int_u128 only.

Returns the positive version of the angle (no-op for unsigned).

Source

pub fn set_positive(&mut self)

Available on crate feature _int_u128 only.

Sets the angle as positive (no-op for unsigned).

Source§

impl Angle<usize>

§Methods for angles represented using usize.

Source

pub const fn new_full() -> Self

Available on crate feature _int_usize only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _int_usize only.

Creates a normalized right positive angle at 90 degrees.

Source

pub const fn new_straight() -> Self

Available on crate feature _int_usize only.

Creates a normalized straight positive angle at 180 degrees.

Source

pub fn from_rad(radians: fsize) -> Self

Available on crate feature _int_usize and (crate features std or _float_f64) only.

Creates a new angle from a floating-point radians value.

Source

pub fn from_deg(degrees: fsize) -> Self

Available on crate feature _int_usize and (crate features std or _float_f64) only.

Creates a new angle from a floating-point degrees value.

Source

pub fn from_custom(value: fsize, custom_unit: fsize) -> Self

Available on crate feature _int_usize and (crate features std or _float_f64) only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> fsize

Available on crate feature _int_usize and (crate feature std or _float··) only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> fsize

Available on crate feature _int_usize only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: fsize) -> fsize

Available on crate feature _int_usize only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate feature _int_usize only.

Always returns true since integer representations are always normalized.

Source

pub const fn normalize(self) -> Self

Available on crate feature _int_usize only.

Returns the angle normalized (no-op for integer representation).

Source

pub fn set_normalized(&mut self)

Available on crate feature _int_usize only.

Sets the angle normalized (no-op for integer representation).

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _int_usize only.

Returns true if the angle has the given direction.

Source

pub const fn kind(self) -> AngleKind

Available on crate feature _int_usize only.

Returns the kind of the normalized angle.

Source

pub const fn is_kind(self, kind: AngleKind) -> bool

Available on crate feature _int_usize only.

Returns true if the angle is of the given kind.

Source§

impl Angle<usize>

§Methods for angles represented using usize, unsigned.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _int_usize only.

Returns the angle direction.

For unsigned integers the direction is always CounterClockwise.

Source

pub const fn with_direction(self, _direction: AngleDirection) -> Self

Available on crate feature _int_usize only.

Returns a version of the angle with the given direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn set_direction(self, _direction: AngleDirection)

Available on crate feature _int_usize only.

Returns a version of the angle with the given direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _int_usize only.

Returns a version of the angle with inverted direction (no-op for unsigned).

Unsigned integers can only have CounterClockwise direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _int_usize only.

Returns the negative version of the angle (no-op for unsigned).

Source

pub fn set_negative(&mut self)

Available on crate feature _int_usize only.

Sets the angle as negative (no-op for unsigned).

Source

pub const fn positive(self) -> Self

Available on crate feature _int_usize only.

Returns the positive version of the angle (no-op for unsigned).

Source

pub fn set_positive(&mut self)

Available on crate feature _int_usize only.

Sets the angle as positive (no-op for unsigned).

Source§

impl Angle<f32>

§Methods for angles represented using f32.

Source

pub const fn new_full() -> Self

Available on crate feature _float_f32 only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _float_f32 only.

Creates a normalized right positive angle at 90 degrees (0.25).

Source

pub const fn new_straight() -> Self

Available on crate feature _float_f32 only.

Creates a normalized straight positive angle at 180 degrees (0.5).

Source

pub const fn from_rad(radians: f32) -> Self

Available on crate feature _float_f32 only.

Creates a new angle from a radians value.

Source

pub const fn from_deg(degrees: f32) -> Self

Available on crate feature _float_f32 only.

Creates a new angle from a degrees value.

Source

pub const fn from_custom(value: f32, custom_unit: f32) -> Self

Available on crate feature _float_f32 only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> f32 ⓘ

Available on crate feature _float_f32 only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> f32 ⓘ

Available on crate feature _float_f32 only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: f32) -> f32 ⓘ

Available on crate feature _float_f32 only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate features _float_f32 and _cmp_f32 only.

Returns true if the angle is between -1 and 1 (non-inclusive).

Source

pub fn normalize(self) -> Self

Available on crate feature _float_f32 only.

Returns the angle normalized to the non-inclusive range -1 to 1.

Source

pub fn set_normalized(&mut self)

Available on crate feature _float_f32 only.

Sets the angle normalized to the non-inclusive range -1 to 1.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _float_f32 only.

Returns the angle direction.

Since the floating-point representation always maintains the sign the direction can’t be undefined.

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _float_f32 only.

Returns true if the angle has the given direction.

Since the floating-point representation always maintains the sign the direction can’t be undefined, and it will return false in that case.

Source

pub const fn with_direction(self, direction: AngleDirection) -> Self

Available on crate feature _float_f32 only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub const fn set_direction(&mut self, direction: AngleDirection)

Available on crate feature _float_f32 only.

Sets the angle to the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _float_f32 only.

Returns a version of the angle with inverted direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _float_f32 only.

Returns the negative version of the angle.

Source

pub const fn set_negative(&mut self)

Available on crate feature _float_f32 only.

Sets the angle as negative.

Source

pub const fn positive(self) -> Self

Available on crate feature _float_f32 only.

Returns the positive version of the angle.

Source

pub const fn set_positive(&mut self)

Available on crate feature _float_f32 only.

Sets the angle as positive.

Source

pub fn kind(self) -> AngleKind

Available on crate features _float_f32 and _cmp_f32 only.

Returns the kind of the normalized angle.

Source

pub fn kind_approx(self, tolerance: f32) -> AngleKind

Available on crate feature _float_f32 only.

Returns the kind of the angle using a custom tolerance for approximate matching.

Source

pub fn is_kind(self, kind: AngleKind) -> bool

Available on crate features _float_f32 and _cmp_f32 only.

Returns true if the angle is of the given kind.

Source

pub fn is_kind_approx(self, kind: AngleKind, tolerance: f32) -> bool

Available on crate feature _float_f32 only.

Returns true if the angle is of the given kind using a custom tolerance.

Source§

impl Angle<f64>

§Methods for angles represented using f64.

Source

pub const fn new_full() -> Self

Available on crate feature _float_f64 only.

Creates a normalized full positive angle at 0 degrees.

Source

pub const fn new_right() -> Self

Available on crate feature _float_f64 only.

Creates a normalized right positive angle at 90 degrees (0.25).

Source

pub const fn new_straight() -> Self

Available on crate feature _float_f64 only.

Creates a normalized straight positive angle at 180 degrees (0.5).

Source

pub const fn from_rad(radians: f64) -> Self

Available on crate feature _float_f64 only.

Creates a new angle from a radians value.

Source

pub const fn from_deg(degrees: f64) -> Self

Available on crate feature _float_f64 only.

Creates a new angle from a degrees value.

Source

pub const fn from_custom(value: f64, custom_unit: f64) -> Self

Available on crate feature _float_f64 only.

Creates a new angle from a value in a custom_unit which represents a full turn.

Source

pub const fn to_rad(self) -> f64 ⓘ

Available on crate feature _float_f64 only.

Converts the angle to radians.

Source

pub const fn to_deg(self) -> f64 ⓘ

Available on crate feature _float_f64 only.

Converts the angle to degrees.

Source

pub const fn to_custom(self, custom_unit: f64) -> f64 ⓘ

Available on crate feature _float_f64 only.

Converts the angle to a custom_unit which represents a full turn.

Source

pub const fn is_normalized(self) -> bool

Available on crate features _float_f64 and _cmp_f64 only.

Returns true if the angle is between -1 and 1 (non-inclusive).

Source

pub fn normalize(self) -> Self

Available on crate feature _float_f64 only.

Returns the angle normalized to the non-inclusive range -1 to 1.

Source

pub fn set_normalized(&mut self)

Available on crate feature _float_f64 only.

Sets the angle normalized to the non-inclusive range -1 to 1.

Source

pub const fn direction(self) -> AngleDirection

Available on crate feature _float_f64 only.

Returns the angle direction.

Since the floating-point representation always maintains the sign the direction can’t be undefined.

Source

pub const fn has_direction(self, direction: AngleDirection) -> bool

Available on crate feature _float_f64 only.

Returns true if the angle has the given direction.

Since the floating-point representation always maintains the sign the direction can’t be undefined, and it will return false in that case.

Source

pub const fn with_direction(self, direction: AngleDirection) -> Self

Available on crate feature _float_f64 only.

Returns a version of the angle with the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub const fn set_direction(&mut self, direction: AngleDirection)

Available on crate feature _float_f64 only.

Sets the angle to the given direction.

An Undefined direction will be interpreted as counter-clockwise (positive).

Source

pub const fn invert_direction(self) -> Self

Available on crate feature _float_f64 only.

Returns a version of the angle with inverted direction.

Source

pub const fn negative(self) -> Self

Available on crate feature _float_f64 only.

Returns the negative version of the angle.

Source

pub const fn set_negative(&mut self)

Available on crate feature _float_f64 only.

Sets the angle as negative.

Source

pub const fn positive(self) -> Self

Available on crate feature _float_f64 only.

Returns the positive version of the angle.

Source

pub const fn set_positive(&mut self)

Available on crate feature _float_f64 only.

Sets the angle as positive.

Source

pub fn kind(self) -> AngleKind

Available on crate features _float_f64 and _cmp_f64 only.

Returns the kind of the normalized angle.

Source

pub fn kind_approx(self, tolerance: f64) -> AngleKind

Available on crate feature _float_f64 only.

Returns the kind of the angle using a custom tolerance for approximate matching.

Source

pub fn is_kind(self, kind: AngleKind) -> bool

Available on crate features _float_f64 and _cmp_f64 only.

Returns true if the angle is of the given kind.

Source

pub fn is_kind_approx(self, kind: AngleKind, tolerance: f64) -> bool

Available on crate feature _float_f64 only.

Returns true if the angle is of the given kind using a custom tolerance.

Trait Implementations§

Source§

impl<T: Clone> Clone for Angle<T>

Source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: ConstDefault> ConstDefault for Angle<T>

Source§

const DEFAULT: Self

Returns a Angle, allocated in the stack, using the default value to fill the data.

Source§

impl<T: Debug> Debug for Angle<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult<()>

Formats the value using the given formatter. Read more
Source§

impl<T: Default> Default for Angle<T>

Source§

fn default() -> Self

Returns a Angle, allocated in the stack, using the default value to fill the data.

Source§

impl<T: Ord> Ord for Angle<T>

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl<T: PartialEq> PartialEq for Angle<T>

Source§

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: PartialOrd> PartialOrd for Angle<T>

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering> ⓘ

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: Copy> Copy for Angle<T>

Source§

impl<T: Eq> Eq for Angle<T>

Auto Trait Implementations§

§

impl<T> Freeze for Angle<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Angle<T>
where T: RefUnwindSafe,

§

impl<T> Send for Angle<T>
where T: Send,

§

impl<T> Sync for Angle<T>
where T: Sync,

§

impl<T> Unpin for Angle<T>
where T: Unpin,

§

impl<T> UnwindSafe for Angle<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> ArchivePointee for T

§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> ByteSized for T

Source§

const BYTE_ALIGN: usize = _

The alignment of this type in bytes.
Source§

const BYTE_SIZE: usize = _

The size of this type in bytes.
Source§

fn byte_align(&self) -> usize ⓘ

Returns the alignment of this type in bytes.
Source§

fn byte_size(&self) -> usize ⓘ

Returns the size of this type in bytes. Read more
Source§

fn ptr_size_ratio(&self) -> [usize; 2]

Returns the size ratio between Ptr::BYTES and BYTE_SIZE. Read more
Source§

impl<T, R> Chain<R> for T
where T: ?Sized,

Source§

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

Chain a function which takes the parameter by value.
Source§

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

Chain a function which takes the parameter by shared reference.
Source§

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

Chain a function which takes the parameter by exclusive reference.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> ExtAny for T
where T: Any + ?Sized,

Source§

fn type_id() -> TypeId

Returns the TypeId of Self. Read more
Source§

fn type_of(&self) -> TypeId

Returns the TypeId of self. Read more
Source§

fn type_name(&self) -> &'static str ⓘ

Returns the type name of self. Read more
Source§

fn type_is<T: 'static>(&self) -> bool

Returns true if Self is of type T. Read more
Source§

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

Upcasts &self as &dyn Any. Read more
Source§

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

Upcasts &mut self as &mut dyn Any. Read more
Source§

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

Upcasts Box<self> as Box<dyn Any>. Read more
Source§

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

Available on crate feature unsafe_layout only.
Returns some shared reference to the inner value if it is of type T. Read more
Source§

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

Available on crate feature unsafe_layout only.
Returns some exclusive reference to the inner value if it is of type T. Read more
Source§

impl<T> ExtMem for T
where T: ?Sized,

Source§

const NEEDS_DROP: bool = _

Know whether dropping values of this type matters, in compile-time.
Source§

fn mem_align_of<T>() -> usize ⓘ

Returns the minimum alignment of the type in bytes. Read more
Source§

fn mem_align_of_val(&self) -> usize ⓘ

Returns the alignment of the pointed-to value in bytes. Read more
Source§

fn mem_size_of<T>() -> usize ⓘ

Returns the size of a type in bytes. Read more
Source§

fn mem_size_of_val(&self) -> usize ⓘ

Returns the size of the pointed-to value in bytes. Read more
Source§

fn mem_copy(&self) -> Self
where Self: Copy,

Bitwise-copies a value. Read more
Source§

fn mem_needs_drop(&self) -> bool

Returns true if dropping values of this type matters. Read more
Source§

fn mem_drop(self)
where Self: Sized,

Drops self by running its destructor. Read more
Source§

fn mem_forget(self)
where Self: Sized,

Forgets about self without running its destructor. Read more
Source§

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

Replaces self with other, returning the previous value of self. Read more
Source§

fn mem_take(&mut self) -> Self
where Self: Default,

Replaces self with its default value, returning the previous value of self. Read more
Source§

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

Swaps the value of self and other without deinitializing either one. Read more
Source§

unsafe fn mem_zeroed<T>() -> T

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

Available on crate feature unsafe_layout only.
Returns the value of type T represented by the all-zero byte-pattern. Read more
Source§

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &[u8]. Read more
Source§

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

Available on crate feature unsafe_slice only.
View a Sync + Unpin self as &mut [u8]. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

Source§

impl<T> Hook for T

Source§

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

Applies a function which takes the parameter by shared reference, and then returns the (possibly) modified owned value. Read more
Source§

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

Applies a function which takes the parameter by exclusive reference, and then returns the (possibly) modified owned value. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> LayoutRaw for T

§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError> ⓘ

Returns the layout of the type.
§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize ⓘ

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Pointee for T

§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> ⓘ

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error> ⓘ

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

§

impl<T> Ungil for T
where T: Send,