UnityEngine.SpriteShapeModule.xml 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.SpriteShapeModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.Experimental.U2D.AngleRangeInfo">
  8. <summary>
  9. <para>Describes the information about the edge and how to tessellate it.</para>
  10. </summary>
  11. </member>
  12. <member name="F:UnityEngine.Experimental.U2D.AngleRangeInfo.end">
  13. <summary>
  14. <para>The maximum angle to be considered within this range.</para>
  15. </summary>
  16. </member>
  17. <member name="F:UnityEngine.Experimental.U2D.AngleRangeInfo.order">
  18. <summary>
  19. <para>The render order of the edges that belong in this range.</para>
  20. </summary>
  21. </member>
  22. <member name="F:UnityEngine.Experimental.U2D.AngleRangeInfo.sprites">
  23. <summary>
  24. <para>The list of Sprites that are associated with this range.</para>
  25. </summary>
  26. </member>
  27. <member name="F:UnityEngine.Experimental.U2D.AngleRangeInfo.start">
  28. <summary>
  29. <para>The minimum angle to be considered within this range.</para>
  30. </summary>
  31. </member>
  32. <member name="T:UnityEngine.Experimental.U2D.ShapeControlPoint">
  33. <summary>
  34. <para>Data that describes the important points of the shape.</para>
  35. </summary>
  36. </member>
  37. <member name="F:UnityEngine.Experimental.U2D.ShapeControlPoint.leftTangent">
  38. <summary>
  39. <para>The position of the left tangent in local space.</para>
  40. </summary>
  41. </member>
  42. <member name="F:UnityEngine.Experimental.U2D.ShapeControlPoint.mode">
  43. <summary>
  44. <para>The various modes of the tangent handles. They could be continuous or broken.</para>
  45. </summary>
  46. </member>
  47. <member name="F:UnityEngine.Experimental.U2D.ShapeControlPoint.position">
  48. <summary>
  49. <para>The position of this point in the object's local space.</para>
  50. </summary>
  51. </member>
  52. <member name="F:UnityEngine.Experimental.U2D.ShapeControlPoint.rightTangent">
  53. <summary>
  54. <para>The position of the right tangent point in the local space.</para>
  55. </summary>
  56. </member>
  57. <member name="T:UnityEngine.Experimental.U2D.SpriteShapeMetaData">
  58. <summary>
  59. <para>Additional data about the shape's control point. This is useful during tessellation of the shape.</para>
  60. </summary>
  61. </member>
  62. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeMetaData.bevelCutoff">
  63. <summary>
  64. <para>The threshold of the angle that decides if it should be tessellated as a curve or a corner.</para>
  65. </summary>
  66. </member>
  67. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeMetaData.bevelSize">
  68. <summary>
  69. <para>The radius of the curve to be tessellated.</para>
  70. </summary>
  71. </member>
  72. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeMetaData.corner">
  73. <summary>
  74. <para>True will indicate that this point should be tessellated as a corner or a continuous line otherwise.</para>
  75. </summary>
  76. </member>
  77. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeMetaData.height">
  78. <summary>
  79. <para>The height of the tessellated edge.</para>
  80. </summary>
  81. </member>
  82. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeMetaData.spriteIndex">
  83. <summary>
  84. <para>The Sprite to be used for a particular edge.</para>
  85. </summary>
  86. </member>
  87. <member name="T:UnityEngine.Experimental.U2D.SpriteShapeParameters">
  88. <summary>
  89. <para>Input parameters for the SpriteShape tessellator.</para>
  90. </summary>
  91. </member>
  92. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeParameters.adaptiveUV">
  93. <summary>
  94. <para>If enabled, the tessellator will adapt the size of the quads based on the height of the edge.</para>
  95. </summary>
  96. </member>
  97. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeParameters.angleThreshold">
  98. <summary>
  99. <para>The threshold of the angle that indicates whether it is a corner or not.</para>
  100. </summary>
  101. </member>
  102. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeParameters.bevelCutoff">
  103. <summary>
  104. <para>The threshold of the angle that decides if it should be tessellated as a curve or a corner.</para>
  105. </summary>
  106. </member>
  107. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeParameters.bevelSize">
  108. <summary>
  109. <para>The radius of the curve to be tessellated.</para>
  110. </summary>
  111. </member>
  112. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeParameters.borderPivot">
  113. <summary>
  114. <para>The local displacement of the Sprite when tessellated.</para>
  115. </summary>
  116. </member>
  117. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeParameters.carpet">
  118. <summary>
  119. <para>If true, the Shape will be tessellated as a closed form.</para>
  120. </summary>
  121. </member>
  122. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeParameters.fillScale">
  123. <summary>
  124. <para>The scale to be used to calculate the UVs of the fill texture.</para>
  125. </summary>
  126. </member>
  127. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeParameters.fillTexture">
  128. <summary>
  129. <para>The texture to be used for the fill of the SpriteShape.</para>
  130. </summary>
  131. </member>
  132. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeParameters.smartSprite">
  133. <summary>
  134. <para>If enabled the tessellator will consider creating corners based on the various input parameters.</para>
  135. </summary>
  136. </member>
  137. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeParameters.splineDetail">
  138. <summary>
  139. <para>The tessellation quality of the input Spline that determines the complexity of the mesh.</para>
  140. </summary>
  141. </member>
  142. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeParameters.spriteBorders">
  143. <summary>
  144. <para>The borders to be used for calculating the uv of the edges based on the border info found in Sprites.</para>
  145. </summary>
  146. </member>
  147. <member name="F:UnityEngine.Experimental.U2D.SpriteShapeParameters.transform">
  148. <summary>
  149. <para>The world space transform of the game object used for calculating the UVs of the fill texture.</para>
  150. </summary>
  151. </member>
  152. <member name="T:UnityEngine.Experimental.U2D.SpriteShapeRenderer">
  153. <summary>
  154. <para>Renders SpriteShapes defined through the SpriteShapeUtility.GenerateSpriteShape API.</para>
  155. </summary>
  156. </member>
  157. <member name="T:UnityEngine.Experimental.U2D.SpriteShapeUtility">
  158. <summary>
  159. <para>A static class that helps tessellate a SpriteShape mesh.</para>
  160. </summary>
  161. </member>
  162. <member name="M:UnityEngine.Experimental.U2D.SpriteShapeUtility.Generate(UnityEngine.Mesh,UnityEngine.Experimental.U2D.SpriteShapeParameters,UnityEngine.Experimental.U2D.ShapeControlPoint[],UnityEngine.Experimental.U2D.SpriteShapeMetaData[],UnityEngine.Experimental.U2D.AngleRangeInfo[],UnityEngine.Sprite[],UnityEngine.Sprite[])">
  163. <summary>
  164. <para>Generate a mesh based on input parameters.</para>
  165. </summary>
  166. <param name="mesh">The output mesh.</param>
  167. <param name="shapeParams">Input parameters for the SpriteShape tessellator.</param>
  168. <param name="points">A list of control points that describes the shape.</param>
  169. <param name="metaData">Additional data about the shape's control point. This is useful during tessellation of the shape.</param>
  170. <param name="sprites">The list of Sprites that could be used for the edges.</param>
  171. <param name="corners">The list of Sprites that could be used for the corners.</param>
  172. <param name="angleRange">A parameter that determins how to tessellate each of the edge.</param>
  173. </member>
  174. <member name="M:UnityEngine.Experimental.U2D.SpriteShapeUtility.GenerateSpriteShape(UnityEngine.Experimental.U2D.SpriteShapeRenderer,UnityEngine.Experimental.U2D.SpriteShapeParameters,UnityEngine.Experimental.U2D.ShapeControlPoint[],UnityEngine.Experimental.U2D.SpriteShapeMetaData[],UnityEngine.Experimental.U2D.AngleRangeInfo[],UnityEngine.Sprite[],UnityEngine.Sprite[])">
  175. <summary>
  176. <para>Generate a mesh based on input parameters.</para>
  177. </summary>
  178. <param name="renderer">SpriteShapeRenderer to which the generated geometry is fed to.</param>
  179. <param name="shapeParams">Input parameters for the SpriteShape tessellator.</param>
  180. <param name="points">A list of control points that describes the shape.</param>
  181. <param name="metaData">Additional data about the shape's control point. This is useful during tessellation of the shape.</param>
  182. <param name="sprites">The list of Sprites that could be used for the edges.</param>
  183. <param name="corners">The list of Sprites that could be used for the corners.</param>
  184. <param name="angleRange">A parameter that determins how to tessellate each of the edge.</param>
  185. </member>
  186. </members>
  187. </doc>