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.

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

Adds a probe volume to the scene.

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

Adds a dependency set.

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.

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.

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.

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

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

GetPackedSystemFilename(const Geo::GeoFileString &)

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

GetParamsetFilename()

Returns the full path to the paramset file.

GetPrecomputeLogFilename()

Returns the full path to the precompute log file.

GetProbeDependenciesFilename(const Geo::GeoFileString &)

Returns the full path to the system dependencies output file for the specified probe-set.

GetProbeRegionFilename(const Geo::GeoFileString &)

Returns the full path to the probe region file with the specified name.

GetProbeSetCoreFilename(const Geo::GeoFileString &)

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

GetRadCoreFilename(const Geo::GeoFileString &, const Geo::s32)

Returns the full path to the rad lightmap core file for the specified system and lod.

GetRadiosityNormalTextureFilename(const Geo::GeoFileString &, const Geo::s32)

Returns the full path to the radiosity normal texture file for the specified system and lod.

GetRefInputWorkspaceFilename(const Geo::GeoFileString &)

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

GetSceneFilename()

Returns the full path to the .scene file.

GetSceneName()

Returns the name of the scene.

GetSceneOutputPath()

Returns the full path to the directory containing the build results.

GetSystemDusterFilename(const Geo::GeoFileString &)

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

LoadClusterAlbedoWorkspaceMaterialData(const Geo::GeoFileString &)

Load a precompute object from file.

LoadGeneratedSystems(const Geo::GeoFileString &)

Load a precompute object from file.

LoadInputWorkspace(const Geo::GeoFileString &)

Load a precompute object from file.

LoadOctreeProbeSetCore(const Geo::GeoFileString &, Geo::s32)

Load a precompute object from file.

LoadOutputProbeOctree(const Geo::GeoFileString &)

Load a precompute object from file.

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

Load a precompute object from file.

LoadPackedSystem(const Geo::GeoFileString &)

Load a precompute object from file.

LoadPrecomputedVisibilityData(const Geo::GeoFileString &)

Load a precompute object from file.

LoadRadCubeMapCore(const Geo::GeoFileString &)

Load a precompute object from file.

LoadRadiosityNormalTexture(const Geo::GeoFileString &, Geo::s32)

Load a precompute object from file.

LoadRadProbeSetCore(const Geo::GeoFileString &)

Load a precompute object from file.

LoadRadSystemCore(const Geo::GeoFileString &, Geo::s32)

Load a precompute object from file.

LoadSystemDuster(const Geo::GeoFileString &)

Load a precompute object from file.

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

Provide an export path to which the current process can write files.

PipelinePaths(const Geo::GeoFileString &)

Provide an export path to which the current process can write files.

PipelineScene(PipelinePaths, const PipelineGlobalParameters &)

Constructor.

PrecomputeParameters(PrecomputeDistribute, Geo::u32, bool, bool)

Constructor.

PrecomputePipeline(PipelinePaths, PrecomputeParameters, const PipelineGlobalParameters &, const Geo::GeoFileString &)

Constructor.

StartPrecompute(bool)

Launches the High Level Build System to run the build.

TryGetPrecomputeResult()

If the precompute is still running, return Running, else return the precompute result.

WaitForPrecompute()

Wait for the precompute to complete.

WriteScene(Geo::IGeoProgressProxy &)

Write the Enlighten scene to disk.

Typedefs

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

Array of dependencies.

Geo::GeoArray< Geo::GeoFileString > InstanceNames

An array of instance names.

Variables

Name Description
bool m_DebugTool

If true, the precompute uses the debug configuration of the build tools.

PrecomputeDistribute m_Distribute

The way the precompute process should be distributed.

bool m_DumpInputs

If true, the precompute dumps additional data for debugging and testing.

Geo::u32 m_MemoryLimit

Limit the percentage of the total system memory available to the precompute.

bool m_SampleFramework

Advanced.

bool m_Unattended

If true, the precompute does not wait for user input when an error occurs.


void Enlighten::PipelineScene::AddCubemap


public: void AddCubemap
(
    const PipelineCubemap & cubemap
)


Add a cubemap to the scene.


void Enlighten::PipelineScene::AddGeom


public: void AddGeom
(
    const PipelineGeom & geom
)


Add the geom to the scene.


void Enlighten::PipelineScene::AddInstance


public: void AddInstance
(
    const PipelineRadiosityInstance & instance
)


Add a radiosity instance to the scene.


void Enlighten::PipelineScene::AddInstance


public: void AddInstance
(
    const PipelineExcludedInstance & instance
)


Add an excluded instance to the scene.


void Enlighten::PipelineScene::AddInstanceParameters


public: void AddInstanceParameters
(
    const PipelineInstanceParameters & parameters
)


Add a named set of instance parameters to the scene.


void Enlighten::PipelineScene::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::PipelineScene::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::PipelineScene::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::PipelineScene::AddProbeVolume


public: void AddProbeVolume
(
    const PipelineProbeVolume & probeVolume
)


Adds a probe volume to the scene.


void Enlighten::PipelineScene::AddRadiosityDependencies


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


Adds a dependency set.


void Enlighten::PrecomputePipeline::CancelPrecompute


public: void CancelPrecompute()


Cancel the currently running precompute.


static AlbedoBufferPtr Enlighten::PipelineScene::CreateAlbedoBuffer


public: AlbedoBufferPtr CreateAlbedoBuffer
(
    InputWorkspace * inputWorkspace
)


Create a runtime object.

Return a unique pointer which owns the object.


static DynamicMaterialWorkspacePtr Enlighten::PipelineScene::CreateDynamicMaterialWorkspace


public: DynamicMaterialWorkspacePtr CreateDynamicMaterialWorkspace
(
    ClusterAlbedoWorkspaceMaterialData * cawMaterialData
)


Create a runtime object.

Return a unique pointer which owns the object.


static EmissiveBufferPtr Enlighten::PipelineScene::CreateEmissiveBuffer


public: EmissiveBufferPtr CreateEmissiveBuffer
(
    InputWorkspace * inputWorkspace
)


Create a runtime object.

Return a unique pointer which owns the object.


void Enlighten::PipelineScene::DumpDebugScene


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


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

Note: For use only in Enlighten internal testing, may be removed in a future release!


Geo::GeoFileString Enlighten::PipelinePaths::GetClusterAlbedoMaterialDataFilename


public: Geo::GeoFileString GetClusterAlbedoMaterialDataFilename
(
    const Geo::GeoFileString & SystemName
) const


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


Geo::GeoFileString Enlighten::PipelinePaths::GetCubemapCoreFilename


public: Geo::GeoFileString GetCubemapCoreFilename
(
    const Geo::GeoFileString & cubemapName
) const


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


Geo::GeoFileString Enlighten::PipelinePaths::GetCubemapDependenciesFilename


public: Geo::GeoFileString GetCubemapDependenciesFilename
(
    const Geo::GeoFileString & cubemapName
) const


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


static const char* Enlighten::PipelinePaths::GetDefaultSceneName


public: const char * GetDefaultSceneName()


Returns the default name of the scene.


Geo::GeoFileString Enlighten::PipelinePaths::GetDepsFilename


public: Geo::GeoFileString GetDepsFilename() const


Returns the full path to the .deps file.


Geo::GeoFileString Enlighten::PipelinePaths::GetDirectionalVisibilityFilename


public: Geo::GeoFileString GetDirectionalVisibilityFilename
(
    const Geo::GeoFileString & SystemName
) const


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


const Geo::GeoFileString& Enlighten::PipelinePaths::GetExportPath


public: const Geo::GeoFileString & GetExportPath() const


Returns the export path that was supplied to the constructor.


Geo::GeoFileString Enlighten::PipelinePaths::GetGeneratedSystemsFilename


public: Geo::GeoFileString GetGeneratedSystemsFilename
(
    const Geo::GeoFileString & zoneName
) const


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


Geo::GeoFileString Enlighten::PipelinePaths::GetInputGeometryFilename


public: Geo::GeoFileString GetInputGeometryFilename
(
    const Geo::GeoFileString & geomName,
    const Geo::GeoFileString & paramsetName
) const


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


Geo::GeoFileString Enlighten::PipelinePaths::GetInputSystemFilename


public: Geo::GeoFileString GetInputSystemFilename
(
    const Geo::GeoFileString & systemName
) const


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


Geo::GeoFileString Enlighten::PipelinePaths::GetInputWorkspaceFilename


public: Geo::GeoFileString GetInputWorkspaceFilename
(
    const Geo::GeoFileString & SystemName
) const


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


const InstanceNames& Enlighten::PipelineScene::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.


Geo::GeoFileString Enlighten::PipelinePaths::GetLightsFilename


public: Geo::GeoFileString GetLightsFilename() const


Returns the full path to the.lights file.


Geo::GeoFileString Enlighten::PipelinePaths::GetLightTransportOutputFilename


public: Geo::GeoFileString GetLightTransportOutputFilename
(
    const Geo::GeoFileString & SystemName
) const


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


Geo::GeoFileString Enlighten::PipelinePaths::GetOutputProbeOctreeFilename


public: Geo::GeoFileString GetOutputProbeOctreeFilename
(
    const Geo::GeoFileString & name
) const


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


Geo::GeoFileString Enlighten::PipelinePaths::GetPackedGeometryFilename


public: Geo::GeoFileString GetPackedGeometryFilename
(
    const Geo::GeoFileString & geomName,
    const Geo::GeoFileString & paramsetName
) const


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


Geo::GeoFileString Enlighten::PipelinePaths::GetPackedSystemFilename


public: Geo::GeoFileString GetPackedSystemFilename
(
    const Geo::GeoFileString & systemName
) const


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


Geo::GeoFileString Enlighten::PipelinePaths::GetParamsetFilename


public: Geo::GeoFileString GetParamsetFilename() const


Returns the full path to the paramset file.


Geo::GeoFileString Enlighten::PipelinePaths::GetPrecomputeLogFilename


public: Geo::GeoFileString GetPrecomputeLogFilename() const


Returns the full path to the precompute log file.


Geo::GeoFileString Enlighten::PipelinePaths::GetProbeDependenciesFilename


public: Geo::GeoFileString GetProbeDependenciesFilename
(
    const Geo::GeoFileString & probeSetName
) const


Returns the full path to the system dependencies output file for the specified probe-set.


Geo::GeoFileString Enlighten::PipelinePaths::GetProbeRegionFilename


public: Geo::GeoFileString GetProbeRegionFilename
(
    const Geo::GeoFileString & name
) const


Returns the full path to the probe region file with the specified name.


Geo::GeoFileString Enlighten::PipelinePaths::GetProbeSetCoreFilename


public: Geo::GeoFileString GetProbeSetCoreFilename
(
    const Geo::GeoFileString & probeSetName
) const


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


Geo::GeoFileString Enlighten::PipelinePaths::GetRadCoreFilename


public: Geo::GeoFileString GetRadCoreFilename
(
    const Geo::GeoFileString & SystemName,
    const Geo::s32 LodIndex
) const


Returns the full path to the rad lightmap core file for the specified system and lod.


Geo::GeoFileString Enlighten::PipelinePaths::GetRadiosityNormalTextureFilename


public: Geo::GeoFileString GetRadiosityNormalTextureFilename
(
    const Geo::GeoFileString & SystemName,
    const Geo::s32 LodIndex
) const


Returns the full path to the radiosity normal texture file for the specified system and lod.


Geo::GeoFileString Enlighten::PipelinePaths::GetRefInputWorkspaceFilename


public: Geo::GeoFileString GetRefInputWorkspaceFilename
(
    const Geo::GeoFileString & SystemName
) const


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


Geo::GeoFileString Enlighten::PipelinePaths::GetSceneFilename


public: Geo::GeoFileString GetSceneFilename() const


Returns the full path to the .scene file.


const Geo::GeoFileString& Enlighten::PipelinePaths::GetSceneName


public: const Geo::GeoFileString & GetSceneName() const


Returns the name of the scene.


Geo::GeoFileString Enlighten::PipelinePaths::GetSceneOutputPath


public: Geo::GeoFileString GetSceneOutputPath() const


Returns the full path to the directory containing the build results.


Geo::GeoFileString Enlighten::PipelinePaths::GetSystemDusterFilename


public: Geo::GeoFileString GetSystemDusterFilename
(
    const Geo::GeoFileString & systemName
) const


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


CAWMaterialDataPtr Enlighten::PipelineScene::LoadClusterAlbedoWorkspaceMaterialData


public: CAWMaterialDataPtr LoadClusterAlbedoWorkspaceMaterialData
(
    const Geo::GeoFileString & systemName
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


GeneratedSystemsPtr Enlighten::PipelineScene::LoadGeneratedSystems


public: GeneratedSystemsPtr LoadGeneratedSystems
(
    const Geo::GeoFileString & zoneName
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


InputWorkspacePtr Enlighten::PipelineScene::LoadInputWorkspace


public: InputWorkspacePtr LoadInputWorkspace
(
    const Geo::GeoFileString & systemName
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


RadProbeSetCorePtr Enlighten::PipelineScene::LoadOctreeProbeSetCore


public: RadProbeSetCorePtr LoadOctreeProbeSetCore
(
    const Geo::GeoFileString & probeSetName,
    Geo::s32 probeSetIndex
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


OutputProbeOctreePtr Enlighten::PipelineScene::LoadOutputProbeOctree


public: OutputProbeOctreePtr LoadOutputProbeOctree
(
    const Geo::GeoFileString & octreeName
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


PackedGeometryPtr Enlighten::PipelineScene::LoadPackedGeometry


public: PackedGeometryPtr LoadPackedGeometry
(
    const Geo::GeoFileString & geomName,
    const Geo::GeoFileString & paramSetName
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


PackedSystemPtr Enlighten::PipelineScene::LoadPackedSystem


public: PackedSystemPtr LoadPackedSystem
(
    const Geo::GeoFileString & systemName
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


PrecompVisDataPtr Enlighten::PipelineScene::LoadPrecomputedVisibilityData


public: PrecompVisDataPtr LoadPrecomputedVisibilityData
(
    const Geo::GeoFileString & systemName
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


RadCubeMapCorePtr Enlighten::PipelineScene::LoadRadCubeMapCore


public: RadCubeMapCorePtr LoadRadCubeMapCore
(
    const Geo::GeoFileString & cubeMapName
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


RGBXTexturePtr Enlighten::PipelineScene::LoadRadiosityNormalTexture


public: RGBXTexturePtr LoadRadiosityNormalTexture
(
    const Geo::GeoFileString & systemName,
    Geo::s32 lodIndex
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


RadProbeSetCorePtr Enlighten::PipelineScene::LoadRadProbeSetCore


public: RadProbeSetCorePtr LoadRadProbeSetCore
(
    const Geo::GeoFileString & probeSetName
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


RadSystemCorePtr Enlighten::PipelineScene::LoadRadSystemCore


public: RadSystemCorePtr LoadRadSystemCore
(
    const Geo::GeoFileString & systemName,
    Geo::s32 lodIndex
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


SystemDusterPtr Enlighten::PipelineScene::LoadSystemDuster


public: SystemDusterPtr LoadSystemDuster
(
    const Geo::GeoFileString & systemName
) const


Load a precompute object from file.

Return a unique pointer which owns the object.


Enlighten::PipelinePaths::PipelinePaths


public: PipelinePaths
(
    const Geo::GeoFileString & exportPath,
    const Geo::GeoFileString & sceneName
)


Provide an export path to which the current process can write files.


Enlighten::PipelinePaths::PipelinePaths


public: PipelinePaths
(
    const Geo::GeoFileString & exportPath
)


Provide an export path to which the current process can write files.


Enlighten::PipelineScene::PipelineScene


protected: PipelineScene
(
    PipelinePaths paths,
    const PipelineGlobalParameters & global
)


Constructor.


Enlighten::PrecomputeParameters::PrecomputeParameters


public: PrecomputeParameters
(
    PrecomputeDistribute distribute,
    Geo::u32 memoryLimit,
    bool sampleFramework,
    bool unattended
)


Constructor.


Enlighten::PrecomputePipeline::PrecomputePipeline


public: PrecomputePipeline
(
    PipelinePaths paths,
    PrecomputeParameters parameters,
    const PipelineGlobalParameters & global,
    const Geo::GeoFileString & toolsPath
)


Constructor.


void Enlighten::PrecomputePipeline::StartPrecompute


public: void StartPrecompute
(
    bool parameterize
)


Launches the High Level Build System to run the build.


PrecomputeResult Enlighten::PrecomputePipeline::TryGetPrecomputeResult


public: PrecomputeResult TryGetPrecomputeResult()


If the precompute is still running, return Running, else return the precompute result.


bool Enlighten::PrecomputePipeline::WaitForPrecompute


public: bool WaitForPrecompute()


Wait for the precompute to complete.

Return true if the precompute succeeded.


void Enlighten::PipelineScene::WriteScene


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


Write the Enlighten scene to disk.