ViewPathTracingPolicy.h

Go to the documentation of this file.

#pragma once
 
#include "Core/SurfaceBehavior/surface_optics_fwd.h"
 
#include <Common/assertion.h>
 
namespace ph
{
 
enum class EViewPathSampleMode
{
    SinglePath,
 
    ElementalBranch
};
 
class ViewPathTracingPolicy
{
public:
    ViewPathTracingPolicy();
 
    ViewPathTracingPolicy& kill();
 
    ViewPathTracingPolicy& useRussianRoulette(bool useRR);
 
    ViewPathTracingPolicy& traceSinglePathFor(SurfaceElemental elemental);
 
    ViewPathTracingPolicy& traceBranchedPathFor(SurfacePhenomena phenomena);
 
    bool isKilled() const;
    bool useRussianRoulette() const;
    EViewPathSampleMode getSampleMode() const;
    SurfacePhenomena getTargetPhenomena() const;
    SurfaceElemental getTargetElemental() const;
 
private:
    bool                m_isKilled;
    bool                m_useRussianRoulette;
    EViewPathSampleMode m_sampleMode;
    SurfaceElemental    m_targetElemental;
    SurfacePhenomena    m_targetPhenomena;
};
 
// In-header Implementations:
 
inline ViewPathTracingPolicy::ViewPathTracingPolicy() : 
    m_isKilled(false),
    m_useRussianRoulette(true),
    m_sampleMode(EViewPathSampleMode::SinglePath),
    m_targetElemental(ALL_SURFACE_ELEMENTALS),
    m_targetPhenomena()
{}
 
inline ViewPathTracingPolicy& ViewPathTracingPolicy::kill()
{
    m_isKilled = true;
 
    return *this;
}
 
inline ViewPathTracingPolicy& ViewPathTracingPolicy::useRussianRoulette(const bool useRR)
{
    m_useRussianRoulette = useRR;
 
    return *this;
}
 
inline ViewPathTracingPolicy& ViewPathTracingPolicy::traceSinglePathFor(const SurfaceElemental elemental)
{
    m_sampleMode      = EViewPathSampleMode::SinglePath;
    m_targetElemental = elemental;
 
    return *this;
}
 
inline ViewPathTracingPolicy& ViewPathTracingPolicy::traceBranchedPathFor(const SurfacePhenomena phenomena)
{
    m_sampleMode      = EViewPathSampleMode::ElementalBranch;
    m_targetPhenomena = phenomena;
 
    return *this;
}
 
inline bool ViewPathTracingPolicy::useRussianRoulette() const
{
    return m_useRussianRoulette;
}
 
inline EViewPathSampleMode ViewPathTracingPolicy::getSampleMode() const
{
    return m_sampleMode;
}
 
inline SurfaceElemental ViewPathTracingPolicy::getTargetElemental() const
{
    PH_ASSERT(m_sampleMode == EViewPathSampleMode::SinglePath);
 
    return m_targetElemental;
}
 
inline SurfacePhenomena ViewPathTracingPolicy::getTargetPhenomena() const
{
    PH_ASSERT(m_sampleMode == EViewPathSampleMode::ElementalBranch);
 
    return m_targetPhenomena;
}
 
inline bool ViewPathTracingPolicy::isKilled() const
{
    return m_isKilled;
}
 
}// end namespace ph