SRange

maliput::api

Struct SRange 

Source 
pub struct SRange { /* private fields */ }
Expand description

Directed, inclusive longitudinal (s value) range from s0 to s1.

Implementations§

Source§

impl SRange

Source

pub fn new(s0: f64, s1: f64) -> SRange

Creates a new SRange with the given s0 and s1.

§Arguments
  • s0 - The starting value of the range.
  • s1 - The ending value of the range.
§Returns

A new SRange instance.

Source

pub fn s0(&self) -> f64

Returns the s0 of the SRange.

§Returns

The starting value of the range.

Source

pub fn s1(&self) -> f64

Returns the s1 of the SRange.

§Returns

The ending value of the range.

Source

pub fn set_s0(&mut self, s0: f64)

Sets the s0 of the SRange.

§Arguments
  • s0 - The new starting value of the range.
Source

pub fn set_s1(&mut self, s1: f64)

Sets the s1 of the SRange.

§Arguments
  • s1 - The new ending value of the range.
Source

pub fn size(&self) -> f64

Get the size of the SRange.

§Returns

The size of the range, which is the difference between s1 and s0.

Source

pub fn with_s(&self) -> bool

Defines whether this SRange is in the direction of +s (i.e., s1() > s0()).

§Returns

A boolean indicating whether the SRange is in the direction of +s.

Source

pub fn intersects(&self, s_range: &SRange, tolerance: f64) -> bool

Determines whether this SRange intersects with s_range.

§Arguments
  • s_range - Another SRange to check for intersection.
  • tolerance - A tolerance value to consider when checking for intersection.
§Returns

A boolean indicating whether this SRange intersects with s_range.

Source

pub fn contains(&self, s_range: &SRange, tolerance: f64) -> bool

Determines whether this SRange contains s_range.

§Arguments
  • s_range - Another SRange to check if it is contained within this SRange.
  • tolerance - A tolerance value to consider when checking for containment.
Source

pub fn get_intersection( &self, s_range: &SRange, tolerance: f64, ) -> Option<SRange>

Get the intersection of this SRange with s_range.

§Arguments
  • s_range - Another SRange to get the intersection with.
  • tolerance - A tolerance value to consider when checking for intersection.
§Returns

An Option<SRange> containing the intersection of this SRange with s_range. If the intersection is empty, it returns None.

Trait Implementations§

Source§

impl Debug for SRange

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for SRange

§

impl RefUnwindSafe for SRange

§

impl !Send for SRange

§

impl !Sync for SRange

§

impl Unpin for SRange

§

impl UnwindSafe for SRange

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
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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.