PhotonMapEnergy Class Reference

#include <PhotonMapEnergy.h>

Inheritance diagram for PhotonMapEnergy:

List of all members.

Public Types
enum	Type { UNKNOWN, POLYGONAL, MAP2D, MAP3D }
Public Member Functions
	PhotonMapEnergy ()
virtual	~PhotonMapEnergy ()
virtual Type	type (void) const
const PhotonMap *	getGlobalMap () const
const PhotonMap *	getCausticsMap () const
IrradianceCache *const	getIrradianceCache ()
void	storeGlobalPhoton (const Photon &photon)
void	storeCausticPhoton (const Photon &photon)
bool	buildGlobalMap ()
bool	buildCausticsMap ()
bool	buildIrradianceCache (float wFactor, float dist)
bool	isGlobalMapBuilt () const
bool	isCausticsMapBuilt () const
unsigned	numGlobalPhotons () const
unsigned	numCausticPhotons () const
PhotonsIterator *	globalMapIterator () const
PhotonsIterator *	causticsMapIterator () const
Protected Attributes
vector< Photon >	_globalPhotons
vector< Photon >	_causticPhotons
PhotonMap *	_pGlobalMap
PhotonMap *	_pCausticsMap
IrradianceCache *	_pIrradCache
Geometry *	_pGeometry

---

Detailed Description

Definition at line 19 of file PhotonMapEnergy.h.

---

Member Enumeration Documentation

enum Type [inherited]

Enumerator: UNKNOWN  POLYGONAL  MAP2D  MAP3D  Definition at line 14 of file EnergyCoat.h.

---

Constructor & Destructor Documentation

PhotonMapEnergy (   )  [inline]

Implicit cosntructor with empty maps. Definition at line 31 of file PhotonMapEnergy.h.

virtual ~PhotonMapEnergy (   )  [inline, virtual]

Destructor. Never deletes stored photons! Use clearPhotons() to delete them. Definition at line 41 of file PhotonMapEnergy.h.

---

Member Function Documentation

bool buildCausticsMap (   )  [inline]

Builds the map from list of photons. This operation can be invoked only once. Returns: true on success, false otherwise Definition at line 106 of file PhotonMapEnergy.h.

bool buildGlobalMap (   )  [inline]

Builds the map from list of photons. This operation can be invoked only once. Returns: true on success, false otherwise Definition at line 93 of file PhotonMapEnergy.h.

bool buildIrradianceCache (  float  wFactor, float  dist )  [inline]

Builds an empty irradiance cache, deletes the old one if exists. Parameters: wFacor  user-defined parameter 1/a, where a is proportional to acceptable error of estimate dist  maximal distance of scene (size of the root of octree) Returns: true on success, false otherwise Definition at line 121 of file PhotonMapEnergy.h.

PhotonsIterator* causticsMapIterator (   )  const [inline]

Returns: Iterator of caustics photon map or null Definition at line 176 of file PhotonMapEnergy.h.

const PhotonMap* getCausticsMap (   )  const [inline]

Returns: reference to caustic photon map or null if the map was not built yet Definition at line 58 of file PhotonMapEnergy.h.

const PhotonMap* getGlobalMap (   )  const [inline]

Returns: reference to global photon map or null if map was not built Definition at line 52 of file PhotonMapEnergy.h.

IrradianceCache* const getIrradianceCache (   )  [inline]

Returns: pointer to irradiance cache Definition at line 63 of file PhotonMapEnergy.h.

PhotonsIterator* globalMapIterator (   )  const [inline]

Returns: Iterator of global photon map or null Definition at line 169 of file PhotonMapEnergy.h.

bool isCausticsMapBuilt (   )  const [inline]

Returns: true if caustic map is built Definition at line 148 of file PhotonMapEnergy.h.

bool isGlobalMapBuilt (   )  const [inline]

Returns: true if global map is built Definition at line 141 of file PhotonMapEnergy.h.

unsigned numCausticPhotons (   )  const [inline]

Returns: number of photons stored in caustic map Definition at line 162 of file PhotonMapEnergy.h.

unsigned numGlobalPhotons (   )  const [inline]

Returns: number of photons stored in global map Definition at line 155 of file PhotonMapEnergy.h.

void storeCausticPhoton (  const Photon &  photon  )  [inline]

Appends photon to the list of photons for later photon map creation. This operation has no effect if the map was alredy built, see buildCausticsMap(). Parameters: photon  New caustic photon Definition at line 83 of file PhotonMapEnergy.h.

void storeGlobalPhoton (  const Photon &  photon  )  [inline]

Appends photon to the list of photons for later photon map creation. This operation has no effect if the map was alredy built, see buildGlobalMap(). Parameters: photon  New global photon Definition at line 72 of file PhotonMapEnergy.h.

virtual Type type (  void   )  const [inline, virtual]

Returns: energy type identification Reimplemented from EnergyCoat. Definition at line 46 of file PhotonMapEnergy.h.

---

Member Data Documentation

vector<Photon> _causticPhotons [protected]

Definition at line 22 of file PhotonMapEnergy.h.

vector<Photon> _globalPhotons [protected]

Definition at line 21 of file PhotonMapEnergy.h.

PhotonMap* _pCausticsMap [protected]

Definition at line 24 of file PhotonMapEnergy.h.

Geometry* _pGeometry [protected, inherited]

Definition at line 22 of file EnergyCoat.h.

PhotonMap* _pGlobalMap [protected]

Definition at line 23 of file PhotonMapEnergy.h.

IrradianceCache* _pIrradCache [protected]

Definition at line 25 of file PhotonMapEnergy.h.

---

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

• esg/include/esg/energy/PhotonMapEnergy.h

---