Struct Point3d 

#[repr(C)]
pub struct Point3d<T = f32> {
    pub x: T,
    pub y: T,
    pub z: T,
}

A point in 3D space

Fields

x: T

y: T

z: T

Implementations

impl<T> Point3d<T>

where T: Default,

pub fn only_x(x: T) -> Self

Set the x component to the given value, and all other components to their default.

use kcl_api::point::Point3d;
let expected = Point3d{
	x: 8,
	y: 0,
	z: 0,
};
let actual = Point3d::only_x(8);
assert_eq!(actual, expected);

impl<T> Point3d<T>

where T: Default,

pub fn only_y(y: T) -> Self

Set the y component to the given value, and all other components to their default.

use kcl_api::point::Point3d;
let expected = Point3d{
	y: 8,
	x: 0,
	z: 0,
};
let actual = Point3d::only_y(8);
assert_eq!(actual, expected);

impl<T> Point3d<T>

where T: Default,

pub fn only_z(z: T) -> Self

Set the z component to the given value, and all other components to their default.

use kcl_api::point::Point3d;
let expected = Point3d{
	z: 8,
	x: 0,
	y: 0,
};
let actual = Point3d::only_z(8);
assert_eq!(actual, expected);

impl<T> Point3d<T>

where T: Copy,

pub const fn uniform(value: T) -> Self

Set all components to the same value.

impl Point3d<f64>

pub const fn zero() -> Self

Set all components to zero.

impl<T> Point3d<T>

pub fn from_2d(_: Point2d<T>, z: T) -> Self

Add the given z component to a 2D point to produce a 3D point.

pub fn with_w(self, w: T) -> Point4d<T>

Add the given w component to a 3D point to produce a 4D point.

pub fn map<U, F>(self, f: F) -> Point3d<U>

where F: FnMut(T) -> U,

Takes some closure, and calls it on each component of this point.

Examples

use kcl_api::point::Point3d;
let p0 = Point3d {
    x: 1.0,
    y: 1.0,
    z: 1.0,
};
assert_eq!(
    p0.map(|n| n * 2.0),
    Point3d {
        x: 2.0,
        y: 2.0,
        z: 2.0
    }
);

Trait Implementations

impl<T> Add for Point3d<T>

where T: Add<Output = T>,

Arithmetic between two points happens component-wise, e.g. p + q == (p.x + q.x, p.y + q.y)

type Output = Point3d<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign for Point3d<T>

where T: AddAssign<T>,

Arithmetic between two points happens component-wise, e.g. p + q == (p.x + q.x, p.y + q.y)

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl<T: Clone> Clone for Point3d<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Point3d<T>

impl<T: Debug> Debug for Point3d<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Point3d<T>

fn default() -> Point3d<T>

Returns the “default value” for a type.

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

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Point3d<f64>

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

Formats the value using the given formatter.

impl<T> Div for Point3d<T>

where T: Div<Output = T>,

Arithmetic between two points happens component-wise, e.g. p + q == (p.x + q.x, p.y + q.y)

type Output = Point3d<T>

The resulting type after applying the / operator.

fn div(self, rhs: Point3d<T>) -> Self::Output

Performs the / operation.

impl<T> Div<T> for Point3d<T>

where T: Div<Output = T> + Copy,

Applies an arithmetic operation to each component, e.g. p * 3 = (p.x * 3, p.y * 3)

type Output = Point3d<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T> DivAssign for Point3d<T>

where T: DivAssign<T>,

Arithmetic between two points happens component-wise, e.g. p + q == (p.x + q.x, p.y + q.y)

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<T> DivAssign<T> for Point3d<T>

where T: DivAssign<T> + Copy,

Applies an arithmetic operation to each component, e.g. p * 3 = (p.x * 3, p.y * 3)

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl<T> From<Point3d<T>> for [T; 3]

fn from(_: Point3d<T>) -> Self

Converts to this type from the input type.

impl From<Vec3> for Point3d<f32>

fn from(v: Vec3) -> Self

Converts to this type from the input type.

impl<T> From<[T; 3]> for Point3d<T>

fn from([x, y, z]: [T; 3]) -> Self

Converts to this type from the input type.

impl<T: JsonSchema> JsonSchema for Point3d<T>

fn schema_name() -> String

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 is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<T> Mul for Point3d<T>

where T: Mul<Output = T>,

Arithmetic between two points happens component-wise, e.g. p + q == (p.x + q.x, p.y + q.y)

type Output = Point3d<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Point3d<T>) -> Self::Output

Performs the * operation.

impl<T> Mul<T> for Point3d<T>

where T: Mul<Output = T> + Copy,

Applies an arithmetic operation to each component, e.g. p * 3 = (p.x * 3, p.y * 3)

type Output = Point3d<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> MulAssign for Point3d<T>

where T: MulAssign<T>,

Arithmetic between two points happens component-wise, e.g. p + q == (p.x + q.x, p.y + q.y)

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<T> MulAssign<T> for Point3d<T>

where T: MulAssign<T> + Copy,

Applies an arithmetic operation to each component, e.g. p * 3 = (p.x * 3, p.y * 3)

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl<T: PartialEq> PartialEq for Point3d<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T> Serialize for Point3d<T>

where T: Serialize,

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> StructuralPartialEq for Point3d<T>

impl<T> Sub for Point3d<T>

where T: Sub<Output = T>,

Arithmetic between two points happens component-wise, e.g. p + q == (p.x + q.x, p.y + q.y)

type Output = Point3d<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign for Point3d<T>

where T: SubAssign<T>,

Arithmetic between two points happens component-wise, e.g. p + q == (p.x + q.x, p.y + q.y)

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl<T> TS for Point3d<T>

where T: TS,

type WithoutGenerics = Point3d<Dummy>

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = Point3d<T>

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.