UnityEngine.GridModule.xml 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.GridModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.Grid">
  8. <summary>
  9. <para>Grid is the base class for plotting a layout of uniformly spaced points and lines.</para>
  10. </summary>
  11. </member>
  12. <member name="P:UnityEngine.Grid.cellGap">
  13. <summary>
  14. <para>The size of the gap between each cell in the Grid.</para>
  15. </summary>
  16. </member>
  17. <member name="P:UnityEngine.Grid.cellLayout">
  18. <summary>
  19. <para>The layout of the cells in the Grid.</para>
  20. </summary>
  21. </member>
  22. <member name="P:UnityEngine.Grid.cellSize">
  23. <summary>
  24. <para>The size of each cell in the Grid.</para>
  25. </summary>
  26. </member>
  27. <member name="P:UnityEngine.Grid.cellSwizzle">
  28. <summary>
  29. <para>The cell swizzle for the Grid.</para>
  30. </summary>
  31. </member>
  32. <member name="M:UnityEngine.Grid.GetCellCenterLocal(UnityEngine.Vector3Int)">
  33. <summary>
  34. <para>Get the logical center coordinate of a grid cell in local space.</para>
  35. </summary>
  36. <param name="position">Grid cell position.</param>
  37. <returns>
  38. <para>Center of the cell transformed into local space coordinates.</para>
  39. </returns>
  40. </member>
  41. <member name="M:UnityEngine.Grid.GetCellCenterWorld(UnityEngine.Vector3Int)">
  42. <summary>
  43. <para>Get the logical center coordinate of a grid cell in world space.</para>
  44. </summary>
  45. <param name="position">Grid cell position.</param>
  46. <returns>
  47. <para>Center of the cell transformed into world space coordinates.</para>
  48. </returns>
  49. </member>
  50. <member name="M:UnityEngine.Grid.InverseSwizzle(UnityEngine.GridLayout/CellSwizzle,UnityEngine.Vector3)">
  51. <summary>
  52. <para>Does the inverse swizzle of the given position for given swizzle order.</para>
  53. </summary>
  54. <param name="swizzle">Determines the rearrangement order for the inverse swizzle.</param>
  55. <param name="position">Position to inverse swizzle.</param>
  56. <returns>
  57. <para>The inversed swizzled position.</para>
  58. </returns>
  59. </member>
  60. <member name="M:UnityEngine.Grid.Swizzle(UnityEngine.GridLayout/CellSwizzle,UnityEngine.Vector3)">
  61. <summary>
  62. <para>Swizzles the given position with the given swizzle order.</para>
  63. </summary>
  64. <param name="swizzle">Determines the rearrangement order for the swizzle.</param>
  65. <param name="position">Position to swizzle.</param>
  66. <returns>
  67. <para>The swizzled position.</para>
  68. </returns>
  69. </member>
  70. <member name="T:UnityEngine.GridLayout">
  71. <summary>
  72. <para>An abstract class that defines a grid layout.</para>
  73. </summary>
  74. </member>
  75. <member name="P:UnityEngine.GridLayout.cellGap">
  76. <summary>
  77. <para>The size of the gap between each cell in the layout.</para>
  78. </summary>
  79. </member>
  80. <member name="P:UnityEngine.GridLayout.cellLayout">
  81. <summary>
  82. <para>The layout of the cells.</para>
  83. </summary>
  84. </member>
  85. <member name="P:UnityEngine.GridLayout.cellSize">
  86. <summary>
  87. <para>The size of each cell in the layout.</para>
  88. </summary>
  89. </member>
  90. <member name="P:UnityEngine.GridLayout.cellSwizzle">
  91. <summary>
  92. <para>The cell swizzle for the layout.</para>
  93. </summary>
  94. </member>
  95. <member name="T:UnityEngine.GridLayout.CellLayout">
  96. <summary>
  97. <para>The layout of the GridLayout.</para>
  98. </summary>
  99. </member>
  100. <member name="F:UnityEngine.GridLayout.CellLayout.Hexagon">
  101. <summary>
  102. <para>Hexagonal layout for cells in the GridLayout.</para>
  103. </summary>
  104. </member>
  105. <member name="F:UnityEngine.GridLayout.CellLayout.Rectangle">
  106. <summary>
  107. <para>Rectangular layout for cells in the GridLayout.</para>
  108. </summary>
  109. </member>
  110. <member name="T:UnityEngine.GridLayout.CellSwizzle">
  111. <summary>
  112. <para>Swizzles cell positions to other positions.</para>
  113. </summary>
  114. </member>
  115. <member name="F:UnityEngine.GridLayout.CellSwizzle.XYZ">
  116. <summary>
  117. <para>Keeps the cell positions at XYZ.</para>
  118. </summary>
  119. </member>
  120. <member name="F:UnityEngine.GridLayout.CellSwizzle.XZY">
  121. <summary>
  122. <para>Swizzles the cell positions from XYZ to XZY.</para>
  123. </summary>
  124. </member>
  125. <member name="F:UnityEngine.GridLayout.CellSwizzle.YXZ">
  126. <summary>
  127. <para>Swizzles the cell positions from XYZ to YXZ.</para>
  128. </summary>
  129. </member>
  130. <member name="F:UnityEngine.GridLayout.CellSwizzle.YZX">
  131. <summary>
  132. <para>Swizzles the cell positions from XYZ to YZX.</para>
  133. </summary>
  134. </member>
  135. <member name="F:UnityEngine.GridLayout.CellSwizzle.ZXY">
  136. <summary>
  137. <para>Swizzles the cell positions from XYZ to ZXY.</para>
  138. </summary>
  139. </member>
  140. <member name="F:UnityEngine.GridLayout.CellSwizzle.ZYX">
  141. <summary>
  142. <para>Swizzles the cell positions from XYZ to ZYX.</para>
  143. </summary>
  144. </member>
  145. <member name="M:UnityEngine.GridLayout.CellToLocal(UnityEngine.Vector3Int)">
  146. <summary>
  147. <para>Converts a cell position to local position space.</para>
  148. </summary>
  149. <param name="cellPosition">Cell position to convert.</param>
  150. <returns>
  151. <para>Local position of the cell position.</para>
  152. </returns>
  153. </member>
  154. <member name="M:UnityEngine.GridLayout.CellToLocalInterpolated(UnityEngine.Vector3)">
  155. <summary>
  156. <para>Converts an interpolated cell position in floats to local position space.</para>
  157. </summary>
  158. <param name="cellPosition">Interpolated cell position to convert.</param>
  159. <returns>
  160. <para>Local position of the cell position.</para>
  161. </returns>
  162. </member>
  163. <member name="M:UnityEngine.GridLayout.CellToWorld(UnityEngine.Vector3Int)">
  164. <summary>
  165. <para>Converts a cell position to world position space.</para>
  166. </summary>
  167. <param name="cellPosition">Cell position to convert.</param>
  168. <returns>
  169. <para>World position of the cell position.</para>
  170. </returns>
  171. </member>
  172. <member name="M:UnityEngine.GridLayout.GetBoundsLocal(UnityEngine.Vector3Int)">
  173. <summary>
  174. <para>Returns the local bounds for a cell at the location.</para>
  175. </summary>
  176. <param name="localPosition">Location of the cell.</param>
  177. <param name="cellPosition"></param>
  178. <returns>
  179. <para>Local bounds of cell at the position.</para>
  180. </returns>
  181. </member>
  182. <member name="M:UnityEngine.GridLayout.GetLayoutCellCenter">
  183. <summary>
  184. <para>Get the default center coordinate of a cell for the set layout of the Grid.</para>
  185. </summary>
  186. <returns>
  187. <para>Cell Center coordinate.</para>
  188. </returns>
  189. </member>
  190. <member name="M:UnityEngine.GridLayout.LocalToCell(UnityEngine.Vector3)">
  191. <summary>
  192. <para>Converts a local position to cell position.</para>
  193. </summary>
  194. <param name="localPosition">Local Position to convert.</param>
  195. <returns>
  196. <para>Cell position of the local position.</para>
  197. </returns>
  198. </member>
  199. <member name="M:UnityEngine.GridLayout.LocalToCellInterpolated(UnityEngine.Vector3)">
  200. <summary>
  201. <para>Converts a local position to cell position.</para>
  202. </summary>
  203. <param name="localPosition">Local Position to convert.</param>
  204. <returns>
  205. <para>Interpolated cell position of the local position.</para>
  206. </returns>
  207. </member>
  208. <member name="M:UnityEngine.GridLayout.LocalToWorld(UnityEngine.Vector3)">
  209. <summary>
  210. <para>Converts a local position to world position.</para>
  211. </summary>
  212. <param name="localPosition">Local Position to convert.</param>
  213. <returns>
  214. <para>World position of the local position.</para>
  215. </returns>
  216. </member>
  217. <member name="M:UnityEngine.GridLayout.WorldToCell(UnityEngine.Vector3)">
  218. <summary>
  219. <para>Converts a world position to cell position.</para>
  220. </summary>
  221. <param name="worldPosition">World Position to convert.</param>
  222. <returns>
  223. <para>Cell position of the world position.</para>
  224. </returns>
  225. </member>
  226. <member name="M:UnityEngine.GridLayout.WorldToLocal(UnityEngine.Vector3)">
  227. <summary>
  228. <para>Converts a world position to local position.</para>
  229. </summary>
  230. <param name="worldPosition">World Position to convert.</param>
  231. <returns>
  232. <para>Local position of the world position.</para>
  233. </returns>
  234. </member>
  235. </members>
  236. </doc>