└>Enlighten::IProbeSetManager

Probe Set Manager Voxel class Implementation of the IProbeSetManager interface class This implementation is based on a voxel grid acceleration data structure.

The scene is being voxelised, for each voxel we store an array of probe sets that intersect that voxel. Then at run time for a given point we can retrieve the voxel this point is in, and therefore all the probe sets that may be needed for interpolation.

To assign probe sets to voxels we do not need any run time data for the probe sets. Only their geometrical properties are needed (bounding box, resolution). At run time ProbeSetManagerVoxel keeps track (via MarkProbeSetAsLoaded and MarkProbeSetAsUnLoaded methods) of which probe sets have their run time data loaded, and uses only those ones for interpolation.

During interpolation each probe sets gets a weight (based on where it is in relation to the query point), that maximum weight that a given probe set can get is limited by the MaxWeight that can be set using SetMaxWeightForProbeSet method. This mechanism allows for LOD switching (given probe set can has its maximum weight gradually decreased to 0 and when it reaches 0 it can be unloaded and a different LOD probe set loaded)

public: std::size_t CalculateInternalMemoryRequirement
(
    Geo::v128 voxelSize,
    float maxVolumeThreshold,
    RadProbeSetMetaData const *const * probeSets,
    Geo::u16 numProbeSets
)

Method to calculate the upper limit on memory needed by the Probe Set Manager.

The upper limit on memory needed to initialise the Probe Set Manager.

public: Geo::GeoNonAABoundingBox ConstructExpandedNonAABBVolume
(
    Enlighten::RadProbeSetMetaData const & volumeMetaData
) const

Return an expanded bounding volume constructed from given meta data.

expanded bounding volume of the probe set

protected: bool FindIndexIntoProbeSetPropsArray
(
    Geo::GeoGuid guid,
    Geo::u16 & index
) const

For a given Probe Set guid, find an index into m_ProbeSetProps array.

Since m_ProbeSetProbs is sorted by the Probe Set guids, so this is a OLog(n) operation.

TRUE if the Probe Set Manager is initialised and the Probe Set with guid is under its management, FALSE otherwise.

public: void * GetInternalMemory() const

Get the internal memory storage.

the internal memory storage.

public: Enlighten::InterpolationInputSet const * GetInterpolationInputSet
(
    Geo::u32 index
) const

Get an interpolation set that corresponds to given index - this index needs to be comaptible with ProbeInterpolant::m_ProbeSetIndex filled by the GetProbeInterpolants(...) method.

May return NULL is Probe Set that corresponds to index is unloaded. Note, however that none of the ProbeInterpolant::m_ProbeSetIndex indices returned from GetProbeInterpolants(...) should correspond to an unloaded Probe Sets.

The InterpolationI Input Set for a given index or NULL if that Probe Set in unloaded.

public: virtual Enlighten::InterpolationInputSet const * GetInterpolationInputSet
(
    Geo::u32 index
) const

Get an interpolation set that corresponds to given index.

This index is comaptible with ProbeInterpolant::m_ProbeSetIndex

InterpolationInputSet that corresponds to the given index. Can be NULL if the probe set for that index is not loaded. Note that none of the probe set indices returned from GetProbeInterpolants will correspond to unloaded probe sets.

public: Enlighten::InterpolationInputSet const * GetInterpolationInputSet
(
    Geo::GeoGuid guid
) const

Get an interpolation set that corresponds to given guid.

Needs to perform a search. Scales as Log(N) [N - num of probe sets)

InterpolationInputSet that corresponds to the given guid. Can be NULL if the probe set for that guid is not loaded.

public: virtual bool GetMaxWeightForProbeSet
(
    Geo::GeoGuid const & probeSet,
    float & maxWeight
) const

Get the maximum weight for a given Probe Set.

TRUE if the input to this function is valid, Probe Set Manager is initialised and the probeSet probe set is under Probe Set Manager management, otherwise FALSE.

public: bool GetMaxWeightForProbeSet
(
    Geo::GeoGuid const & probeSet,
    float & maxWeight
) const

Set a maximum interpolation weight for the given Probe Set.

. Needs to perform a search OLog(N). Where N is number of probe sets under management.

TRUE if the Probe Set is under ProbeSetManager management, otherwise FALSE.

public: ProbeSetProps const & GetNotVoxelisedProbeSetProps
(
    Geo::s32 index
) const

Get the ProbeSetProps for a given not voxelised Probe Set.

The index used here is an index to m_NotVoxelisedProbeSetPropsIndices array which in turn holds indices to m_ProbeSetProps. This index is NOT compatible with what is being returned from GetProbeInterpolants in ProbeInterpolant::m_ProbeSetIndex.

ProbeSetProps for the requested not voxelised Probe Set index.

public: Geo::u16 GetNumNotVoxelisedProbeSets() const

Some of the Probe Sets may be too big to undergo full voxelisation (i.e.

voxelising them would produce too many voxels. Those probe sets are stored in an additional array. This method returns the number of those not voxelised volumes. If for a given point in space no voxel in the m_Voxels can be found, then not voxelised probe sets should be used for interpolation. If however a voxel is found, then there is no need to check the not voxelised sets as the Voxel::m_ProbeSetPropsIndices contains not voxelised volumes too.

Number of not voxelised Probe Sets.

public: virtual Geo::s32 GetNumProbeSets() const

Return the total (both voxelised and not voxelised) probe sets that are under management.

total number of probe sets under management.

public: Geo::s32 GetNumProbeSets() const

Get the total number of Probe Sets under management.

the total number of Probe Sets under management.

public: Geo::s32 GetNumVoxels() const

Get the total number of occupied voxels.

Number of occupied voxels.

public: virtual bool GetProbeInterpolants
(
    Geo::v128 const & point,
    ProbeInterpolant * interpolants,
    Geo::s32 numMaxInterpolants,
    Geo::s32 & numUsedInterpolants
) const

Retrieves the probes interpolants for a given point.