This is the documentation for Enlighten.

class Enlighten OctreeBuilder

class Enlighten::OctreeBuilder

Builds an octree.

Functions

Name Description
CalculateVoxelBox(const PrecompVoxelOctreePath)

bounding box of the voxel

CalculateVoxelBox(const PrecompVoxelId)

bounding box of the voxel

Compute(const PrecompOutputSystem *const *, const Geo::s32)

builds the octree and subdivides it, testing against geometry

GetAllNodes()

all octree nodes at all depths

GetBoundingBox()

octree bounding box

GetDepth()

octree depth

GetLeafNodes()

octree leaf nodes

GetName()

Gets the name.

GetRootNode()

octree root node

GetVoxelNode(const PrecompVoxelId)

check if voxel is a leaf node in the octree

GetVoxelSize()

voxel size of the octree

Initialise(const Geo::GeoNonAABoundingBox &, const float)

initialise the octree builder

SetName(const char *)

Sets the name.


Geo::GeoNonAABoundingBox Enlighten::OctreeBuilder::CalculateVoxelBox


public: Geo::GeoNonAABoundingBox CalculateVoxelBox
(
    const PrecompVoxelOctreePath path
) const


bounding box of the voxel


Geo::GeoNonAABoundingBox Enlighten::OctreeBuilder::CalculateVoxelBox


public: Geo::GeoNonAABoundingBox CalculateVoxelBox
(
    const PrecompVoxelId voxelId
) const


bounding box of the voxel


bool Enlighten::OctreeBuilder::Compute


public: bool Compute
(
    const PrecompOutputSystem *const * systems,
    const Geo::s32 numSystems
)


builds the octree and subdivides it, testing against geometry


const Geo::GeoArray<OctreeNode*>& Enlighten::OctreeBuilder::GetAllNodes


public: const Geo::GeoArray< OctreeNode * > & GetAllNodes() const


all octree nodes at all depths


Geo::GeoNonAABoundingBox Enlighten::OctreeBuilder::GetBoundingBox


public: Geo::GeoNonAABoundingBox GetBoundingBox() const


octree bounding box


Geo::u32 Enlighten::OctreeBuilder::GetDepth


public: Geo::u32 GetDepth() const


octree depth


const Geo::GeoArray<OctreeNode*>& Enlighten::OctreeBuilder::GetLeafNodes


public: const Geo::GeoArray< OctreeNode * > & GetLeafNodes() const


octree leaf nodes


const char* Enlighten::OctreeBuilder::GetName


public: const char * GetName() const


Gets the name.


const OctreeNode* Enlighten::OctreeBuilder::GetRootNode


public: const OctreeNode * GetRootNode() const


octree root node


OctreeNode* Enlighten::OctreeBuilder::GetVoxelNode


public: OctreeNode * GetVoxelNode
(
    const PrecompVoxelId voxelId
) const


check if voxel is a leaf node in the octree


float Enlighten::OctreeBuilder::GetVoxelSize


public: float GetVoxelSize() const


voxel size of the octree


bool Enlighten::OctreeBuilder::Initialise


public: bool Initialise
(
    const Geo::GeoNonAABoundingBox & volumeBox,
    const float voxelSize
)


initialise the octree builder


void Enlighten::OctreeBuilder::SetName


public: void SetName
(
    const char * name
)


Sets the name.