<!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.3.1"/>
<title>Chipmunk2D Pro API Reference: ChipmunkAbstractTileCache 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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">Chipmunk2D Pro API Reference
 <span id="projectnumber">7.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<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 Page</span></a></li>
<li><a href="modules.html"><span>Modules</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">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Instance Methods</a> |
<a href="#properties">Properties</a> |
<a href="class_chipmunk_abstract_tile_cache-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ChipmunkAbstractTileCache Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A tile cache enables an efficient means of updating a large deformable terrain.
<a href="interface_chipmunk_abstract_tile_cache.html#details">More...</a></p>
<p><code>#import <<a class="el" href="_chipmunk_tile_cache_8h_source.html">ChipmunkTileCache.h</a>></code></p>
<p>Inherits NSObject.</p>
<p>Inherited by <a class="el" href="interface_chipmunk_basic_tile_cache.html">ChipmunkBasicTileCache</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Instance Methods</h2></td></tr>
<tr class="memitem:a5a7090df1c395f9e5354f41b99003b34"><td class="memItemLeft" align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_chipmunk_abstract_tile_cache.html#a5a7090df1c395f9e5354f41b99003b34">initWithSampler:space:tileSize:samplesPerTile:cacheSize:</a></td></tr>
<tr class="memdesc:a5a7090df1c395f9e5354f41b99003b34"><td class="mdescLeft"> </td><td class="mdescRight">Create the cache from the given sampler, space to add the generated segments to, size of the tiles, and the number of samples for each tile. <a href="#a5a7090df1c395f9e5354f41b99003b34">More...</a><br/></td></tr>
<tr class="separator:a5a7090df1c395f9e5354f41b99003b34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a803778d7b8ec954ef8273de7f7abfc0f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a803778d7b8ec954ef8273de7f7abfc0f"></a>
(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_chipmunk_abstract_tile_cache.html#a803778d7b8ec954ef8273de7f7abfc0f">resetCache</a></td></tr>
<tr class="memdesc:a803778d7b8ec954ef8273de7f7abfc0f"><td class="mdescLeft"> </td><td class="mdescRight">Clear out all the cached tiles to force a full regen. <br/></td></tr>
<tr class="separator:a803778d7b8ec954ef8273de7f7abfc0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3684d14ccc684575b25e7cb286bb767d"><td class="memItemLeft" align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_chipmunk_abstract_tile_cache.html#a3684d14ccc684575b25e7cb286bb767d">markDirtyRect:</a></td></tr>
<tr class="memdesc:a3684d14ccc684575b25e7cb286bb767d"><td class="mdescLeft"> </td><td class="mdescRight">Mark a region as needing an update. <a href="#a3684d14ccc684575b25e7cb286bb767d">More...</a><br/></td></tr>
<tr class="separator:a3684d14ccc684575b25e7cb286bb767d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0311da2191c87b72765dfa09c0b97695"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0311da2191c87b72765dfa09c0b97695"></a>
(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_chipmunk_abstract_tile_cache.html#a0311da2191c87b72765dfa09c0b97695">ensureRect:</a></td></tr>
<tr class="memdesc:a0311da2191c87b72765dfa09c0b97695"><td class="mdescLeft"> </td><td class="mdescRight">Ensure that the given rect has been fully generated and contains no dirty rects. <br/></td></tr>
<tr class="separator:a0311da2191c87b72765dfa09c0b97695"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66fcb209967bd6e8b29d00826e93590b"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="structcp_polyline.html">cpPolyline</a> *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_chipmunk_abstract_tile_cache.html#a66fcb209967bd6e8b29d00826e93590b">simplify:</a></td></tr>
<tr class="memdesc:a66fcb209967bd6e8b29d00826e93590b"><td class="mdescLeft"> </td><td class="mdescRight">Override this in a subclass to make custom polygon simplification behavior. <a href="#a66fcb209967bd6e8b29d00826e93590b">More...</a><br/></td></tr>
<tr class="separator:a66fcb209967bd6e8b29d00826e93590b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6aa4a54d33170c8f3234cd0b23ad6861"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_chipmunk_segment_shape.html">ChipmunkSegmentShape</a> *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_chipmunk_abstract_tile_cache.html#a6aa4a54d33170c8f3234cd0b23ad6861">makeSegmentFor:from:to:</a></td></tr>
<tr class="memdesc:a6aa4a54d33170c8f3234cd0b23ad6861"><td class="mdescLeft"> </td><td class="mdescRight">Override this method to construct the segment shapes. <a href="#a6aa4a54d33170c8f3234cd0b23ad6861">More...</a><br/></td></tr>
<tr class="separator:a6aa4a54d33170c8f3234cd0b23ad6861"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a6c4053aba37bd1afce1504cb62d23f29"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_abstract_tile_cache.html#a6c4053aba37bd1afce1504cb62d23f29">marchHard</a></td></tr>
<tr class="memdesc:a6c4053aba37bd1afce1504cb62d23f29"><td class="mdescLeft"> </td><td class="mdescRight">Should the marching be hard or soft? See cpMarchHard() and cpMarchSoft() for more information. <a href="#a6c4053aba37bd1afce1504cb62d23f29">More...</a><br/></td></tr>
<tr class="separator:a6c4053aba37bd1afce1504cb62d23f29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a587e3fdbe74ee56bdaf93f05179ee121"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a587e3fdbe74ee56bdaf93f05179ee121"></a>
<a class="el" href="structcp_vect.html">cpVect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_abstract_tile_cache.html#a587e3fdbe74ee56bdaf93f05179ee121">tileOffset</a></td></tr>
<tr class="memdesc:a587e3fdbe74ee56bdaf93f05179ee121"><td class="mdescLeft"> </td><td class="mdescRight">Offset of the tile grid origin. <br/></td></tr>
<tr class="separator:a587e3fdbe74ee56bdaf93f05179ee121"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a90beab26c86139e5a3aff6cbb3e6c4d1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a90beab26c86139e5a3aff6cbb3e6c4d1"></a>
<a class="el" href="interface_chipmunk_abstract_sampler.html">ChipmunkAbstractSampler</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_chipmunk_abstract_tile_cache.html#a90beab26c86139e5a3aff6cbb3e6c4d1">sampler</a></td></tr>
<tr class="memdesc:a90beab26c86139e5a3aff6cbb3e6c4d1"><td class="mdescLeft"> </td><td class="mdescRight">The sampling function to use. <br/></td></tr>
<tr class="separator:a90beab26c86139e5a3aff6cbb3e6c4d1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A tile cache enables an efficient means of updating a large deformable terrain. </p>
<p>General usage would be to pass a rectangle covering the viewport to ensureRect: and calling markDirtyRect: each time a change is made that requires an area to be resampled. </p>
</div><h2 class="groupheader">Method Documentation</h2>
<a class="anchor" id="a5a7090df1c395f9e5354f41b99003b34"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (id) initWithSampler: </td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_chipmunk_abstract_sampler.html">ChipmunkAbstractSampler</a> *) </td>
<td class="paramname"><em>sampler</em></td>
</tr>
<tr>
<td class="paramkey">space:</td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_chipmunk_space.html">ChipmunkSpace</a> *) </td>
<td class="paramname"><em>space</em></td>
</tr>
<tr>
<td class="paramkey">tileSize:</td>
<td></td>
<td class="paramtype">(<a class="el" href="group__basic_types.html#gac1ed65573e035bf892505768c852d8d3">cpFloat</a>) </td>
<td class="paramname"><em>tileSize</em></td>
</tr>
<tr>
<td class="paramkey">samplesPerTile:</td>
<td></td>
<td class="paramtype">(NSUInteger) </td>
<td class="paramname"><em>samplesPerTile</em></td>
</tr>
<tr>
<td class="paramkey">cacheSize:</td>
<td></td>
<td class="paramtype">(NSUInteger) </td>
<td class="paramname"><em>cacheSize</em> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create the cache from the given sampler, space to add the generated segments to, size of the tiles, and the number of samples for each tile. </p>
</div>
</div>
<a class="anchor" id="a6aa4a54d33170c8f3234cd0b23ad6861"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (<a class="el" href="interface_chipmunk_segment_shape.html">ChipmunkSegmentShape</a> *) makeSegmentFor: </td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_chipmunk_body.html">ChipmunkBody</a> *) </td>
<td class="paramname"><em>staticBody</em></td>
</tr>
<tr>
<td class="paramkey">from:</td>
<td></td>
<td class="paramtype">(<a class="el" href="structcp_vect.html">cpVect</a>) </td>
<td class="paramname"><em>a</em></td>
</tr>
<tr>
<td class="paramkey">to:</td>
<td></td>
<td class="paramtype">(<a class="el" href="structcp_vect.html">cpVect</a>) </td>
<td class="paramname"><em>b</em> </td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Override this method to construct the segment shapes. </p>
<p>By default, it creates a 0 radius segment and sets 1.0 for friction and elasticity and nothing else. </p>
</div>
</div>
<a class="anchor" id="a3684d14ccc684575b25e7cb286bb767d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (void) markDirtyRect: </td>
<td></td>
<td class="paramtype">(<a class="el" href="structcp_b_b.html">cpBB</a>) </td>
<td class="paramname"><em>bounds</em></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Mark a region as needing an update. </p>
<p>Geometry is not regenerated until ensureRect: is called. </p>
</div>
</div>
<a class="anchor" id="a66fcb209967bd6e8b29d00826e93590b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (<a class="el" href="structcp_polyline.html">cpPolyline</a> *) simplify: </td>
<td></td>
<td class="paramtype">(<a class="el" href="structcp_polyline.html">cpPolyline</a> *) </td>
<td class="paramname"><em>polyline</em></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Override this in a subclass to make custom polygon simplification behavior. </p>
<p>Defaults to cpPolylineSimplifyCurves(polyline, 2.0f) </p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a6c4053aba37bd1afce1504cb62d23f29"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">- (bool) marchHard</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">read</span><span class="mlabel">write</span><span class="mlabel">nonatomic</span><span class="mlabel">assign</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Should the marching be hard or soft? See cpMarchHard() and cpMarchSoft() for more information. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="_chipmunk_tile_cache_8h_source.html">ChipmunkTileCache.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 2 2015 11:28:11 for Chipmunk2D Pro API Reference by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
