ILine

Struct ILine 

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

A line segment represented by two points, in integer coordinates.

Implementations§

Source§

impl ILine

Source

pub const ZERO: Self

Source

pub fn new<P>(start: P, end: P) -> Self
where P: Into<IVec2>,

Creates a new line with the given start and end points.

Source

pub fn start(&self) -> IVec2

Get the start point.

Source

pub fn end(&self) -> IVec2

Get the end point.

Source

pub fn length_squared(&self) -> f32

Get the line’s length squared.

Source

pub fn length(&self) -> f32

Get the line’s length.

Source

pub fn distance_squared_to_point(&self, p: Vec2) -> f32

Source

pub fn distance_to_point(&self, p: Vec2) -> f32

Source

pub fn rotate(&self, radians: f32) -> Self

Create a new line that is the rotation of this line around its start point, by the given radians.

Source

pub fn rotate_around(&self, center: IVec2, radians: f32) -> Self

Create a new line that is the rotation of this line around the given point, by the given radians.

Source

pub fn flip(&self) -> Self

Flip the orientation of the line such that the start point becomes the end point and vice versa.

Source

pub fn contains<P>(&self, point: P) -> bool
where P: Into<Vec2>,

Determine if the given point lies on this line.

Source

pub fn is_vertical(&self) -> bool

Source

pub fn is_horizontal(&self) -> bool

Source

pub fn is_axis_aligned(&self) -> bool

Determine if this line is axis-aligned.

Source

pub fn aabb(&self) -> IRect

Get the axis-aligned bounding box of this line.

Source

pub fn axis_alignment(&self) -> Option<Direction>

Get the axis-aligned direction of this line, if it is axis-aligned, None otherwise.

Source

pub fn diagonal_axis_alignment(&self) -> Option<Direction>

Get the diagonal axis-aligned direction of this line, if it is diagonally axis-aligned, None otherwise.

Source

pub fn intersects_line(&self, other: &ILine) -> Option<IVec2>

Determine if this line intersects the given line.

Source

pub fn intersects_rect(&self, rect: &IRect) -> bool

Determine if this line intersects the edges of, or is contained within the given rectangle.

Source

pub fn axis_aligned_intersect_rect(&self, rect: &IRect) -> Option<ILine>

Obtain the segment of this line that intersects the given rectangle, if any, otherwise None. This line must be axis-aligned, otherwise None is returned.

Source

pub fn overlap(&self, other: &ILine) -> Option<ILine>

If this and the given line segments overlap, return the overlapping segment. Otherwise, return None.

Source

pub fn visit_points<F>(&self, visitor: F)
where F: FnMut(i32, i32),

Use Bresenham’s line algorithm to visit points on this line.

Source

pub fn pixels(&self) -> LinePixelIterator

Trait Implementations§

Source§

impl Clone for ILine

Source§

fn clone(&self) -> ILine

Returns a duplicate 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 Debug for ILine

Source§

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

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

impl Default for ILine

Source§

fn default() -> ILine

Returns the “default value” for a type. Read more
Source§

impl Display for ILine

Source§

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

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

impl From<&ILine> for [IVec2; 2]

Source§

fn from(value: &ILine) -> Self

Converts to this type from the input type.
Source§

impl From<&ILine> for [Vec2; 2]

Source§

fn from(value: &ILine) -> Self

Converts to this type from the input type.
Source§

impl From<ILine> for [IVec2; 2]

Source§

fn from(value: ILine) -> Self

Converts to this type from the input type.
Source§

impl From<ILine> for [Vec2; 2]

Source§

fn from(value: ILine) -> Self

Converts to this type from the input type.
Source§

impl Hash for ILine

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ILine

Source§

fn eq(&self, other: &ILine) -> 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 Copy for ILine

Source§

impl Eq for ILine

Source§

impl StructuralPartialEq for ILine

Auto Trait Implementations§

§

impl Freeze for ILine

§

impl RefUnwindSafe for ILine

§

impl Send for ILine

§

impl Sync for ILine

§

impl Unpin for ILine

§

impl UnwindSafe for ILine

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> CloneToUninit for T
where T: Clone,

Source§

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

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

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

Source§

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

Checks if this value is equivalent to the given key. Read more
Source§

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

Source§

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

Compare self to key and return true if they are equal.
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> 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
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
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V