This is the documentation for Enlighten.

class Enlighten PipelinePaths

class Enlighten::PipelinePaths

The paths to the Enlighten scene and runtime data generated by the pipeline.

Functions

Name Description
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.

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.

GetProbeAtlasMaximaFilename()

Returns the full path to the probe atlas maxima 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.

GetSystemDependenciesFilename(const Geo::GeoFileString &)

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

GetSystemDusterFilename(const Geo::GeoFileString &)

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

MakeOctreeProbeSetName(const PrecompOctreeCode, const char *)

Returns the name of the octree probe set for the specified octree code and optional parameter set.

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.


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::GetInputProbeSetFilename


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


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


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.


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::GetProbeAtlasMaximaFilename


public: Geo::GeoFileString GetProbeAtlasMaximaFilename() const


Returns the full path to the probe atlas maxima 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::GetSystemDependenciesFilename


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


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


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.


static Geo::GeoFileString Enlighten::PipelinePaths::MakeOctreeProbeSetName


public: Geo::GeoFileString MakeOctreeProbeSetName
(
    const PrecompOctreeCode octreeCode,
    const char * paramSetName
)


Returns the name of the octree probe set for the specified octree code and optional parameter set.


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.