Struct k::joint::Range

source · []
pub struct Range<T: RealField> {
    pub min: T,
    pub max: T,
}
Expand description

min/max range to check the joint position

Fields

min: Tmax: T

Implementations

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

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));

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

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));

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

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

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

Performs the conversion.

Should always be Self

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

Checks if self is actually part of its subset T (and can be converted to it).

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

The inclusion map: converts self to the equivalent element of its superset.

The resulting type after obtaining ownership.

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

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

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