Enum fj_kernel::geometry::path::GlobalPath

pub enum GlobalPath {
    Circle(Circle<3>),
    Line(Line<3>),
}

A path through global (3D) space

Variants

Circle(Circle<3>)

A circle

Line(Line<3>)

A line

Implementations

impl GlobalPath

pub fn x_axis() -> Self

Construct a GlobalPath that represents the x-axis

Examples found in repository

src/objects/stores.rs (line 115)

    fn default() -> Self {
        let mut store: Store<Surface> = Store::new();

        let xy_plane = store.reserve();
        store.insert(
            xy_plane.clone(),
            Surface::new(SurfaceGeometry {
                u: GlobalPath::x_axis(),
                v: Vector::unit_y(),
            }),
        );

        let xz_plane = store.reserve();
        store.insert(
            xz_plane.clone(),
            Surface::new(SurfaceGeometry {
                u: GlobalPath::x_axis(),
                v: Vector::unit_z(),
            }),
        );
        let yz_plane = store.reserve();
        store.insert(
            yz_plane.clone(),
            Surface::new(SurfaceGeometry {
                u: GlobalPath::y_axis(),
                v: Vector::unit_z(),
            }),
        );

        Self {
            store,
            xy_plane,
            xz_plane,
            yz_plane,
        }
    }

pub fn y_axis() -> Self

Construct a GlobalPath that represents the y-axis

Examples found in repository

src/objects/stores.rs (line 132)

    fn default() -> Self {
        let mut store: Store<Surface> = Store::new();

        let xy_plane = store.reserve();
        store.insert(
            xy_plane.clone(),
            Surface::new(SurfaceGeometry {
                u: GlobalPath::x_axis(),
                v: Vector::unit_y(),
            }),
        );

        let xz_plane = store.reserve();
        store.insert(
            xz_plane.clone(),
            Surface::new(SurfaceGeometry {
                u: GlobalPath::x_axis(),
                v: Vector::unit_z(),
            }),
        );
        let yz_plane = store.reserve();
        store.insert(
            yz_plane.clone(),
            Surface::new(SurfaceGeometry {
                u: GlobalPath::y_axis(),
                v: Vector::unit_z(),
            }),
        );

        Self {
            store,
            xy_plane,
            xz_plane,
            yz_plane,
        }
    }

pub fn z_axis() -> Self

Construct a GlobalPath that represents the z-axis

pub fn circle_from_radius(radius: impl Into<Scalar>) -> Self

Build a circle from the given radius

pub fn line_from_points(
    points: [impl Into<Point<3>>; 2]
) -> (Self, [Point<1>; 2])

Construct a line from two points

Also returns the coordinates of the points on the path.

Examples found in repository

src/builder/surface.rs (line 33)

    fn plane_from_points(
        points: [impl Into<Point<3>>; 3],
    ) -> (Self, [Point<2>; 3]) {
        let [a, b, c] = points.map(Into::into);

        let (u, u_coords) = GlobalPath::line_from_points([a, b]);
        let v = c - a;

        let coords = {
            let [a, b] = u_coords.map(|point| point.t);
            [[a, Scalar::ZERO], [b, Scalar::ZERO], [a, Scalar::ONE]]
                .map(Point::from)
        };

        (
            Self {
                geometry: Some(SurfaceGeometry { u, v }),
            },
            coords,
        )
    }

pub fn origin(&self) -> Point<3>

Access the origin of the path’s coordinate system

Examples found in repository

src/geometry/surface.rs (line 39)

    fn path_to_line(&self) -> Line<3> {
        Line::from_origin_and_direction(self.u.origin(), self.v)
    }

pub fn point_from_path_coords(&self, point: impl Into<Point<1>>) -> Point<3>

Convert a point on the path into global coordinates

Examples found in repository

src/geometry/surface.rs (line 24)

    pub fn point_from_surface_coords(
        &self,
        point: impl Into<Point<2>>,
    ) -> Point<3> {
        let point = point.into();
        self.u.point_from_path_coords([point.u])
            + self.path_to_line().vector_from_line_coords([point.v])
    }

pub fn vector_from_path_coords(&self, vector: impl Into<Vector<1>>) -> Vector<3>

Convert a vector on the path into global coordinates

Examples found in repository

src/geometry/surface.rs (line 34)

    pub fn vector_from_surface_coords(
        &self,
        vector: impl Into<Vector<2>>,
    ) -> Vector<3> {
        let vector = vector.into();
        self.u.vector_from_path_coords([vector.u])
            + self.path_to_line().vector_from_line_coords([vector.v])
    }

pub fn transform(self, transform: &Transform) -> Self

Transform the path

Examples found in repository

src/geometry/surface.rs (line 45)

    pub fn transform(self, transform: &Transform) -> Self {
        let u = self.u.transform(transform);
        let v = transform.transform_vector(&self.v);
        Self { u, v }
    }

Trait Implementations

impl Clone for GlobalPath

fn clone(&self) -> GlobalPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GlobalPath

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

Formats the value using the given formatter.

impl Hash for GlobalPath

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 Ord for GlobalPath

fn cmp(&self, other: &GlobalPath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<GlobalPath> for GlobalPath

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<GlobalPath> for GlobalPath

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

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

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

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

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

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

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

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

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

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

impl Copy for GlobalPath

impl Eq for GlobalPath

impl StructuralEq for GlobalPath

impl StructuralPartialEq for GlobalPath