diff options
Diffstat (limited to 'html/simple-shape/docs/Shapes.html')
-rw-r--r-- | html/simple-shape/docs/Shapes.html | 436 |
1 files changed, 436 insertions, 0 deletions
diff --git a/html/simple-shape/docs/Shapes.html b/html/simple-shape/docs/Shapes.html new file mode 100644 index 0000000..716e63a --- /dev/null +++ b/html/simple-shape/docs/Shapes.html @@ -0,0 +1,436 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Namespace: Shapes</title> + + <script src="scripts/prettify/prettify.js"> </script> + <script src="scripts/prettify/lang-css.js"> </script> + <!--[if lt IE 9]> + <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> + <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> +</head> + +<body> + +<div id="main"> + + <h1 class="page-title">Namespace: Shapes</h1> + + + + + + +<section> + +<header> + + <h2>Shapes</h2> + + +</header> + +<article> + <div class="container-overview"> + + + <div class="description">Shape Factory Pattern</div> + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="app.js.html">app.js</a>, <a href="app.js.html#line128">line 128</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + </div> + + + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + + + + + + + <h4 class="name" id=".circle"><span class="type-signature">(static) </span>circle<span class="signature">(x, y, size, params)</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + Creates a circle with optional fill +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>x</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + </td> + + + + + + <td class="description last">Center X coordinate</td> + </tr> + + + + <tr> + + <td class="name"><code>y</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + </td> + + + + + + <td class="description last">Center Y coordinate</td> + </tr> + + + + <tr> + + <td class="name"><code>size</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + </td> + + + + + + <td class="description last">Reference size for radius calculation</td> + </tr> + + + + <tr> + + <td class="name"><code>params</code></td> + + + <td class="type"> + + +<span class="param-type">Object</span> + + + + </td> + + + + + + <td class="description last">Optional parameters for customization + <h6>Properties</h6> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Attributes</th> + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>radius</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + + <td class="description last">Optional explicit radius</td> + </tr> + + + + <tr> + + <td class="name"><code>fill</code></td> + + + <td class="type"> + + +<span class="param-type">boolean</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + + <td class="description last">Whether to fill the circle</td> + </tr> + + + </tbody> +</table> + + </td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="app.js.html">app.js</a>, <a href="app.js.html#line142">line 142</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + + + + + + + +</article> + +</section> + + + + +</div> + +<nav> + <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="ContextManager.html">ContextManager</a></li><li><a href="Layout.html">Layout</a></li><li><a href="Patterns.html">Patterns</a></li><li><a href="Shapes.html">Shapes</a></li><li><a href="Utils.html">Utils</a></li></ul><h3>Global</h3><ul><li><a href="global.html#CONFIG">CONFIG</a></li><li><a href="global.html#canvas">canvas</a></li></ul> +</nav> + +<br class="clear"> + +<footer> + Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.3</a> on Mon Feb 17 2025 15:13:39 GMT-0500 (Eastern Standard Time) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html> \ No newline at end of file |