EnvironmentMap Class Reference

Environment map using latitude-longitude format. An environment map roughly models distant illumination surrounding a scene by conceptually surrounding the scene with a spherical emitter that emits light inwards according to a distribution defined by a 2D 'environment' texture map that is projected onto the surface of the sphere. Note the term HDR environment map is thrown around a lot; the only difference is that the underlying environment texture is stored in some type of high dynamic range format, such as OpenEXR or HDR. More...

#include <EnvironmentMap.h>

Inheritance diagram for EnvironmentMap:

Emitter BSDF Sampler SSEAligned

List of all members.

Public Member Functions

Constructors
 EnvironmentMap (Material *parent=NULL, ImagePtr image=ImagePtr())
virtual ~EnvironmentMap ()
Initialization
virtual void init ()
 Performs any initialization that may be necessary before beginning to use this environment map.
Main usage interface
virtual SpectralSampleSet getLe (const Vector3 &w)
virtual void preview (Shape *shape)
 Overridden to be empty.
Accessors / Mutators
ImagePtrgetImage ()
void setImage (ImagePtr image)
Spherical <-> Planar mapping
virtual Vector2 getSphericalCoords (const Vector3 &w)
virtual Vector2 getSphericalCoords (const UV &uv)
virtual UV getUV (const Vector3 &w)
virtual UV getUV (const Vector2 &coords)
virtual Vector3 getDirection (const UV &uv)

Protected Attributes

KernelFilterm_filter
ImagePtr m_image


Detailed Description

Environment map using latitude-longitude format. An environment map roughly models distant illumination surrounding a scene by conceptually surrounding the scene with a spherical emitter that emits light inwards according to a distribution defined by a 2D 'environment' texture map that is projected onto the surface of the sphere. Note the term HDR environment map is thrown around a lot; the only difference is that the underlying environment texture is stored in some type of high dynamic range format, such as OpenEXR or HDR.

Author:
Travis Fischer (fisch0920@gmail.com)
Date:
Fall 2008

Definition at line 27 of file EnvironmentMap.h.


Constructor & Destructor Documentation

EnvironmentMap::EnvironmentMap ( Material parent = NULL,
ImagePtr  image = ImagePtr() 
) [inline]

Definition at line 32 of file EnvironmentMap.h.

virtual EnvironmentMap::~EnvironmentMap (  )  [inline, virtual]

Definition at line 38 of file EnvironmentMap.h.


Member Function Documentation

void EnvironmentMap::init (  )  [virtual]

Performs any initialization that may be necessary before beginning to use this environment map.

Reimplemented from Emitter.

Definition at line 22 of file EnvironmentMap.cpp.

SpectralSampleSet EnvironmentMap::getLe ( const Vector3 w  )  [virtual]

Returns:
the spectral radiance emitted along the given vector

Implements Emitter.

Definition at line 42 of file EnvironmentMap.cpp.

void EnvironmentMap::preview ( Shape shape  )  [virtual]

Overridden to be empty.

Reimplemented from Emitter.

Definition at line 39 of file EnvironmentMap.cpp.

ImagePtr& EnvironmentMap::getImage (  )  [inline]

Definition at line 71 of file EnvironmentMap.h.

void EnvironmentMap::setImage ( ImagePtr  image  )  [inline]

Definition at line 75 of file EnvironmentMap.h.

Vector2 EnvironmentMap::getSphericalCoords ( const Vector3 w  )  [virtual]

Definition at line 61 of file EnvironmentMap.cpp.

Vector2 EnvironmentMap::getSphericalCoords ( const UV uv  )  [virtual]

Definition at line 73 of file EnvironmentMap.cpp.

UV EnvironmentMap::getUV ( const Vector3 w  )  [virtual]

Definition at line 77 of file EnvironmentMap.cpp.

UV EnvironmentMap::getUV ( const Vector2 coords  )  [virtual]

Definition at line 81 of file EnvironmentMap.cpp.

Vector3 EnvironmentMap::getDirection ( const UV uv  )  [virtual]

Definition at line 85 of file EnvironmentMap.cpp.


Member Data Documentation

Definition at line 94 of file EnvironmentMap.h.

Definition at line 95 of file EnvironmentMap.h.


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

Generated on 28 Feb 2009 for Milton by doxygen 1.5.6