MarchingCubes

Struct MarchingCubes 

Source
pub struct MarchingCubes { /* private fields */ }
Expand description

A struct representing the Marching Cubes algorithm.

The Marching Cubes algorithm is used to extract a triangular mesh representation of a three-dimensional surface from a scalar field.

§Examples

use iso::{MarchingCubes, GridCell, Triangle};

let grid = GridCell {
    positions: [
        [0.0, 0.0, 0.0],
        [1.0, 0.0, 0.0],
        [1.0, 1.0, 0.0],
        [0.0, 1.0, 0.0],
        [0.0, 0.0, 1.0],
        [1.0, 0.0, 1.0],
        [1.0, 1.0, 1.0],
        [0.0, 1.0, 1.0]
    ],
    value: [0.0, 0.5, 0.5, 1.0, 0.0, 1.0, 1.0, 0.0],
};

let isolevel = 0.5;
let mc = MarchingCubes::new(isolevel, grid);
let mut triangles = vec![];
let triangle_count = mc.polygonise(&mut triangles);

assert_eq!(triangle_count, 4);

Implementations§

Source§

impl MarchingCubes

Source

pub fn new(iso_value: f32, grid: GridCell) -> Self

Creates a new instance of the MarchingCubes struct.

§Parameters
  • iso_value: A float value representing the isolevel to use when determining which parts of the grid cell are inside and outside the surface.
  • grid: A GridCell struct representing the cell to be polygonised. It contains the positions of the cell’s vertices and their values.
§Returns

A new instance of the MarchingCubes struct.

Source

pub fn polygonise(self, triangles: &mut [Triangle]) -> i32

Polygonises a grid cell based on the stored isolevel, populating the given triangles slice with the resulting triangles. Look at polygonise for more information regarding this function.

§Parameters
  • triangles: A mutable slice of Triangle structs to be filled with the resulting triangles.
§Returns

The number of triangles generated, as an i32.

Trait Implementations§

Source§

impl Clone for MarchingCubes

Source§

fn clone(&self) -> MarchingCubes

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MarchingCubes

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for MarchingCubes

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.