<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: vtkDirectionEncoder Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.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="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>vtkDirectionEncoder Class Reference</h1><!-- doxytag: class="vtkDirectionEncoder" --><!-- doxytag: inherits="vtkObject" --><code>#include <<a class="el" href="a05390.html">vtkDirectionEncoder.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkDirectionEncoder:</div>
<div class="dynsection">
<p><center><img src="a09278.png" border="0" usemap="#a09279" alt="Inheritance graph"></center>
<map name="a09279">
<area shape="rect" href="a01474.html" title="A direction encoder based on the recursive subdivision of an octahedron." alt="" coords="5,229,253,256"><area shape="rect" href="a01585.html" title="A direction encoder based on spherical coordinates." alt="" coords="277,229,480,256"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="213,80,293,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="199,5,308,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkDirectionEncoder:</div>
<div class="dynsection">
<p><center><img src="a09280.png" border="0" usemap="#a09281" alt="Collaboration graph"></center>
<map name="a09281">
<area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="87,96,167,123"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="5,5,115,32"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="139,5,248,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a09282.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
encode a direction into a one or two byte value
<p>
Given a direction, encode it into an integer value. This value should be less than 65536, which is the maximum number of encoded directions supported by this superclass. A direction encoded is used to encode normals in a volume for use during volume rendering, and the amount of space that is allocated per normal is 2 bytes. This is an abstract superclass - see the subclasses for specific implementation details.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a01474.html" title="A direction encoder based on the recursive subdivision of an octahedron.">vtkRecursiveSphereDirectionEncoder</a> </dd></dl>
<p>Definition at line <a class="el" href="a05390.html#l00037">37</a> of file <a class="el" href="a05390.html">vtkDirectionEncoder.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a01084.html">vtkObject</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00423.html#6f649b6fa6334146fe96f9f06994a2d7">Superclass</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00423.html#f5430586d8bc77e8ba4e144021e49ad8">GetClassName</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00423.html#67c44d285f36ebae2b5e20cac13f376d">IsA</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00423.html#666c07098efd4e7ac2ce8506ed23f284">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00423.html#34914b386f2c3e7f72c4c30f4bdd79d5">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00423.html">vtkDirectionEncoder</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00423.html#4acb1f08bed0cc54efa4c54f2d81a7e3">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00423.html#2f1df849b7d8982cb16770505757d543">GetEncodedDirection</a> (float n[3])=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00423.html#f29912b41b911f31d95dd0e90ea644a3">GetDecodedGradient</a> (int value)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00423.html#0c8572b7660aa30b335b3c1037ed7ba1">GetNumberOfEncodedDirections</a> (void)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual float * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00423.html#ce27086397c0480da8a20f9e8d6a0e03">GetDecodedGradientTable</a> (void)=0</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00423.html#914492e2b326c63b465f521469c20d54">vtkDirectionEncoder</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00423.html#6bce964e63bb6a62466fc1f91ccfea91">~vtkDirectionEncoder</a> ()</td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="6f649b6fa6334146fe96f9f06994a2d7"></a><!-- doxytag: member="vtkDirectionEncoder::Superclass" ref="6f649b6fa6334146fe96f9f06994a2d7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a01084.html">vtkObject</a> <a class="el" href="a01084.html">vtkDirectionEncoder::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name of this class
<p>Reimplemented from <a class="el" href="a01084.html#11429dee69f4b562e03e07b453dae9b5">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a01474.html#3e5833885e275da8b5e3eddeb3e9791f">vtkRecursiveSphereDirectionEncoder</a>, and <a class="el" href="a01585.html#bad49814d2f4929d278df7bc765b58e1">vtkSphericalDirectionEncoder</a>.</p>
<p>Definition at line <a class="el" href="a05390.html#l00042">42</a> of file <a class="el" href="a05390.html">vtkDirectionEncoder.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="914492e2b326c63b465f521469c20d54"></a><!-- doxytag: member="vtkDirectionEncoder::vtkDirectionEncoder" ref="914492e2b326c63b465f521469c20d54" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkDirectionEncoder::vtkDirectionEncoder </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05390.html#l00062">62</a> of file <a class="el" href="a05390.html">vtkDirectionEncoder.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="6bce964e63bb6a62466fc1f91ccfea91"></a><!-- doxytag: member="vtkDirectionEncoder::~vtkDirectionEncoder" ref="6bce964e63bb6a62466fc1f91ccfea91" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkDirectionEncoder::~vtkDirectionEncoder </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05390.html#l00063">63</a> of file <a class="el" href="a05390.html">vtkDirectionEncoder.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="f5430586d8bc77e8ba4e144021e49ad8"></a><!-- doxytag: member="vtkDirectionEncoder::GetClassName" ref="f5430586d8bc77e8ba4e144021e49ad8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkDirectionEncoder::GetClassName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name of this class
<p>Reimplemented from <a class="el" href="a01084.html#d95975c85c2896ea32ff4cf1f8de0886">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a01474.html#e96440143923760532d8bcd588fb88ac">vtkRecursiveSphereDirectionEncoder</a>, and <a class="el" href="a01585.html#fbbf7f83b6c148fac8929f7c4fd6024f">vtkSphericalDirectionEncoder</a>.</p>
</div>
</div><p>
<a class="anchor" name="34914b386f2c3e7f72c4c30f4bdd79d5"></a><!-- doxytag: member="vtkDirectionEncoder::IsTypeOf" ref="34914b386f2c3e7f72c4c30f4bdd79d5" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkDirectionEncoder::IsTypeOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name of this class
<p>Reimplemented from <a class="el" href="a01084.html#e9548a248bce0f02f73bbcccd0a9489e">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a01474.html#f7435dec4941148b6a35968c5cd9f368">vtkRecursiveSphereDirectionEncoder</a>, and <a class="el" href="a01585.html#8c4676277695b69e9cb84b27e08e4834">vtkSphericalDirectionEncoder</a>.</p>
</div>
</div><p>
<a class="anchor" name="67c44d285f36ebae2b5e20cac13f376d"></a><!-- doxytag: member="vtkDirectionEncoder::IsA" ref="67c44d285f36ebae2b5e20cac13f376d" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkDirectionEncoder::IsA </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>type</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name of this class
<p>Reimplemented from <a class="el" href="a01084.html#831e57b04e46827a7098aa81abadee69">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a01474.html#ac1f9025f925da9e074cd0e13149a12d">vtkRecursiveSphereDirectionEncoder</a>, and <a class="el" href="a01585.html#a3be4f82ed65d9884213a50494a54ecc">vtkSphericalDirectionEncoder</a>.</p>
</div>
</div><p>
<a class="anchor" name="4acb1f08bed0cc54efa4c54f2d81a7e3"></a><!-- doxytag: member="vtkDirectionEncoder::SafeDownCast" ref="4acb1f08bed0cc54efa4c54f2d81a7e3" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00423.html">vtkDirectionEncoder</a>* vtkDirectionEncoder::SafeDownCast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name of this class
<p>Reimplemented from <a class="el" href="a01084.html#bb9351f076544c427ee91229dce83abe">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a01474.html#be6e33b1491b77cfa24b8edf37bfc258">vtkRecursiveSphereDirectionEncoder</a>, and <a class="el" href="a01585.html#3cae7d1ed31f2a6768596f1c97b5d4b7">vtkSphericalDirectionEncoder</a>.</p>
</div>
</div><p>
<a class="anchor" name="666c07098efd4e7ac2ce8506ed23f284"></a><!-- doxytag: member="vtkDirectionEncoder::PrintSelf" ref="666c07098efd4e7ac2ce8506ed23f284" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkDirectionEncoder::PrintSelf </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a> </td>
<td class="paramname"> <em>indent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name of this class
<p>Reimplemented from <a class="el" href="a01084.html#bf3dbb4154289b56a12483eee3866263">vtkObject</a>.</p>
<p>Reimplemented in <a class="el" href="a01474.html#10169f493050abbd0f0304bb275cc6d7">vtkRecursiveSphereDirectionEncoder</a>, and <a class="el" href="a01585.html#24005a104a15bb5e90f5b0e2ca032681">vtkSphericalDirectionEncoder</a>.</p>
</div>
</div><p>
<a class="anchor" name="2f1df849b7d8982cb16770505757d543"></a><!-- doxytag: member="vtkDirectionEncoder::GetEncodedDirection" ref="2f1df849b7d8982cb16770505757d543" args="(float n[3])=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkDirectionEncoder::GetEncodedDirection </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"> <em>n</em>[3] </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Given a normal vector n, return the encoded direction
<p>Implemented in <a class="el" href="a01474.html#42a9dab787a6479eed766dcafaed84e8">vtkRecursiveSphereDirectionEncoder</a>, and <a class="el" href="a01585.html#9ac5f86fc12a11913a09df4f8edf749c">vtkSphericalDirectionEncoder</a>.</p>
</div>
</div><p>
<a class="anchor" name="f29912b41b911f31d95dd0e90ea644a3"></a><!-- doxytag: member="vtkDirectionEncoder::GetDecodedGradient" ref="f29912b41b911f31d95dd0e90ea644a3" args="(int value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float* vtkDirectionEncoder::GetDecodedGradient </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>value</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
/ Given an encoded value, return a pointer to the normal vector
<p>Implemented in <a class="el" href="a01474.html#af7974f5c39361397c9485ff899e003d">vtkRecursiveSphereDirectionEncoder</a>, and <a class="el" href="a01585.html#7ef967d4e5eec4c6d30c5cd32a9a7953">vtkSphericalDirectionEncoder</a>.</p>
</div>
</div><p>
<a class="anchor" name="0c8572b7660aa30b335b3c1037ed7ba1"></a><!-- doxytag: member="vtkDirectionEncoder::GetNumberOfEncodedDirections" ref="0c8572b7660aa30b335b3c1037ed7ba1" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkDirectionEncoder::GetNumberOfEncodedDirections </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the number of encoded directions
<p>Implemented in <a class="el" href="a01474.html#62b29b5d1b98a47b1d6a2cc8488eba2a">vtkRecursiveSphereDirectionEncoder</a>, and <a class="el" href="a01585.html#1136eaf04017eaed36d1cb97c518691c">vtkSphericalDirectionEncoder</a>.</p>
</div>
</div><p>
<a class="anchor" name="ce27086397c0480da8a20f9e8d6a0e03"></a><!-- doxytag: member="vtkDirectionEncoder::GetDecodedGradientTable" ref="ce27086397c0480da8a20f9e8d6a0e03" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual float* vtkDirectionEncoder::GetDecodedGradientTable </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the decoded gradient table. There are this-><a class="el" href="a00423.html#0c8572b7660aa30b335b3c1037ed7ba1">GetNumberOfEncodedDirections()</a> entries in the table, each containing a normal (direction) vector. This is a flat structure - 3 times the number of directions floats in an array.
<p>Implemented in <a class="el" href="a01474.html#8d8f915a7825b3872148885c40afd125">vtkRecursiveSphereDirectionEncoder</a>, and <a class="el" href="a01585.html#2b7a25159f767646a76bd1f3a8dc5ac0">vtkSphericalDirectionEncoder</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/VolumeRendering/<a class="el" href="a05390.html">vtkDirectionEncoder.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:00:17 2009 for VTK by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
426
