Nearby chunks 3x3x3 group container. More...

#include <cluster.hpp>

Classes
struct	Position
	Cluster 3D position container. More...

Public Types
typedef C	Chunk
typedef V	Voxel

Public Member Functions
	Cluster3D (Chunk *chunks[size]=nullptr) noexcept
	Creates a new chunk 3x3x3 cluster.
Chunk *	getChunks () noexcept
	Returns cluster chunk array.
const Chunk *	getChunks () const noexcept
	Returns constant cluster chunk array.
bool	isComplete () const noexcept
	Are all cluster chunks not null.
Chunk *	getCentralChunk () const noexcept
	Returns cluster central chunk. (It can be null).
Chunk *	getChunk (uint8_t x, uint8_t y, uint8_t z) const noexcept
	Returns cluster chunk at specified 3D position. (It can be null).
Chunk *	getChunk (uint8_t index) const noexcept
	Returns cluster chunk at specified array index. (It can be null).
Chunk *	tryGetChunk (uint8_t x, uint8_t y, uint8_t z) const noexcept
	Returns cluster chunk at specified 3D position. (It can be null).
Chunk *	tryGetChunk (uint8_t index) const noexcept
	Returns cluster chunk at specified array index. (It can be null).
Chunk *	unsafeGetChunk (uint8_t x, uint8_t y, uint8_t z) const noexcept
	Returns cluster chunk at specified 3D position. (It can be null).
Chunk *	unsafeGetChunk (uint8_t index) const noexcept
	Returns cluster chunk at specified array index. (It can be null).
Chunk *	getVoxelChunk (int16_t &x, int16_t &y, int16_t &z) const noexcept
	Returns cluster chunk at specified voxel 3D position relative to the central chunk.
Chunk *	tryGetVoxelChunk (int16_t &x, int16_t &y, int16_t &z) const noexcept
	Returns cluster chunk at specified voxel 3D position relative to the central chunk.
Chunk *	unsafeGetVoxelChunk (int16_t &x, int16_t &y, int16_t &z) const noexcept
	Returns cluster chunk at specified voxel 3D position relative to the central chunk.
Voxel	getVoxel (int16_t x, int16_t y, int16_t z, Voxel nullVoxel=voxel::null) const noexcept
	Returns voxel at specified 3D position relative to the central chunk.
void	setVoxel (uint16_t x, uint16_t y, uint16_t z, Voxel voxel) noexcept
	Sets voxel at specified 3D position relative to the central chunk.
bool	tryGetVoxel (int16_t x, int16_t y, int16_t z, Voxel &voxel) const noexcept
	Returns voxel at specified 3D position relative to the central chunk.
bool	trySetVoxel (uint16_t x, uint16_t y, uint16_t z, Voxel voxel) noexcept
	Sets voxel at specified 3D position relative to the central chunk.
Voxel	unsafeGetVoxel (int16_t x, int16_t y, int16_t z, Voxel nullVoxel=voxel::null) const noexcept
	Returns voxel at specified 3D position relative to the central chunk.

Static Public Member Functions
static constexpr uint8_t	posToIndex (uint8_t x, uint8_t y, uint8_t z) noexcept
	Calculates cluster chunk index from the 3D position.
template<typename T>
static constexpr void	indexToPos (uint8_t index, uint8_t &x, uint8_t &y, uint8_t &z) noexcept
	Calculates cluster chunk 3D position from the index.

Static Public Attributes
static constexpr uint8_t	length = 3
static constexpr uint8_t	layerSize = 9
static constexpr uint8_t	size = 27
static constexpr Position	positions [size]
	Cluster 3D positions 3x3x3.
static constexpr uint8_t	centralIndex = posToIndex(1, 1, 1)
	Central cluster chunk index.

Protected Attributes
Chunk *	chunks [size]

Detailed Description

template<class C, typename V>
struct voxy::Cluster3D< C, V >

Nearby chunks 3x3x3 group container.

Template Parameters

C	cluster chunk type
V	chunk voxel ID type

Member Typedef Documentation

◆ Chunk

template<class C, typename V>

typedef C Chunk

Cluster chunk type.

◆ Voxel

template<class C, typename V>

typedef V Voxel

Chunk voxel ID type.

Constructor & Destructor Documentation

◆ Cluster3D()

template<class C, typename V>

Cluster3D ( Chunk * chunks[size] = nullptr )

inlinenoexcept

Creates a new chunk 3x3x3 cluster.

Parameters

chunks target cluster chunk array or null

Member Function Documentation

◆ posToIndex()

template<class C, typename V>

constexpr uint8_t posToIndex	(	uint8_t	x,
		uint8_t	y,
		uint8_t	z )

inlinestaticconstexprnoexcept

Calculates cluster chunk index from the 3D position.

Parameters

x	chunk position along X-axis
y	chunk position along Y-axis
z	chunk position along Z-axis

◆ indexToPos()

template<class C, typename V>

template<typename T>

constexpr void indexToPos	(	uint8_t	index,
		uint8_t &	x,
		uint8_t &	y,
		uint8_t &	z )

inlinestaticconstexprnoexcept

Calculates cluster chunk 3D position from the index.

Parameters

	index	chunk index inside the chunk
[out]	x	chunk position along X-axis
[out]	y	chunk position along Y-axis
[out]	z	chunk position along Z-axis

◆ getChunk() [1/2]

template<class C, typename V>

Chunk * getChunk	(	uint8_t	x,
		uint8_t	y,
		uint8_t	z ) const

inlinenoexcept

Returns cluster chunk at specified 3D position. (It can be null).

Note: Use with care, it doesn't checks for out of cluster bounds!

Parameters

x	chunk position along X-axis
y	chunk position along Y-axis
z	chunk position along Z-axis

◆ getChunk() [2/2]

template<class C, typename V>

Chunk * getChunk ( uint8_t index ) const

inlinenoexcept

Returns cluster chunk at specified array index. (It can be null).

Note: Use with care, it doesn't checks for out of array bounds!

Parameters

index target chunk index inside array

◆ tryGetChunk() [1/2]

template<class C, typename V>

Chunk * tryGetChunk	(	uint8_t	x,
		uint8_t	y,
		uint8_t	z ) const

inlinenoexcept

Returns cluster chunk at specified 3D position. (It can be null).

Parameters

x	chunk position along X-axis
y	chunk position along Y-axis
z	chunk position along Z-axis

Returns: Chunk instance if 3D position is inside array bounds.

◆ tryGetChunk() [2/2]

template<class C, typename V>

Chunk * tryGetChunk ( uint8_t index ) const

inlinenoexcept

Returns cluster chunk at specified array index. (It can be null).

Parameters

index target chunk index inside array

Returns: Chunk instance if index is inside array bounds.

◆ unsafeGetChunk() [1/2]

template<class C, typename V>

Chunk * unsafeGetChunk	(	uint8_t	x,
		uint8_t	y,
		uint8_t	z ) const

inlinenoexcept

Returns cluster chunk at specified 3D position. (It can be null).

Warning: Skips out of bounds check in Debug and Release builds!

Parameters

x	chunk position along X-axis
y	chunk position along Y-axis
z	chunk position along Z-axis

◆ unsafeGetChunk() [2/2]

template<class C, typename V>

Chunk * unsafeGetChunk ( uint8_t index ) const

inlinenoexcept

Returns cluster chunk at specified array index. (It can be null).

Warning: Skips out of bounds check in Debug and Release builds!

Parameters

index target chunk index inside array

◆ getVoxelChunk()

template<class C, typename V>

Chunk * getVoxelChunk	(	int16_t &	x,
		int16_t &	y,
		int16_t &	z ) const

inlinenoexcept

Returns cluster chunk at specified voxel 3D position relative to the central chunk.

Note: Use with care, it doesn't checks for out of cluster bounds!

Parameters

[in,out]	x	voxel position along X-axis (Relative to the central chunk)
[in,out]	y	voxel position along Y-axis (Relative to the central chunk)
[in,out]	z	voxel position along Z-axis (Relative to the central chunk)

Returns: Target voxel chunk and sets local x/y/z if it is not null.

◆ tryGetVoxelChunk()

template<class C, typename V>

Chunk * tryGetVoxelChunk	(	int16_t &	x,
		int16_t &	y,
		int16_t &	z ) const

inlinenoexcept

Returns cluster chunk at specified voxel 3D position relative to the central chunk.

Parameters

[in,out]	x	voxel position along X-axis (Relative to the central chunk)
[in,out]	y	voxel position along Y-axis (Relative to the central chunk)
[in,out]	z	voxel position along Z-axis (Relative to the central chunk)

Returns: Target voxel chunk and sets local x/y/z if it is not null.

◆ unsafeGetVoxelChunk()

template<class C, typename V>

Chunk * unsafeGetVoxelChunk	(	int16_t &	x,
		int16_t &	y,
		int16_t &	z ) const

inlinenoexcept

Returns cluster chunk at specified voxel 3D position relative to the central chunk.

Warning: Skips out of bounds check in Debug and Release builds!

Parameters

[in,out]	x	voxel position along X-axis (Relative to the central chunk)
[in,out]	y	voxel position along Y-axis (Relative to the central chunk)
[in,out]	z	voxel position along Z-axis (Relative to the central chunk)

Returns: Target voxel chunk and sets local x/y/z if it is not null.

◆ getVoxel()

template<class C, typename V>

Voxel getVoxel	(	int16_t	x,
		int16_t	y,
		int16_t	z,
		Voxel	nullVoxel = voxel::null ) const

inlinenoexcept

Returns voxel at specified 3D position relative to the central chunk.

Note: Use with care, it doesn't checks for out of cluster bounds!

Parameters

x	voxel position along X-axis (Relative to the central chunk)
y	voxel position along Y-axis (Relative to the central chunk)
z	voxel position along Z-axis (Relative to the central chunk)
nullVoxel	voxel ID returned if chunk instance is null

Returns: Voxel at specified 3D position, or null if target chunk is null.

◆ setVoxel()

template<class C, typename V>

void setVoxel	(	uint16_t	x,
		uint16_t	y,
		uint16_t	z,
		Voxel	voxel )

inlinenoexcept

Sets voxel at specified 3D position relative to the central chunk.

Note: Use with care, it doesn't checks for out of cluster bounds!

Parameters

x	voxel position along X-axis
y	voxel position along Y-axis
z	voxel position along Z-axis
voxel	target voxel ID

◆ tryGetVoxel()

template<class C, typename V>

bool tryGetVoxel	(	int16_t	x,
		int16_t	y,
		int16_t	z,
		Voxel &	voxel ) const

inlinenoexcept

Returns voxel at specified 3D position relative to the central chunk.

Parameters

	x	voxel position along X-axis (Relative to the central chunk)
	y	voxel position along Y-axis (Relative to the central chunk)
	z	voxel position along Z-axis (Relative to the central chunk)
[out]	voxel	target voxel ID on success

Returns: True if specified 3D position is inside array bounds and chunk is not null.

◆ trySetVoxel()

template<class C, typename V>

bool trySetVoxel	(	uint16_t	x,
		uint16_t	y,
		uint16_t	z,
		Voxel	voxel )

inlinenoexcept

Sets voxel at specified 3D position relative to the central chunk.

Parameters

x	voxel position along X-axis
y	voxel position along Y-axis
z	voxel position along Z-axis
voxel	target voxel ID

Returns: True if specified 3D position is inside array bounds and chunk is not null.

◆ unsafeGetVoxel()

template<class C, typename V>

Voxel unsafeGetVoxel	(	int16_t	x,
		int16_t	y,
		int16_t	z,
		Voxel	nullVoxel = voxel::null ) const

inlinenoexcept

Returns voxel at specified 3D position relative to the central chunk.

Warning: Skips out of bounds check in Debug and Release builds!

Parameters

x	voxel position along X-axis (Relative to the central chunk)
y	voxel position along Y-axis (Relative to the central chunk)
z	voxel position along Z-axis (Relative to the central chunk)
nullVoxel	voxel ID returned if chunk instance is null

Returns: Voxel at specified 3D position, or null if target chunk is null.

Member Data Documentation

◆ length

template<class C, typename V>

uint8_t length = 3

staticconstexpr

Cluster length in chunks.

◆ layerSize

template<class C, typename V>

uint8_t layerSize = 9

staticconstexpr

Cluster layer size in chunks. (length ^ 2)

◆ size

template<class C, typename V>

uint8_t size = 27

staticconstexpr

Cluster size in chunks. (length ^ 3)

◆ positions

template<class C, typename V>

Position positions[size]

staticconstexpr

Initial value:

= 
    {
        Position(-1, -1, -1), Position( 0, -1, -1), Position( 1, -1, -1), 
        Position(-1,  0, -1), Position( 0,  0, -1), Position( 1,  0, -1), 
        Position(-1,  1, -1), Position( 0,  1, -1), Position( 1,  1, -1), 
        Position(-1, -1,  0), Position( 0, -1,  0), Position( 1, -1,  0), 
        Position(-1,  0,  0), Position( 0,  0,  0), Position( 1,  0,  0), 
        Position(-1,  1,  0), Position( 0,  1,  0), Position( 1,  1,  0), 
        Position(-1, -1,  1), Position( 0, -1,  1), Position( 1, -1,  1), 
        Position(-1,  0,  1), Position( 0,  0,  1), Position( 1,  0,  1), 
        Position(-1,  1,  1), Position( 0,  1,  1), Position( 1,  1,  1)
    }

Cluster 3D positions 3x3x3.

◆ chunks

template<class C, typename V>

Chunk* chunks[size]

protected

Cluster chunk array.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Chunk

◆ Voxel

Constructor & Destructor Documentation

◆ Cluster3D()

Member Function Documentation

◆ posToIndex()

◆ indexToPos()

◆ getChunk() [1/2]

◆ getChunk() [2/2]

◆ tryGetChunk() [1/2]

◆ tryGetChunk() [2/2]

◆ unsafeGetChunk() [1/2]

◆ unsafeGetChunk() [2/2]

◆ getVoxelChunk()

◆ tryGetVoxelChunk()

◆ unsafeGetVoxelChunk()

◆ getVoxel()

◆ setVoxel()

◆ tryGetVoxel()

◆ trySetVoxel()

◆ unsafeGetVoxel()

Member Data Documentation

◆ length

◆ layerSize

◆ size

◆ positions

◆ chunks