This is the documentation for Enlighten.
class Enlighten PrecompOctreeProbeKey
- geosw (Unlicensed)
class Enlighten::PrecompOctreeProbeKey
  └>Enlighten::PrecompVoxelId
Provides an ordering of probe voxel positions by their depth within the octree.
Functions
| Name | Description |
|---|---|
| Depth() | Gets the depth. |
| PrecompOctreeProbeKey(const PrecompVoxelId &) | Constructor. |
| PrecompOctreeProbeKey(const PrecompVoxelId &, Geo::u32) | Constructor. |
| PrecompVoxelId() | Constructors. |
| PrecompVoxelId(const Geo::s32, const Geo::s32, const Geo::s32) | Constructors. |
| Priority() | Gets the priority. |
| Voxel() | Gets the voxel. |
Friends
| Name | Description |
|---|---|
| friend bool operator!=(const PrecompOctreeProbeKey &l, const PrecompOctreeProbeKey &r) | Returns true if the keys are not equal. |
| friend bool operator<(const PrecompOctreeProbeKey &l, const PrecompOctreeProbeKey &r) | Returns true if the left argument is ordered before the right argument. |
| friend bool operator==(const PrecompOctreeProbeKey &l, const PrecompOctreeProbeKey &r) | Returns true if the keys are equal. |
| friend void WriteObject(Writer &writer, const PrecompVoxelId &object) | Write to any type compatible with IffWriter. |
Variables
| Name | Description |
|---|---|
| Geo::s32 x | Voxel co-ordinates. |
| Geo::s32 y | Voxel co-ordinates. |
| Geo::s32 z | Voxel co-ordinates. |
Geo::u32 Enlighten::PrecompOctreeProbeKey::Depth
public: Geo::u32 Depth() const
Gets the depth.
Enlighten::PrecompOctreeProbeKey::PrecompOctreeProbeKey
public: PrecompOctreeProbeKey
(
  const PrecompVoxelId & voxel
)
Constructor.
Enlighten::PrecompOctreeProbeKey::PrecompOctreeProbeKey
public: PrecompOctreeProbeKey
(
  const PrecompVoxelId & voxel,
  Geo::u32 priority
)
Constructor.
Enlighten::PrecompVoxelId::PrecompVoxelId
public: PrecompVoxelId()
Constructors.
Enlighten::PrecompVoxelId::PrecompVoxelId
public: PrecompVoxelId
(
  const Geo::s32 x,
  const Geo::s32 y,
  const Geo::s32 z
)
Constructors.
Geo::u32 Enlighten::PrecompOctreeProbeKey::Priority
public: Geo::u32 Priority() const
Gets the priority.
const PrecompVoxelId& Enlighten::PrecompOctreeProbeKey::Voxel
public: const PrecompVoxelId & Voxel() const
Gets the voxel.