This is the documentation for Enlighten.

class Enlighten ExporterScene

class Enlighten::ExporterScene

The scene to be exported.

Typedefs

Name Description
Geo::GeoArray< Geo::GeoFileString > Dependencies

Array of dependencies.

Geo::GeoArray< Geo::GeoFileString > InstanceNames

An array of instance names.

Functions

Name Description
AddCubemap(const ExporterCubemap &)

Add a cubemap to the scene.

AddGeom(const ExporterGeom &)

Add the geom to the scene.

AddInstance(const PipelineRadiosityInstance &)

Add a radiosity instance to the scene.

AddInstance(const PipelineExcludedInstance &)

Add an excluded instance to the scene.

AddInstanceParameters(const ExporterInstanceParameters &)

Add a named set of instance parameters to the scene.

AddProbeOctreeBoxes(Geo::GeoFileString, ProbeOctreeResolution, const Geo::GeoBoundingBox *, Geo::s32)

Add a region defined by an array of boxes to the specified probe octree.

AddProbeOctreePoints(Geo::GeoFileString, ProbeOctreeResolution, const Geo::v128 *, Geo::s32)

Add a region defined by an array of points to the specified probe octree.

AddProbeOctreeVolume(Geo::GeoFileString, ProbeOctreeResolution, const IPrecompVolumeQuery &)

Add a region defined by a volume to the specified probe octree.

AddProbeVolume(const ExporterProbeVolume &)

Adds a probe volume to the scene.

AddRadiosityDependencies(PipelineRadiosityGroupType, Geo::GeoFileString, const Dependencies &, const Dependencies &)

Adds a dependency set.

DumpDebugScene(const Geo::GeoFileString &)

Dump the entire scene to a single text file for debug and test purposes.

ExporterScene(ExporterPaths, const ExporterGlobalParameters &)

Constructor.

GetInstanceNames(const Geo::GeoFileString &)

Return the names of the instances within the specified group.

WriteScene(Geo::IGeoProgressProxy &)

Write the Enlighten scene to disk.


void Enlighten::ExporterScene::AddCubemap


public: void AddCubemap
(
    const ExporterCubemap & cubemap
)


Add a cubemap to the scene.


void Enlighten::ExporterScene::AddGeom


public: void AddGeom
(
    const ExporterGeom & geom
)


Add the geom to the scene.


void Enlighten::ExporterScene::AddInstance


public: void AddInstance
(
    const PipelineRadiosityInstance & instance
)


Add a radiosity instance to the scene.


void Enlighten::ExporterScene::AddInstance


public: void AddInstance
(
    const PipelineExcludedInstance & instance
)


Add an excluded instance to the scene.


void Enlighten::ExporterScene::AddInstanceParameters


public: void AddInstanceParameters
(
    const ExporterInstanceParameters & parameters
)


Add a named set of instance parameters to the scene.


void Enlighten::ExporterScene::AddProbeOctreeBoxes


public: void AddProbeOctreeBoxes
(
    Geo::GeoFileString octreeName,
    ProbeOctreeResolution resolution,
    const Geo::GeoBoundingBox * boxes,
    Geo::s32 count
)


Add a region defined by an array of boxes to the specified probe octree.


void Enlighten::ExporterScene::AddProbeOctreePoints


public: void AddProbeOctreePoints
(
    Geo::GeoFileString octreeName,
    ProbeOctreeResolution resolution,
    const Geo::v128 * points,
    Geo::s32 count
)


Add a region defined by an array of points to the specified probe octree.


void Enlighten::ExporterScene::AddProbeOctreeVolume


public: void AddProbeOctreeVolume
(
    Geo::GeoFileString octreeName,
    ProbeOctreeResolution resolution,
    const IPrecompVolumeQuery & query
)


Add a region defined by a volume to the specified probe octree.


void Enlighten::ExporterScene::AddProbeVolume


public: void AddProbeVolume
(
    const ExporterProbeVolume & probeVolume
)


Adds a probe volume to the scene.


void Enlighten::ExporterScene::AddRadiosityDependencies


public: void AddRadiosityDependencies
(
    PipelineRadiosityGroupType type,
    Geo::GeoFileString groupName,
    const Dependencies & dependencies,
    const Dependencies & explicitDependencies
)


Adds a dependency set.


void Enlighten::ExporterScene::DumpDebugScene


public: void DumpDebugScene
(
    const Geo::GeoFileString & filename
) const


Dump the entire scene to a single text file for debug and test purposes.


Enlighten::ExporterScene::ExporterScene


public: ExporterScene
(
    ExporterPaths paths,
    const ExporterGlobalParameters & global
)


Constructor.


const InstanceNames& Enlighten::ExporterScene::GetInstanceNames


public: const InstanceNames & GetInstanceNames
(
    const Geo::GeoFileString & group
) const


Return the names of the instances within the specified group.

The instances are listed in the order that they were added to the scene. Use IPrecompPackedInstance::GetInstanceId to index this array.


bool Enlighten::ExporterScene::WriteScene


public: bool WriteScene
(
    Geo::IGeoProgressProxy & progressProxy
) const


Write the Enlighten scene to disk.