ph::ViewPathTracingPolicy Class Reference

Specifying and querying policies for tracing view path. More...

#include <ViewPathTracingPolicy.h>

Public Member Functions
	ViewPathTracingPolicy ()
ViewPathTracingPolicy &	kill ()
	Kills the path.
ViewPathTracingPolicy &	useRussianRoulette (bool useRR)
	Use russian roulette to kill the path.
ViewPathTracingPolicy &	traceSinglePathFor (SurfaceElemental elemental)
	Effectively as specifying EViewPathSampleMode::SinglePath.
ViewPathTracingPolicy &	traceBranchedPathFor (SurfacePhenomena phenomena)
	Effectively as specifying EViewPathSampleMode::ElementalBranch.
bool	isKilled () const
bool	useRussianRoulette () const
EViewPathSampleMode	getSampleMode () const
SurfacePhenomena	getTargetPhenomena () const
SurfaceElemental	getTargetElemental () const

Detailed Description

Specifying and querying policies for tracing view path.

Constructor & Destructor Documentation

ViewPathTracingPolicy()

ph::ViewPathTracingPolicy::ViewPathTracingPolicy ( )

inline

Member Function Documentation

getSampleMode()

EViewPathSampleMode ph::ViewPathTracingPolicy::getSampleMode ( ) const

inline

getTargetElemental()

SurfaceElemental ph::ViewPathTracingPolicy::getTargetElemental ( ) const

inline

getTargetPhenomena()

SurfacePhenomena ph::ViewPathTracingPolicy::getTargetPhenomena ( ) const

inline

isKilled()

bool ph::ViewPathTracingPolicy::isKilled ( ) const

inline

kill()

ViewPathTracingPolicy & ph::ViewPathTracingPolicy::kill ( )

inline

Kills the path.

traceBranchedPathFor()

ViewPathTracingPolicy & ph::ViewPathTracingPolicy::traceBranchedPathFor ( SurfacePhenomena phenomena )

inline

Effectively as specifying EViewPathSampleMode::ElementalBranch.

Parameters

phenomena

The target phenomena for tracing. Path will not be traced if the elemental's phenomenon is not one of the targets.

traceSinglePathFor()

ViewPathTracingPolicy & ph::ViewPathTracingPolicy::traceSinglePathFor ( SurfaceElemental elemental )

inline

Effectively as specifying EViewPathSampleMode::SinglePath.

Parameters

elemental

The desired elemental for tracing the path.

useRussianRoulette() [1/2]

bool ph::ViewPathTracingPolicy::useRussianRoulette ( ) const

inline

useRussianRoulette() [2/2]

ViewPathTracingPolicy & ph::ViewPathTracingPolicy::useRussianRoulette ( bool useRR )

inline

Use russian roulette to kill the path.

---

The documentation for this class was generated from the following file:

• Source/Core/Renderer/PM/ViewPathTracingPolicy.h