This is the documentation for Enlighten.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

class Enlighten::PipelineScene

The scene to be exported

Functions

Name Description
AddCubemap(const PipelineCubemap &)

Add a cubemap to the scene.

AddGeom(const PipelineGeom &)

Add the geom to the scene.

AddInstance(const PipelineExcludedInstance &)

Add an excluded instance to the scene.

AddInstance(const PipelineRadiosityInstance &)

Add a radiosity 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.

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.

GetInstanceNames(const Geo::GeoFileString &)

Return the names of the instances within the specified group.

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.

PipelineScene(PipelinePaths, const PipelineGlobalParameters &)

Constructor.

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.


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 PipelineExcludedInstance & instance
)


Add an excluded instance to the scene.


void Enlighten::PipelineScene::AddInstance


public: void AddInstance
(
    const PipelineRadiosityInstance & instance
)


Add a radiosity 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.


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.


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.


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


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


Constructor.


bool Enlighten::PipelineScene::WriteScene


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


Write the Enlighten scene to disk.

  • No labels