Struct k::joint::Range

pub struct Range<T: RealField> {
    pub min: T,
    pub max: T,
}

min/max range to check the joint position

Fields

min: T

max: T

Implementations

impl<T> Range<T>

where T: RealField,

pub fn new(min: T, max: T) -> Self

Create new Range instance

In case min is greater than max, this function panics.

Examples

let range = k::joint::Range::new(-1.0, 1.0);
// let range = k::joint::Range::new(1.0, -1.0);  // panic

pub fn is_valid(&self, val: T) -> bool

Check if the value is in the range

true means it is OK. If the val is the same as the limit value (min or max), it returns true (valid).

Examples

let range = k::joint::Range::new(-1.0, 1.0);
assert!(range.is_valid(0.0));
assert!(range.is_valid(1.0));
assert!(!range.is_valid(1.5));

pub fn clamp(&self, val: T) -> T

Clamp the value with the range

Examples

let range = k::joint::Range::new(-1.0, 1.0);
assert_eq!(range.clamp(0.5), 0.5);
assert_eq!(range.clamp(2.0), 1.0);
assert_eq!(range.clamp(-2.0), -1.0);

Trait Implementations

impl<T: Clone + RealField> Clone for Range<T>

fn clone(&self) -> Range<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + RealField> Debug for Range<T>

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

Formats the value using the given formatter.

impl<T> From<RangeInclusive<T>> for Range<T>

where T: RealField,

fn from(range: RangeInclusive<T>) -> Self

Examples

let range : k::joint::Range<f64> = (-1.0..=1.0).into();
assert!(range.is_valid(0.0));
assert!(range.is_valid(1.0));
assert!(!range.is_valid(1.5));

impl<T: Copy + RealField> Copy for Range<T>