<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>Crystal Space 1.2.1: csPoly2DPool Class Reference (Crystal Space 1.2.1 Public API Reference)</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <table border="0" cellpadding="0" cellspacing="0" width="100%" class="head"> <tr height="59"> <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td> <td class="head"><h2>Public API Reference</h2></td> </tr> <tr height="11"> <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td> </tr> </table> <div class="content"> <!-- Generated by Doxygen 1.5.3 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</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="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</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> <h1>csPoly2DPool Class Reference<br> <small> [<a class="el" href="group__geom__utils.html">Geometry utilities</a>]</small> </h1><!-- doxytag: class="csPoly2DPool" -->This is an object pool which holds objects of type <a class="el" href="classcsPoly2D.html" title="The following class represents a general 2D polygon.">csPoly2D</a>. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="polypool_8h-source.html">csgeom/polypool.h</a>></code> <p> <p> <a href="classcsPoly2DPool-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsPoly2D.html">csPoly2D</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPoly2DPool.html#8b298c7fb65fdd005ea8e74a17335ac4">Alloc</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate a new object in the pool. <a href="#8b298c7fb65fdd005ea8e74a17335ac4"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPoly2DPool.html#21675f701ad147888723f0d9b09aa89e">csPoly2DPool</a> (<a class="el" href="classcsPoly2DFactory.html">csPoly2DFactory</a> *fact)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty pool. <a href="#21675f701ad147888723f0d9b09aa89e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPoly2DPool.html#c63123f4f14171044d9e7d8cc058ff57">Free</a> (<a class="el" href="classcsPoly2D.html">csPoly2D</a> *pol)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Free an object and put it back in the pool. <a href="#c63123f4f14171044d9e7d8cc058ff57"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsPoly2DPool.html#b736a029419c884cfedfbe9fb3869168">~csPoly2DPool</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy pool and all objects in the pool. <a href="#b736a029419c884cfedfbe9fb3869168"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> This is an object pool which holds objects of type <a class="el" href="classcsPoly2D.html" title="The following class represents a general 2D polygon.">csPoly2D</a>. <p> You can ask new instances from this pool. If needed it will allocate one for you but ideally it can give you one which was allocated earlier. <p>Definition at line <a class="el" href="polypool_8h-source.html#l00039">39</a> of file <a class="el" href="polypool_8h-source.html">polypool.h</a>.</p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="21675f701ad147888723f0d9b09aa89e"></a><!-- doxytag: member="csPoly2DPool::csPoly2DPool" ref="21675f701ad147888723f0d9b09aa89e" args="(csPoly2DFactory *fact)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csPoly2DPool::csPoly2DPool </td> <td>(</td> <td class="paramtype"><a class="el" href="classcsPoly2DFactory.html">csPoly2DFactory</a> * </td> <td class="paramname"> <em>fact</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create an empty pool. <p> <p>Definition at line <a class="el" href="polypool_8h-source.html#l00057">57</a> of file <a class="el" href="polypool_8h-source.html">polypool.h</a>.</p> </div> </div><p> <a class="anchor" name="b736a029419c884cfedfbe9fb3869168"></a><!-- doxytag: member="csPoly2DPool::~csPoly2DPool" ref="b736a029419c884cfedfbe9fb3869168" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">csPoly2DPool::~csPoly2DPool </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Destroy pool and all objects in the pool. <p> <p>Definition at line <a class="el" href="polypool_8h-source.html#l00061">61</a> of file <a class="el" href="polypool_8h-source.html">polypool.h</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="8b298c7fb65fdd005ea8e74a17335ac4"></a><!-- doxytag: member="csPoly2DPool::Alloc" ref="8b298c7fb65fdd005ea8e74a17335ac4" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsPoly2D.html">csPoly2D</a>* csPoly2DPool::Alloc </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Allocate a new object in the pool. <p> <p>Definition at line <a class="el" href="polypool_8h-source.html#l00083">83</a> of file <a class="el" href="polypool_8h-source.html">polypool.h</a>.</p> <p>References <a class="el" href="poly2d_8h-source.html#l00235">csPoly2DFactory::Create()</a>.</p> </div> </div><p> <a class="anchor" name="c63123f4f14171044d9e7d8cc058ff57"></a><!-- doxytag: member="csPoly2DPool::Free" ref="c63123f4f14171044d9e7d8cc058ff57" args="(csPoly2D *pol)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void csPoly2DPool::Free </td> <td>(</td> <td class="paramtype"><a class="el" href="classcsPoly2D.html">csPoly2D</a> * </td> <td class="paramname"> <em>pol</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Free an object and put it back in the pool. <p> Note that it is only legal to free objects which were allocated from the pool. <p>Definition at line <a class="el" href="polypool_8h-source.html#l00106">106</a> of file <a class="el" href="polypool_8h-source.html">polypool.h</a>.</p> <p>References <a class="el" href="cssysdef_8h.html#c380bd47888ecfe73e7b7a40b6f827a1">CS_ASSERT</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li>csgeom/<a class="el" href="polypool_8h-source.html">polypool.h</a></ul> <hr size="1"><address><small>Generated for Crystal Space 1.2.1 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 </small></address> </div></body> </html>