Struct Point 

#[repr(C)]
pub struct Point<T: Clone + Debug + Default + PartialEq> {
    pub x: T,
    pub y: T,
}

A position or offset in two-dimensional space.

GPUI’s coordinate system has its origin at the top left corner of the window. The x axis increases to the right and the y axis increases downward, so a larger y is lower on the screen. Coordinates are in logical pixels: px(1.) is one logical pixel, which the platform scales to device pixels for the display. Use Pixels for positions that the UI lays out.

Point<T> works with any T that is Clone, Debug, Default and PartialEq. The arithmetic and ordering methods also need T to support the matching operators.

Bounds uses points for its origin. For how positions map onto the layout tree, see layout and style.

Examples

use gpui::{Point, point, px};

let card = point(px(20.), px(30.));
let offset = point(px(5.), px(-10.));
assert_eq!(card + offset, point(px(25.), px(20.)));

Fields

x: T

The horizontal coordinate, increasing to the right.

y: T

The vertical coordinate, increasing downward.

Implementations

impl<T: Clone + Debug + Default + PartialEq> Point<T>

pub const fn new(x: T, y: T) -> Self

Creates a point from its x and y coordinates. Same as point.

Examples

use gpui::Point;

let p = Point::new(10, 20);
assert_eq!(p.x, 10);
assert_eq!(p.y, 20);

pub fn map<U: Clone + Debug + Default + PartialEq>( &self, f: impl Fn(T) -> U, ) -> Point<U>

Returns a new point with f applied to both coordinates.

Examples

let p = Point { x: 3, y: 4 };
let p_float = p.map(|coord| coord as f32);
assert_eq!(p_float, Point { x: 3.0, y: 4.0 });

impl Point<Pixels>

pub fn scale(&self, factor: f32) -> Point<ScaledPixels>

Multiplies both coordinates by factor, producing ScaledPixels.

Pass the display’s scale factor, such as 2.0 on a Retina display, to convert a logical position into the scaled space that GPUI draws in.

Examples

let p = Point { x: Pixels::from(10.0), y: Pixels::from(20.0) };
let scaled_p = p.scale(1.5);
assert_eq!(scaled_p, Point { x: ScaledPixels::from(15.0), y: ScaledPixels::from(30.0) });

pub fn magnitude(&self) -> f64

Returns the distance from (0, 0) to this point.

The result is an f64, not Pixels.

Examples

let p = Point { x: Pixels::from(3.0), y: Pixels::from(4.0) };
assert_eq!(p.magnitude(), 5.0);

pub fn is_nearly_eq(&self, other: &Self, epsilon: Pixels) -> bool

Returns true if both coordinates differ from other by less than epsilon.

Use this to compare positions computed with floating point arithmetic. The comparison is strict: a difference of exactly epsilon returns false.

Examples

let p1 = Point { x: Pixels::from(1.0), y: Pixels::from(1.0) };
let p2 = Point { x: Pixels::from(3.0), y: Pixels::from(-2.0) };
assert_eq!(p1.is_nearly_eq(&p2, Pixels::from(4.0)), true);

impl<T> Point<T>

where T: Sub<T, Output = T> + Clone + Debug + Default + PartialEq,

pub fn relative_to(&self, origin: &Point<T>) -> Point<T>

Returns this point’s position relative to origin.

Subtracts origin from both coordinates. Bounds::localize uses it to convert a point in window coordinates into a bounds rectangle’s local coordinates.

Examples

let pointer = point(px(150.), px(90.));
let element_origin = point(px(100.), px(80.));
assert_eq!(pointer.relative_to(&element_origin), point(px(50.), px(10.)));

impl<T> Point<T>

where T: PartialOrd + Clone + Debug + Default + PartialEq,

pub fn max(&self, other: &Self) -> Self

Returns a point with the larger x and the larger y of self and other.

Examples

let p1 = Point { x: 3, y: 7 };
let p2 = Point { x: 5, y: 2 };
assert_eq!(p1.max(&p2), Point { x: 5, y: 7 });

pub fn min(&self, other: &Self) -> Self

Returns a point with the smaller x and the smaller y of self and other.

Examples

let p1 = Point { x: 3, y: 7 };
let p2 = Point { x: 5, y: 2 };
assert_eq!(p1.min(&p2), Point { x: 3, y: 2 });

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

Limits each coordinate to the range from min to max.

A coordinate below min becomes min, and a coordinate above max becomes max. If min is greater than max in a coordinate, that coordinate becomes max.

Examples

let p = Point { x: 10, y: 20 };
let min = Point { x: 0, y: 5 };
let max = Point { x: 15, y: 25 };
assert_eq!(p.clamp(&min, &max), Point { x: 10, y: 20 });

let p_out_of_bounds = Point { x: -5, y: 30 };
assert_eq!(p_out_of_bounds.clamp(&min, &max), Point { x: 0, y: 25 });

Trait Implementations

impl<T> Add for Point<T>

where T: Add<Output = T> + Clone + Debug + Default + PartialEq,

type Output = Point<T>

The resulting type after applying the + operator.

fn add(self, __rhs: Self) -> Self::Output

Performs the + operation.

impl<T> Add<Point<T>> for Bounds<T>

where T: Add<T, Output = T> + Clone + Debug + Default + PartialEq,

type Output = Bounds<T>

The resulting type after applying the + operator.

fn add(self, rhs: Point<T>) -> Self

Performs the + operation.

impl<T> AddAssign for Point<T>

where T: AddAssign + Clone + Debug + Default + PartialEq,

fn add_assign(&mut self, __rhs: Self)

Performs the += operation.

impl<T: Clone + Debug + Default + PartialEq> Along for Point<T>

type Unit = T

The type of the value along each axis.

fn along(&self, axis: Axis) -> T

Returns the value along axis.

fn apply_along(&self, axis: Axis, f: impl FnOnce(T) -> T) -> Point<T>

Returns a copy with f applied to the value along axis. The other axis is unchanged.

impl<T: Clone + Debug + Default + PartialEq> Clone for Point<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy + Clone + Debug + Default + PartialEq> Copy for Point<T>

impl<T: Debug + Clone + Debug + Default + PartialEq> Debug for Point<T>

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

Formats the value using the given formatter.

impl<T: Default + Clone + Debug + Default + PartialEq> Default for Point<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Point<T>

where T: Deserialize<'de> + Clone + Debug + Default + PartialEq,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Clone + Debug + Default + PartialEq + Display> Display for Point<T>

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

Formats the value using the given formatter.

impl<T, S> Div<S> for Point<T>

where T: Div<S, Output = T> + Clone + Debug + Default + PartialEq, S: Clone,

type Output = Point<T>

The resulting type after applying the / operator.

fn div(self, rhs: S) -> Self::Output

Performs the / operation.

impl<T: Eq + Clone + Debug + Default + PartialEq> Eq for Point<T>

impl From<Point2D<f32, UnknownUnit>> for Point<Pixels>

fn from(p: Point) -> Self

Converts to this type from the input type.

impl From<Point<Pixels>> for Point

fn from(p: Point<Pixels>) -> Self

Converts to this type from the input type.

impl From<Point<Pixels>> for Vector

fn from(p: Point<Pixels>) -> Self

Converts to this type from the input type.

impl From<Point<Pixels>> for Point2D<f32, Pixels>

fn from(p: Point<Pixels>) -> Self

Converts to this type from the input type.

impl<T: Clone + Debug + Default + PartialEq> From<Point<T>> for Size<T>

fn from(point: Point<T>) -> Self

Converts to this type from the input type.

impl<T, T2> From<Point<T>> for Point<T2>

where T: Into<T2>, T2: Clone + Debug + Default + PartialEq,

fn from(point: TaffyPoint<T>) -> Point<T2>

Converts to this type from the input type.

impl<T, T2> From<Point<T>> for Point<T2>

where T: Into<T2> + Clone + Debug + Default + PartialEq,

fn from(val: Point<T>) -> Self

Converts to this type from the input type.

impl<T: Clone + Debug + Default + PartialEq> From<PointRefinement<T>> for Point<T>

where Option<T>: Clone,

fn from(value: PointRefinement<T>) -> Self

Converts to this type from the input type.

impl<T: Clone + Debug + Default + PartialEq> From<Size<T>> for Point<T>

fn from(size: Size<T>) -> Self

Converts to this type from the input type.

impl<T: Hash + Clone + Debug + Default + PartialEq> Hash for Point<T>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: IsZero + Clone + Debug + Default + PartialEq> IsZero for Point<T>

fn is_zero(&self) -> bool

Returns true if this value is zero.

impl<T> JsonSchema for Point<T>

where T: JsonSchema + Clone + Debug + Default + PartialEq,

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl<T: Lerp + Clone + Debug + Default + PartialEq> Lerp for Point<T>

fn lerp(&self, to: &Self, delta: f32) -> Self

Returns the value delta of the way from self to to.

impl<T, Rhs> Mul<Rhs> for Point<T>

where T: Mul<Rhs, Output = T> + Clone + Debug + Default + PartialEq, Rhs: Clone + Debug,

type Output = Point<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Rhs) -> Self::Output

Performs the * operation.

impl<T, S> MulAssign<S> for Point<T>

where T: Mul<S, Output = T> + Clone + Debug + Default + PartialEq, S: Clone,

fn mul_assign(&mut self, rhs: S)

Performs the *= operation.

impl<T: Clone + Debug + Default + PartialEq + Neg<Output = T>> Neg for Point<T>

type Output = Point<T>

The resulting type after applying the - operator.

fn neg(self) -> Point<T>

Performs the unary - operation.

impl<T: PartialEq + Clone + Debug + Default + PartialEq> PartialEq for Point<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: Clone + Debug + Default + PartialEq> Refineable for Point<T>

where Option<T>: Clone,

type Refinement = PointRefinement<T>

fn refine(&mut self, refinement: &Self::Refinement)

Applies the given refinement to this instance, modifying it in place.

fn refined(self, refinement: Self::Refinement) -> Self

Returns a new instance with the refinement applied, equivalent to cloning self and calling refine on it.

fn is_superset_of(&self, refinement: &Self::Refinement) -> bool

Returns true if this instance would contain all values from the refinement.

fn subtract(&self, refinement: &Self::Refinement) -> Self::Refinement

Returns a refinement that represents the difference between this instance and the given refinement.

fn from_cascade(cascade: &Cascade<Self>) -> Self

where Self: Sized + Default,

Creates an instance from a cascade by merging all refinements atop the default value.

impl<T> Serialize for Point<T>

where T: Serialize + Clone + Debug + Default + PartialEq,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq + Clone + Debug + Default + PartialEq> StructuralPartialEq for Point<T>

impl<T> Sub for Point<T>

where T: Sub<Output = T> + Clone + Debug + Default + PartialEq,

type Output = Point<T>

The resulting type after applying the - operator.

fn sub(self, __rhs: Self) -> Self::Output

Performs the - operation.

impl<T> Sub<Point<T>> for Bounds<T>

where T: Sub<T, Output = T> + Clone + Debug + Default + PartialEq,

type Output = Bounds<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Point<T>) -> Self

Performs the - operation.

impl<T> SubAssign for Point<T>

where T: SubAssign + Clone + Debug + Default + PartialEq,

fn sub_assign(&mut self, __rhs: Self)

Performs the -= operation.