Struct veloren_common::volumes::dyna::Dyna

pub struct Dyna<V, M, A: Access = ColumnAccess> {
    vox: Vec<V>,
    meta: M,
    pub sz: Vec3<u32>,
    _phantom: PhantomData<A>,
}

A volume with dimensions known only at the creation of the object.

Fields

vox: Vec<V>

meta: M

sz: Vec3<u32>

_phantom: PhantomData<A>

Implementations

impl Dyna<Cell, ()>

pub fn from_voxes(data: &[(&DotVoxData, Vec3<i32>, bool)]) -> (Self, Vec3<i32>)

Take a list of voxel data, offsets, and x-mirror flags, and assembled them into a combined segment

pub fn from_vox_model_index( dot_vox_data: &DotVoxData, model_index: usize, ) -> Self

pub fn from_vox( dot_vox_data: &DotVoxData, flipped: bool, model_index: usize, ) -> Self

pub fn map(self, transform: impl Fn(Cell) -> Option<Cell>) -> Self

Transform cells

pub fn map_rgb(self, transform: impl Fn(Rgb<u8>) -> Rgb<u8>) -> Self

Transform cell colors

impl Dyna<MatCell, ()>

pub fn to_segment(&self, map: impl Fn(Material) -> Rgb<u8>) -> Segment

pub fn map(self, transform: impl Fn(MatCell) -> Option<MatCell>) -> Self

Transform cells

pub fn map_rgb(self, transform: impl Fn(Rgb<u8>) -> Rgb<u8>) -> Self

Transform cell colors

pub fn from_vox_model_index( dot_vox_data: &DotVoxData, model_index: usize, ) -> Self

pub fn from_vox( dot_vox_data: &DotVoxData, flipped: bool, model_index: usize, ) -> Self

impl<V, M, A: Access> Dyna<V, M, A>

fn idx_for(sz: Vec3<u32>, pos: Vec3<i32>) -> Option<usize>

Used to transform a voxel position in the volume into its corresponding index in the voxel array.

pub fn map_into<W, F: FnMut(V) -> W>(self, f: F) -> Dyna<W, M, A>

impl<V: Clone, M, A: Access> Dyna<V, M, A>

pub fn filled(sz: Vec3<u32>, vox: V, meta: M) -> Self

Create a new Dyna with the provided dimensions and all voxels filled with duplicates of the provided voxel.

pub fn from_fn<F: FnMut(Vec3<i32>) -> V>(sz: Vec3<u32>, meta: M, f: F) -> Self

Same as Dyna::filled, but with the voxel determined by the function f.

pub fn metadata(&self) -> &M

Get a reference to the internal metadata.

pub fn metadata_mut(&mut self) -> &mut M

Get a mutable reference to the internal metadata.

Trait Implementations

impl<V, M, A: Access> BaseVol for Dyna<V, M, A>

type Error = DynaError

type Vox = V

fn scaled_by(self, scale: Vec3<f32>) -> Scaled<Self>

where Self: Sized,

impl<V: Clone, M: Clone, A: Access> Clone for Dyna<V, M, A>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V: Debug, M: Debug, A: Debug + Access> Debug for Dyna<V, M, A>

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

Formats the value using the given formatter.

impl<'de, V, M, A: Access> Deserialize<'de> for Dyna<V, M, A>

where V: Deserialize<'de>, M: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Dyna<Cell, ()>> for TerrainSegment

fn from(value: Segment) -> Self

Converts to this type from the input type.

impl<'a, V, M, A: Access> IntoPosIterator for &'a Dyna<V, M, A>

type IntoIter = DefaultPosIterator

fn pos_iter( self, lower_bound: Vec3<i32>, upper_bound: Vec3<i32>, ) -> Self::IntoIter

impl<'a, V, M, A: Access> IntoVolIterator<'a> for &'a Dyna<V, M, A>

type IntoIter = DefaultVolIterator<'a, Dyna<V, M, A>>

fn vol_iter( self, lower_bound: Vec3<i32>, upper_bound: Vec3<i32>, ) -> Self::IntoIter

impl<V, M, A: Access> ReadVol for Dyna<V, M, A>

fn get(&self, pos: Vec3<i32>) -> Result<&V, DynaError>

Get a reference to the voxel at the provided position in the volume.

fn get_unchecked(&self, pos: Vec3<i32>) -> &Self::Vox

Get a reference to the voxel at the provided position in the volume. Many volumes provide a fast path, provided the position is always in-bounds. Note that this function is still safe.

fn ray( &self, from: Vec3<f32>, to: Vec3<f32>, ) -> Ray<'_, Self, fn(_: &Self::Vox) -> bool, fn(_: &Self::Vox, _: Vec3<i32>)>

where Self: Sized,

NOTE: By default, this ray will simply run from from to to without stopping. To make something interesting happen, call until or for_each.

impl<V, M, A: Access> Serialize for Dyna<V, M, A>

where V: Serialize, M: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, V, M, A: Access> SizedVol for &'a Dyna<V, M, A>

fn lower_bound(&self) -> Vec3<i32>

Returns the (inclusive) lower bound of the volume.

fn upper_bound(&self) -> Vec3<i32>

Returns the (exclusive) upper bound of the volume.

fn size(&self) -> Vec3<u32>

Returns the size of the volume.

impl<V, M, A: Access> SizedVol for Dyna<V, M, A>

fn lower_bound(&self) -> Vec3<i32>

Returns the (inclusive) lower bound of the volume.

fn upper_bound(&self) -> Vec3<i32>

Returns the (exclusive) upper bound of the volume.

fn size(&self) -> Vec3<u32>

Returns the size of the volume.

impl<V, M, A: Access> WriteVol for Dyna<V, M, A>

fn set( &mut self, pos: Vec3<i32>, vox: Self::Vox, ) -> Result<Self::Vox, DynaError>

Set the voxel at the provided position in the volume to the provided value.