/usr/share/doc/libcoyotl-dev/html/a00001.html is in libcoyotl-dev 3.1.0-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | <!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>libcoyotl</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<h1 align="center" color="#606080">
libcoyotl - A Library of C++ Tools
</h1>
<p align="center">
Created by <a href="mailto:scott.ladd@@coyotegulch.com?subject=libcoyotl">Scott Robert Ladd</a> at
<a href="http://www.coyotegulch.com">Coyote Gulch Productions</a>.
</p>
<hr>
<!-- Generated by Doxygen 1.8.1.1 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>libcoyotl</b></li><li class="navelem"><a class="el" href="a00008.html">maze</a></li><li class="navelem"><a class="el" href="a00001.html">architect</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-static-methods">Static Protected Member Functions</a> </div>
<div class="headertitle">
<div class="title">libcoyotl::maze::architect Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Pluggable object to randomize a maze.
<a href="a00001.html#details">More...</a></p>
<p><code>#include <<a class="el" href="a00023_source.html">maze.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for libcoyotl::maze::architect:</div>
<div class="dyncontent">
<div class="center">
<img src="a00001.png" usemap="#libcoyotl::maze::architect_map" alt=""/>
<map id="libcoyotl::maze::architect_map" name="libcoyotl::maze::architect_map">
<area href="a00016.html" title="Implements a recursive, back-tracking maze architect." alt="libcoyotl::recursive_maze_architect" shape="rect" coords="0,56,211,80"/>
</map>
</div></div>
<p><a href="a00041.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a851123d883f75166bae3b0f6908c82d3"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#a851123d883f75166bae3b0f6908c82d3">create_floor_plan</a> (<a class="el" href="a00008.html">maze</a> &a_target)=0</td></tr>
<tr class="memdesc:a851123d883f75166bae3b0f6908c82d3"><td class="mdescLeft"> </td><td class="mdescRight">Creates a floor plan for a maze. <a href="#a851123d883f75166bae3b0f6908c82d3"></a><br/></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pro-static-methods"></a>
Static Protected Member Functions</h2></td></tr>
<tr class="memitem:ab2378f0e1b340c27c863ad05788a06d5"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00003.html">cell</a> ** </td><td class="memItemRight" valign="bottom"><a class="el" href="a00001.html#ab2378f0e1b340c27c863ad05788a06d5">get_cells</a> (<a class="el" href="a00008.html">maze</a> &a_target)</td></tr>
<tr class="memdesc:ab2378f0e1b340c27c863ad05788a06d5"><td class="mdescLeft"> </td><td class="mdescRight">Get cell map for a maze. <a href="#ab2378f0e1b340c27c863ad05788a06d5"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Since several different algorithms can carve mazes with different characteristics, <em>architect</em> implements a polymorphic class, thus divorcing the carving algorithm from the data it generates. The abstract architect class is tightly bound to the maze data structures, and I defined it within the scope of <em>maze</em>, as a friend; it implements protected static methods that access the internal data of a maze. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a851123d883f75166bae3b0f6908c82d3"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void libcoyotl::maze::architect::create_floor_plan </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00008.html">maze</a> & </td>
<td class="paramname"><em>a_target</em></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>This method "draws" in the given <em>maze</em> object, creating the floor plan. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">a_target</td><td>- The <em>maze</em> that will be "architected". </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="a00016.html#a5852dd23f83d144f08bed689c9e3c085">libcoyotl::recursive_maze_architect</a>.</p>
</div>
</div>
<a class="anchor" id="ab2378f0e1b340c27c863ad05788a06d5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00003.html">cell</a>** libcoyotl::maze::architect::get_cells </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00008.html">maze</a> & </td>
<td class="paramname"><em>a_target</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the two-dimensional maze containing the cells for a maze. This function provides direct read-write access to the cell data. </p>
<dl class="params"><dt>Parameters:</dt><dd>
<table class="params">
<tr><td class="paramname">a_target</td><td>- The target maze </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns:</dt><dd>A two-dimensional pointer to the cell grid </dd></dl>
<p>References <a class="el" href="a00008.html#ab440740d68529c050dffb739ce442dae">libcoyotl::maze::m_cells</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00023_source.html">maze.h</a></li>
</ul>
</div><!-- contents -->
<hr>
<p align="center"><small>
© 1996-2005 Scott Robert Ladd. All rights reserved.<br>
HTML documentation generated by Dimitri van Heesch's excellent <a href="http://www.doxygen.org">Doxygen</a> tool.
</small>
</p>
</body>
</html>
|