class Enlighten PrecomputePipeline

This is the documentation for Enlighten.

class Enlighten PrecomputePipeline

class Enlighten::PrecomputePipeline

    └>Enlighten::PipelinePaths    └>Enlighten::PipelineScene    └>Enlighten::PrecomputeParameters

Exports the scene and runs the precompute process.

Member functions may assert or throw a PipelineError exception to indicate a violation of the API contract. If you handle the exception, destroy the PrecomputePipeline instance to prevent unexpected behaviour.

Functions

Name

Description

AddCubemap(const PipelineCubemap &)

Add a cubemap to the scene.

AddGeom(const PipelineGeom &)

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 PipelineInstanceParameters &)

Add a named set of instance parameters to the scene.

AddProbeRegion(const PipelineBoxSetProbeRegion &)

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

AddProbeRegion(const PipelinePointSetProbeRegion &)

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

AddProbeRegion(const PipelineVolumeProbeRegion &)

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

AddProbeVolume(const PipelineProbeVolume &)

Adds a probe volume to the scene.

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

Adds a dependency set.

AddRadiosityDependencies(Geo::GeoFileString, const Dependencies &)

Limit the radiosity dependencies of the specified zone to the specified set of zone dependencies.

CancelPrecompute()

Cancel the currently running precompute.

CreateAlbedoBuffer(InputWorkspace *)

Create a runtime object.

CreateDynamicMaterialWorkspace(ClusterAlbedoWorkspaceMaterialData *)

Create a runtime object.

CreateEmissiveBuffer(InputWorkspace *)

Create a runtime object.

DumpDebugScene(const Geo::GeoFileString &)

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

GeomExists(const Geo::GeoFileString &)

Returns true if there is a geometry object associated with the specified name. O(1) complexity.

GetClusterAlbedoMaterialDataFilename(const Geo::GeoFileString &)

Returns the full path to the cluster albedo material data file for the specified system.

GetCubemapCoreFilename(const Geo::GeoFileString &)

Returns the full path to the rad cubemap core output file for the specified cubemap.

GetCubemapDependenciesFilename(const Geo::GeoFileString &)

Returns the full path to the system dependencies output file for the specified cubemap.

GetDefaultSceneName()

Returns the default name of the scene.

GetDepsFilename()

Returns the full path to the .deps file.

GetDirectionalVisibilityFilename(const Geo::GeoFileString &)

Returns the full path to the directional visibility file for the specified system.

GetExportPath()

Returns the export path that was supplied to the constructor.

GetGeneratedSystemsFilename(const Geo::GeoFileString &)

Returns the full path to the generated systems file for the specified zone.

GetInputGeometryFilename(const Geo::GeoFileString &, const Geo::GeoFileString &)

Returns the full path to the input geometry output file for a the specified geom/paramSet combination.

GetInputProbeSetFilename(const Geo::GeoFileString &)

Returns the full path to the input probeset file for the specified system.

GetInputSystemFilename(const Geo::GeoFileString &)

Returns the full path to the input system output file for the specified system.

GetInputWorkspaceFilename(const Geo::GeoFileString &)

Returns the full path to the input workspace file for the specified system.

GetInstanceNames(const Geo::GeoFileString &)

Return the names of the instances within the specified group.

GetLightsFilename()

Returns the full path to the.lights file.

GetLightTransportOutputFilename(const Geo::GeoFileString &)

Returns the full path to the light transport output file for the specified system.

GetOutputProbeOctreeFilename(const Geo::GeoFileString &)

Returns the full path to the output probe octree file for the specified input octree.