ph::DirectEnergySampleOutput Class Reference

Output for DirectEnergySampleQuery. More...

#include <DirectEnergySampleQuery.h>

Public Member Functions
void	setEmitPos (const math::Vector3R &emitPos)
void	setEmittedEnergy (const math::Spectrum &emittedEnergy)
void	setPdf (const lta::PDF &pdf)
void	setSrcPrimitive (const Primitive *srcPrimitive)
void	setObservationRay (const Ray &observationRay)
const math::Vector3R &	getEmitPos () const
const math::Spectrum &	getEmittedEnergy () const
	The sampled emitted energy of. Does not contain any path weighting.
real	getPdfW () const
const lta::PDF &	getPdf () const
const Primitive &	getSrcPrimitive () const
const Ray &	getObservationRay () const
	Get the ray from target position to sampled emitting position. If target position or emitting position is required, it is recommended to use DirectEnergySampleInput::getTargetPos() and getEmitPos(), respectively. Using the head and tail of the observation ray tends to have larger numerical error.
	operator bool () const
	Checks the validity of the sample.

Detailed Description

Output for DirectEnergySampleQuery.

Member Function Documentation

getEmitPos()

const math::Vector3R & ph::DirectEnergySampleOutput::getEmitPos ( ) const

inline

Returns

The position that emits energy.

getEmittedEnergy()

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

inline

The sampled emitted energy of. Does not contain any path weighting.

getObservationRay()

const Ray & ph::DirectEnergySampleOutput::getObservationRay ( ) const

inline

Get the ray from target position to sampled emitting position. If target position or emitting position is required, it is recommended to use DirectEnergySampleInput::getTargetPos() and getEmitPos(), respectively. Using the head and tail of the observation ray tends to have larger numerical error.

getPdf()

const lta::PDF & ph::DirectEnergySampleOutput::getPdf ( ) const

inline

getPdfW()

real ph::DirectEnergySampleOutput::getPdfW ( ) const

inline

getSrcPrimitive()

const Primitive & ph::DirectEnergySampleOutput::getSrcPrimitive ( ) const

inline

operator bool()

ph::DirectEnergySampleOutput::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.

setEmitPos()

void ph::DirectEnergySampleOutput::setEmitPos ( const math::Vector3R & emitPos )

inline

setEmittedEnergy()

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

inline

setObservationRay()

void ph::DirectEnergySampleOutput::setObservationRay ( const Ray & observationRay )

inline

setPdf()

void ph::DirectEnergySampleOutput::setPdf ( const lta::PDF & pdf )

inline

setSrcPrimitive()

void ph::DirectEnergySampleOutput::setSrcPrimitive ( const Primitive * srcPrimitive )

inline

---

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

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