This is the documentation for Enlighten.

class Enlighten OctreeSearchResult

class Enlighten::OctreeSearchResult

Result of an octree search.

Functions

Name Description
GetIndex()

Returns the zero-based index of the node in the linear array, for visibility look-up.

GetOctant()

Returns the octant index, for visibility look-up.

GetPosition()

Returns the position within the node, specified in node-space [0, 1].

GetProbe(Geo::u32)

Returns the probe at the specified corner of the node.

GetResolution()

Returns the resolution assigned to the node.

OctreeSearchResult(const Geo::u32 *, Geo::v128, Geo::s32, Geo::s32, Geo::s32, bool)

Constructor.


Geo::s32 Enlighten::OctreeSearchResult::GetIndex


public: Geo::s32 GetIndex() const


Returns the zero-based index of the node in the linear array, for visibility look-up.


Geo::s32 Enlighten::OctreeSearchResult::GetOctant


public: Geo::s32 GetOctant() const


Returns the octant index, for visibility look-up.


Geo::v128 Enlighten::OctreeSearchResult::GetPosition


public: Geo::v128 GetPosition() const


Returns the position within the node, specified in node-space [0, 1].


Geo::u32 Enlighten::OctreeSearchResult::GetProbe


public: Geo::u32 GetProbe
(
    Geo::u32 i
) const


Returns the probe at the specified corner of the node.


Geo::s32 Enlighten::OctreeSearchResult::GetResolution


public: Geo::s32 GetResolution() const


Returns the resolution assigned to the node.


Enlighten::OctreeSearchResult::OctreeSearchResult


public: OctreeSearchResult
(
    const Geo::u32 * probes,
    Geo::v128 position,
    Geo::s32 index,
    Geo::s32 octant,
    Geo::s32 resolution,
    bool isRoot
)


Constructor.