Struct Chunk 

pub struct Chunk {
    pub layer_masks: Vec<TextureResource>,
    /* private fields */
}

Chunk is smaller block of a terrain. Terrain can have as many chunks as you need, which always arranged in a grid. You can add chunks from any side of a terrain. Chunks could be considered as a “sub-terrain”, which could use its own set of materials for layers. This could be useful for different biomes, to prevent high amount of layers which could harm the performance.

Fields

layer_masks: Vec<TextureResource>

Layer blending masks of the chunk.

Implementations

impl Chunk

pub const HEIGHTMAP: &'static str = "heightmap"

impl Chunk

pub fn height_data(&self) -> ChunkHeightData<'_>

Return a view of the height data as a 2D array of f32.

pub fn create_margin(&mut self)

Modify the height texture of the chunk to give it a one pixel margin around all four edges. The Chunk::height_map_size is increased to match. The margin is initialized to zero.

pub fn update(&self)

Check the heightmap for modifications and update data as necessary.

pub fn local_position(&self) -> Vector2<f32>

Returns position of the chunk in local 2D coordinates relative to origin of the terrain.

pub fn position(&self) -> Vector3<f32>

The position of the chunk within the terrain based on its grid_position and physical_size.

pub fn grid_position(&self) -> Vector2<i32>

The 2D position of the chunk within the chunk array.

pub fn heightmap(&self) -> &TextureResource

Returns a reference to height map.

pub fn set_height_map( &mut self, height_map: Option<TextureResource>, ) -> Option<TextureResource>

Sets new height map to the chunk. Tries to create a copy of the given texture and convert the copy into R32F format. If the conversion is successful, the resulting texture becomes the source for height data of this chunk and the new texture is returned. If the conversion fails, the argument texture is returned in its original format and the chunk is not modified.

Failure can happen if:

• The given texture is None.
• The given texture is not in the Ok state.
• The given texture is not TextureKind::Rectangle.
• The width or height is incorrect due to not matching height_map_size.
• The texture’s format is not one of the many formats that this method is capable of converting as identified by its Texture::pixel_kind.

pub fn heightmap_owned(&self) -> Vec<f32>

Returns the height map of the terrain as an array of f32s.

pub fn replace_height_map( &mut self, heightmap: TextureResource, ) -> Result<(), TextureResource>

Replaces the current height map with a new one. New height map must be equal with size of current.

pub fn hole_mask(&self) -> Option<&TextureResource>

Returns a reference to hole mask texture, if one exists.

pub fn physical_size(&self) -> Vector2<f32>

Returns the size of the chunk in meters.

pub fn height_map_size(&self) -> Vector2<u32>

Returns amount of pixels in the height map along each dimension.

pub fn hole_mask_size(&self) -> Vector2<u32>

Returns amount of pixels in the hole mask along each dimension.

pub fn debug_draw( &self, transform: &Matrix4<f32>, ctx: &mut SceneDrawingContext, )

Performs debug drawing of the chunk. It draws internal quad-tree structure for debugging purposes.

pub fn update_quad_tree(&self)

Recalculates the quad tree for this chunk.

Trait Implementations

impl Clone for Chunk

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Chunk

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

Formats the value using the given formatter.

impl Default for Chunk

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Chunk

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Reflect for Chunk

where Self: 'static, Option<TextureResource>: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

fn into_any(self: Box<Self>) -> Box<dyn Any>

fn set( &mut self, value: Box<dyn Reflect>, ) -> Result<Box<dyn Reflect>, Box<dyn Reflect>>

fn set_field( &mut self, name: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_any(&self, func: &mut dyn FnMut(&dyn Any))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut dyn Any))

fn as_reflect(&self, func: &mut dyn FnMut(&dyn Reflect))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut dyn Reflect))

fn fields(&self, func: &mut dyn FnMut(&[&dyn Reflect]))

fn fields_mut(&mut self, func: &mut dyn FnMut(&mut [&mut dyn Reflect]))

fn field(&self, name: &str, func: &mut dyn FnMut(Option<&dyn Reflect>))

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut dyn Reflect>), )

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl TypeUuidProvider for Chunk

fn type_uuid() -> Uuid

Return type UUID.

impl Visit for Chunk

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

Read or write this value, depending on whether Visitor::is_reading() is true or false.