Struct kas::geom::Offset

pub struct Offset(pub i32, pub i32);

A (x, y) offset, also known as a vector

This is a relative position. It can be added to or subtracted from a Coord, and it can be added to or subtracted from itself. It can be negative. It can be multiplied by a scalar.

This may be converted to Size with from / into.

Tuple Fields

0: i32

1: i32

Implementations

impl Offset

pub fn new(x: i32, y: i32) -> Offset

Construct

pub const fn splat(n: i32) -> Offset

Construct, using the same value on all axes

impl Offset

pub const ZERO: Offset

The constant (0, 0)

pub const MIN: Offset

The minimum value

pub const MAX: Offset

The maximum value

pub fn lt(self, rhs: Offset) -> bool

True when for all components, lhs < rhs

pub fn le(self, rhs: Offset) -> bool

True when for all components, lhs ≤ rhs

pub fn ge(self, rhs: Offset) -> bool

True when for all components, lhs ≥ rhs

pub fn gt(self, rhs: Offset) -> bool

True when for all components, lhs > rhs

pub fn min(self, other: Offset) -> Offset

Return the minimum, componentwise

pub fn max(self, other: Offset) -> Offset

Return the maximum, componentwise

pub fn clamp(self, min: Offset, max: Offset) -> Offset

Return the value clamped to the given min and max

In the case that min > max, the min value is returned.

pub fn transpose(self) -> Offset

Return the transpose (swap x and y values)

pub fn cwise_mul(self, rhs: Offset) -> Offset

Return the result of component-wise multiplication

pub fn cwise_div(self, rhs: Offset) -> Offset

Return the result of component-wise division

pub fn distance_l1(self) -> i32

Return the L1 (rectilinear / taxicab) distance

pub fn distance_l_inf(self) -> i32

Return the L-inf (max) distance

pub fn extract<D>(self, dir: D) -> i32 where
    D: Directional, 

Extract one component, based on a direction

This merely extracts the horizontal or vertical component. It never negates it, even if the axis is reversed.

pub fn set_component<D>(&mut self, dir: D, value: i32) where
    D: Directional, 

Set one component of self, based on a direction

This does not negate components when the direction is reversed.

Trait Implementations

impl Add<Offset> for Coord

type Output = Coord

The resulting type after applying the + operator.

pub fn add(self, other: Offset) -> Coord

Performs the + operation.

impl Add<Offset> for Offset

type Output = Offset

The resulting type after applying the + operator.

pub fn add(self, other: Offset) -> Offset

Performs the + operation.

impl Add<Offset> for Rect

type Output = Rect

The resulting type after applying the + operator.

pub fn add(self, offset: Offset) -> Rect

Performs the + operation.

impl AddAssign<Offset> for Rect

pub fn add_assign(&mut self, offset: Offset)

Performs the += operation.

impl AddAssign<Offset> for Coord

pub fn add_assign(&mut self, rhs: Offset)

Performs the += operation.

impl AddAssign<Offset> for Offset

pub fn add_assign(&mut self, rhs: Offset)

Performs the += operation.

impl Clone for Offset

pub fn clone(&self) -> Offset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Offset

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

Formats the value using the given formatter.

impl Default for Offset

pub fn default() -> Offset

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Offset

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<Offset, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Div<f32> for Offset

type Output = Offset

The resulting type after applying the / operator.

pub fn div(self, x: f32) -> Offset

Performs the / operation.

impl Div<i32> for Offset

type Output = Offset

The resulting type after applying the / operator.

pub fn div(self, x: i32) -> Offset

Performs the / operation.

impl From<(i32, i32)> for Offset

pub fn from(v: (i32, i32)) -> Offset

Performs the conversion.

impl From<DVec2> for Offset

pub fn from(arg: DVec2) -> Offset

Performs the conversion.

impl From<Offset> for DVec2

pub fn from(arg: Offset) -> DVec2

Performs the conversion.

impl From<Offset> for Vec2

pub fn from(size: Offset) -> Vec2

Performs the conversion.

impl From<Offset> for Size

pub fn from(v: Offset) -> Size

Performs the conversion.

impl From<Offset> for Vec2

pub fn from(arg: Offset) -> Vec2

Performs the conversion.

impl From<Size> for Offset

pub fn from(v: Size) -> Offset

Performs the conversion.

impl From<Vec2> for Offset

pub fn from(arg: Vec2) -> Offset

Performs the conversion.

impl Mul<f32> for Offset

type Output = Offset

The resulting type after applying the * operator.

pub fn mul(self, x: f32) -> Offset

Performs the * operation.

impl Mul<i32> for Offset

type Output = Offset

The resulting type after applying the * operator.

pub fn mul(self, x: i32) -> Offset

Performs the * operation.

impl PartialEq<Offset> for Offset

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Offset

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Sub<Offset> for Coord

type Output = Coord

The resulting type after applying the - operator.

pub fn sub(self, other: Offset) -> Coord

Performs the - operation.

impl Sub<Offset> for Offset

type Output = Offset

The resulting type after applying the - operator.

pub fn sub(self, other: Offset) -> Offset

Performs the - operation.

impl Sub<Offset> for Rect

type Output = Rect

The resulting type after applying the - operator.

pub fn sub(self, offset: Offset) -> Rect

Performs the - operation.

impl SubAssign<Offset> for Coord

pub fn sub_assign(&mut self, rhs: Offset)

Performs the -= operation.

impl SubAssign<Offset> for Offset

pub fn sub_assign(&mut self, rhs: Offset)

Performs the -= operation.

impl SubAssign<Offset> for Rect

pub fn sub_assign(&mut self, offset: Offset)

Performs the -= operation.

impl Copy for Offset

impl Eq for Offset

impl StructuralEq for Offset

impl StructuralPartialEq for Offset