...
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 &) | Constructs Provide an PipelinePaths instance and copies the export path and the scene nameto which the current process can write files. |
| PipelinePaths(const Geo::GeoFileString &) | Constructs Provide an PipelinePaths instance and copies the export path and sets the default scene nameto 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. |
...
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!
| Anchor | ||||
|---|---|---|---|---|
|
...
public: PipelinePaths
(
const Geo::GeoFileString & exportPath,
const Geo::GeoFileString & sceneName
)
...
Constructs Provide an PipelinePaths instance and copies the export path and the scene nameto which the current process can write files.
| Anchor | ||||
|---|---|---|---|---|
|
...
public: PipelinePaths
(
const Geo::GeoFileString & exportPath
)
...
Constructs Provide an PipelinePaths instance and copies the export path and sets the default scene nameto which the current process can write files.
| Anchor | ||||
|---|---|---|---|---|
|
Enlighten::PipelineScene::PipelineScene
...
publicprotected: PipelineScene
(
PipelinePaths paths,
const PipelineGlobalParameters & global
)
...
Return true if the precompute succeeded.
| Anchor | ||||
|---|---|---|---|---|
|
...
void Enlighten::PipelineScene::WriteScene
...
public: bool void WriteScene
(
Geo::IGeoProgressProxy & progressProxy
) const
...
Write the Enlighten scene to disk.