Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 60f1dc962abad0f3b492991a4fbef9be > files > 182

vtk-doc-5.4.2-5mdv2010.0.noarch.rpm

<!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: vtkBMPWriter 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
      <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>vtkBMPWriter Class Reference</h1><!-- doxytag: class="vtkBMPWriter" --><!-- doxytag: inherits="vtkImageWriter" --><code>#include &lt;<a class="el" href="a04891.html">vtkBMPWriter.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkBMPWriter:</div>
<div class="dynsection">
<p><center><img src="a08169.png" border="0" usemap="#a08170" alt="Inheritance graph"></center>
<map name="a08170">
<area shape="rect" href="a00851.html" title="Writes images to files." alt="" coords="16,304,131,331"><area shape="rect" href="a00727.html" title="Generic algorithm superclass for image algs." alt="" coords="6,230,142,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="24,155,123,182"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="34,80,114,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="19,6,128,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkBMPWriter:</div>
<div class="dynsection">
<p><center><img src="a08171.png" border="0" usemap="#a08172" alt="Collaboration graph"></center>
<map name="a08172">
<area shape="rect" href="a00851.html" title="Writes images to files." alt="" coords="193,576,308,603"><area shape="rect" href="a00727.html" title="Generic algorithm superclass for image algs." alt="" coords="183,499,319,525"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="281,381,380,408"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="477,499,576,525"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="407,173,487,200"><area shape="rect" href="a00895.html" title="Store zero or more vtkInformation instances." alt="" coords="404,264,553,291"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="212,264,321,291"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="164,5,273,32"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="5,173,168,200"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="153,83,284,109"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="308,83,417,109"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="192,173,373,200"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a08173.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Writes Windows BMP files. 
<p>
<a class="el" href="a00179.html" title="Writes Windows BMP files.">vtkBMPWriter</a> writes BMP files. The data type of the file is unsigned char regardless of the input type.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00178.html" title="read Windows BMP files">vtkBMPReader</a></dd></dl>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_2.html#c2_vtk_t_vtkBMPWriter">vtkBMPWriter (Tests)</a> </dd></dl>

<p>Definition at line <a class="el" href="a04891.html#l00033">33</a> of file <a class="el" href="a04891.html">vtkBMPWriter.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a00851.html">vtkImageWriter</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#eb3466db53cfdaaeb47deae21625e4c3">Superclass</a></td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#7de0af9777d6f4d2315db044db696b3a">GetClassName</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#ce83ac2458bebf7835c5f2dabac07da3">IsA</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#2be89a34ad59ccc715d86fc775320b44">PrintSelf</a> (ostream &amp;os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>

<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00179.html">vtkBMPWriter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#5248f091d51c0a202c36fb1d2ea88b91">New</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#0d8eb838dd32b243cd3d5ad87aebb1d2">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00179.html">vtkBMPWriter</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#92477c76ec4e01786c60cf9be4873204">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#755e38fdb549da085d30868e46a748da">vtkBMPWriter</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#b20737fe9648b5eb9ccb4e7b21858b1b">~vtkBMPWriter</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#6869b3e3d63a72052ab501bb3bde270b">WriteFile</a> (ofstream *file, <a class="el" href="a00751.html">vtkImageData</a> *data, int ext[6])</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00179.html#4cf2e6f7cb588a5f2a33169b59f87ca6">WriteFileHeader</a> (ofstream *, <a class="el" href="a00751.html">vtkImageData</a> *)</td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="eb3466db53cfdaaeb47deae21625e4c3"></a><!-- doxytag: member="vtkBMPWriter::Superclass" ref="eb3466db53cfdaaeb47deae21625e4c3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a00851.html">vtkImageWriter</a> <a class="el" href="a00851.html">vtkBMPWriter::Superclass</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00851.html#d46fb666d388feb51154e5f89f8db802">vtkImageWriter</a>.</p>

<p>Definition at line <a class="el" href="a04891.html#l00037">37</a> of file <a class="el" href="a04891.html">vtkBMPWriter.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="755e38fdb549da085d30868e46a748da"></a><!-- doxytag: member="vtkBMPWriter::vtkBMPWriter" ref="755e38fdb549da085d30868e46a748da" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkBMPWriter::vtkBMPWriter           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="b20737fe9648b5eb9ccb4e7b21858b1b"></a><!-- doxytag: member="vtkBMPWriter::~vtkBMPWriter" ref="b20737fe9648b5eb9ccb4e7b21858b1b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkBMPWriter::~vtkBMPWriter           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04891.html#l00042">42</a> of file <a class="el" href="a04891.html">vtkBMPWriter.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5248f091d51c0a202c36fb1d2ea88b91"></a><!-- doxytag: member="vtkBMPWriter::New" ref="5248f091d51c0a202c36fb1d2ea88b91" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a00179.html">vtkBMPWriter</a>* vtkBMPWriter::New           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. 
<p>Reimplemented from <a class="el" href="a00851.html#5114cbf67bc22e348935cf2b682540f8">vtkImageWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="7de0af9777d6f4d2315db044db696b3a"></a><!-- doxytag: member="vtkBMPWriter::GetClassName" ref="7de0af9777d6f4d2315db044db696b3a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkBMPWriter::GetClassName           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00851.html#86a176a5502bab7d009b1f2f70bdfe77">vtkImageWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="0d8eb838dd32b243cd3d5ad87aebb1d2"></a><!-- doxytag: member="vtkBMPWriter::IsTypeOf" ref="0d8eb838dd32b243cd3d5ad87aebb1d2" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkBMPWriter::IsTypeOf           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. 
<p>Reimplemented from <a class="el" href="a00851.html#1e0f8d99e62e4a9754b7f08a34f50f21">vtkImageWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="ce83ac2458bebf7835c5f2dabac07da3"></a><!-- doxytag: member="vtkBMPWriter::IsA" ref="ce83ac2458bebf7835c5f2dabac07da3" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkBMPWriter::IsA           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h. 
<p>Reimplemented from <a class="el" href="a00851.html#74ee6ec43cb11c5fe41c8837e9588001">vtkImageWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="92477c76ec4e01786c60cf9be4873204"></a><!-- doxytag: member="vtkBMPWriter::SafeDownCast" ref="92477c76ec4e01786c60cf9be4873204" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a00179.html">vtkBMPWriter</a>* vtkBMPWriter::SafeDownCast           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> *&nbsp;</td>
          <td class="paramname"> <em>o</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00851.html#e98e39d577982a7247c42e8d8cbbf2e5">vtkImageWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="2be89a34ad59ccc715d86fc775320b44"></a><!-- doxytag: member="vtkBMPWriter::PrintSelf" ref="2be89a34ad59ccc715d86fc775320b44" args="(ostream &amp;os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkBMPWriter::PrintSelf           </td>
          <td>(</td>
          <td class="paramtype">ostream &amp;&nbsp;</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>&nbsp;</td>
          <td class="paramname"> <em>indent</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes. 
<p>Reimplemented from <a class="el" href="a00851.html#9af63bfc6f3d3f46be94ac4e57478447">vtkImageWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="6869b3e3d63a72052ab501bb3bde270b"></a><!-- doxytag: member="vtkBMPWriter::WriteFile" ref="6869b3e3d63a72052ab501bb3bde270b" args="(ofstream *file, vtkImageData *data, int ext[6])" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkBMPWriter::WriteFile           </td>
          <td>(</td>
          <td class="paramtype">ofstream *&nbsp;</td>
          <td class="paramname"> <em>file</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00751.html">vtkImageData</a> *&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>ext</em>[6]</td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00851.html#92b8a7bc7bd2c517a4a176239131007c">vtkImageWriter</a>.</p>

</div>
</div><p>
<a class="anchor" name="4cf2e6f7cb588a5f2a33169b59f87ca6"></a><!-- doxytag: member="vtkBMPWriter::WriteFileHeader" ref="4cf2e6f7cb588a5f2a33169b59f87ca6" args="(ofstream *, vtkImageData *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkBMPWriter::WriteFileHeader           </td>
          <td>(</td>
          <td class="paramtype">ofstream *&nbsp;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00751.html">vtkImageData</a> *&nbsp;</td>
          <td class="paramname"></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00851.html#ceb3fee16c5a5d923621aef16f4f6c2e">vtkImageWriter</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/IO/<a class="el" href="a04891.html">vtkBMPWriter.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:54:22 2009 for VTK by&nbsp;
<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>