core::VectorOctree Class Reference

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

#include <VectorOctree.h>

Public Member Functions
	VectorOctree (const OctreeVectors &vectors, double voxelSize, const Vector3d &minAABB, const Vector3d &maxAABB)
	Construct a new VectorOctree object. More...
	~VectorOctree ()
	Destroy the VectorOctree object. More...
const core::Vector3ui &	getVolumeDimensions () const
	Get the volume dimensions 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 VectorOctree. More...
uint32_t	getOctreeDepth () const
	Get the depth of the VectorOctree. More...
const uint32_ts &	getFlatIndices () const
	Get a flattened representation of the VectorOctree indices. More...
const floats &	getFlatData () const
	Get a flattened representation of the VectorOctree data (node values) More...

Detailed Description

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

Definition at line 37 of file VectorOctree.h.

Constructor & Destructor Documentation

VectorOctree()

core::VectorOctree::VectorOctree	(	const OctreeVectors &	vectors,
		double	voxelSize,
		const Vector3d &	minAABB,
		const Vector3d &	maxAABB
	)

Construct a new VectorOctree object.

Parameters

events	Events used to build the tree. Events 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 VectorOctree.cpp.

~VectorOctree()

core::VectorOctree::~VectorOctree

(

)

Destroy the VectorOctree object.

Definition at line 147 of file VectorOctree.cpp.

Member Function Documentation

getFlatData()

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

inline

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

Returns

A flattened representation of the VectorOctree data (node values)

Definition at line 97 of file VectorOctree.h.

getFlatIndices()

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

inline

Get a flattened representation of the VectorOctree indices.

Returns

A flattened representation of the VectorOctree indices

Definition at line 90 of file VectorOctree.h.

getOctreeDepth()

uint32_t core::VectorOctree::getOctreeDepth ( ) const

inline

Get the depth of the VectorOctree.

Returns

The depth of the VectorOctree

Definition at line 83 of file VectorOctree.h.

getOctreeSize()

uint32_t core::VectorOctree::getOctreeSize ( ) const

inline

Get the size of the VectorOctree.

Returns

The size of the VectorOctree

Definition at line 76 of file VectorOctree.h.

getVolumeDimensions()

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

inline

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

Returns

The dimensions of the volume

Definition at line 62 of file VectorOctree.h.

getVolumeSize()

uint32_t core::VectorOctree::getVolumeSize ( ) const

inline

Get the size of the volume.

Returns

The size of the volume

Definition at line 69 of file VectorOctree.h.

---

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

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