class Enlighten::IPrecompInputProbeOctree

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

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

Variables

Name	Description
const float WaterPlaneInvalid	Represents an unspecified water plane.

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 IPrecompInputProbeRegion const , Geo::s32, float)	Create a new IPrecompInputProbeOctree that represents the specified regions.
Create(const IPrecompInputProbeRegion const , Geo::s32, float, const PrecompMeshProbeRegion &, const PrecompMeshProbeRegion &, WorldAxis, float)	Create a new IPrecompInputProbeOctree that represents the specified regions.
Create(const IPrecompInputProbeRegion const , Geo::s32, float, WorldAxis, float)	Create a new IPrecompInputProbeOctree that represents the specified regions.
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.
NonCopyable(NonCopyable &&)	Defaulted to allow move.
operator=(NonCopyable &&)	Defaulted to allow move.
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 IPrecompInputProbeRegion *const * regions,
Geo::s32 regionCount,
float voxelSize
)

Create a new IPrecompInputProbeOctree that represents the specified regions.

Parameters

[in]	regions	The regions to include in the volume. Note: object lifetime must be at least the duration of this function call.
[in]	regionCount	The number of entries in the regions array.
[in]	voxelSize	The size of the smallest possible voxel used to represent the region of 3D space.

static IPrecompInputProbeOctree* Enlighten::IPrecompInputProbeOctree::Create

public: IPrecompInputProbeOctree * Create
(
const IPrecompInputProbeRegion *const * regions,
Geo::s32 regionCount,
float voxelSize,
const PrecompMeshProbeRegion & surfaceRegion,
const PrecompMeshProbeRegion & terrainRegion,
WorldAxis verticalAxis,
float waterPlane
)

Create a new IPrecompInputProbeOctree that represents the specified regions.

Parameters

[in]	regions	The regions to include in the volume. Note: object lifetime must be at least the duration of this function call.
[in]	regionCount	The number of entries in the regions array.
[in]	voxelSize	The size of the smallest possible voxel used to represent the region of 3D space.
[in]	surfaceRegion	The surfaces to include in the volume
[in]	terrainRegion	The terrains to include in the volume.
[in]	verticalAxis	The axis aligned vector pointing directly upwards.
[in]	waterPlane	If the value is not WaterPlaneInvalid, probes are placed for terrain only above the plane defined by this distance and the vertical axis.

static IPrecompInputProbeOctree* Enlighten::IPrecompInputProbeOctree::Create

public: IPrecompInputProbeOctree * Create
(
const IPrecompInputProbeRegion *const * regions,
Geo::s32 regionCount,
float voxelSize,
WorldAxis verticalAxis,
float waterPlane
)

Create a new IPrecompInputProbeOctree that represents the specified regions.

Parameters

[in]	regions	The regions to include in the volume. Note: object lifetime must be at least the duration of this function call.
[in]	regionCount	The number of entries in the regions array.
[in]	voxelSize	The size of the smallest possible voxel used to represent the region of 3D space.
[in]	verticalAxis	The axis aligned vector pointing directly upwards.
[in]	waterPlane	If the value is not WaterPlaneInvalid, probes are placed for terrain only above the plane defined by this distance and the vertical axis.

virtual IPrecompProbeSetBuildParameters* Enlighten::IPrecompInputProbeOctree::GetBuildParameters

public: IPrecompProbeSetBuildParameters * GetBuildParameters()

Edit the build parameters for this probe octree.

virtual const IPrecompProbeSetBuildParameters* Enlighten::IPrecompInputProbeOctree::GetBuildParameters

public: const IPrecompProbeSetBuildParameters * GetBuildParameters() const

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

virtual const char* Enlighten::IPrecompInputProbeOctree::GetName

public: const char * GetName() const

Get the full name.

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.

Geo::NonCopyable::NonCopyable

public: NonCopyable
(
NonCopyable &&
)

Defaulted to allow move.

NonCopyable& Geo::NonCopyable::operator=

public: NonCopyable & operator=
(
NonCopyable &&
)

Defaulted to allow move.

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.

virtual void Enlighten::IPrecompInputProbeOctree::SetName

public: void SetName
(
const char * name
)

Set a globally unique name.