class Enlighten IClusteringOutput

This is the documentation for Enlighten.

class Enlighten IClusteringOutput

class Enlighten::IClusteringOutput

    └>Geo::IGeoSerialisable
        └>Geo::IGeoReleasable

An interface for diagnosing the quality and any issues with the clustering process in EnlightenPrecomp2.

In particular, it contains the clustered geometry, used during the precompute. This can be helpful to debug clustering related problems and is the interface GeoRadiosity uses in it's clustering render mode. If you are just interested in debugging a problem, you may be best off simply using these debugging modes in GeoRadiosity.

Functions

Name

Description

Name

Description

Create()

Creates a new IClusteringOutput.

GetClusterAncestor(const Geo::s32, const Geo::s32)

The index of the ancestor at a particular level of a cluster in the tree.

GetClusterForest()

Returns the entire tree structure for the clustering.

GetClusterTriList(Geo::s32)

Returns a collection of triangles that make up the mesh for cluster.

GetDusterPoints(Geo::s32)

Returns a collection of duster points within this cluster.

GetNumLeafClusters()

Returns the number of leaves in the clustering.

GetPreClusterIndex(Geo::s32)

The index of a cluster in the pre-clustering.

Load(IGeoInputStream &, Geo::u32)

Load an instance of this class from an IGeoInputStream.

Release()

Free this object that was created within the Enlighten libraries.

Save(IGeoStream &, Geo::u32)

Save an instance of this class to an IGeoStream.



static IClusteringOutput* Enlighten::IClusteringOutput::Create


public: IClusteringOutput * Create()


Creates a new IClusteringOutput.



virtual Geo::s32 Enlighten::IClusteringOutput::GetClusterAncestor


public: Geo::s32 GetClusterAncestor
(
    const Geo::s32 level,
    const Geo::s32 clusterTreeIdx
) const


The index of the ancestor at a particular level of a cluster in the tree.

 

Parameters

 

level

The level in the tree to view. Root is level 0, and we count up from there towards the leaves.

 

clusterTreeIdx

The index of the cluster. Should be from 0 to GetNumLeafClusters().

Returns

The ClusterTreeIdx, should be passed to GeoClusterNodeTree::FindNode() to get the cluster data.

Note

Advanced functionality for internal debugging of the Clustering precompute tasks.

 



virtual const GeoClusterNodeForest* Enlighten::IClusteringOutput::GetClusterForest


public: const GeoClusterNodeForest * GetClusterForest() const