Struct bbecs::data_types::point::Point

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

Point that stores a f32 x and y with methods for manipulating the point. Uses Vector math for the methods

Fields

x: f32

y: f32

Implementations

impl Point

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

pub fn to_array(&self) -> [f32; 2]

Creates an array of the point with x being the first element, and y being the second. This is mostly useful for working with ggez points as they can cast from arrays.

use bbecs::data_types::point::Point;
let location = Point::new(15.0, 7.0);
assert_eq!(location.to_array(), [15.0, 7.0]);

pub fn add(&mut self, other: &Point)

Adds another point to the one being called, mutating itself

use bbecs::data_types::point::Point;
let mut location = Point::new(0.0, 0.0);
let velocity = Point::new(1.0, 2.0);
location.add(&velocity);
assert_eq!(location, Point::new(1.0, 2.0));

pub fn to_perpendicular_left(&self) -> Self

Create a new Point that is perpendicular to the self pointing towards the left

use bbecs::data_types::point::Point;
let velocity = Point::new(10.0, 25.0);
let left_velocity = velocity.to_perpendicular_left();
assert_eq!(left_velocity, Point::new(25.0, -10.0));

pub fn to_perpendicular_right(&self) -> Self

Create a new Point that is perpendicular to the self pointing towards the right

use bbecs::data_types::point::Point;
let velocity = Point::new(10.0, 25.0);
let right_velocity = velocity.to_perpendicular_right();
assert_eq!(right_velocity, Point::new(-25.0, 10.0));

pub fn multiply_scalar(&mut self, scalar: f32)

Multiplies the x and y by a scalar (single f32) and mutates itself

use bbecs::data_types::point::Point;
let mut point = Point::new(1.0, 2.0);
point.multiply_scalar(10.0);
assert_eq!(point, Point::new(10.0, 20.0));

pub fn normalize(&mut self)

Normalize the point, which makes the hypotenuse equal to 1.0

pub fn length(&self) -> f32

Get the length of the Point

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

pub fn rotation(&self) -> f32

Trait Implementations

impl AddAssign<Point> for Point

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl CastComponents<Point> for Components

fn cast_mut(&mut self) -> Result<&mut Vec<Point>>

Cast the components to it’s contained data as long as it is really a point.

use bbecs::components::{Components, CastComponents};
use bbecs::data_types::point::Point;
let mut wrapped_locations = Components::Point(vec![]);
let locations: &mut Vec<Point> = wrapped_locations.cast_mut().unwrap();

fn cast(&self) -> Result<&Vec<Point>>

impl Clone for Point

fn clone(&self) -> Point

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Point

impl Debug for Point

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

Formats the value using the given formatter.

impl Default for Point

fn default() -> Point

Returns the “default value” for a type.

impl Div<usize> for Point

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl PartialEq<Point> for Point

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

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

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

This method tests for !=.

impl ResourceCast<Point> for Resource

fn cast(&self) -> Result<&Point>

fn cast_mut(&mut self) -> Result<&mut Point>

impl ResourceDataLens<Point> for ResourcesData

fn get(&self, name: &str) -> Result<&Point>

fn get_mut(&mut self, name: &str) -> Result<&mut Point>

impl StructuralPartialEq for Point

impl Sub<Point> for Point

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sum<Point> for Point

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

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

impl WorldMethods<Point> for World

fn with_component<S: Into<String>>(
    &mut self,
    name: S,
    data: Point
) -> Result<&mut Self>

fn add_resource<S: Into<String>>(&mut self, name: S, data: Point)

fn get_resource<S: Into<String>>(&self, name: S) -> Result<&Point>

fn get_resource_mut<S: Into<String>>(&mut self, name: S) -> Result<&mut Point>