se::OctantBase Class Reference

The base class of all octants (se::Node and se::Block) in an se::Octree. More...

#include <octant.hpp>

Inheritance diagram for se::OctantBase:

Public Member Functions
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
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.

Protected Member Functions
	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

The base class of all octants (se::Node and se::Block) in an se::Octree.

Constructor & Destructor Documentation

OctantBase()

se::OctantBase::OctantBase ( const Eigen::Vector3i &  coord, const bool  is_block, OctantBase *const  parent_ptr  )

inlineprotected

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).

When constructing the root octant of an se::Octree, parent_ptr must be null.

Member Function Documentation

parent() [1/2]

OctantBase * se::OctantBase::parent ( )

inline

Return the pointer to the octant's parent.

The parent pointer of the root octant is null.

parent() [2/2]

const OctantBase * se::OctantBase::parent ( ) const

inline

Const version of se::OctantBase::parent().

isLeaf()

bool se::OctantBase::isLeaf ( ) const

inline

Return whether the octant is a leaf, that is, whether it has no children.

Member Data Documentation

coord

const Eigen::Vector3i se::OctantBase::coord

The coordinates in voxels of the octant's vertex closest to the origin.

timestamp

timestamp_t se::OctantBase::timestamp

The time the octant was last updated at.

child_mask

std::uint8_t se::OctantBase::child_mask

The i-th least significant bit of the mask must be set if the i-th child of the octant is allocated.

is_block

const bool se::OctantBase::is_block

Whether the octant is an se::Block.

---

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

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