<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.8"/> <title>Assimp: Assimp::ProgressHandler Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Assimp  <span id="projectnumber">v3.1.1 (June 2014)</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <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="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</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><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('class_assimp_1_1_progress_handler.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="class_assimp_1_1_progress_handler-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">Assimp::ProgressHandler Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p>CPP-API: Abstract interface for custom progress report receivers. <a href="class_assimp_1_1_progress_handler.html#details">More...</a></p> <p>Inherits AllocateFromAssimpHeap.</p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ab08a1d300d434f6dd86ca41747cba448"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_assimp_1_1_progress_handler.html#ab08a1d300d434f6dd86ca41747cba448">Update</a> (float percentage=-1.f)=0</td></tr> <tr class="memdesc:ab08a1d300d434f6dd86ca41747cba448"><td class="mdescLeft"> </td><td class="mdescRight">Progress callback. <a href="#ab08a1d300d434f6dd86ca41747cba448">More...</a><br /></td></tr> <tr class="separator:ab08a1d300d434f6dd86ca41747cba448"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a3ec465a62e1feaae00f585ca0cffb81e"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_assimp_1_1_progress_handler.html#a3ec465a62e1feaae00f585ca0cffb81e">~ProgressHandler</a> ()</td></tr> <tr class="memdesc:a3ec465a62e1feaae00f585ca0cffb81e"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#a3ec465a62e1feaae00f585ca0cffb81e">More...</a><br /></td></tr> <tr class="separator:a3ec465a62e1feaae00f585ca0cffb81e"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:a53b192913e9904c674b851c46e1ea9e8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_assimp_1_1_progress_handler.html#a53b192913e9904c674b851c46e1ea9e8">ProgressHandler</a> ()</td></tr> <tr class="memdesc:a53b192913e9904c674b851c46e1ea9e8"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a53b192913e9904c674b851c46e1ea9e8">More...</a><br /></td></tr> <tr class="separator:a53b192913e9904c674b851c46e1ea9e8"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>CPP-API: Abstract interface for custom progress report receivers. </p> <p>Each #Importer instance maintains its own <a class="el" href="class_assimp_1_1_progress_handler.html#a53b192913e9904c674b851c46e1ea9e8" title="Default constructor. ">ProgressHandler</a>. The default implementation provided by <a class="el" href="namespace_assimp.html" title="Assimp's CPP-API and all internal APIs. ">Assimp</a> doesn't do anything at all. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a53b192913e9904c674b851c46e1ea9e8"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">Assimp::ProgressHandler::ProgressHandler </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Default constructor. </p> </div> </div> <a class="anchor" id="a3ec465a62e1feaae00f585ca0cffb81e"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual Assimp::ProgressHandler::~ProgressHandler </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Virtual destructor. </p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="ab08a1d300d434f6dd86ca41747cba448"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool Assimp::ProgressHandler::Update </td> <td>(</td> <td class="paramtype">float </td> <td class="paramname"><em>percentage</em> = <code>-1.f</code></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Progress callback. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">percentage</td><td>An estimate of the current loading progress, in percent. Or -1.f if such an estimate is not available.</td></tr> </table> </dd> </dl> <p>There are restriction on what you may do from within your implementation of this method: no exceptions may be thrown and no non-const #Importer methods may be called. It is not generally possible to predict the number of callbacks fired during a single import.</p> <dl class="section return"><dt>Returns</dt><dd>Return false to abort loading at the next possible occasion (loaders and <a class="el" href="namespace_assimp.html" title="Assimp's CPP-API and all internal APIs. ">Assimp</a> are generally allowed to perform all needed cleanup tasks prior to returning control to the caller). If the loading is aborted, #Importer::ReadFile() returns always NULL.</dd></dl> <dl class="section note"><dt>Note</dt><dd>Currently, percentage is always -1.f because there is no reliable way to compute it. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="_progress_handler_8hpp.html">ProgressHandler.hpp</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="namespace_assimp.html">Assimp</a></li><li class="navelem"><a class="el" href="class_assimp_1_1_progress_handler.html">ProgressHandler</a></li> <li class="footer">Generated on Sat Oct 18 2014 15:01:15 for Assimp by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li> </ul> </div> </body> </html>