core::PointOctree Class Reference

The PointOctree class implements the PointOctree acceleration structure used by the FieldsRenderer class to render magnetic fields. More...

#include <PointOctree.h>

Public Member Functions
	PointOctree (const OctreePoints &points, double voxelSize, const Vector3f &minAABB, const Vector3f &maxAABB)
	Construct a new PointOctree object. More...
	~PointOctree ()
	Destroy the PointOctree object. More...
const Vector3ui &	getVolumeDimensions () const
	Get the volume dimentions defined by the scene and the voxel sizes. More...
uint32_t	getVolumeSize () const
	Get the size of the volume. More...
uint32_t	getOctreeSize () const
	Get the size of the PointOctree. More...
uint32_t	getOctreeDepth () const
	Get the depth of the PointOctree. More...
const uint32_ts &	getFlatIndices () const
	Get a flattened representation of the PointOctree indices. More...
const floats &	getFlatData () const
	Get a flattened representation of the PointOctree data (node values) More...

Detailed Description

The PointOctree class implements the PointOctree acceleration structure used by the FieldsRenderer class to render magnetic fields.

Definition at line 37 of file PointOctree.h.

Constructor & Destructor Documentation

PointOctree()

core::PointOctree::PointOctree	(	const OctreePoints &	points,
		double	voxelSize,
		const Vector3f &	minAABB,
		const Vector3f &	maxAABB
	)

Construct a new PointOctree object.

Parameters

points	Points used to build the tree. Points contain x, y, z coordinates, as well as a radius, and a value
voxelSize	Voxel size
minAABB	Lower bound of the scene bounding box
maxAABB	Upper bound of the scene bounding box

Definition at line 33 of file PointOctree.cpp.

~PointOctree()

core::PointOctree::~PointOctree

(

)

Destroy the PointOctree object.

Definition at line 145 of file PointOctree.cpp.

Member Function Documentation

getFlatData()

const floats& core::PointOctree::getFlatData ( ) const

inline

Get a flattened representation of the PointOctree data (node values)

Returns

A flattened representation of the PointOctree data (node values)

Definition at line 97 of file PointOctree.h.

getFlatIndices()

const uint32_ts& core::PointOctree::getFlatIndices ( ) const

inline

Get a flattened representation of the PointOctree indices.

Returns

A flattened representation of the PointOctree indices

Definition at line 90 of file PointOctree.h.

getOctreeDepth()

uint32_t core::PointOctree::getOctreeDepth ( ) const

inline

Get the depth of the PointOctree.

Returns

The depth of the PointOctree

Definition at line 83 of file PointOctree.h.

getOctreeSize()

uint32_t core::PointOctree::getOctreeSize ( ) const

inline

Get the size of the PointOctree.

Returns

The size of the PointOctree

Definition at line 76 of file PointOctree.h.

getVolumeDimensions()

const Vector3ui& core::PointOctree::getVolumeDimensions ( ) const

inline

Get the volume dimentions defined by the scene and the voxel sizes.

Returns

The dimensions of the volume

Definition at line 62 of file PointOctree.h.

getVolumeSize()

uint32_t core::PointOctree::getVolumeSize ( ) const

inline

Get the size of the volume.

Returns

The size of the volume

Definition at line 69 of file PointOctree.h.

---

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

• platform/core/common/octree/PointOctree.h
• platform/core/common/octree/PointOctree.cpp