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 |
|---|---|
| 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. |
| Anchor | ||||
|---|---|---|---|---|
|
static IPrecompInputProbeOctree* Enlighten::IPrecompInputProbeOctree::Create
...
public: IPrecompInputProbeOctree * Create()
...
Create a new empty IPrecompInputProbeOctree.
| Anchor | ||||
|---|---|---|---|---|
|
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. |
| Anchor | ||||
|---|---|---|---|---|
|
static IPrecompInputProbeOctree* Enlighten::IPrecompInputProbeOctree::Create
...
public: IPrecompInputProbeOctree * Create
(
const IPrecompVolumeQuery & volume,
float voxelSize
)
...
Create a new IPrecompInputProbeOctree that represents the specified volume with voxels of the specified size.
Parameters
| [in] | volume | An implementation of IPrecompVolumeQuery which represents the desired volume. Note: object lifetime must be at least the duration of this function call. |
| [in] | voxelSize | The size of the smallest possible voxel used to represent the volume. |
| Anchor | ||||
|---|---|---|---|---|
|
static IPrecompInputProbeOctree* Enlighten::IPrecompInputProbeOctree::Create
...
public: IPrecompInputProbeOctree * Create
(
float voxelSize,
const PrecompInputOctreeVolume * volumes,
Geo::s32 numVolumes,
const PrecompInputOctreePointSet * pointSets,
Geo::s32 numPointSets,
const PrecompInputOctreeBoxSet * boxSets,
Geo::s32 numBoxSets
)
...
Create a new IPrecompInputProbeOctree that represents the specified 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. |
| [in] | volumes | An array of IPrecompVolumeQuery references which represent the desired region of 3D space. Note: object lifetime must be at least the duration of this function call. |
| [in] | numVolumes | The number of entries in the volumes array. |
| [in] | pointSets | An array of point sets which represent the desired region of 3D space. |
| [in] | numPointSets | The number of entries in the pointSets array. |
| [in] | boxSets | An array of box sets which represent the desired region of 3D space. |
| [in] | numBoxSets | The number of entries in the boxSets array. |
| Anchor | ||||
|---|---|---|---|---|
|
virtual IPrecompProbeSetBuildParameters* Enlighten::IPrecompInputProbeOctree::GetBuildParameters
...
public: IPrecompProbeSetBuildParameters * GetBuildParameters()
...
Edit the build parameters for this probe octree.
| Anchor | ||||
|---|---|---|---|---|
|
virtual const IPrecompProbeSetBuildParameters* Enlighten::IPrecompInputProbeOctree::GetBuildParameters
...
public: const IPrecompProbeSetBuildParameters * GetBuildParameters() const
...
Read only access to the build parameters for this probe octree.
| Anchor | ||||
|---|---|---|---|---|
|
virtual const char* Enlighten::IPrecompInputProbeOctree::GetName
...
public: const char * GetName() const
...
Get the full name.
| Anchor | ||||
|---|---|---|---|---|
|
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.
| Anchor | ||||
|---|---|---|---|---|
|
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)'
| Anchor | ||||
|---|---|---|---|---|
|
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.
| Anchor | ||||
|---|---|---|---|---|
|
virtual void Enlighten::IPrecompInputProbeOctree::SetName
...
public: void SetName
(
const char * name
)
...
Set a globally unique name.