UnityEngine.ClothModule.xml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.ClothModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.Cloth">
  8. <summary>
  9. <para>The Cloth class provides an interface to cloth simulation physics.</para>
  10. </summary>
  11. </member>
  12. <member name="P:UnityEngine.Cloth.bendingStiffness">
  13. <summary>
  14. <para>Bending stiffness of the cloth.</para>
  15. </summary>
  16. </member>
  17. <member name="P:UnityEngine.Cloth.capsuleColliders">
  18. <summary>
  19. <para>An array of CapsuleColliders which this Cloth instance should collide with.</para>
  20. </summary>
  21. </member>
  22. <member name="P:UnityEngine.Cloth.clothSolverFrequency">
  23. <summary>
  24. <para>Number of cloth solver iterations per second.</para>
  25. </summary>
  26. </member>
  27. <member name="P:UnityEngine.Cloth.coefficients">
  28. <summary>
  29. <para>The cloth skinning coefficients used to set up how the cloth interacts with the skinned mesh.</para>
  30. </summary>
  31. </member>
  32. <member name="P:UnityEngine.Cloth.collisionMassScale">
  33. <summary>
  34. <para>How much to increase mass of colliding particles.</para>
  35. </summary>
  36. </member>
  37. <member name="P:UnityEngine.Cloth.damping">
  38. <summary>
  39. <para>Damp cloth motion.</para>
  40. </summary>
  41. </member>
  42. <member name="P:UnityEngine.Cloth.enableContinuousCollision">
  43. <summary>
  44. <para>Enable continuous collision to improve collision stability.</para>
  45. </summary>
  46. </member>
  47. <member name="P:UnityEngine.Cloth.enabled">
  48. <summary>
  49. <para>Is this cloth enabled?</para>
  50. </summary>
  51. </member>
  52. <member name="P:UnityEngine.Cloth.externalAcceleration">
  53. <summary>
  54. <para>A constant, external acceleration applied to the cloth.</para>
  55. </summary>
  56. </member>
  57. <member name="P:UnityEngine.Cloth.friction">
  58. <summary>
  59. <para>The friction of the cloth when colliding with the character.</para>
  60. </summary>
  61. </member>
  62. <member name="P:UnityEngine.Cloth.normals">
  63. <summary>
  64. <para>The current normals of the cloth object.</para>
  65. </summary>
  66. </member>
  67. <member name="P:UnityEngine.Cloth.randomAcceleration">
  68. <summary>
  69. <para>A random, external acceleration applied to the cloth.</para>
  70. </summary>
  71. </member>
  72. <member name="P:UnityEngine.Cloth.selfCollisionDistance">
  73. <summary>
  74. <para>Minimum distance at which two cloth particles repel each other (default: 0.0).</para>
  75. </summary>
  76. </member>
  77. <member name="P:UnityEngine.Cloth.selfCollisionStiffness">
  78. <summary>
  79. <para>Self-collision stiffness defines how strong the separating impulse should be for colliding particles.</para>
  80. </summary>
  81. </member>
  82. <member name="P:UnityEngine.Cloth.sleepThreshold">
  83. <summary>
  84. <para>Cloth's sleep threshold.</para>
  85. </summary>
  86. </member>
  87. <member name="P:UnityEngine.Cloth.sphereColliders">
  88. <summary>
  89. <para>An array of ClothSphereColliderPairs which this Cloth instance should collide with.</para>
  90. </summary>
  91. </member>
  92. <member name="P:UnityEngine.Cloth.stiffnessFrequency">
  93. <summary>
  94. <para>Sets the stiffness frequency parameter.</para>
  95. </summary>
  96. </member>
  97. <member name="P:UnityEngine.Cloth.stretchingStiffness">
  98. <summary>
  99. <para>Stretching stiffness of the cloth.</para>
  100. </summary>
  101. </member>
  102. <member name="P:UnityEngine.Cloth.useGravity">
  103. <summary>
  104. <para>Should gravity affect the cloth simulation?</para>
  105. </summary>
  106. </member>
  107. <member name="P:UnityEngine.Cloth.useTethers">
  108. <summary>
  109. <para>Use Tether Anchors.</para>
  110. </summary>
  111. </member>
  112. <member name="P:UnityEngine.Cloth.useVirtualParticles">
  113. <summary>
  114. <para>Add one virtual particle per triangle to improve collision stability.</para>
  115. </summary>
  116. </member>
  117. <member name="P:UnityEngine.Cloth.vertices">
  118. <summary>
  119. <para>The current vertex positions of the cloth object.</para>
  120. </summary>
  121. </member>
  122. <member name="P:UnityEngine.Cloth.worldAccelerationScale">
  123. <summary>
  124. <para>How much world-space acceleration of the character will affect cloth vertices.</para>
  125. </summary>
  126. </member>
  127. <member name="P:UnityEngine.Cloth.worldVelocityScale">
  128. <summary>
  129. <para>How much world-space movement of the character will affect cloth vertices.</para>
  130. </summary>
  131. </member>
  132. <member name="M:UnityEngine.Cloth.ClearTransformMotion">
  133. <summary>
  134. <para>Clear the pending transform changes from affecting the cloth simulation.</para>
  135. </summary>
  136. </member>
  137. <member name="M:UnityEngine.Cloth.GetSelfAndInterCollisionIndices(System.Collections.Generic.List`1&lt;System.UInt32&gt;)">
  138. <summary>
  139. <para>Get list of particles to be used for self and inter collision.</para>
  140. </summary>
  141. <param name="indices">List to be populated with cloth particle indices that are used for self and/or inter collision.</param>
  142. </member>
  143. <member name="M:UnityEngine.Cloth.GetVirtualParticleIndices(System.Collections.Generic.List`1&lt;System.UInt32&gt;)">
  144. <summary>
  145. <para>Get list of indices to be used when generating virtual particles.</para>
  146. </summary>
  147. <param name="indices">List to be populated with virtual particle indices.</param>
  148. <param name="indicesOutList"></param>
  149. </member>
  150. <member name="M:UnityEngine.Cloth.GetVirtualParticleWeights(System.Collections.Generic.List`1&lt;UnityEngine.Vector3&gt;)">
  151. <summary>
  152. <para>Get weights to be used when generating virtual particles for cloth.</para>
  153. </summary>
  154. <param name="weights">List to populate with virtual particle weights.</param>
  155. <param name="weightsOutList"></param>
  156. </member>
  157. <member name="M:UnityEngine.Cloth.SetEnabledFading(System.Boolean,System.Single)">
  158. <summary>
  159. <para>Fade the cloth simulation in or out.</para>
  160. </summary>
  161. <param name="enabled">Fading enabled or not.</param>
  162. <param name="interpolationTime"></param>
  163. </member>
  164. <member name="M:UnityEngine.Cloth.SetSelfAndInterCollisionIndices(System.Collections.Generic.List`1&lt;System.UInt32&gt;)">
  165. <summary>
  166. <para>This allows you to set the cloth indices used for self and inter collision.</para>
  167. </summary>
  168. <param name="indices">List of cloth particles indices to use for cloth self and/or inter collision.</param>
  169. </member>
  170. <member name="M:UnityEngine.Cloth.SetVirtualParticleIndices(System.Collections.Generic.List`1&lt;System.UInt32&gt;)">
  171. <summary>
  172. <para>Set indices to use when generating virtual particles.</para>
  173. </summary>
  174. <param name="indices">List of cloth particle indices to use when generating virtual particles.</param>
  175. <param name="indicesIn"></param>
  176. </member>
  177. <member name="M:UnityEngine.Cloth.SetVirtualParticleWeights(System.Collections.Generic.List`1&lt;UnityEngine.Vector3&gt;)">
  178. <summary>
  179. <para>Sets weights to be used when generating virtual particles for cloth.</para>
  180. </summary>
  181. <param name="weights">List of weights to be used when setting virutal particles for cloth.</param>
  182. </member>
  183. <member name="T:UnityEngine.ClothSkinningCoefficient">
  184. <summary>
  185. <para>The ClothSkinningCoefficient struct is used to set up how a Cloth component is allowed to move with respect to the SkinnedMeshRenderer it is attached to.</para>
  186. </summary>
  187. </member>
  188. <member name="F:UnityEngine.ClothSkinningCoefficient.collisionSphereDistance">
  189. <summary>
  190. <para>Definition of a sphere a vertex is not allowed to enter. This allows collision against the animated cloth.</para>
  191. </summary>
  192. </member>
  193. <member name="F:UnityEngine.ClothSkinningCoefficient.maxDistance">
  194. <summary>
  195. <para>Distance a vertex is allowed to travel from the skinned mesh vertex position.</para>
  196. </summary>
  197. </member>
  198. <member name="T:UnityEngine.ClothSphereColliderPair">
  199. <summary>
  200. <para>A pair of SphereColliders used to define shapes for Cloth objects to collide against.</para>
  201. </summary>
  202. </member>
  203. <member name="P:UnityEngine.ClothSphereColliderPair.first">
  204. <summary>
  205. <para>The first SphereCollider of a ClothSphereColliderPair.</para>
  206. </summary>
  207. </member>
  208. <member name="P:UnityEngine.ClothSphereColliderPair.second">
  209. <summary>
  210. <para>The second SphereCollider of a ClothSphereColliderPair.</para>
  211. </summary>
  212. </member>
  213. <member name="M:UnityEngine.ClothSphereColliderPair.#ctor(UnityEngine.SphereCollider)">
  214. <summary>
  215. <para>Creates a ClothSphereColliderPair. If only one SphereCollider is given, the ClothSphereColliderPair will define a simple sphere. If two SphereColliders are given, the ClothSphereColliderPair defines a conic capsule shape, composed of the two spheres and the cone connecting the two.</para>
  216. </summary>
  217. <param name="a">The first SphereCollider of a ClothSphereColliderPair.</param>
  218. <param name="b">The second SphereCollider of a ClothSphereColliderPair.</param>
  219. </member>
  220. <member name="M:UnityEngine.ClothSphereColliderPair.#ctor(UnityEngine.SphereCollider,UnityEngine.SphereCollider)">
  221. <summary>
  222. <para>Creates a ClothSphereColliderPair. If only one SphereCollider is given, the ClothSphereColliderPair will define a simple sphere. If two SphereColliders are given, the ClothSphereColliderPair defines a conic capsule shape, composed of the two spheres and the cone connecting the two.</para>
  223. </summary>
  224. <param name="a">The first SphereCollider of a ClothSphereColliderPair.</param>
  225. <param name="b">The second SphereCollider of a ClothSphereColliderPair.</param>
  226. </member>
  227. <member name="A:UnityEngine.ClothModule">
  228. <summary>
  229. <para>The Cloth module implements cloth physics simulation through the Cloth component.</para>
  230. </summary>
  231. </member>
  232. </members>
  233. </doc>