Struct f1_api::types::Property3D

pub struct Property3D<T> where
    T: Copy,  { /* fields omitted */ }

Property in a three-dimensional world

The F1 games publish data that places objects in a three dimensional world. Examples include the position of a car, its velocity, or the direction of its motion.

Examples

use f1_api::types::Property3D;

let g_forces = Property3D::new(1.0, 1.3, 0.9);

Methods

impl<T> Property3D<T> where
    T: Copy, 

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

Constructs a new Property3D.

impl<T> Property3D<T> where
    T: Copy, 

pub fn x(&self) -> T

Returns the component on the X axis of the three-dimensional property.

pub fn y(&self) -> T

Returns the component on the Y axis of the three-dimensional property.

pub fn z(&self) -> T

Returns the component on the Z axis of the three-dimensional property.

Trait Implementations

impl<T: Clone> Clone for Property3D<T> where
    T: Copy, 

fn clone(&self) -> Property3D<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Property3D<T> where
    T: Copy, 

impl<T: Debug> Debug for Property3D<T> where
    T: Copy, 

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

Formats the value using the given formatter.

impl<T: Default> Default for Property3D<T> where
    T: Copy, 

fn default() -> Property3D<T>

Returns the "default value" for a type.

impl<T: Eq> Eq for Property3D<T> where
    T: Copy, 

impl<T: Hash> Hash for Property3D<T> where
    T: Copy, 

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, 

Feeds a slice of this type into the given [Hasher].

impl<T: Ord> Ord for Property3D<T> where
    T: Copy, 

fn cmp(&self, other: &Property3D<T>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Property3D<T>> for Property3D<T> where
    T: Copy, 

fn eq(&self, other: &Property3D<T>) -> bool

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

fn ne(&self, other: &Property3D<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Property3D<T>> for Property3D<T> where
    T: Copy, 

fn partial_cmp(&self, other: &Property3D<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Property3D<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Property3D<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Property3D<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Property3D<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> StructuralEq for Property3D<T> where
    T: Copy, 

impl<T> StructuralPartialEq for Property3D<T> where
    T: Copy,