Sophie

Sophie

distrib > Fedora > 16 > i386 > by-pkgid > 4bc66056a634db26a1f4d0845dc41ca6 > files > 3945

mrpt-doc-0.9.5-0.1.20110925svn2670.fc16.i686.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>mrpt::gui::mrptEvent3DWindowGrabImageFile Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<div align="left"><a href="http://www.mrpt.org/">Main MRPT website</a> &gt; <b>C++ reference</b> </div>
<div align="right">
<a href="index.html"><img border="0" src="mrpt_logo.png" alt="MRPT logo"></a>
</div>
<!-- Generated by Doxygen 1.7.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</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>
        <div id="MSearchBox" class="MSearchBoxInactive">
          <div class="left">
            <form id="FSearchBox" action="search.php" method="get">
              <img id="MSearchSelect" src="search/mag.png" alt=""/>
              <input type="text" id="MSearchField" name="query" value="Search" size="20" accesskey="S" 
                     onfocus="searchBox.OnSearchFieldFocus(true)" 
                     onblur="searchBox.OnSearchFieldFocus(false)"/>
            </form>
          </div><div class="right"></div>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespacemrpt.html">mrpt</a>      </li>
      <li class="navelem"><a class="el" href="namespacemrpt_1_1gui.html">gui</a>      </li>
      <li class="navelem"><a class="el" href="classmrpt_1_1gui_1_1mrpt_event3_d_window_grab_image_file.html">mrptEvent3DWindowGrabImageFile</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">mrpt::gui::mrptEvent3DWindowGrabImageFile Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="mrpt::gui::mrptEvent3DWindowGrabImageFile" --><!-- doxytag: inherits="mrpt::utils::mrptEvent" --><hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An event sent by a <a class="el" href="classmrpt_1_1gui_1_1_c_display_window3_d.html" title="A graphical user interface (GUI) for efficiently rendering 3D scenes in real-time.">CDisplayWindow3D</a> window when an image is saved after enabling this feature with <a class="el" href="classmrpt_1_1gui_1_1_c_display_window3_d.html#a71d0697aff632b04ae8d73251ea73bd9" title="Start to save rendered images to disk.">CDisplayWindow3D::grabImagesStart()</a> </p>
<p>IMPORTANTE NOTICE: Event handlers in your observer class will be invoked from the wxWidgets internal MRPT thread, so all your code in the handler must be thread safe. </p>
</div>
<p><code>#include &lt;<a class="el" href="_c_display_window3_d_8h_source.html">mrpt/gui/CDisplayWindow3D.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mrpt::gui::mrptEvent3DWindowGrabImageFile:</div>
<div class="dyncontent">
<div class="center"><img src="classmrpt_1_1gui_1_1mrpt_event3_d_window_grab_image_file__inherit__graph.png" border="0" usemap="#mrpt_1_1gui_1_1mrpt_event3_d_window_grab_image_file_inherit__map" alt="Inheritance graph"/></div>
<map name="mrpt_1_1gui_1_1mrpt_event3_d_window_grab_image_file_inherit__map" id="mrpt_1_1gui_1_1mrpt_event3_d_window_grab_image_file_inherit__map">
<area shape="rect" id="node2" href="classmrpt_1_1utils_1_1mrpt_event.html" title="The basic event type for the observer&#45;observable pattern in MRPT." alt="" coords="77,5,224,32"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classmrpt_1_1gui_1_1mrpt_event3_d_window_grab_image_file-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">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1gui_1_1mrpt_event3_d_window_grab_image_file.html#a9e8469e7f5f6010ce1986ffc3a92faea">mrptEvent3DWindowGrabImageFile</a> (<a class="el" href="classmrpt_1_1gui_1_1_c_display_window3_d.html">CDisplayWindow3D</a> *obj, const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;_img_file)</td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;class EVENTTYPE &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html#aa9971e6282c268bd4380e294bfb71b60">isOfType</a> () const </td></tr>
<tr><td class="memTemplParams" colspan="2">template&lt;class EVENTTYPE &gt; </td></tr>
<tr><td class="memTemplItemLeft" align="right" valign="top">const EVENTTYPE *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html#ab487ce428310b75d268edadff6be6c0c">getAs</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmrpt_1_1gui_1_1_c_display_window3_d.html">CDisplayWindow3D</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1gui_1_1mrpt_event3_d_window_grab_image_file.html#a27f2516ee67ecb1461aa8f0fe45603df">source_object</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1gui_1_1mrpt_event3_d_window_grab_image_file.html#a48ad56490f47a2ffa8f5fcebdbcc20af">img_file</a></td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">The absolute path of the file that has been just saved.  <a href="#a48ad56490f47a2ffa8f5fcebdbcc20af"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__time__date.html#ga42674286d8d56afea013b6329bb7327a">mrpt::system::TTimeStamp</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html#aceba670cb9ef07097a20af98b5e40f61">timestamp</a></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">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmrpt_1_1gui_1_1mrpt_event3_d_window_grab_image_file.html#aae9f0c9c79a47664165f927c9b0f7b7a">do_nothing</a> ()</td></tr>
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Just to allow this class to be polymorphic.  <a href="#aae9f0c9c79a47664165f927c9b0f7b7a"></a><br/></td></tr>
</table>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a9e8469e7f5f6010ce1986ffc3a92faea"></a><!-- doxytag: member="mrpt::gui::mrptEvent3DWindowGrabImageFile::mrptEvent3DWindowGrabImageFile" ref="a9e8469e7f5f6010ce1986ffc3a92faea" args="(CDisplayWindow3D *obj, const std::string &amp;_img_file)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">mrpt::gui::mrptEvent3DWindowGrabImageFile::mrptEvent3DWindowGrabImageFile </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classmrpt_1_1gui_1_1_c_display_window3_d.html">CDisplayWindow3D</a> *&#160;</td>
          <td class="paramname"><em>obj</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classstd_1_1string.html">std::string</a> &amp;&#160;</td>
          <td class="paramname"><em>_img_file</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_c_display_window3_d_8h_source.html#l00380">380</a> of file <a class="el" href="_c_display_window3_d_8h_source.html">CDisplayWindow3D.h</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aae9f0c9c79a47664165f927c9b0f7b7a"></a><!-- doxytag: member="mrpt::gui::mrptEvent3DWindowGrabImageFile::do_nothing" ref="aae9f0c9c79a47664165f927c9b0f7b7a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void mrpt::gui::mrptEvent3DWindowGrabImageFile::do_nothing </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [inline, protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Just to allow this class to be polymorphic. </p>

<p>Reimplemented from <a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html#acfe7c36c5c89d7efd437f83870171f0a">mrpt::utils::mrptEvent</a>.</p>

<p>Definition at line <a class="el" href="_c_display_window3_d_8h_source.html#l00378">378</a> of file <a class="el" href="_c_display_window3_d_8h_source.html">CDisplayWindow3D.h</a>.</p>

</div>
</div>
<a class="anchor" id="ab487ce428310b75d268edadff6be6c0c"></a><!-- doxytag: member="mrpt::gui::mrptEvent3DWindowGrabImageFile::getAs" ref="ab487ce428310b75d268edadff6be6c0c" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EVENTTYPE &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">const EVENTTYPE* mrpt::utils::mrptEvent::getAs </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline, inherited]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="mrpt_event_8h_source.html#l00066">66</a> of file <a class="el" href="mrpt_event_8h_source.html">mrptEvent.h</a>.</p>

</div>
</div>
<a class="anchor" id="aa9971e6282c268bd4380e294bfb71b60"></a><!-- doxytag: member="mrpt::gui::mrptEvent3DWindowGrabImageFile::isOfType" ref="aa9971e6282c268bd4380e294bfb71b60" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class EVENTTYPE &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool mrpt::utils::mrptEvent::isOfType </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline, inherited]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="mrpt_event_8h_source.html#l00063">63</a> of file <a class="el" href="mrpt_event_8h_source.html">mrptEvent.h</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a48ad56490f47a2ffa8f5fcebdbcc20af"></a><!-- doxytag: member="mrpt::gui::mrptEvent3DWindowGrabImageFile::img_file" ref="a48ad56490f47a2ffa8f5fcebdbcc20af" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="classstd_1_1string.html">std::string</a>&amp; <a class="el" href="classmrpt_1_1gui_1_1mrpt_event3_d_window_grab_image_file.html#a48ad56490f47a2ffa8f5fcebdbcc20af">mrpt::gui::mrptEvent3DWindowGrabImageFile::img_file</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The absolute path of the file that has been just saved. </p>

<p>Definition at line <a class="el" href="_c_display_window3_d_8h_source.html#l00386">386</a> of file <a class="el" href="_c_display_window3_d_8h_source.html">CDisplayWindow3D.h</a>.</p>

</div>
</div>
<a class="anchor" id="a27f2516ee67ecb1461aa8f0fe45603df"></a><!-- doxytag: member="mrpt::gui::mrptEvent3DWindowGrabImageFile::source_object" ref="a27f2516ee67ecb1461aa8f0fe45603df" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classmrpt_1_1gui_1_1_c_display_window3_d.html">CDisplayWindow3D</a>* <a class="el" href="classmrpt_1_1gui_1_1mrpt_event3_d_window_grab_image_file.html#a27f2516ee67ecb1461aa8f0fe45603df">mrpt::gui::mrptEvent3DWindowGrabImageFile::source_object</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_c_display_window3_d_8h_source.html#l00385">385</a> of file <a class="el" href="_c_display_window3_d_8h_source.html">CDisplayWindow3D.h</a>.</p>

</div>
</div>
<a class="anchor" id="aceba670cb9ef07097a20af98b5e40f61"></a><!-- doxytag: member="mrpt::gui::mrptEvent3DWindowGrabImageFile::timestamp" ref="aceba670cb9ef07097a20af98b5e40f61" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__time__date.html#ga42674286d8d56afea013b6329bb7327a">mrpt::system::TTimeStamp</a> <a class="el" href="classmrpt_1_1utils_1_1mrpt_event.html#aceba670cb9ef07097a20af98b5e40f61">mrpt::utils::mrptEvent::timestamp</a><code> [inherited]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="mrpt_event_8h_source.html#l00068">68</a> of file <a class="el" href="mrpt_event_8h_source.html">mrptEvent.h</a>.</p>

</div>
</div>
</div>
<br><hr><br> <table border="0" width="100%"> <tr> <td> Page generated by <a href="http://www.doxygen.org" target="_blank">Doxygen 1.7.5</a> for MRPT 0.9.5 SVN: at Sun Sep 25 17:20:18 UTC 2011</td><td></td> <td width="100"> </td> <td width="150">  </td></tr> </table>  </body></html>