shape-polygon-object.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  1. <!DOCTYPE html>
  2. <html class="writer-html5" lang="en" >
  3. <head>
  4. <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>Polygon &mdash; Phaser Editor 2D Help</title>
  7. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  8. <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  9. <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
  10. <link rel="shortcut icon" href="../_static/icon.png"/>
  11. <!--[if lt IE 9]>
  12. <script src="../_static/js/html5shiv.min.js"></script>
  13. <![endif]-->
  14. <script src="../_static/jquery.js?v=5d32c60e"></script>
  15. <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
  16. <script src="../_static/documentation_options.js?v=a1f35292"></script>
  17. <script src="../_static/doctools.js?v=888ff710"></script>
  18. <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
  19. <script src="../_static/js/theme.js"></script>
  20. <link rel="index" title="Index" href="../genindex.html" />
  21. <link rel="search" title="Search" href="../search.html" />
  22. <link rel="next" title="Container" href="container-object.html" />
  23. <link rel="prev" title="Triangle" href="shape-triangle-object.html" />
  24. </head>
  25. <body class="wy-body-for-nav">
  26. <div class="wy-grid-for-nav">
  27. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  28. <div class="wy-side-scroll">
  29. <div class="wy-side-nav-search" style="background: #343131" >
  30. <a href="../index.html" class="icon icon-home">
  31. Phaser Editor 2D
  32. <img src="../_static/logo.png" class="logo" alt="Logo"/>
  33. </a>
  34. <div class="version">
  35. v3.67.0
  36. </div>
  37. <div role="search">
  38. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  39. <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
  40. <input type="hidden" name="check_keywords" value="yes" />
  41. <input type="hidden" name="area" value="default" />
  42. </form>
  43. </div>
  44. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  45. <ul class="current">
  46. <li class="toctree-l1"><a class="reference internal" href="../intro/index.html">Introduction</a></li>
  47. <li class="toctree-l1"><a class="reference internal" href="../first-steps/index.html">First steps</a></li>
  48. <li class="toctree-l1"><a class="reference internal" href="../workbench/index.html">Workbench</a></li>
  49. <li class="toctree-l1"><a class="reference internal" href="../asset-pack-editor/index.html">Asset Pack Editor</a></li>
  50. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Scene Editor</a><ul class="current">
  51. <li class="toctree-l2"><a class="reference internal" href="create-new-scene-file.html">Create a new Scene file</a></li>
  52. <li class="toctree-l2"><a class="reference internal" href="add-object.html">Adding an object to the scene</a></li>
  53. <li class="toctree-l2"><a class="reference internal" href="inspector-view.html">Inspector view</a></li>
  54. <li class="toctree-l2 current"><a class="reference internal" href="game-objects.html">Game Object types</a><ul class="current">
  55. <li class="toctree-l3"><a class="reference internal" href="common-object-properties.html">Common object properties</a></li>
  56. <li class="toctree-l3"><a class="reference internal" href="image-object.html">Image</a></li>
  57. <li class="toctree-l3"><a class="reference internal" href="sprite-object.html">Sprite</a></li>
  58. <li class="toctree-l3"><a class="reference internal" href="tile-sprite-object.html">TileSprite</a></li>
  59. <li class="toctree-l3"><a class="reference internal" href="nine-slice-object.html">NineSlice</a></li>
  60. <li class="toctree-l3"><a class="reference internal" href="text-object.html">Text</a></li>
  61. <li class="toctree-l3"><a class="reference internal" href="bitmap-text-object.html">BitmapText</a></li>
  62. <li class="toctree-l3"><a class="reference internal" href="tilemap-object.html">Tilemap</a></li>
  63. <li class="toctree-l3"><a class="reference internal" href="tilemap-layer-object.html">TilemapLayer</a></li>
  64. <li class="toctree-l3 current"><a class="reference internal" href="shape-object.html">Shape</a><ul class="current">
  65. <li class="toctree-l4"><a class="reference internal" href="shape-rectangle-object.html">Rectangle</a></li>
  66. <li class="toctree-l4"><a class="reference internal" href="shape-ellipse-object.html">Ellipse</a></li>
  67. <li class="toctree-l4"><a class="reference internal" href="shape-triangle-object.html">Triangle</a></li>
  68. <li class="toctree-l4 current"><a class="current reference internal" href="#">Polygon</a></li>
  69. </ul>
  70. </li>
  71. <li class="toctree-l3"><a class="reference internal" href="container-object.html">Container</a></li>
  72. <li class="toctree-l3"><a class="reference internal" href="layer-object.html">Layer</a></li>
  73. <li class="toctree-l3"><a class="reference internal" href="spine-game-object.html">SpineGameObject</a></li>
  74. <li class="toctree-l3"><a class="reference internal" href="replace-object-type.html">Replacing the type of an object</a></li>
  75. </ul>
  76. </li>
  77. <li class="toctree-l2"><a class="reference internal" href="scene-properties.html">Scene properties</a></li>
  78. <li class="toctree-l2"><a class="reference internal" href="arcade-physics.html">Arcade Physics</a></li>
  79. <li class="toctree-l2"><a class="reference internal" href="sprite-animations.html">Sprite animations</a></li>
  80. <li class="toctree-l2"><a class="reference internal" href="spine-animations.html">Spine animations</a></li>
  81. <li class="toctree-l2"><a class="reference internal" href="shader-effects.html">Shader Effects</a></li>
  82. <li class="toctree-l2"><a class="reference internal" href="working-with-parent-objects.html">Working with parent objects</a></li>
  83. <li class="toctree-l2"><a class="reference internal" href="object-list.html">Object List</a></li>
  84. <li class="toctree-l2"><a class="reference internal" href="input.html">Input</a></li>
  85. <li class="toctree-l2"><a class="reference internal" href="prefabs.html">Prefabs</a></li>
  86. <li class="toctree-l2"><a class="reference internal" href="script-node.html">Script Nodes</a></li>
  87. <li class="toctree-l2"><a class="reference internal" href="user-components.html">User Components</a></li>
  88. <li class="toctree-l2"><a class="reference internal" href="manipulation-tools.html">Manipulation tools</a></li>
  89. <li class="toctree-l2"><a class="reference internal" href="layout-tools.html">Layout tools</a></li>
  90. <li class="toctree-l2"><a class="reference internal" href="scene-compiler.html">The scene compiler</a></li>
  91. <li class="toctree-l2"><a class="reference internal" href="misc.html">Miscellaneous</a></li>
  92. <li class="toctree-l2"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
  93. </ul>
  94. </li>
  95. <li class="toctree-l1"><a class="reference internal" href="../code-editor/index.html">Code Editor</a></li>
  96. <li class="toctree-l1"><a class="reference internal" href="../animations-editor/index.html">Animations Editor</a></li>
  97. <li class="toctree-l1"><a class="reference internal" href="../atlas-editor/index.html">Atlas Editor</a></li>
  98. <li class="toctree-l1"><a class="reference internal" href="../misc/index.html">Miscellaneous</a></li>
  99. <li class="toctree-l1"><a class="reference internal" href="../pricing/index.html">License and pricing</a></li>
  100. </ul>
  101. </div>
  102. </div>
  103. </nav>
  104. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #343131" >
  105. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  106. <a href="../index.html">Phaser Editor 2D</a>
  107. </nav>
  108. <div class="wy-nav-content">
  109. <div class="rst-content">
  110. <div role="navigation" aria-label="Page navigation">
  111. <ul class="wy-breadcrumbs">
  112. <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
  113. <li class="breadcrumb-item"><a href="index.html">Scene Editor</a></li>
  114. <li class="breadcrumb-item"><a href="game-objects.html">Game Object types</a></li>
  115. <li class="breadcrumb-item"><a href="shape-object.html">Shape</a></li>
  116. <li class="breadcrumb-item active">Polygon</li>
  117. <li class="wy-breadcrumbs-aside">
  118. </li>
  119. </ul>
  120. <hr/>
  121. </div>
  122. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  123. <div itemprop="articleBody">
  124. <section id="polygon">
  125. <h1>Polygon<a class="headerlink" href="#polygon" title="Link to this heading"></a></h1>
  126. <p>You can create <a class="reference external" href="https://photonstorm.github.io/phaser3-docs/Phaser.GameObjects.Polygon.html">Polygon</a> object by dropping the <strong>Polygon</strong> block, from the <a class="reference external" href="../workbench/blocks-view.html">Blocks view</a>, on the scene.</p>
  127. <img alt="Create a polygon." src="../_images/scene-editor-polygon-create-20220623.webp" />
  128. <p>A polygon is made with points. You can edit the points in the <strong>Polygon section</strong> or with the <a class="reference external" href="manipulation-tools.html#polygon-tool">Polygon tool</a>.</p>
  129. <p>The Polygon section shows the Points field. The points are presented as a string of the X Y pairs of the points, separated by a space.</p>
  130. <img alt="Polygon section." src="../_images/scene-editor-polygon-section-20220623.webp" />
  131. <p>The Polygon tool (that you can activate with the <code class="docutils literal notranslate"><span class="pre">Y</span></code> key) shows the polygon’s points in the scene. It allows you:</p>
  132. <ul class="simple">
  133. <li><p>Change the position of a point: drag the point with the mouse cursor.</p></li>
  134. <li><p>Delete a point: move the mouse cursor over the point and press the <cite>Delete</cite> key (or double click). When the cursor is over the point, it is painted in red color.</p></li>
  135. </ul>
  136. <img alt="Move polygon point." src="../_images/scene-editor-polygon-edit-points-20220623.webp" />
  137. <ul class="simple">
  138. <li><p>Add a new point: move the mouse cursor over a line. It shows a white handler under the cursor, you can drag it for creating a new point.</p></li>
  139. </ul>
  140. <img alt="Add new point." src="../_images/scene-editor-polygon-add-point-20220623.webp" />
  141. <img alt="Add new point." src="../_images/scene-editor-polygon-add-point-2-20220623.webp" />
  142. <p>The <a class="reference external" href="https://photonstorm.github.io/phaser3-docs/Phaser.GameObjects.Polygon.html">Polygon</a> code is generated by the <a class="reference external" href="../scene-editor/scene-compiler.html">scene compiler</a> using the <a class="reference external" href="https://photonstorm.github.io/phaser3-docs/Phaser.GameObjects.GameObjectFactory.html#polygon__anchor">polygon object factory</a>:</p>
  143. <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">polygon</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">this</span><span class="p">.</span><span class="nx">add</span><span class="p">.</span><span class="nx">polygon</span><span class="p">(</span><span class="mf">10</span><span class="p">,</span><span class="w"> </span><span class="mf">10</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;0 0 20 70 100 100 80 20&quot;</span><span class="p">);</span>
  144. </pre></div>
  145. </div>
  146. </section>
  147. </div>
  148. </div>
  149. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  150. <a href="shape-triangle-object.html" class="btn btn-neutral float-left" title="Triangle" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  151. <a href="container-object.html" class="btn btn-neutral float-right" title="Container" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  152. </div>
  153. <hr/>
  154. <div role="contentinfo">
  155. <p>&#169; Copyright 2016-2024, Arian Fornaris.</p>
  156. </div>
  157. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  158. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  159. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  160. </footer>
  161. </div>
  162. </div>
  163. </section>
  164. </div>
  165. <script>
  166. jQuery(function () {
  167. SphinxRtdTheme.Navigation.enable(true);
  168. });
  169. </script>
  170. <!-- Theme Analytics -->
  171. <script async src="https://www.googletagmanager.com/gtag/js?id=UA-67206336-2"></script>
  172. <script>
  173. window.dataLayer = window.dataLayer || [];
  174. function gtag(){dataLayer.push(arguments);}
  175. gtag('js', new Date());
  176. gtag('config', 'UA-67206336-2', {
  177. 'anonymize_ip': false,
  178. });
  179. </script>
  180. </body>
  181. </html>