PhotonMappingVisualizer.h

Go to the documentation of this file.

#pragma once
 
#include "EngineEnv/Visualizer/FrameVisualizer.h"
#include "Math/TVector2.h"
#include "Math/Geometry/TAABB2D.h"
#include "SDL/sdl_interface.h"
#include "EngineEnv/Visualizer/sdl_photon_mapping_mode.h"
#include "EngineEnv/Visualizer/sdl_sample_filter_type.h"
#include "Core/Renderer/PM/PMCommonParams.h"
 
#include <Common/primitive_type.h>
 
#include <memory>
 
namespace ph { class IRayEnergyEstimator; }
namespace ph { class SampleFilter; }
 
namespace ph
{
 
class PhotonMappingVisualizer : public FrameVisualizer
{
public:
    void cook(const CoreCookingContext& ctx, CoreCookedUnit& cooked) override;
 
    EPhotonMappingMode getMode() const;
    ESampleFilter getSampleFilter() const;
 
protected:
    SampleFilter makeSampleFilter() const;
    PMCommonParams makeCommonParams() const;
 
private:
    EPhotonMappingMode m_mode;
    ESampleFilter m_sampleFilter;
    uint64 m_numPhotons;
    uint64 m_numPasses;
    uint64 m_numSamplesPerPixel;
    real m_photonRadius;
    uint32 m_glossyMergeBeginLength;
    uint32 m_stochasticViewSampleBeginLength;
 
public:
    PH_DEFINE_SDL_CLASS(TSdlOwnerClass<PhotonMappingVisualizer>)
    {
        ClassType clazz("photon-mapping");
        clazz.docName("Photon Mapping Visualizer");
        clazz.description("Render frames with common photon mapping methods.");
        clazz.baseOn<FrameVisualizer>();
 
        TSdlEnumField<OwnerType, EPhotonMappingMode> mode("mode", &OwnerType::m_mode);
        mode.description(
            "The photon mapping technique used by the visualizer.");
        mode.defaultTo(EPhotonMappingMode::Vanilla);
        mode.optional();
        clazz.addField(mode);
 
        TSdlEnumField<OwnerType, ESampleFilter> sampleFilter("sample-filter", &OwnerType::m_sampleFilter);
        sampleFilter.description(
            "Sample filter for the film sampling process.");
        sampleFilter.defaultTo(ESampleFilter::BlackmanHarris);
        sampleFilter.optional();
        clazz.addField(sampleFilter);
 
        // Borrow the default values there
        const PMCommonParams commonParams{};
 
        TSdlUInt64<OwnerType> numPhotons("num-photons", &OwnerType::m_numPhotons);
        numPhotons.description(
            "Number of photons used. For progressive techniques, this value is for a single pass.");
        numPhotons.defaultTo(commonParams.numPhotons);
        numPhotons.optional();
        clazz.addField(numPhotons);
 
        TSdlUInt64<OwnerType> numPasses("num-passes", &OwnerType::m_numPasses);
        numPasses.description(
            "Number of passes performed by progressive techniques.");
        numPasses.defaultTo(commonParams.numPasses);
        numPasses.optional();
        clazz.addField(numPasses);
 
        TSdlUInt64<OwnerType> numSamplesPerPixel("num-samples-per-pixel", &OwnerType::m_numSamplesPerPixel);
        numSamplesPerPixel.description(
            "Number of samples per pixel. Higher values can resolve image aliasing, but can consume "
            "large amounts of memory for some algorithms. This value can also mean the number of "
            "statistics gathered in a single pixel for some techniques. If the value is not a "
            "power-of-2 number, it may be adjusted.");
        numSamplesPerPixel.defaultTo(commonParams.numSamplesPerPixel);
        numSamplesPerPixel.optional();
        clazz.addField(numSamplesPerPixel);
 
        TSdlReal<OwnerType> photonRadius("photon-radius", &OwnerType::m_photonRadius);
        photonRadius.description(
            "Energy contribution radius for each photon. For progressive techniques, this value is for "
            "setting up the initial radius.");
        photonRadius.defaultTo(commonParams.kernelRadius);
        photonRadius.optional();
        clazz.addField(photonRadius);
 
        TSdlUInt32<OwnerType> glossyMergeBeginLength("glossy-merge-begin-length", &OwnerType::m_glossyMergeBeginLength);
        glossyMergeBeginLength.description(
            "Hint for the minimum path length to start estimating energy using photons on glossy surface."
            "If the scene contains diffuse surface and is easily reachable by photons, it is recommended "
            "to set this to a lower value.");
        glossyMergeBeginLength.defaultTo(commonParams.glossyMergeBeginLength);
        glossyMergeBeginLength.optional();
        clazz.addField(glossyMergeBeginLength);
 
        TSdlUInt32<OwnerType> stochasticViewSampleBeginLength("stochastic-view-sample-begin-length", &OwnerType::m_stochasticViewSampleBeginLength);
        stochasticViewSampleBeginLength.description(
            "Hint for the view path length to start random path sampling. If this value differ too much "
            "from the mean specular path length from the scene, the energy estimation result may contain "
            "higher variance or bias. Beware when using higher values as non-stochastic path may be "
            "branched, which can result in exponential growth of number of rays.");
        stochasticViewSampleBeginLength.defaultTo(commonParams.stochasticViewSampleBeginLength);
        stochasticViewSampleBeginLength.optional();
        clazz.addField(stochasticViewSampleBeginLength);
 
        return clazz;
    }
};
 
// In-header Implementations:
 
inline EPhotonMappingMode PhotonMappingVisualizer::getMode() const
{
    return m_mode;
}
 
inline ESampleFilter PhotonMappingVisualizer::getSampleFilter() const
{
    return m_sampleFilter;
}
 
}// end namespace ph