class Enlighten IPrecompBuildParameters

This is the documentation for Enlighten.

class Enlighten IPrecompBuildParameters

class Enlighten::IPrecompBuildParameters

A class containing various parameters and dials for the system level precompute process.

Variables

Name

Description

Name

Description

const Geo::s32 kShadowFaceBack = 0

Deprecated ShadowFace API.

const Geo::s32 kShadowFaceBoth = -1

Deprecated ShadowFace API.

const Geo::s32 kShadowFaceFront = 1

Deprecated ShadowFace API.

const Geo::s32 kShadowFaceUseMaterialAPI = -2

Deprecated ShadowFace API.

Functions

Name

Description

Name

Description

GetAlignedEdgeStitching()

Whether to use edge stitching.

GetBackFaceTolerance()

Whether to reject ray origins which can see any back face (if false, we only reject ray origins if they see nothing but back faces).

GetClusterSize()

The size of an input cluster.

GetClusterTolerance()

The strictness with which the geometry is voxelised during preclustering.

GetComputeRayOriginOutput()

General Debugging Options -------------------------------------------------- Whether to compute ray origin output during light transport.

GetCTDiv()

Number of children per node in the cluster hierarchy.

GetDefaultValues()

Returns a set of build parameters representing the defaults.

GetDependencyIncludedSystemDistance()

Bounding box of the system whose dependencies are being calculated is expanded by this distance in all directions.

GetDependencyLocalityDistance()

Maximum distance at which a given system will be considered local.

GetDependencyVisibilityThreshold()

Do not consider a system as a dependency if its visibility is smaller than the threshold.

GetDirectionalIrradiance()

Whether to generate directional irradiance output.

GetDirectionalVisibilityDirectionsPerByte()

Number of visibility samples to store per byte for precomputed directional visibility.

GetDirectionalVisibilitySlices()

Number of vertical sphere slices for precomputed directional visibility storage.

GetEdgeStitching()

Whether to use edge stitching.

GetEdgeStitchingDistanceMultiplier()

Maximum distance between edges for them to be stitchable, as a multiple of output pixel size.

GetEnvironmentResolution()

The resolution for each face of the environment map.

GetExcludeEnvironmentInPrimaryBounce()

Whether to exclude the environment form factors from the rad core data which is used for solving to the lightmap.

GetGenerateClusterProbeSampleOffsets()

Whether to generate per cluster offsets for sampling probes.

GetHQVisWeight()

High quality clustering visibility weighting.

GetImportance()

A relative importance multiplier for this system in the global light transport step.

GetIrradianceBudget()

The number of form factors to store per irradiance output sample.

GetIrradiancePushOff()

Push off for irradiance form factor rays, in cm.

GetIrradianceQuality()

The number of rays to cast for computing irradiance form factors.

GetITBudget()

Maximum number of clustering iterations.

GetLCEpsilon()

Clustering iteration termination error threshold.

GetMaxSamples()

Maximum number of input samples for a system.

GetMaxSolutionSize()

The maximum size of an output system, in pixels.

GetMinSamples()

Minimum number of input samples for a system.

GetMinSolutionSize()

The minimum size of an output system, in pixels.

GetModellingTolerance()

Radius controlling how close ray origins can be to other geometry, in cm.

GetNSBudget()

Number of per-triangle visibility samples to use for computing triangle visibility and input sample visibility.

GetNumTerrainLODLevels()

If terrain LODs are being generated, specifies how many LODs to generate.

GetPixelStitching()

Whether to use pixel stitching.

GetPixelStitchingNormalDotProduct()

Maximum dot product of normals for pixels to be stitchable.

GetSafe16BitClustering()

High quality clustering visibility weighting.

GetSampleCullingThreshold()

Threshold controlling input (duster) sample culling behaviour.

GetSamplesPerCluster()

The number of input samples per cluster.

GetShadowFaces()

Deprecated ShadowFace API.

GetStitchingDistanceMultiplier()

Maximum distance between charts for them to be stitchable, as a multiple of output pixel size.

GetStitchingNormalDotProduct()

Maximum dot product of normals for charts to be stitchable.

GetTriangleCullingThreshold()

Threshold controlling visibility-based cluster triangle culling behaviour.

GetValidOverhangDistance()

The valid overhang distance for mesh projection.

GetViewsDisabled()

Whether to disable viewsets.

GetViewVoxelMultiplier()

Size of voxel grid to use for automatic viewsets, as a multiplier of (minimum) output pixel size.

GetVisibilityThreshold()

The error allowed for reducing the number of form factors for each spherical output sample.

Load(Geo::IGeoInputStream &, Geo::u32)

Load an instance of this class from an IGeoStream.

RequiresTerrainLODs()

Whether to create "terrain" LODs.

RequiresTerrainPackingPadding()

If terrain LODs are being generated, specifies whether half a pixel padding should be added to final terrain system atlas.

Save(Geo::IGeoStream &, Geo::u32)

Save an instance of this class to an IGeoStream.

SetAlignedEdgeStitching(bool)

Whether to use edge stitching.

SetBackFaceTolerance(float)

Whether to reject ray origins which can see any back face (if false, we only reject ray origins if they see nothing but back faces).

SetClusterSize(float)

The size of an input cluster.

SetClusterTolerance(float)

The strictness with which the geometry is voxelised during preclustering.

SetComputeRayOriginOutput(bool)

General Debugging Options -------------------------------------------------- Whether to compute ray origin output during light transport.

SetCTDiv(float)

Number of children per node in the cluster hierarchy.

SetDependencyIncludedSystemDistance(float)

Bounding box of the system whose dependencies are being calculated is expanded by this distance in all directions.

SetDependencyLocalityDistance(float)

Maximum distance at which a given system will be considered local.

SetDependencyVisibilityThreshold(float)

Do not consider a system as a dependency if its visibility is smaller than the threshold.

SetDirectionalIrradiance(bool)

Whether to generate directional irradiance output.

SetDirectionalVisibilityDirectionsPerByte(Geo::s32)

Number of visibility samples to store per byte for precomputed directional visibility.

SetDirectionalVisibilitySlices(Geo::s32)

Number of vertical sphere slices for precomputed directional visibility storage.

SetEdgeStitching(bool)

Whether to use edge stitching.

SetEdgeStitchingDistanceMultiplier(float)

Maximum distance between edges for them to be stitchable, as a multiple of output pixel size.

SetEnvironmentResolution(Geo::s32)

The resolution for each face of the environment map.

SetExcludeEnvironmentInPrimaryBounce(bool)

Whether to exclude the environment form factors from the rad core data which is used for solving to the lightmap.

SetGenerateClusterProbeSampleOffsets(bool)

Whether to generate per cluster offsets for sampling probes.

SetHQVisWeight(float)

High quality clustering visibility weighting.

SetImportance(float)

A relative importance multiplier for this system in the global light transport step.

SetIrradianceBudget(Geo::s32)

The number of form factors to store per irradiance output sample.

SetIrradiancePushOff(float)

Push off for irradiance form factor rays, in cm.

SetIrradianceQuality(Geo::s32)

The number of rays to cast for computing irradiance form factors.

SetITBudget(Geo::s32)

Maximum number of clustering iterations.

SetLCEpsilon(float)

Clustering iteration termination error threshold.

SetMaxSamples(Geo::s32)

Maximum number of input samples for a system.

SetMaxSolutionSize(Geo::s32, Geo::s32)

The maximum size of an output system, in pixels.

SetMinSamples(Geo::s32)

Minimum number of input samples for a system.

SetMinSolutionSize(Geo::s32, Geo::s32)

The minimum size of an output system, in pixels.

SetModellingTolerance(float)

Radius controlling how close ray origins can be to other geometry, in cm.

SetNSBudget(Geo::s32)

Number of per-triangle visibility samples to use for computing triangle visibility and input sample visibility.

SetNumTerrainLODLevels(Geo::s32)

If terrain LODs are being generated, specifies how many LODs to generate.

SetPixelStitching(bool)

Whether to use pixel stitching.

SetPixelStitchingNormalDotProduct(float)

Maximum dot product of normals for pixels to be stitchable.

SetRequiresTerrainLODs(bool)

Whether to create "terrain" LODs.

SetRequiresTerrainPackingPadding(bool)

If terrain LODs are being generated, specifies whether half a pixel padding should be added to final terrain system atlas.

SetSafe16BitClustering(bool)

Whether to enforce that clustering creates no more than 65535 clusters such that a cluster index will fit in an unsigned integer.

SetSampleCullingThreshold(float)

Threshold controlling input (duster) sample culling behaviour.

SetSamplesPerCluster(Geo::s32)

The number of input samples per cluster.

SetShadowFaces(Geo::s32)

Deprecated ShadowFace API.

SetStitchingDistanceMultiplier(float)

Maximum distance between charts for them to be stitchable, as a multiple of output pixel size.

SetStitchingNormalDotProduct(float)

Maximum dot product of normals for charts to be stitchable.

SetTriangleCullingThreshold(float)

Threshold controlling visibility-based cluster triangle culling behaviour.

SetValidOverhangDistance(Geo::s32)

The valid overhang distance for mesh projection.

SetViewsDisabled(bool)

Whether to disable viewsets.

SetViewVoxelMultiplier(float)

Size of voxel grid to use for automatic viewsets, as a multiplier of (minimum) output pixel size.

SetVisibilityThreshold(float)

The error allowed for reducing the number of form factors for each spherical output sample.



virtual bool Enlighten::IPrecompBuildParameters::GetAlignedEdgeStitching


public: bool GetAlignedEdgeStitching() const


Whether to use edge stitching.



virtual float Enlighten::IPrecompBuildParameters::GetBackFaceTolerance


public: float GetBackFaceTolerance() const


Whether to reject ray origins which can see any back face (if false, we only reject ray origins if they see nothing but back faces).



virtual float Enlighten::IPrecompBuildParameters::GetClusterSize


public: float GetClusterSize() const


The size of an input cluster.



virtual float Enlighten::IPrecompBuildParameters::GetClusterTolerance


public: float GetClusterTolerance() const


The strictness with which the geometry is voxelised during preclustering.



virtual bool Enlighten::IPrecompBuildParameters::GetComputeRayOriginOutput


public: bool GetComputeRayOriginOutput() const


General Debugging Options -------------------------------------------------- Whether to compute ray origin output during light transport.

Ray origin output is useful for debugging radiosity issues. The default value is false.



virtual float Enlighten::IPrecompBuildParameters::GetCTDiv


public: float GetCTDiv() const


Number of children per node in the cluster hierarchy.



static const IPrecompBuildParameters* Enlighten::IPrecompBuildParameters::GetDefaultValues


public: const IPrecompBuildParameters * GetDefaultValues()


Returns a set of build parameters representing the defaults.



virtual float Enlighten::IPrecompBuildParameters::GetDependencyIncludedSystemDistance


public: float GetDependencyIncludedSystemDistance() const


Bounding box of the system whose dependencies are being calculated is expanded by this distance in all directions.

All systems whose bounding boxes intersect this expanded bounding box will be fully represented in ray tracing when calculating dependencies. Other systems will be represented as bounding boxes only.



virtual float Enlighten::IPrecompBuildParameters::GetDependencyLocalityDistance


public: float GetDependencyLocalityDistance() const


Maximum distance at which a given system will be considered local.



virtual float Enlighten::IPrecompBuildParameters::GetDependencyVisibilityThreshold


public: float GetDependencyVisibilityThreshold() const


Do not consider a system as a dependency if its visibility is smaller than the threshold.

Specify 0 to accept systems with any visibility.



virtual bool Enlighten::IPrecompBuildParameters::GetDirectionalIrradiance


public: bool GetDirectionalIrradiance() const


Whether to generate directional irradiance output.



virtual Geo::s32 Enlighten::IPrecompBuildParameters::GetDirectionalVisibilityDirectionsPerByte


public: Geo::s32 GetDirectionalVisibilityDirectionsPerByte() const


Number of visibility samples to store per byte for precomputed directional visibility.

The default value is 4 (2 bits per direction). Valid values are 1,2,4 and 8. 8 produces the best compression, 1 the best quality. 4 produces the best size / quality balance.



virtual Geo::s32 Enlighten::IPrecompBuildParameters::GetDirectionalVisibilitySlices


public: Geo::s32 GetDirectionalVisibilitySlices() const


Number of vertical sphere slices for precomputed directional visibility storage.

The number of sampled visibility directions will be roughly the square of this number. Defaults to 27 (875 sampled directions). Valid values range between 2 and 64.



virtual bool Enlighten::IPrecompBuildParameters::GetEdgeStitching


public: bool GetEdgeStitching() const


Whether to use edge stitching.



virtual float Enlighten::IPrecompBuildParameters::GetEdgeStitchingDistanceMultiplier


public: float GetEdgeStitchingDistanceMultiplier() const


Maximum distance between edges for them to be stitchable, as a multiple of output pixel size.



virtual Geo::s32 Enlighten::IPrecompBuildParameters::GetEnvironmentResolution


public: Geo::s32 GetEnvironmentResolution() const


The resolution for each face of the environment map.



virtual bool Enlighten::IPrecompBuildParameters::GetExcludeEnvironmentInPrimaryBounce


public: bool GetExcludeEnvironmentInPrimaryBounce() const


Whether to exclude the environment form factors from the rad core data which is used for solving to the lightmap.



virtual bool Enlighten::IPrecompBuildParameters::GetGenerateClusterProbeSampleOffsets


public: bool GetGenerateClusterProbeSampleOffsets() const


Whether to generate per cluster offsets for sampling probes.



virtual float Enlighten::IPrecompBuildParameters::GetHQVisWeight


public: float GetHQVisWeight() const


High quality clustering visibility weighting.

A value of 0 means that only position information is used for clustering, a value of 1 means only visibility information is used. Generally, a value close to 1 should be used..



virtual float Enlighten::IPrecompBuildParameters::GetImportance