Struct rust_sc2::geometry::Point2

pub struct Point2 {
    pub x: f32,
    pub y: f32,
}

Point on 2D grid, the most frequently used geometric primitive.

Fields

x: f32

y: f32

Implementations

impl Point2

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

Constructs new 2D Point with given coordinates.

pub fn towards(self, other: Self, offset: f32) -> Self

Returns new point with offset towards other on given distance.

pub fn towards_angle(self, angle: f32, offset: f32) -> Self

Returns new point with offset towards given angle on given distance.

pub fn offset(self, x: f32, y: f32) -> Self

Returns new point with given offset.

pub fn circle_intersection(self, other: Self, radius: f32) -> Option<[Self; 2]>

Returns points where circles with centers self and other, and given radius intersect, or None if they aren't intersect.

pub fn len(self) -> f32

Returns length of the vector.

pub fn normalize(self) -> Self

Normalizes the vector.

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

Rotates the vector on given angle.

pub fn rotate90(self, clockwise: bool) -> Self

Fast rotation of the vector on 90 degrees.

pub fn round(self) -> Self

Returns rounded point.

pub fn floor(self) -> Self

Returns point rounded to closest lower integer.

pub fn ceil(self) -> Self

Returns point rounded to closest greater integer.

pub fn abs(self) -> Self

Returns point with absolute coordinates.

pub fn neighbors4(self) -> [Self; 4]

Returns 4 closest neighbors of point.

pub fn neighbors4diagonal(self) -> [Self; 4]

Returns 4 closest diagonal neighbors of point.

pub fn neighbors8(self) -> [Self; 8]

Returns 8 closest neighbors of point.

pub fn as_tuple(self) -> (f32, f32)

Returns tuple with point's coordinates.

pub fn to3(self, z: f32) -> Point3

Converts 2D Point to 3D Point using given z value.

Trait Implementations

impl Add<Point2> for Point2

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl Add<f32> for Point2

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: f32) -> Self

Performs the + operation.

impl AddAssign<Point2> for Point2

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl AddAssign<f32> for Point2

fn add_assign(&mut self, other: f32)

Performs the += operation.

impl Clone for Point2

fn clone(&self) -> Point2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Point2

impl Debug for Point2

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

Formats the value using the given formatter.

impl Default for Point2

fn default() -> Point2

Returns the "default value" for a type.

impl Div<Point2> for Point2

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self

Performs the / operation.

impl Div<f32> for Point2

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: f32) -> Self

Performs the / operation.

impl DivAssign<Point2> for Point2

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl DivAssign<f32> for Point2

fn div_assign(&mut self, other: f32)

Performs the /= operation.

impl Eq for Point2

impl From<&'_ Point2> for Point2

fn from(p: &Point2) -> Self

Performs the conversion.

impl From<&'_ Unit> for Point2

fn from(u: &Unit) -> Self

Performs the conversion.

impl From<(f32, f32)> for Point2

fn from((x, y): (f32, f32)) -> Self

Performs the conversion.

impl From<(usize, usize)> for Point2

fn from((x, y): (usize, usize)) -> Self

Performs the conversion.

impl From<Point3> for Point2

fn from(p3: Point3) -> Self

Performs the conversion.

impl From<Unit> for Point2

fn from(u: Unit) -> Self

Performs the conversion.

impl Hash for Point2

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Mul<Point2> for Point2

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl Mul<f32> for Point2

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: f32) -> Self

Performs the * operation.

impl MulAssign<Point2> for Point2

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl MulAssign<f32> for Point2

fn mul_assign(&mut self, other: f32)

Performs the *= operation.

impl Neg for Point2

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq<Point2> for Point2

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Radius for Point2

fn radius(&self) -> f32

Radius for struct

impl Radius for &Point2

fn radius(&self) -> f32

Radius for struct

impl Sub<Point2> for Point2

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl Sub<f32> for Point2

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: f32) -> Self

Performs the - operation.

impl SubAssign<Point2> for Point2

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl SubAssign<f32> for Point2

fn sub_assign(&mut self, other: f32)

Performs the -= operation.

impl Sum<Point2> for Point2

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Method which takes an iterator and generates Self from the elements by "summing up" the items.