<!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::GLView 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.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">The Gnome Chemistry Utils <span id="projectnumber">0.13.5</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main 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 id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacegcu.html">gcu</a> </li>
<li class="navelem"><a class="el" href="classgcu_1_1GLView.html">GLView</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">gcu::GLView Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="gcu::GLView" -->
<p><code>#include <<a class="el" href="glview_8h_source.html">gcu/glview.h</a>></code></p>
<p><a href="classgcu_1_1GLView-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a12773d88a79619d6e70159d3ede8215d">GLView</a> (<a class="el" href="classgcu_1_1GLDocument.html">GLDocument</a> *pDoc) throw (std::runtime_error)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a12773d88a79619d6e70159d3ede8215d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a3f3491edcef778660323ee26e83e924b">~GLView</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a3f3491edcef778660323ee26e83e924b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#ad0fb065965415763e74ca8b02a4023a2">Update</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a74a290d10b91dc4cb411715abc61eec8">SetRotation</a> (double psi, double theta, double phi)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#aa24dd1bf510dfae62e9c729b115a89ea">SaveAsImage</a> (std::string const &filename, char const *type, std::map< std::string, std::string > &options, unsigned width, unsigned height, bool use_bg) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual GdkPixbuf * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#aaa58e708fb9bed1b210bb4fbdd1bd64b">BuildPixbuf</a> (unsigned width, unsigned height, bool use_bg) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a0cca4204e5936ae1474a5b02abf364d1">RenderToCairo</a> (cairo_t *cr, unsigned width, unsigned height, bool use_bg) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#afeceae8b5707439c622a4eb1681f51f5">SetAngle</a> (double val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#aff210c5e0d55d2414f5ae760b26131f4">GetAngle</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a57dfca41ecb19df708901887b31ece70">GetRefAngle</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#ae9b369632eafd7478ae59c698c7ce532">SetPsi</a> (double val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a2742d3faaa212701baf7c5e505a65b57">GetPsi</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a80ad8bf479d5a75ba64beae312ab52e4">GetRefPsi</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#ad0739df1477cadbac6b40e2b9c0c0a40">SetPhi</a> (double val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a3bfa2f23b282c2ca33cbb410f3efb6a3">GetPhi</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#ad56aeb037e9e11ba7ffdd84f82cc6281">GetRefPhi</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a75de7807ccf9f2687216f34ab1f293f9">SetTheta</a> (double val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a8e452ac84df257d1d97c2d4e954d5b98">GetTheta</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a90ff225780bf29c3dd0634b0dda5ac07">GetRefTheta</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a5d4bcd6d0fc4a12e7cff79cca3ee536e">SetRed</a> (float val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#af3ca9b15f1f8ef8f685be71ae8fed791">GetRed</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a1e79b0c32b12a11239fe92f8835ff652">GetRefRed</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#ae477011e82f744061d34e961914de748">SetGreen</a> (float val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a2089e17e7c7732e498cd46e88c1c3056">GetGreen</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a02354ef26f50a732e2350dd8ce561023">GetRefGreen</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a2bd44f71fe06f8ffd434089d6409922b">SetBlue</a> (float val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#ae62ad2b284f6db651927c0752dfad990">GetBlue</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a12bfa1467ab90175fe40c79e76a95693">GetRefBlue</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a3ffe782c0c7c30d9f7167469ab34785c">SetAlpha</a> (float val)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#ab75c711042ae1b143f8cb388a5492e84">GetAlpha</a> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#ac153dfe6cef664b2eb624e3d31fad49d">GetRefAlpha</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgcu_1_1GLDocument.html">GLDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a89df1c25164fdd94b685f0a576968540">GetDoc</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a385bafe3081bc78a85f9f55dfd468cbf">GetRadius</a> (void)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#a5149952a005f6dc2bef24995b1faed15">Rotate</a> (gdouble x, gdouble y)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classgcu_1_1GLView.html#afc93b1b526679cdc0656d6d9f80b6d2f">m_Radius</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>View class based on OpenGL for rendering. Used to display 3d chemical structures such as molecules or crystals cells. </p>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00047">47</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a12773d88a79619d6e70159d3ede8215d"></a><!-- doxytag: member="gcu::GLView::GLView" ref="a12773d88a79619d6e70159d3ede8215d" args="(GLDocument *pDoc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GLView </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgcu_1_1GLDocument.html">GLDocument</a> * </td>
<td class="paramname"><em>pDoc</em></td><td>)</td>
<td> throw (std::runtime_error)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pDoc,:</td><td>a pointer to the <a class="el" href="classgcu_1_1GLDocument.html">GLDocument</a> instance.</td></tr>
</table>
</dd>
</dl>
<p>Creates a view for the document. </p>
</div>
</div>
<a class="anchor" id="a3f3491edcef778660323ee26e83e924b"></a><!-- doxytag: member="gcu::GLView::~GLView" ref="a3f3491edcef778660323ee26e83e924b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual gcu::GLView::~GLView </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>The destructor of <a class="el" href="classgcu_1_1GLView.html">GLView</a>. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aaa58e708fb9bed1b210bb4fbdd1bd64b"></a><!-- doxytag: member="gcu::GLView::BuildPixbuf" ref="aaa58e708fb9bed1b210bb4fbdd1bd64b" args="(unsigned width, unsigned height, bool use_bg) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual GdkPixbuf* gcu::GLView::BuildPixbuf </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>use_bg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">width</td><td>the width of the generated image. </td></tr>
<tr><td class="paramname">height</td><td>the height of the generated image. </td></tr>
<tr><td class="paramname">use_bg</td><td>whether to use the window background or a transparent background.</td></tr>
</table>
</dd>
</dl>
<p>Generates a pixbuf from the current view.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pixbuf containing the generated image </dd></dl>
</div>
</div>
<a class="anchor" id="ab75c711042ae1b143f8cb388a5492e84"></a><!-- doxytag: member="gcu::GLView::GetAlpha" ref="ab75c711042ae1b143f8cb388a5492e84" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetAlpha </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The alpha value for the background is not supported in this version and this is only a place holder. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the current alpha value of the background color. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00211">211</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="aff210c5e0d55d2414f5ae760b26131f4"></a><!-- doxytag: member="gcu::GLView::GetAngle" ref="aff210c5e0d55d2414f5ae760b26131f4" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetAngle </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current half field of view. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00134">134</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae62ad2b284f6db651927c0752dfad990"></a><!-- doxytag: member="gcu::GLView::GetBlue" ref="ae62ad2b284f6db651927c0752dfad990" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetBlue </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current blue component of the background color. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00194">194</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a89df1c25164fdd94b685f0a576968540"></a><!-- doxytag: member="gcu::GLView::GetDoc" ref="a89df1c25164fdd94b685f0a576968540" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetDoc </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the associated document. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00215">215</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2089e17e7c7732e498cd46e88c1c3056"></a><!-- doxytag: member="gcu::GLView::GetGreen" ref="a2089e17e7c7732e498cd46e88c1c3056" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetGreen </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current green component of the background color. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00184">184</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3bfa2f23b282c2ca33cbb410f3efb6a3"></a><!-- doxytag: member="gcu::GLView::GetPhi" ref="a3bfa2f23b282c2ca33cbb410f3efb6a3" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetPhi </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current phi Euler's angle. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00154">154</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2742d3faaa212701baf7c5e505a65b57"></a><!-- doxytag: member="gcu::GLView::GetPsi" ref="a2742d3faaa212701baf7c5e505a65b57" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetPsi </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current psi Euler's angle. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00144">144</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a385bafe3081bc78a85f9f55dfd468cbf"></a><!-- doxytag: member="gcu::GLView::GetRadius" ref="a385bafe3081bc78a85f9f55dfd468cbf" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetRadius </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the distance between the center of the model and the point of view. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00222">222</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="af3ca9b15f1f8ef8f685be71ae8fed791"></a><!-- doxytag: member="gcu::GLView::GetRed" ref="af3ca9b15f1f8ef8f685be71ae8fed791" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetRed </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current red component of the background color. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00174">174</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac153dfe6cef664b2eb624e3d31fad49d"></a><!-- doxytag: member="gcu::GLView::GetRefAlpha" ref="ac153dfe6cef664b2eb624e3d31fad49d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetRefAlpha </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The alpha value for the background is not supported in this version and this is only a place holder. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the current alpha value of the background color as a reference. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00211">211</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a57dfca41ecb19df708901887b31ece70"></a><!-- doxytag: member="gcu::GLView::GetRefAngle" ref="a57dfca41ecb19df708901887b31ece70" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetRefAngle </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current half field of view as a reference. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00134">134</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a12bfa1467ab90175fe40c79e76a95693"></a><!-- doxytag: member="gcu::GLView::GetRefBlue" ref="a12bfa1467ab90175fe40c79e76a95693" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetRefBlue </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current blue component of the background color as a reference. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00194">194</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a02354ef26f50a732e2350dd8ce561023"></a><!-- doxytag: member="gcu::GLView::GetRefGreen" ref="a02354ef26f50a732e2350dd8ce561023" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetRefGreen </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current green component of the background color as a reference. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00184">184</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad56aeb037e9e11ba7ffdd84f82cc6281"></a><!-- doxytag: member="gcu::GLView::GetRefPhi" ref="ad56aeb037e9e11ba7ffdd84f82cc6281" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetRefPhi </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current psh Euler's angle as a reference. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00154">154</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a80ad8bf479d5a75ba64beae312ab52e4"></a><!-- doxytag: member="gcu::GLView::GetRefPsi" ref="a80ad8bf479d5a75ba64beae312ab52e4" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetRefPsi </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current psi Euler's angle as a reference. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00144">144</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1e79b0c32b12a11239fe92f8835ff652"></a><!-- doxytag: member="gcu::GLView::GetRefRed" ref="a1e79b0c32b12a11239fe92f8835ff652" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetRefRed </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current red component of the background color as a reference. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00174">174</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a90ff225780bf29c3dd0634b0dda5ac07"></a><!-- doxytag: member="gcu::GLView::GetRefTheta" ref="a90ff225780bf29c3dd0634b0dda5ac07" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetRefTheta </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current theta Euler's angle as a reference. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00164">164</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8e452ac84df257d1d97c2d4e954d5b98"></a><!-- doxytag: member="gcu::GLView::GetTheta" ref="a8e452ac84df257d1d97c2d4e954d5b98" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::GetTheta </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the current theta Euler's angle. </dd></dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00164">164</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0cca4204e5936ae1474a5b02abf364d1"></a><!-- doxytag: member="gcu::GLView::RenderToCairo" ref="a0cca4204e5936ae1474a5b02abf364d1" args="(cairo_t *cr, unsigned width, unsigned height, bool use_bg) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcu::GLView::RenderToCairo </td>
<td>(</td>
<td class="paramtype">cairo_t * </td>
<td class="paramname"><em>cr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>use_bg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">cr</td><td>a cairo_t. </td></tr>
<tr><td class="paramname">width</td><td>the width used for rendering. </td></tr>
<tr><td class="paramname">height</td><td>the height used for rendering. </td></tr>
<tr><td class="paramname">use_bg</td><td>whether to use the window background or a transparent background.</td></tr>
</table>
</dd>
</dl>
<p>Outputs a bitmap to cairo. Used internally for printing and various image formats exports. </p>
</div>
</div>
<a class="anchor" id="a5149952a005f6dc2bef24995b1faed15"></a><!-- doxytag: member="gcu::GLView::Rotate" ref="a5149952a005f6dc2bef24995b1faed15" args="(gdouble x, gdouble y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcu::GLView::Rotate </td>
<td>(</td>
<td class="paramtype">gdouble </td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">gdouble </td>
<td class="paramname"><em>y</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">x</td><td>the x component of the rotation. </td></tr>
<tr><td class="paramname">y</td><td>the y component of the rotation. std:: Called by OnMotion(). x and y are the displacement coordinates of the mouse. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa24dd1bf510dfae62e9c729b115a89ea"></a><!-- doxytag: member="gcu::GLView::SaveAsImage" ref="aa24dd1bf510dfae62e9c729b115a89ea" args="(std::string const &filename, char const *type, std::map< std::string, std::string > &options, unsigned width, unsigned height, bool use_bg) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcu::GLView::SaveAsImage </td>
<td>(</td>
<td class="paramtype">std::string const & </td>
<td class="paramname"><em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::map< std::string, std::string > & </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>use_bg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>the name of the file. </td></tr>
<tr><td class="paramname">type</td><td>the type as supported by GdkPixbuf (e.g. "png" or "jpeg"). </td></tr>
<tr><td class="paramname">options</td><td>the pairs of keys/values to pass GdkPixbuf. </td></tr>
<tr><td class="paramname">width</td><td>the width of the generated image. </td></tr>
<tr><td class="paramname">height</td><td>the height of the generated image. </td></tr>
<tr><td class="paramname">use_bg</td><td>whether to use the window background or a transparent background.</td></tr>
</table>
</dd>
</dl>
<p>Export the view contents as an image. The size of the new image is defined by the width and height parameters. </p>
</div>
</div>
<a class="anchor" id="a3ffe782c0c7c30d9f7167469ab34785c"></a><!-- doxytag: member="gcu::GLView::SetAlpha" ref="a3ffe782c0c7c30d9f7167469ab34785c" args="(float val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::SetAlpha </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>alpha</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">alpha</td><td>the new alpha value for the background.</td></tr>
</table>
</dd>
</dl>
<p>The alpha value for the background is not supported in this version and this is only a place holder. </p>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00211">211</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="afeceae8b5707439c622a4eb1681f51f5"></a><!-- doxytag: member="gcu::GLView::SetAngle" ref="afeceae8b5707439c622a4eb1681f51f5" args="(double val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::SetAngle </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>angle</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">angle</td><td>the new half field of view. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00134">134</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2bd44f71fe06f8ffd434089d6409922b"></a><!-- doxytag: member="gcu::GLView::SetBlue" ref="a2bd44f71fe06f8ffd434089d6409922b" args="(float val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::SetBlue </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>blue</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">blue</td><td>the new blue component for the background color. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00194">194</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae477011e82f744061d34e961914de748"></a><!-- doxytag: member="gcu::GLView::SetGreen" ref="ae477011e82f744061d34e961914de748" args="(float val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::SetGreen </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>green</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">green</td><td>the new green component for the background color. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00184">184</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad0739df1477cadbac6b40e2b9c0c0a40"></a><!-- doxytag: member="gcu::GLView::SetPhi" ref="ad0739df1477cadbac6b40e2b9c0c0a40" args="(double val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::SetPhi </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>phi</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">phi</td><td>the new phi Euler's angle. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00154">154</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae9b369632eafd7478ae59c698c7ce532"></a><!-- doxytag: member="gcu::GLView::SetPsi" ref="ae9b369632eafd7478ae59c698c7ce532" args="(double val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::SetPsi </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>psi</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">psi</td><td>the new psi Euler's angle. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00144">144</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5d4bcd6d0fc4a12e7cff79cca3ee536e"></a><!-- doxytag: member="gcu::GLView::SetRed" ref="a5d4bcd6d0fc4a12e7cff79cca3ee536e" args="(float val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::SetRed </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>red</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">red</td><td>the new red component for the background color. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00174">174</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="a74a290d10b91dc4cb411715abc61eec8"></a><!-- doxytag: member="gcu::GLView::SetRotation" ref="a74a290d10b91dc4cb411715abc61eec8" args="(double psi, double theta, double phi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void gcu::GLView::SetRotation </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>psi</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>theta</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>phi</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">psi</td><td>the first Euler's angle. </td></tr>
<tr><td class="paramname">theta</td><td>the second Euler's angle. </td></tr>
<tr><td class="paramname">phi</td><td>the third Euler's angle.</td></tr>
</table>
</dd>
</dl>
<p>Sets the orientation of the model, using the Euler's angles. </p>
</div>
</div>
<a class="anchor" id="a75de7807ccf9f2687216f34ab1f293f9"></a><!-- doxytag: member="gcu::GLView::SetTheta" ref="a75de7807ccf9f2687216f34ab1f293f9" args="(double val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gcu::GLView::SetTheta </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>theta</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">theta</td><td>the new theta Euler's angle. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00164">164</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<a class="anchor" id="ad0fb065965415763e74ca8b02a4023a2"></a><!-- doxytag: member="gcu::GLView::Update" ref="ad0fb065965415763e74ca8b02a4023a2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void gcu::GLView::Update </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Update the contents of the associated widget if any. This method must be called each time the document or the view are modified. Default implementation doesn't do anything. </p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="afc93b1b526679cdc0656d6d9f80b6d2f"></a><!-- doxytag: member="gcu::GLView::m_Radius" ref="afc93b1b526679cdc0656d6d9f80b6d2f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classgcu_1_1GLView.html#afc93b1b526679cdc0656d6d9f80b6d2f">gcu::GLView::m_Radius</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The distance between the center of the model and the point of view. </p>
<p>Definition at line <a class="el" href="glview_8h_source.html#l00222">222</a> of file <a class="el" href="glview_8h_source.html">glview.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="glview_8h_source.html">glview.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Fri Nov 11 2011 18:01:07 for The Gnome Chemistry Utils by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
