This is the documentation for Enlighten.
class Enlighten IPrecompProbeSetBuildParameters
- geosw (Unlicensed)
class Enlighten::IPrecompProbeSetBuildParameters
A class defining parameters for SH sample probe building.
Functions
| Name | Description |
|---|---|
| GetBudget() | The number of form factors to store per output sample. |
| GetCoefficientBasisX() | The basis vectors for the probe coefficients. |
| GetCoefficientBasisY() | The basis vectors for the probe coefficients. |
| GetCoefficientBasisZ() | The basis vectors for the probe coefficients. |
| GetCoefficientOrder() | The desired output order of the coefficients. |
| GetCullingThreshold() | Determines the threshold of valid visibility below which a point is culled. |
| GetDependencyIncludedSystemDistance() | Bounding box of the probe set (i.e. bounding box containing all the probes) whose dependencies are being calculated is. |
| 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. |
| GetEnvironmentResolution() | The resolution for each face of the environment map. |
| GetEnvironmentValidity() | Limits the region of the environment that is valid. |
| GetErrorThreshold() | Determines the threshold of interpolation error below which a point may be removed. |
| GetExcludeEnvironmentInPrimaryBounce() | Whether to exclude environment when solving the probes directly. |
| GetIndividualProbes() | Whether to treat the probes in this set entirely individually, and disable optimisations in the EntireProbeSetSolver which share data between probes. |
| GetMaximumProbeCount() | Limits maximum number of probes allowed in a set for debugging purposes, default is 2^24. |
| GetNumEnvironmentVisibilitySHCoefficients() | The number of SH coefficients used for environment visibility. |
| GetNumSHCoefficients() | The number of SH coefficients used. |
| GetQuality() | The number of rays to cast for computing form factors. |
| GetUseCulling() | Whether to cull probes that are not in valid locations. |
| GetVerticalAxis() | The axis aligned vector pointing directly upwards. |
| GetVisibilityThreshold() | The necessary visibility of a cluster to be used as form factor. |
| SetBudget(Geo::s32) | The number of form factors to store per output sample. |
| SetCoefficientBasis(const Geo::v128 &, const Geo::v128 &, const Geo::v128 &) | The basis vectors for the probe coefficients. |
| SetCoefficientOrder(const Geo::s8 *) | The desired output order of the coefficients. |
| SetCullingThreshold(float) | Determines the threshold of valid visibility below which a point is culled. |
| SetDependencyIncludedSystemDistance(float) | Bounding box of the probe set (i.e. bounding box containing all the probes) whose dependencies are being calculated is. |
| 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. |
| SetEnvironmentResolution(Geo::s32) | The resolution for each face of the environment map. |
| SetEnvironmentValidity(Enlighten::EnvironmentValidity) | Limits the region of the environment that is valid. |
| SetErrorThreshold(float) | Determines the threshold of interpolation error below which a point may be removed. |
| SetExcludeEnvironmentInPrimaryBounce(bool) | Whether to exclude environment when solving the probes directly. |
| SetIndividualProbes(bool) | Whether to treat the probes in this set entirely individually, and disable optimisations in the EntireProbeSetSolver which share data between probes. |
| SetMaximumProbeCount(Geo::u32) | Limits maximum number of probes allowed in a set for debugging purposes, default is 2^24. |
| SetNumEnvironmentVisibilitySHCoefficients(Geo::s32) | The number of SH coefficients used for environment visibility. |
| SetNumSHCoefficients(Geo::s32) | The number of SH coefficients used. |
| SetQuality(Geo::s32) | The number of rays to cast for computing form factors. |
| SetUseCulling(bool) | Whether to cull probes that are not in valid locations. |
| SetVerticalAxis(Enlighten::WorldAxis) | The axis aligned vector pointing directly upwards. |
| SetVisibilityThreshold(float) | The necessary visibility of a cluster to be used as form factor. |
virtual Geo::s32 Enlighten::IPrecompProbeSetBuildParameters::GetBudget
public: Geo::s32 GetBudget() const
The number of form factors to store per output sample.
virtual const Geo::v128& Enlighten::IPrecompProbeSetBuildParameters::GetCoefficientBasisX
public: const Geo::v128 & GetCoefficientBasisX() const
The basis vectors for the probe coefficients.
Must be axis aligned and orthonormal. Defaults to (+x, +y, +z).
virtual const Geo::v128& Enlighten::IPrecompProbeSetBuildParameters::GetCoefficientBasisY
public: const Geo::v128 & GetCoefficientBasisY() const
The basis vectors for the probe coefficients.
Must be axis aligned and orthonormal. Defaults to (+x, +y, +z).
virtual const Geo::v128& Enlighten::IPrecompProbeSetBuildParameters::GetCoefficientBasisZ
public: const Geo::v128 & GetCoefficientBasisZ() const
The basis vectors for the probe coefficients.
Must be axis aligned and orthonormal. Defaults to (+x, +y, +z).
virtual const Geo::s8* Enlighten::IPrecompProbeSetBuildParameters::GetCoefficientOrder
public: const Geo::s8 * GetCoefficientOrder() const
The desired output order of the coefficients.
Must be called after SetNumSHCoefficients. The length of the array must be 4 for L1 probe sets, and 9 for L2. Each value maps the indexed coefficient to the position of the index in the coefficientOrder array. By default the order is {012345678} which maps to an output order of: Y_00, Y_11, Y_10, Y_1-1; Y_20, Y_21, Y_2-1, Y_2-2, Y_22
virtual float Enlighten::IPrecompProbeSetBuildParameters::GetCullingThreshold
public: float GetCullingThreshold() const
Determines the threshold of valid visibility below which a point is culled.
virtual float Enlighten::IPrecompProbeSetBuildParameters::GetDependencyIncludedSystemDistance
public: float GetDependencyIncludedSystemDistance() const
Bounding box of the probe set (i.e. bounding box containing all the probes) whose dependencies are being calculated is.
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::IPrecompProbeSetBuildParameters::GetDependencyLocalityDistance
public: float GetDependencyLocalityDistance() const
Maximum distance at which a given system will be considered local.
virtual float Enlighten::IPrecompProbeSetBuildParameters::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 Geo::s32 Enlighten::IPrecompProbeSetBuildParameters::GetEnvironmentResolution
public: Geo::s32 GetEnvironmentResolution() const
The resolution for each face of the environment map.
virtual Enlighten::EnvironmentValidity Enlighten::IPrecompProbeSetBuildParameters::GetEnvironmentValidity
public: Enlighten::EnvironmentValidity GetEnvironmentValidity() const
Limits the region of the environment that is valid.
Indirect lighting data is not generated for probes that see invalid regions of the environment. When a non-default value is specified, the vertical axis parameter must also be specified.
virtual float Enlighten::IPrecompProbeSetBuildParameters::GetErrorThreshold
public: float GetErrorThreshold() const
Determines the threshold of interpolation error below which a point may be removed.
virtual bool Enlighten::IPrecompProbeSetBuildParameters::GetExcludeEnvironmentInPrimaryBounce
public: bool GetExcludeEnvironmentInPrimaryBounce() const
Whether to exclude environment when solving the probes directly.
virtual bool Enlighten::IPrecompProbeSetBuildParameters::GetIndividualProbes
public: bool GetIndividualProbes() const
Whether to treat the probes in this set entirely individually, and disable optimisations in the EntireProbeSetSolver which share data between probes.
This is useful for probe sets of "dedicated" probes which are positioned exactly where required by static meshes, but not near each other. The default value is false.
virtual Geo::u32 Enlighten::IPrecompProbeSetBuildParameters::GetMaximumProbeCount
public: Geo::u32 GetMaximumProbeCount() const
Limits maximum number of probes allowed in a set for debugging purposes, default is 2^24.
virtual Geo::s32 Enlighten::IPrecompProbeSetBuildParameters::GetNumEnvironmentVisibilitySHCoefficients
public: Geo::s32 GetNumEnvironmentVisibilitySHCoefficients() const
The number of SH coefficients used for environment visibility.
Can be Enlighten::SH_ORDER_DISABLED, Enlighten::SH_ORDER_L0, Enlighten::SH_ORDER_L1 or Enlighten::SH_ORDER_L2.
virtual Geo::s32 Enlighten::IPrecompProbeSetBuildParameters::GetNumSHCoefficients
public: Geo::s32 GetNumSHCoefficients() const
The number of SH coefficients used.
Can be Enlighten::SH_ORDER_L1 or Enlighten::SH_ORDER_L2.
virtual Geo::s32 Enlighten::IPrecompProbeSetBuildParameters::GetQuality
public: Geo::s32 GetQuality() const
The number of rays to cast for computing form factors.
virtual bool Enlighten::IPrecompProbeSetBuildParameters::GetUseCulling
public: bool GetUseCulling() const
Whether to cull probes that are not in valid locations.
virtual Enlighten::WorldAxis Enlighten::IPrecompProbeSetBuildParameters::GetVerticalAxis
public: Enlighten::WorldAxis GetVerticalAxis() const
The axis aligned vector pointing directly upwards.
virtual float Enlighten::IPrecompProbeSetBuildParameters::GetVisibilityThreshold
public: float GetVisibilityThreshold() const
The necessary visibility of a cluster to be used as form factor.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetBudget
public: void SetBudget
(
  Geo::s32 budget
)
The number of form factors to store per output sample.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetCoefficientBasis
public: void SetCoefficientBasis
(
  const Geo::v128 & basisX,
  const Geo::v128 & basisY,
  const Geo::v128 & basisZ
)
The basis vectors for the probe coefficients.
Must be axis aligned and orthonormal. Defaults to (+x, +y, +z).
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetCoefficientOrder
public: void SetCoefficientOrder
(
  const Geo::s8 * coefficientOrder
)
The desired output order of the coefficients.
Must be called after SetNumSHCoefficients. The length of the array must be 4 for L1 probe sets, and 9 for L2. Each value maps the indexed coefficient to the position of the index in the coefficientOrder array. By default the order is {012345678} which maps to an output order of: Y_00, Y_11, Y_10, Y_1-1; Y_20, Y_21, Y_2-1, Y_2-2, Y_22
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetCullingThreshold
public: void SetCullingThreshold
(
  float cullingThreshold
)
Determines the threshold of valid visibility below which a point is culled.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetDependencyIncludedSystemDistance
public: void SetDependencyIncludedSystemDistance
(
  float v
)
Bounding box of the probe set (i.e. bounding box containing all the probes) whose dependencies are being calculated is.
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 void Enlighten::IPrecompProbeSetBuildParameters::SetDependencyLocalityDistance
public: void SetDependencyLocalityDistance
(
  float v
)
Maximum distance at which a given system will be considered local.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetDependencyVisibilityThreshold
public: void SetDependencyVisibilityThreshold
(
  float v
)
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 void Enlighten::IPrecompProbeSetBuildParameters::SetEnvironmentResolution
public: void SetEnvironmentResolution
(
  Geo::s32 v
)
The resolution for each face of the environment map.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetEnvironmentValidity
public: void SetEnvironmentValidity
(
  Enlighten::EnvironmentValidity v
)
Limits the region of the environment that is valid.
Indirect lighting data is not generated for probes that see invalid regions of the environment. When a non-default value is specified, the vertical axis parameter must also be specified.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetErrorThreshold
public: void SetErrorThreshold
(
  float errorThreshold
)
Determines the threshold of interpolation error below which a point may be removed.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetExcludeEnvironmentInPrimaryBounce
public: void SetExcludeEnvironmentInPrimaryBounce
(
  bool v
)
Whether to exclude environment when solving the probes directly.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetIndividualProbes
public: void SetIndividualProbes
(
  bool b
)
Whether to treat the probes in this set entirely individually, and disable optimisations in the EntireProbeSetSolver which share data between probes.
This is useful for probe sets of "dedicated" probes which are positioned exactly where required by static meshes, but not near each other. The default value is false.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetMaximumProbeCount
public: void SetMaximumProbeCount
(
  Geo::u32 maxProbes
)
Limits maximum number of probes allowed in a set for debugging purposes, default is 2^24.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetNumEnvironmentVisibilitySHCoefficients
public: void SetNumEnvironmentVisibilitySHCoefficients
(
  Geo::s32 numCoefficients
)
The number of SH coefficients used for environment visibility.
Can be Enlighten::SH_ORDER_DISABLED, Enlighten::SH_ORDER_L0, Enlighten::SH_ORDER_L1 or Enlighten::SH_ORDER_L2.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetNumSHCoefficients
public: void SetNumSHCoefficients
(
  Geo::s32 numCoefficients
)
The number of SH coefficients used.
Can be Enlighten::SH_ORDER_L1 or Enlighten::SH_ORDER_L2.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetQuality
public: void SetQuality
(
  Geo::s32 quality
)
The number of rays to cast for computing form factors.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetUseCulling
public: void SetUseCulling
(
  bool useCulling
)
Whether to cull probes that are not in valid locations.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetVerticalAxis
public: void SetVerticalAxis
(
  Enlighten::WorldAxis v
)
The axis aligned vector pointing directly upwards.
virtual void Enlighten::IPrecompProbeSetBuildParameters::SetVisibilityThreshold
public: void SetVisibilityThreshold
(
  float visibilityThreshold
)
The necessary visibility of a cluster to be used as form factor.