class Enlighten IPrecompInputProbeSet

This is the documentation for Enlighten.

class Enlighten IPrecompInputProbeSet

class Enlighten::IPrecompInputProbeSet

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

A class representing a set of sample points for which the run-time can generate spherical harmonic representations of the diffuse light incident on each sample point.

Functions

Name

Description

Name

Description

Create()

Create a new empty IPrecompInputProbeSet.

Create(const IPrecompInputProbeSet *const *, Geo::s32)

Create a new octree IPrecompInputProbeSet as a union of the specified octree probe set objects.

GetBoundingBoxBasisX()

Get the first basis vector of the non-axis aligned bounding box.

GetBoundingBoxBasisY()

Get the second basis vector of the non-axis aligned bounding box.

GetBoundingBoxBasisZ()

Get the third basis vector of the non-axis aligned bounding box.

GetBoundingBoxOrigin()

Get the origin of the non-axis aligned bounding box.

GetBuildParameters()

Edit the build parameters for this probe set.

GetBuildParameters()

Read only access to the build parameters for this probe set.

GetId()

Return the unique ID of this light probe set.

GetName()

Get the full name.

GetNumProbes()

Return the number of probes contained in this probe set.

GetProbePositions()

Access the light probe positions.

GetRegularGridResolutionX()

Get the resolution of the regular grid in the direction of the first bounding box basis vector.

GetRegularGridResolutionY()

Get the resolution of the regular grid in the direction of the second bounding box basis vector.

GetRegularGridResolutionZ()

Get the resolution of the regular grid in the direction of the third bounding box basis vector.

IsOctree()

Returns true if this probe set was generated for a probe octree.

IsRegularGrid()

Returns if this probe set is a probe grid.

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.

SetId(Geo::GeoGuid)

Set the unique ID of this light probe set.

SetName(const char *)

Set a globally unique name.

SetProbePositions(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 *, const Geo::v128 *)

Copy light probe position values between [begin, end) into this object.

SetRandomProbePositions(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::s32, const Geo::s32 &)

Create an random set of light probes within a non axis aligned bounding box.

SetRegularGridProbePositions(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::v128 &, const Geo::s32, const Geo::s32, const Geo::s32)

Create light probes based on a regular grid.



static IPrecompInputProbeSet* Enlighten::IPrecompInputProbeSet::Create


public: IPrecompInputProbeSet * Create()


Create a new empty IPrecompInputProbeSet.



static IPrecompInputProbeSet* Enlighten::IPrecompInputProbeSet::Create


public: IPrecompInputProbeSet * Create
(
    const IPrecompInputProbeSet *const * others,
    Geo::s32 count
)