Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > f37f2c0b149d5391818dc5157943cda0 > files > 165

gnome-chemistry-utils-devel-0.10.8-3mdv2010.0.i586.rpm

<!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>The Gnome Chemistry Utils: gcu::Chem3dDoc 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.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</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>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</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 class="navpath"><a class="el" href="namespacegcu.html">gcu</a>::<a class="el" href="classgcu_1_1Chem3dDoc.html">Chem3dDoc</a>
  </div>
</div>
<div class="contents">
<h1>gcu::Chem3dDoc Class Reference</h1><!-- doxytag: class="gcu::Chem3dDoc" --><!-- doxytag: inherits="gcu::GLDocument" -->
<p><code>#include &lt;<a class="el" href="chem3ddoc_8h_source.html">gcu/chem3ddoc.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for gcu::Chem3dDoc:</div>
<div class="dynsection">
 <div class="center">
  <img src="classgcu_1_1Chem3dDoc.gif" usemap="#gcu::Chem3dDoc_map" alt=""/>
  <map id="gcu::Chem3dDoc_map" name="gcu::Chem3dDoc_map">
<area href="classgcu_1_1GLDocument.html" alt="gcu::GLDocument" shape="rect" coords="61,112,174,136"/>
<area href="classgcu_1_1Document.html" alt="gcu::Document" shape="rect" coords="61,56,174,80"/>
<area href="classgcu_1_1Object.html" alt="gcu::Object" shape="rect" coords="0,0,113,24"/>
<area href="classgcu_1_1DialogOwner.html" alt="gcu::DialogOwner" shape="rect" coords="123,0,236,24"/>
</map>
 </div>
</div>

<p><a href="classgcu_1_1Chem3dDoc-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Chem3dDoc.html#aed122da98350aa78a79e942f0afe494f">Chem3dDoc</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Chem3dDoc.html#ab84a63bcff9988e3617e7b01794f5dc3">Chem3dDoc</a> (<a class="el" href="classgcu_1_1Application.html">Application</a> *App, <a class="el" href="classgcu_1_1GLView.html">GLView</a> *View)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Chem3dDoc.html#a18d808656b023683ab3fb24a51c7f993">~Chem3dDoc</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Chem3dDoc.html#af05ba220e27dd4d471783f802ca30134">Draw</a> (<a class="el" href="classgcu_1_1Matrix.html">Matrix</a> const &amp;m) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Chem3dDoc.html#aa80f903c7660afa78e48c1929e04b486">IsEmpty</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Chem3dDoc.html#a732761f38f0f5bcf32469533f9cbe038">Load</a> (char const *uri, char const *mime_type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Chem3dDoc.html#ad32dd5ccfc336b4d7f5eb70e40135a5e">LoadData</a> (char const *data, char const *mime_type)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Chem3dDoc.html#a113332852c6d5a17993ef623e9852b51">GetTitle</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1Chem3dDoc.html#a3115aa51c6004c187a0ef627c6d16248">OnExportVRML</a> (std::string const &amp;filename)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classgcu_1_1Document.html">Document</a> class for a molecule. Embeds an OpenBabel::OBMol object. </p>

<p>Definition at line <a class="el" href="chem3ddoc_8h_source.html#l00061">61</a> of file <a class="el" href="chem3ddoc_8h_source.html">chem3ddoc.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aed122da98350aa78a79e942f0afe494f"></a><!-- doxytag: member="gcu::Chem3dDoc::Chem3dDoc" ref="aed122da98350aa78a79e942f0afe494f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gcu::Chem3dDoc::Chem3dDoc </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default constructor </p>

</div>
</div>
<a class="anchor" id="ab84a63bcff9988e3617e7b01794f5dc3"></a><!-- doxytag: member="gcu::Chem3dDoc::Chem3dDoc" ref="ab84a63bcff9988e3617e7b01794f5dc3" args="(Application *App, GLView *View)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gcu::Chem3dDoc::Chem3dDoc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgcu_1_1Application.html">Application</a> *&nbsp;</td>
          <td class="paramname"> <em>App</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classgcu_1_1GLView.html">GLView</a> *&nbsp;</td>
          <td class="paramname"> <em>View</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>App</em>&nbsp;</td><td>the application. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>View,:</em>&nbsp;</td><td>an optional already existing <a class="el" href="classgcu_1_1GLView.html">GLView</a> instance. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a18d808656b023683ab3fb24a51c7f993"></a><!-- doxytag: member="gcu::Chem3dDoc::~Chem3dDoc" ref="a18d808656b023683ab3fb24a51c7f993" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual gcu::Chem3dDoc::~Chem3dDoc </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Default destructor </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af05ba220e27dd4d471783f802ca30134"></a><!-- doxytag: member="gcu::Chem3dDoc::Draw" ref="af05ba220e27dd4d471783f802ca30134" args="(Matrix const &amp;m) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gcu::Chem3dDoc::Draw </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgcu_1_1Matrix.html">Matrix</a> const &amp;&nbsp;</td>
          <td class="paramname"> <em>m</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>m</em>&nbsp;</td><td>the <a class="el" href="classgcu_1_1Matrix.html">Matrix</a> giving the current model orientation</td></tr>
  </table>
  </dd>
</dl>
<p>Displays the molecule using OpenGL. </p>

<p>Implements <a class="el" href="classgcu_1_1GLDocument.html#a3157e47c92cd1df3a901f39c48914cad">gcu::GLDocument</a>.</p>

</div>
</div>
<a class="anchor" id="a113332852c6d5a17993ef623e9852b51"></a><!-- doxytag: member="gcu::Chem3dDoc::GetTitle" ref="a113332852c6d5a17993ef623e9852b51" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* gcu::Chem3dDoc::GetTitle </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the title of the molecule if any. </dd></dl>

<p>Reimplemented from <a class="el" href="classgcu_1_1Document.html#ae5df8a6d33cb17e0d61274a561fb8f18">gcu::Document</a>.</p>

<p>Definition at line <a class="el" href="chem3ddoc_8h_source.html#l00109">109</a> of file <a class="el" href="chem3ddoc_8h_source.html">chem3ddoc.h</a>.</p>

</div>
</div>
<a class="anchor" id="aa80f903c7660afa78e48c1929e04b486"></a><!-- doxytag: member="gcu::Chem3dDoc::IsEmpty" ref="aa80f903c7660afa78e48c1929e04b486" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool gcu::Chem3dDoc::IsEmpty </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the molecule have no atom, false otherwise. </dd></dl>

<p>Definition at line <a class="el" href="chem3ddoc_8h_source.html#l00088">88</a> of file <a class="el" href="chem3ddoc_8h_source.html">chem3ddoc.h</a>.</p>

</div>
</div>
<a class="anchor" id="a732761f38f0f5bcf32469533f9cbe038"></a><!-- doxytag: member="gcu::Chem3dDoc::Load" ref="a732761f38f0f5bcf32469533f9cbe038" args="(char const *uri, char const *mime_type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gcu::Chem3dDoc::Load </td>
          <td>(</td>
          <td class="paramtype">char const *&nbsp;</td>
          <td class="paramname"> <em>uri</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char const *&nbsp;</td>
          <td class="paramname"> <em>mime_type</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>uri</em>&nbsp;</td><td>the uri of the molecule file. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>mime_type</em>&nbsp;</td><td>the mime type of the molecule file.</td></tr>
  </table>
  </dd>
</dl>
<p>Loads a molecule from the provided uri using OpenBabel. </p>

</div>
</div>
<a class="anchor" id="ad32dd5ccfc336b4d7f5eb70e40135a5e"></a><!-- doxytag: member="gcu::Chem3dDoc::LoadData" ref="ad32dd5ccfc336b4d7f5eb70e40135a5e" args="(char const *data, char const *mime_type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gcu::Chem3dDoc::LoadData </td>
          <td>(</td>
          <td class="paramtype">char const *&nbsp;</td>
          <td class="paramname"> <em>data</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char const *&nbsp;</td>
          <td class="paramname"> <em>mime_type</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>data</em>&nbsp;</td><td>the inline data. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>mime_type</em>&nbsp;</td><td>the mime type of the data.</td></tr>
  </table>
  </dd>
</dl>
<p>Loads a molecule from the provided data using OpenBabel. </p>

</div>
</div>
<a class="anchor" id="a3115aa51c6004c187a0ef627c6d16248"></a><!-- doxytag: member="gcu::Chem3dDoc::OnExportVRML" ref="a3115aa51c6004c187a0ef627c6d16248" args="(std::string const &amp;filename)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void gcu::Chem3dDoc::OnExportVRML </td>
          <td>(</td>
          <td class="paramtype">std::string const &amp;&nbsp;</td>
          <td class="paramname"> <em>filename</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>filename</em>&nbsp;</td><td>the name of the vrml file to which the data should be written.</td></tr>
  </table>
  </dd>
</dl>
<p>Exports the embedded molecule as a vrml scene. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="chem3ddoc_8h_source.html">chem3ddoc.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Sun Sep 6 18:33:55 2009 for The Gnome Chemistry Utils by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>