se::Block< DataT, ResT, BlockSize > Class Template Reference

A leaf node of an se::Octree. More...

#include <block.hpp>

Inheritance diagram for se::Block< DataT, ResT, BlockSize >:

Collaboration diagram for se::Block< DataT, ResT, BlockSize >:

Public Types
typedef DataT	DataType

Public Member Functions
	Block (Node< DataT, ResT > *parent_ptr, const int child_idx, const DataT init_data)
	Construct the child block of parent_ptr with index child_idx and initialize its data at the coarsest scale with init_data.
Public Member Functions inherited from se::OctantBase
OctantBase *	parent ()
	Return the pointer to the octant's parent.
const OctantBase *	parent () const
	Const version of se::OctantBase::parent().
bool	isLeaf () const
	Return whether the octant is a leaf, that is, whether it has no children.

Public Attributes
	EIGEN_MAKE_ALIGNED_OPERATOR_NEW
Public Attributes inherited from se::OctantBase
const Eigen::Vector3i	coord
	The coordinates in voxels of the octant's vertex closest to the origin.
timestamp_t	timestamp
	The time the octant was last updated at.
std::uint8_t	child_mask
	The i-th least significant bit of the mask must be set if the i-th child of the octant is allocated.
const bool	is_block
	Whether the octant is an se::Block.

Static Public Attributes
static constexpr int	size = BlockSize
	The edge length of the block in voxels.
static constexpr int	size_sq = math::sq(BlockSize)
	The face area of the block in voxels.
static constexpr int	size_cu = math::cu(BlockSize)
	The volume of the block in voxels.

Additional Inherited Members
Protected Member Functions inherited from se::OctantBase
	OctantBase (const Eigen::Vector3i &coord, const bool is_block, OctantBase *const parent_ptr)
	Construct an octant given the non-negative coordinates in voxels of its vertex closest to the origin (coord), whether it's an se::Block (is_block) and the pointer to its parent octant (parent_ptr).

Detailed Description

template<typename DataT, Res ResT, int BlockSize>
class se::Block< DataT, ResT, BlockSize >

A leaf node of an se::Octree.

Template Parameters

DataT	The type of data stored in the octree.
ResT	The value of se::Res for the octree.
BlockSize	The edge length of se::Block in voxels.

Member Typedef Documentation

DataType

template<typename DataT , Res ResT, int BlockSize>

typedef DataT se::Block< DataT, ResT, BlockSize >::DataType

Constructor & Destructor Documentation

Block()

template<typename DataT , Res ResT, int BlockSize>

se::Block< DataT, ResT, BlockSize >::Block	(	Node< DataT, ResT > *	parent_ptr,
		const int	child_idx,
		const DataT	init_data
	)

Construct the child block of parent_ptr with index child_idx and initialize its data at the coarsest scale with init_data.

The value of child_idx must be in the interval [0, 7] inclusive.

Member Data Documentation

size

template<typename DataT , Res ResT, int BlockSize>

constexpr int se::Block< DataT, ResT, BlockSize >::size = BlockSize

staticconstexpr

The edge length of the block in voxels.

size_sq

template<typename DataT , Res ResT, int BlockSize>

constexpr int se::Block< DataT, ResT, BlockSize >::size_sq = math::sq(BlockSize)

staticconstexpr

The face area of the block in voxels.

size_cu

template<typename DataT , Res ResT, int BlockSize>

constexpr int se::Block< DataT, ResT, BlockSize >::size_cu = math::cu(BlockSize)

staticconstexpr

The volume of the block in voxels.

EIGEN_MAKE_ALIGNED_OPERATOR_NEW

template<typename DataT , Res ResT, int BlockSize>

se::Block< DataT, ResT, BlockSize >::EIGEN_MAKE_ALIGNED_OPERATOR_NEW

---

The documentation for this class was generated from the following file:

• include/se/map/octant/block.hpp