transvoxel 0.1.0

Implementation of Eric Lengyel's Transvoxel Algorithm
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

/*!
Main mesh extraction methods
*/
use super::implementation::algorithm::Extractor;
use super::structs::*;
use super::{
    density::*,
    voxel_source::{VoxelSource, WorldMappingVoxelSource},
};
use crate::transition_sides::TransitionSides;

/**
Extracts an iso-surface [Mesh] for a [VoxelSource]

Arguments:
 * `source`: the density source
 * `block`: the world zone for which to extract, and its subdivisions count
 * `threshold`: density value defining the iso-surface
 * `transition_sides`: the set of sides of the block which need to be adapted to neighbour double-resolution blocks (twice the subdivisions)
*/
pub fn extract<D, S>(
    source: S,
    block: &Block,
    threshold: D,
    transition_sides: TransitionSides,
) -> Mesh
where
    D: Density,
    S: VoxelSource<D>,
{
    Extractor::new(source, block, threshold, transition_sides).extract()
}

/**
Extracts an iso-surface [Mesh] for a [ScalarField]

Arguments:
 * `field`: the density field
 * `block`: the world zone for which to extract, and its subdivisions count
 * `threshold`: density value defining the iso-surface
 * `transition_sides`: the set of sides of the block which need to be adapted to neighbour double-resolution blocks (twice the subdivisions)
*/
pub fn extract_from_field<D, F>(
    field: F,
    block: &Block,
    threshold: D,
    transition_sides: TransitionSides,
) -> Mesh
where
    D: Density,
    F: ScalarField<D>,
{
    let mut source = WorldMappingVoxelSource { field, block };
    Extractor::new(&mut source, block, threshold, transition_sides).extract()
}

/**
Extracts an iso-surface [Mesh] for a [ScalarField]-compatible closure

Arguments:
 * `f`: the closure providing world densities
 * `block`: the world zone for which to extract, and its subdivisions count
 * `threshold`: density value defining the iso-surface
 * `transition_sides`: the set of sides of the block which need to be adapted to neighbour double-resolution blocks (twice the subdivisions)
*/
pub fn extract_from_fn<D, F>(
    f: F,
    block: &Block,
    threshold: D,
    transition_sides: TransitionSides,
) -> Mesh
where
    D: Density,
    F: FnMut(f32, f32, f32) -> D,
{
    let field = ScalarFieldForFn(f);
    let mut source = WorldMappingVoxelSource { field, block };
    Extractor::new(&mut source, block, threshold, transition_sides).extract()
}