This is the documentation for Enlighten.

class Enlighten IPrecompInputProbeRegion

class Enlighten::IPrecompInputProbeRegion

    └>Geo::IGeoSerialisable
        └>Geo::IGeoReleasable

Represents a region of 3D space voxelized at various resolutions.

Functions

Name Description
AddBoxes(ProbeOctreeResolution, const Geo::GeoBoundingBox *, Geo::s32)

Extend by the specified array of boxes.

AddPoints(ProbeOctreeResolution, const Geo::v128 *, Geo::s32)

Extend by the specified array of points.

AddVolume(ProbeOctreeResolution, const IPrecompVolumeQuery &)

Extend by the specified volume.

Create()

Create a new empty IPrecompInputProbeRegion.

Create(float)

Create a new IPrecompInputProbeRegion that represents a region of 3D space with voxels of the specified size.

Load(IGeoInputStream &, Geo::u32)

Load an instance of this class from an IGeoInputStream.

Release()

Free this object that was created within the Enlighten libraries.

Save(IGeoStream &, Geo::u32)

Save an instance of this class to an IGeoStream.


virtual void Enlighten::IPrecompInputProbeRegion::AddBoxes


public: void AddBoxes
(
    ProbeOctreeResolution resolution,
    const Geo::GeoBoundingBox * boxes,
    Geo::s32 count
)


Extend by the specified array of boxes.

Parameters
[in] resolution

The desired resolution.

[in] boxes

An array of boxes for which probes will be placed.

[in] count

Number of boxes in the boxes array.


virtual void Enlighten::IPrecompInputProbeRegion::AddPoints


public: void AddPoints
(
    ProbeOctreeResolution resolution,
    const Geo::v128 * points,
    Geo::s32 count
)


Extend by the specified array of points.

Parameters
[in] resolution

The desired resolution.

[in] points

An array of points for which probes will be placed at the specified resolution.

[in] count

Number of points in the points array.


virtual void Enlighten::IPrecompInputProbeRegion::AddVolume


public: void AddVolume
(
    ProbeOctreeResolution resolution,
    const IPrecompVolumeQuery & query
)


Extend by the specified volume.

Parameters
[in] resolution

The desired resolution.

[in] query

An implementation of IPrecompVolumeQuery which represents the desired volume. Note: object lifetime must be at least the duration of this method call.


static IPrecompInputProbeRegion* Enlighten::IPrecompInputProbeRegion::Create


public: IPrecompInputProbeRegion * Create()


Create a new empty IPrecompInputProbeRegion.


static IPrecompInputProbeRegion* Enlighten::IPrecompInputProbeRegion::Create


public: IPrecompInputProbeRegion * Create
(
    float voxelSize
)


Create a new IPrecompInputProbeRegion that represents a region of 3D space with voxels of the specified size.

Parameters
[in] voxelSize

The size of the smallest possible voxel used to represent the region of 3D space.


virtual bool Geo::IGeoSerialisable::Load


public: bool Load
(
    IGeoInputStream & stream,
    Geo::u32 section
)


Load an instance of this class from an IGeoInputStream.

The stream must be ready to read from. You can load sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will load all sections. It is also safe to call this method on an object multiple times with different section arguments to load multiple parts.


virtual void Geo::IGeoReleasable::Release


public: void Release()


Free this object that was created within the Enlighten libraries.

Expect this to behave in a similar way to calling 'delete(this)'


virtual bool Geo::IGeoSerialisable::Save


public: bool Save
(
    IGeoStream & stream,
    Geo::u32 section
) const


Save an instance of this class to an IGeoStream.

The stream must be ready to write to. You can save sections of an object by passing a bitmask representing the desired sections rather than Iff::AllSectionsMask, which will save all sections that are available.