Ocean
Ocean::Geometry::OctreeT< T >::Parameters Class Reference

This class stores construction parameters for an octree. More...

Public Member Functions

 Parameters ()=default
 Default constructor. More...
 
 Parameters (const unsigned int maximalPointsPerLeaf, const bool useTightBoundingBoxes)
 Creates a new parameter object. More...
 
bool isValid () const
 Returns whether this object holds valid parameters. More...
 

Data Fields

unsigned int maximalPointsPerLeaf_ = 40u
 The maximal number of points each leaf node can have. More...
 
bool useTightBoundingBoxes_ = true
 True, to use tight bounding boxes for each individual node (only covering the actual points); False, to use bisected bounding boxes of the bounding box of the previous node. More...
 

Detailed Description

template<typename T>
class Ocean::Geometry::OctreeT< T >::Parameters

This class stores construction parameters for an octree.

Constructor & Destructor Documentation

◆ Parameters() [1/2]

template<typename T >
Ocean::Geometry::OctreeT< T >::Parameters::Parameters ( )
default

Default constructor.

◆ Parameters() [2/2]

template<typename T >
Ocean::Geometry::OctreeT< T >::Parameters::Parameters ( const unsigned int  maximalPointsPerLeaf,
const bool  useTightBoundingBoxes 
)
inline

Creates a new parameter object.

Parameters
maximalPointsPerLeafThe maximal number of points each leaf node can have, with range [1, infinity)
useTightBoundingBoxesTrue, to use tight bounding boxes for each individual node (only covering the actual points); False, to use bisected bounding boxes of the bounding box of the previous node

Member Function Documentation

◆ isValid()

template<typename T >
bool Ocean::Geometry::OctreeT< T >::Parameters::isValid
inline

Returns whether this object holds valid parameters.

Returns
True, if so

Field Documentation

◆ maximalPointsPerLeaf_

template<typename T >
unsigned int Ocean::Geometry::OctreeT< T >::Parameters::maximalPointsPerLeaf_ = 40u

The maximal number of points each leaf node can have.

◆ useTightBoundingBoxes_

template<typename T >
bool Ocean::Geometry::OctreeT< T >::Parameters::useTightBoundingBoxes_ = true

True, to use tight bounding boxes for each individual node (only covering the actual points); False, to use bisected bounding boxes of the bounding box of the previous node.


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