Struct hexasphere::Subdivided

pub struct Subdivided<T, S: BaseShape> { /* private fields */ }

A progressively subdivided shape which can record the indices of the points and list out the individual triangles of the resulting shape.

All base triangles specified by S in BaseShape are expected to be in counter clockwise winding.

Points are preferably stored with coordinates less than or equal to 1.0. This is why all default shapes lie on the unit sphere.

Implementations

impl<T> Subdivided<T, IcoSphereBase>

pub fn radius_shapes(&self) -> f32

Calculate distance from the center of a shape (pentagon or hexagon) to one of the vertices of the shape.

In other words, the radius of the circumscribed circle.

impl<T, S: BaseShape + Default> Subdivided<T, S>

pub fn new(subdivisions: usize, generator: impl FnMut(Vec3A) -> T) -> Self

impl<T, S: BaseShape> Subdivided<T, S>

pub fn new_custom_shape(
    subdivisions: usize,
    generator: impl FnMut(Vec3A) -> T,
    shape: S
) -> Self

Creates the base shape from S and subdivides it.

• subdivisions specifies the number of times a subdivision will be created. In other terms, this is the number of auxiliary points between the vertices on the original shape.

• generator is a function run once all the subdivisions are applied and its values are stored in an internal Vec.

pub fn subdivide(&mut self, calculate: bool)

Subdivides all triangles. calculate signals whether or not to recalculate vertices (To not calculate vertices between many subdivisions).

pub fn raw_points(&self) -> &[Vec3A]

The raw points created by the subdivision process.

pub fn get_indices(&self, triangle: usize, buffer: &mut Vec<u32>)

Appends the indices for the triangle into buffer.

The specified triangle is a main triangle on the base shape. The range of this should be limited to the number of triangles in the base shape.

Alternatively, use get_all_indices to get all the indices.

pub fn get_all_indices(&self) -> Vec<u32>

Gets the indices for all main triangles in the shape.

pub fn get_line_indices(
    &self,
    buffer: &mut Vec<u32>,
    triangle: usize,
    delta: usize,
    breaks: impl FnMut(&mut Vec<u32>)
)

Gets the wireframe indices for the contents of a specified triangle.

delta is added to all of the indices pushed into the buffer, and is generally intended to be used to have a NaN vertex at zero. Set to zero to produce the indices as if there was no NaN vertex.

breaks is run every time there is a necessary break in the line strip. Use this to, for example, swap out the buffer using std::mem::swap, or push a NaN index into the buffer.

pub fn get_major_edge_line_indices(
    &self,
    edge: usize,
    buffer: &mut Vec<u32>,
    delta: usize
)

Gets the wireframe indices for the specified edge of the base shape.

See Self::get_line_indices for more on delta.

pub fn get_all_line_indices(
    &self,
    delta: usize,
    breaks: impl FnMut(&mut Vec<u32>)
) -> Vec<u32>

Gets the wireframe indices for all main triangles in the shape, as well as all edges.

See Self::get_line_indices for more on delta, and breaks.

pub fn subdivisions(&self) -> usize

Returns the number of subdivisions applied when this shape was created.

pub fn raw_data(&self) -> &[T]

Returns the custom data created by the generator function.

pub fn indices_per_main_triangle(&self) -> usize

Calculate the number of indices which each main triangle will add to the vertex buffer.

Equation

(subdivisions + 1)²

pub fn vertices_per_main_triangle_shared(&self) -> usize

Calculate the number of vertices contained within each main triangle including the vertices which are shared with another main triangle.

Equation

(subdivisions + 1) * (subdivisions + 2) / 2

pub fn vertices_per_main_triangle_unique(&self) -> usize

Calculate the number of vertices contained within each main triangle excluding the ones that are shared with other main triangles.

Equation

{
{ subdivisions < 2  : 0
{
{ subdivisions >= 2 : (subdivisions - 1) * subdivisions / 2
{

pub fn shared_vertices(&self) -> usize

Calculate the number of vertices along the edges of the main triangles and the vertices of the main triangles.

Equation

subdivisions * EDGES + INITIAL_POINTS

pub fn linear_distance(&self, p1: u32, p2: u32, radius: f32) -> f32

Linear distance between two points on this shape.

impl<T, S: BaseShape + EquilateralBaseShape> Subdivided<T, S>

pub fn main_triangle_intersect(point: Vec3A) -> usize

Closest “main” triangle.

Undefined results if the point is one of the vertices on the original base shape.

pub fn spherical_distance(&self, p1: u32, p2: u32, radius: f32) -> f32

Distance between two points on this sphere (assuming this is a sphere).