doxygen/html/classVolumeRegion.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>pbrt: VolumeRegion Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>VolumeRegion Class Reference</h1><!-- doxytag: class="VolumeRegion" -->
<p><code>#include &lt;<a class="el" href="volume_8h_source.html">volume.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for VolumeRegion:</div>
<div class="dynsection">
 <div class="center">
  <img src="classVolumeRegion.png" usemap="#VolumeRegion_map" alt=""/>
  <map id="VolumeRegion_map" name="VolumeRegion_map">
<area href="classAggregateVolume.html" alt="AggregateVolume" shape="rect" coords="0,56,134,80"/>
<area href="classDensityRegion.html" alt="DensityRegion" shape="rect" coords="144,56,278,80"/>
<area href="classHomogeneousVolume.html" alt="HomogeneousVolume" shape="rect" coords="288,56,422,80"/>
<area href="classExponentialDensity.html" alt="ExponentialDensity" shape="rect" coords="72,112,206,136"/>
<area href="classVolumeGrid.html" alt="VolumeGrid" shape="rect" coords="216,112,350,136"/>
</map>
 </div>
</div>

<p><a href="classVolumeRegion-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVolumeRegion.html#adc28c6db38a139fb92037bcd5866a031">~VolumeRegion</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classBBox.html">BBox</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVolumeRegion.html#aea1d5b7453a57a1b08c3103e048c7176">WorldBound</a> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVolumeRegion.html#a55e67282f25b5c58632c824f597818dd">IntersectP</a> (const <a class="el" href="classRay.html">Ray</a> &amp;ray, float *t0, float *t1) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classSpectrum.html">Spectrum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVolumeRegion.html#ac4c07791e658cd9c7adc11de1f10b281">sigma_a</a> (const <a class="el" href="classPoint.html">Point</a> &amp;, const <a class="el" href="classVector.html">Vector</a> &amp;) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classSpectrum.html">Spectrum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVolumeRegion.html#a7b8fc74ae58026a7dbf9b29b4d125998">sigma_s</a> (const <a class="el" href="classPoint.html">Point</a> &amp;, const <a class="el" href="classVector.html">Vector</a> &amp;) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classSpectrum.html">Spectrum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVolumeRegion.html#a204a4159db9cf97002a98ff65725d557">Lve</a> (const <a class="el" href="classPoint.html">Point</a> &amp;, const <a class="el" href="classVector.html">Vector</a> &amp;) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVolumeRegion.html#a53101ab357b591db384fbae6036df9cd">p</a> (const <a class="el" href="classPoint.html">Point</a> &amp;, const <a class="el" href="classVector.html">Vector</a> &amp;, const <a class="el" href="classVector.html">Vector</a> &amp;) const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classSpectrum.html">Spectrum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVolumeRegion.html#a84227d16d6308fa03fb4d0d1c168fb87">sigma_t</a> (const <a class="el" href="classPoint.html">Point</a> &amp;, const <a class="el" href="classVector.html">Vector</a> &amp;) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classSpectrum.html">Spectrum</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classVolumeRegion.html#a4be8cab8f7516b69c45c8858903d4bdf">Tau</a> (const <a class="el" href="classRay.html">Ray</a> &amp;ray, float step=1.f, float offset=0.5) const =0</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>

<p>Definition at line <a class="el" href="volume_8h_source.html#l00043">43</a> of file <a class="el" href="volume_8h_source.html">volume.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="adc28c6db38a139fb92037bcd5866a031"></a><!-- doxytag: member="VolumeRegion::~VolumeRegion" ref="adc28c6db38a139fb92037bcd5866a031" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual VolumeRegion::~VolumeRegion </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="volume_8h_source.html#l00046">46</a> of file <a class="el" href="volume_8h_source.html">volume.h</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a55e67282f25b5c58632c824f597818dd"></a><!-- doxytag: member="VolumeRegion::IntersectP" ref="a55e67282f25b5c58632c824f597818dd" args="(const Ray &amp;ray, float *t0, float *t1) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool VolumeRegion::IntersectP </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classRay.html">Ray</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>ray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float *&nbsp;</td>
          <td class="paramname"> <em>t0</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float *&nbsp;</td>
          <td class="paramname"> <em>t1</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implemented in <a class="el" href="classAggregateVolume.html#aee0676e0490e2ed8457280d86c007bba">AggregateVolume</a>, <a class="el" href="classExponentialDensity.html#a43a471d346c4dd7c16b1b893ef49c267">ExponentialDensity</a>, <a class="el" href="classHomogeneousVolume.html#a1320ef12c2a646d51c76fd66a4aae85b">HomogeneousVolume</a>, and <a class="el" href="classVolumeGrid.html#a461a73cfdbe22df2c7f7be6e22651f85">VolumeGrid</a>.</p>

<p>Referenced by <a class="el" href="single_8cpp_source.html#l00057">SingleScattering::Li()</a>, <a class="el" href="emission_8cpp_source.html#l00060">EmissionIntegrator::Li()</a>, and <a class="el" href="volume_8cpp_source.html#l00137">DensityRegion::Tau()</a>.</p>

</div>
</div>
<a class="anchor" id="a204a4159db9cf97002a98ff65725d557"></a><!-- doxytag: member="VolumeRegion::Lve" ref="a204a4159db9cf97002a98ff65725d557" args="(const Point &amp;, const Vector &amp;) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classSpectrum.html">Spectrum</a> VolumeRegion::Lve </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPoint.html">Point</a> &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classVector.html">Vector</a> &amp;&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implemented in <a class="el" href="classDensityRegion.html#a69cdaaf79c1448f22d3ca9aec8728c43">DensityRegion</a>, <a class="el" href="classAggregateVolume.html#afb66fe4b711bc54f60d8ec9612d0c8ef">AggregateVolume</a>, and <a class="el" href="classHomogeneousVolume.html#ab68f9f246f37bdc90f7ac2153b372830">HomogeneousVolume</a>.</p>

<p>Referenced by <a class="el" href="single_8cpp_source.html#l00057">SingleScattering::Li()</a>, and <a class="el" href="emission_8cpp_source.html#l00060">EmissionIntegrator::Li()</a>.</p>

</div>
</div>
<a class="anchor" id="a53101ab357b591db384fbae6036df9cd"></a><!-- doxytag: member="VolumeRegion::p" ref="a53101ab357b591db384fbae6036df9cd" args="(const Point &amp;, const Vector &amp;, const Vector &amp;) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual float VolumeRegion::p </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPoint.html">Point</a> &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classVector.html">Vector</a> &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classVector.html">Vector</a> &amp;&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implemented in <a class="el" href="classDensityRegion.html#a008172d896950636d0e683be615c312a">DensityRegion</a>, <a class="el" href="classAggregateVolume.html#ae1b09381a6cfceda54396b9f7de1c6ab">AggregateVolume</a>, and <a class="el" href="classHomogeneousVolume.html#a1319875df3cdf1021e357f5e32edd3cc">HomogeneousVolume</a>.</p>

<p>Referenced by <a class="el" href="single_8cpp_source.html#l00057">SingleScattering::Li()</a>.</p>

</div>
</div>
<a class="anchor" id="ac4c07791e658cd9c7adc11de1f10b281"></a><!-- doxytag: member="VolumeRegion::sigma_a" ref="ac4c07791e658cd9c7adc11de1f10b281" args="(const Point &amp;, const Vector &amp;) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classSpectrum.html">Spectrum</a> VolumeRegion::sigma_a </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPoint.html">Point</a> &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classVector.html">Vector</a> &amp;&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implemented in <a class="el" href="classDensityRegion.html#aa2620e5499b069d429da6fcb201d3eff">DensityRegion</a>, <a class="el" href="classAggregateVolume.html#a5e3b2fc59f848eb91c1757026842cab4">AggregateVolume</a>, and <a class="el" href="classHomogeneousVolume.html#adbfcc45200a1b301ded66f57243b553f">HomogeneousVolume</a>.</p>

<p>Referenced by <a class="el" href="volume_8cpp_source.html#l00057">sigma_t()</a>.</p>

</div>
</div>
<a class="anchor" id="a7b8fc74ae58026a7dbf9b29b4d125998"></a><!-- doxytag: member="VolumeRegion::sigma_s" ref="a7b8fc74ae58026a7dbf9b29b4d125998" args="(const Point &amp;, const Vector &amp;) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classSpectrum.html">Spectrum</a> VolumeRegion::sigma_s </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPoint.html">Point</a> &amp;&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classVector.html">Vector</a> &amp;&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implemented in <a class="el" href="classDensityRegion.html#a04cd33c7d14296fb222fe2a0687ba4d0">DensityRegion</a>, <a class="el" href="classAggregateVolume.html#a60cd24eebee05999a97682417dd0cc5f">AggregateVolume</a>, and <a class="el" href="classHomogeneousVolume.html#a0ac106159012200366b7d2a63239de9f">HomogeneousVolume</a>.</p>

<p>Referenced by <a class="el" href="single_8cpp_source.html#l00057">SingleScattering::Li()</a>, and <a class="el" href="volume_8cpp_source.html#l00057">sigma_t()</a>.</p>

</div>
</div>
<a class="anchor" id="a84227d16d6308fa03fb4d0d1c168fb87"></a><!-- doxytag: member="VolumeRegion::sigma_t" ref="a84227d16d6308fa03fb4d0d1c168fb87" args="(const Point &amp;, const Vector &amp;) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classSpectrum.html">Spectrum</a> VolumeRegion::sigma_t </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classPoint.html">Point</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classVector.html">Vector</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>w</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Reimplemented in <a class="el" href="classDensityRegion.html#abeec1c76c3b02934eda0b8ea842bf48c">DensityRegion</a>, <a class="el" href="classAggregateVolume.html#a8697e68b0c96bcc444b93d4275fa7c52">AggregateVolume</a>, and <a class="el" href="classHomogeneousVolume.html#ae744eb80f65873ccf5252f775f8d3d0f">HomogeneousVolume</a>.</p>

<p>Definition at line <a class="el" href="volume_8cpp_source.html#l00057">57</a> of file <a class="el" href="volume_8cpp_source.html">volume.cpp</a>.</p>

<p>References <a class="el" href="classVolumeRegion.html#ac4c07791e658cd9c7adc11de1f10b281">sigma_a()</a>, and <a class="el" href="classVolumeRegion.html#a7b8fc74ae58026a7dbf9b29b4d125998">sigma_s()</a>.</p>

</div>
</div>
<a class="anchor" id="a4be8cab8f7516b69c45c8858903d4bdf"></a><!-- doxytag: member="VolumeRegion::Tau" ref="a4be8cab8f7516b69c45c8858903d4bdf" args="(const Ray &amp;ray, float step=1.f, float offset=0.5) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classSpectrum.html">Spectrum</a> VolumeRegion::Tau </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classRay.html">Ray</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>ray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>step</em> = <code>1.f</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>offset</em> = <code>0.5</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implemented in <a class="el" href="classDensityRegion.html#a1f6bb7c121fd1f83894044b6b6758907">DensityRegion</a>, <a class="el" href="classAggregateVolume.html#ada1c7a54084852fd323495826e724618">AggregateVolume</a>, and <a class="el" href="classHomogeneousVolume.html#a5bd7e5842169ef3e16e976754cd62fe9">HomogeneousVolume</a>.</p>

<p>Referenced by <a class="el" href="single_8cpp_source.html#l00057">SingleScattering::Li()</a>, <a class="el" href="emission_8cpp_source.html#l00060">EmissionIntegrator::Li()</a>, <a class="el" href="single_8cpp_source.html#l00048">SingleScattering::Transmittance()</a>, and <a class="el" href="emission_8cpp_source.html#l00048">EmissionIntegrator::Transmittance()</a>.</p>

</div>
</div>
<a class="anchor" id="aea1d5b7453a57a1b08c3103e048c7176"></a><!-- doxytag: member="VolumeRegion::WorldBound" ref="aea1d5b7453a57a1b08c3103e048c7176" args="() const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classBBox.html">BBox</a> VolumeRegion::WorldBound </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implemented in <a class="el" href="classAggregateVolume.html#a495aab26d60cbe2cf46566e54b636d6b">AggregateVolume</a>, <a class="el" href="classExponentialDensity.html#ac48ca191f418669c79e9378703c1cd88">ExponentialDensity</a>, <a class="el" href="classHomogeneousVolume.html#a0e8eb56e3e26b9101ce5666e2f79173d">HomogeneousVolume</a>, and <a class="el" href="classVolumeGrid.html#a31716e3af7d51c675aeaa28e3c8d7143">VolumeGrid</a>.</p>

<p>Referenced by <a class="el" href="scene_8cpp_source.html#l00099">Scene::Scene()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="volume_8h_source.html">volume.h</a></li>
<li><a class="el" href="volume_8cpp_source.html">volume.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>