Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

class Enlighten::IPrecompInputProbeRegion

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

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

Functions

NameDescription
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.

AddSolid(ProbeOctreeResolution, const Geo::Matrix &, Geo::StridedArrayView< PrecompIndex3 >, Geo::StridedArrayView< Geo::GeoPoint3 >)

Extend by the volume of the specified closed triangle mesh.

AddSurface(ProbeOctreeResolution, const Geo::Matrix &, Geo::StridedArrayView< PrecompIndex3 >, Geo::StridedArrayView< Geo::GeoPoint3 >)

Extend by the surface of the specified triangle mesh.

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.

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.


Anchor
a3f6f31f317b249f163334e713f556e0f
a3f6f31f317b249f163334e713f556e0f

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.


Anchor
ab5ec459a2341dbe24941336cfd54512a
ab5ec459a2341dbe24941336cfd54512a

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.


Anchor
a99a75777e7a4f2e6efe47a8d70a6bd69
a99a75777e7a4f2e6efe47a8d70a6bd69

virtual void Enlighten::IPrecompInputProbeRegion::AddSolid

...

public: void AddSolid
(
    ProbeOctreeResolution resolution,
    const Geo::Matrix & transform,
    Geo::StridedArrayView< PrecompIndex3 > faces,
    Geo::StridedArrayView< Geo::GeoPoint3 > vertices
)

...

Extend by the volume of the specified closed triangle mesh.

Each edge must be adjacent to exactly two faces.

Parameters
[in]resolution

The desired resolution.

[in]transform

The transform to apply to each vertex of the mesh.

[in]faces

An array of triangles which index into the vertex array.

[in]vertices

An array which contains all vertices in the mesh.


Anchor
adbd4e386d696b66a66b2be04f5c75d53
adbd4e386d696b66a66b2be04f5c75d53

virtual void Enlighten::IPrecompInputProbeRegion::AddSurface

...

public: void AddSurface
(
    ProbeOctreeResolution resolution,
    const Geo::Matrix & transform,
    Geo::StridedArrayView< PrecompIndex3 > faces,
    Geo::StridedArrayView< Geo::GeoPoint3 > vertices
)

...

Extend by the surface of the specified triangle mesh.

Parameters
[in]resolution

The desired resolution.

[in]transform

The transform to apply to each vertex of the mesh.

[in]faces

An array of triangles which index into the vertex array.

[in]vertices

An array which contains all vertices in the mesh.


Anchor
afb4c0e5e0805bcefe49484ca85e5b9a5
afb4c0e5e0805bcefe49484ca85e5b9a5

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.


Anchor
a7fd444fd336468c29c994ce098240811
a7fd444fd336468c29c994ce098240811

static IPrecompInputProbeRegion* Enlighten::IPrecompInputProbeRegion::Create

...

public: IPrecompInputProbeRegion * Create()

...

Create a new empty IPrecompInputProbeRegion.


Anchor
a74d0aea88b8ab7974511939ca1846b7d
a74d0aea88b8ab7974511939ca1846b7d

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.


Anchor
ae5fb810c8f4470cb3c9fcb16c6f7f7fe
ae5fb810c8f4470cb3c9fcb16c6f7f7fe

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
adaed81b4c59f263dcb4e78c4126f4683
adaed81b4c59f263dcb4e78c4126f4683

Geo::NonCopyable::NonCopyable

...

public: NonCopyable
(
    NonCopyable &&
)

...

Defaulted to allow move.


Anchor
a6abc781e23b8f4864e0b868806e0acbf
a6abc781e23b8f4864e0b868806e0acbf

NonCopyable& Geo::NonCopyable::operator=

...

public: NonCopyable & operator=
(
    NonCopyable &&
)

...

Defaulted to allow move.


Anchor
af6bdf30b42adde386c428e9dc2821eb9
af6bdf30b42adde386c428e9dc2821eb9

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
a5b03439626a3dac9b9c27feb1a3978d3
a5b03439626a3dac9b9c27feb1a3978d3

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.