class Enlighten IPrecompInputProbeOctree

This is the documentation for Enlighten.

class Enlighten IPrecompInputProbeOctree

class Enlighten::IPrecompInputProbeOctree

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

Represents a region of 3D space within which sets of probe positions are adaptively generated.

Functions

Name

Description

Name

Description

Create()

Create a new empty IPrecompInputProbeOctree.

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

Create a new IPrecompInputProbeOctree that represents the specified regions.

Create(const IPrecompVolumeQuery &, float)

Create a new IPrecompInputProbeOctree that represents the specified volume with voxels of the specified size.

Create(float, const PrecompInputOctreeVolume *, Geo::s32, const PrecompInputOctreePointSet *, Geo::s32, const PrecompInputOctreeBoxSet *, Geo::s32)

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

GetBuildParameters()

Edit the build parameters for this probe octree.

GetBuildParameters()

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

GetName()

Get the full name.

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.

SetName(const char *)

Set a globally unique name.



static IPrecompInputProbeOctree* Enlighten::IPrecompInputProbeOctree::Create


public: IPrecompInputProbeOctree * Create()


Create a new empty IPrecompInputProbeOctree.



static IPrecompInputProbeOctree* Enlighten::IPrecompInputProbeOctree::Create


public: IPrecompInputProbeOctree * Create
(
    const IPrecompInputProbeRegion *const * regions,
    Geo::s32 count
)


Create a new IPrecompInputProbeOctree that represents the specified regions.

 

Parameters

[in]

regions

The regions which combined represent the desired volume. Note: object lifetime must be at least the duration of this function call.

[in]

count

The number of entries in the regions array.

 



static IPrecompInputProbeOctree* Enlighten::IPrecompInputProbeOctree::Create


public: IPrecompInputProbeOctree * Create
(
    const IPrecompVolumeQuery & volume,
    float voxelSize
)