ph::EnergyEmissionSampleOutput Class Reference

Output for EnergyEmissionSampleQuery. More...

#include <EnergyEmissionSampleQuery.h>

Public Member Functions
void	setPdf (const lta::PDF &pdfPos, const lta::PDF &pdfDir)
void	setEmittedRay (const Ray &emittedRay)
void	setEmittedEnergy (const math::Spectrum &emittedEnergy)
real	getPdfA () const
real	getPdfW () const
const lta::PDF &	getPdfPos () const
const lta::PDF &	getPdfDir () const
const Ray &	getEmittedRay () const
const math::Spectrum &	getEmittedEnergy () const
	operator bool () const
	Checks the validity of the sample.

Detailed Description

Output for EnergyEmissionSampleQuery.

Member Function Documentation

getEmittedEnergy()

const math::Spectrum & ph::EnergyEmissionSampleOutput::getEmittedEnergy ( ) const

inline

getEmittedRay()

const Ray & ph::EnergyEmissionSampleOutput::getEmittedRay ( ) const

inline

getPdfA()

real ph::EnergyEmissionSampleOutput::getPdfA ( ) const

inline

getPdfDir()

const lta::PDF & ph::EnergyEmissionSampleOutput::getPdfDir ( ) const

inline

getPdfPos()

const lta::PDF & ph::EnergyEmissionSampleOutput::getPdfPos ( ) const

inline

getPdfW()

real ph::EnergyEmissionSampleOutput::getPdfW ( ) const

inline

operator bool()

ph::EnergyEmissionSampleOutput::operator bool ( ) const

inline

Checks the validity of the sample.

Returns

true if the sample is valid. false if the sample failed. A failed sample cannot be used. A typical way to fail is that sampling is not even supported/possible.

setEmittedEnergy()

void ph::EnergyEmissionSampleOutput::setEmittedEnergy ( const math::Spectrum & emittedEnergy )

inline

setEmittedRay()

void ph::EnergyEmissionSampleOutput::setEmittedRay ( const Ray & emittedRay )

inline

setPdf()

void ph::EnergyEmissionSampleOutput::setPdf ( const lta::PDF & pdfPos, const lta::PDF & pdfDir )

inline

---

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

• Source/Core/Emitter/Query/EnergyEmissionSampleQuery.h