PageRenderTime 63ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 0ms

/Dlls/Delta.PhysicsEngines.Jitter.xml

#
XML | 441 lines | 440 code | 1 blank | 0 comment | 0 complexity | 25c54603585573271f18a7bf0265da09 MD5 | raw file
Possible License(s): Apache-2.0
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Delta.PhysicsEngines.Jitter</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Delta.PhysicsEngines.Jitter.JitterDatatypesMapping">
  8. <summary>
  9. Implements mapping between Jitter data types and Delta engine data types.
  10. Sadly we can't do all the nice union stuff we do with XNA, because we
  11. don't have Jitter referenced in the datatypes.
  12. </summary>
  13. </member>
  14. <member name="M:Delta.PhysicsEngines.Jitter.JitterDatatypesMapping.Convert(Delta.Utilities.Datatypes.Matrix@)">
  15. <summary>
  16. Perform conversion between DeltaEngine Matrix and Jitter Matrix.
  17. </summary>
  18. <param name="matrix">The DeltaEngine matrix.</param>
  19. <returns>The converted Jitter matrix.</returns>
  20. </member>
  21. <member name="M:Delta.PhysicsEngines.Jitter.JitterDatatypesMapping.Convert(Jitter.LinearMath.JMatrix,Delta.Utilities.Datatypes.Matrix@)">
  22. <summary>
  23. Convert a Jitter matrix into a Delta Matrix.
  24. </summary>
  25. <param name="matrix">The Jitter matrix to convert.</param>
  26. <param name="result">The converterd delta matrix.</param>
  27. </member>
  28. <member name="M:Delta.PhysicsEngines.Jitter.JitterDatatypesMapping.Convert(Delta.Utilities.Datatypes.Vector@)">
  29. <summary>
  30. Convert DeltaEngine vector to Jitter vector.
  31. </summary>
  32. <param name="vector">DeltaEngine vector.</param>
  33. <returns>The converted Jitter vector.</returns>
  34. </member>
  35. <member name="M:Delta.PhysicsEngines.Jitter.JitterDatatypesMapping.Convert(Delta.Utilities.Datatypes.Vector@,Jitter.LinearMath.JVector@)">
  36. <summary>
  37. Convert DeltaEngine vector to Jitter vector.
  38. </summary>
  39. <param name="vector">DeltaEngine vector.</param>
  40. <param name="result">The converted Jitter vector.</param>
  41. </member>
  42. <member name="M:Delta.PhysicsEngines.Jitter.JitterDatatypesMapping.ConvertSlow(Delta.Utilities.Datatypes.Vector)">
  43. <summary>
  44. Convert DeltaEngine vector to Jitter vector.
  45. </summary>
  46. <param name="vector">DeltaEngine vector.</param>
  47. <returns>The converted Jitter vector.</returns>
  48. </member>
  49. <member name="M:Delta.PhysicsEngines.Jitter.JitterDatatypesMapping.Convert(Jitter.LinearMath.JVector,Delta.Utilities.Datatypes.Vector@)">
  50. <summary>
  51. Convert Jitter vector to DeltaEngine vector.
  52. </summary>
  53. <param name="vector">Jitter vector.</param>
  54. <param name="result">The converted Jitter vector.</param>
  55. </member>
  56. <member name="M:Delta.PhysicsEngines.Jitter.JitterDatatypesMapping.Convert(Jitter.LinearMath.JVector@,Delta.Utilities.Datatypes.Vector@)">
  57. <summary>
  58. Convert Jitter vector to DeltaEngine vector.
  59. </summary>
  60. <param name="vector">Jitter vector.</param>
  61. <param name="result">The converted Jitter vector.</param>
  62. </member>
  63. <member name="T:Delta.PhysicsEngines.Jitter.JitterBody">
  64. <summary>
  65. Jitter body implementation.
  66. </summary>
  67. </member>
  68. <member name="F:Delta.PhysicsEngines.Jitter.JitterBody.rotationMatrix">
  69. <summary>
  70. Create rotation matrix to be filled in by the Jitter matrix. It is
  71. very important that M44 is set to 1.0 to be rendered correctly!
  72. </summary>
  73. </member>
  74. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.#ctor(Delta.PhysicsEngines.Jitter.JitterPhysics,Delta.PhysicsEngines.PhysicsShape,Delta.Utilities.Datatypes.Vector)">
  75. <summary>
  76. Constructor
  77. </summary>
  78. <param name="physicsManager">The physics manager.</param>
  79. <param name="shape">The shape.</param>
  80. <param name="setInitialPosition">Body initial position.</param>
  81. </member>
  82. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.#ctor(Delta.PhysicsEngines.Jitter.JitterPhysics,Jitter.Dynamics.RigidBody)">
  83. <summary>
  84. Internal constructor for creating GroundBody.
  85. </summary>
  86. <param name="physicsManager">Jitter physics manager.</param>
  87. <param name="jitterBody">Initial jitter body created manually.</param>
  88. </member>
  89. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.ApplyForce(Delta.Utilities.Datatypes.Vector)">
  90. <summary>
  91. Applies a force at the center of mass.
  92. </summary>
  93. <param name="force">The force.</param>
  94. </member>
  95. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.ApplyForce(Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">
  96. <summary>
  97. Apply a force at a world point. If the force is not
  98. applied at the center of mass, it will generate a torque and
  99. affect the angular velocity. This wakes up the body.
  100. </summary>
  101. <param name="force">Force vector data.</param>
  102. <param name="position">Position in 3D where to apply force.</param>
  103. </member>
  104. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.ApplyTorque(Delta.Utilities.Datatypes.Vector)">
  105. <summary>
  106. Apply a torque. This affects the angular velocity without affecting the
  107. linear velocity of the center of mass.
  108. <remarks>
  109. This wakes up the body.
  110. </remarks>
  111. </summary>
  112. <param name="torque">
  113. Vector containing torque data for both 2D and 3D shapes.
  114. </param>
  115. </member>
  116. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.ApplyLinearImpulse(Delta.Utilities.Datatypes.Vector)">
  117. <summary>
  118. Apply an impulse at a point. This immediately modifies the velocity.
  119. <remarks>
  120. This wakes up the body.
  121. </remarks>
  122. </summary>
  123. <param name="impulse">Impulse vector data.</param>
  124. </member>
  125. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.ApplyLinearImpulse(Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">
  126. <summary>
  127. Apply an impulse at a point. This immediately modifies the velocity.
  128. It also modifies the angular velocity if the point of application
  129. is not at the center of mass.
  130. <remarks>
  131. This wakes up the body.
  132. </remarks>
  133. </summary>
  134. <param name="impulse">Impulse vector data.</param>
  135. <param name="position">Position in 3D where to apply impulse.</param>
  136. </member>
  137. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.ApplyAngularImpulse(Delta.Utilities.Datatypes.Vector)">
  138. <summary>
  139. Apply an angular impulse.
  140. </summary>
  141. <param name="impulse">
  142. Vector containing impulse data for both 2D and 3D shapes.
  143. </param>
  144. </member>
  145. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.CreateShape">
  146. <summary>
  147. Creates Jitter shape from properties.
  148. </summary>
  149. </member>
  150. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.FireCollisionBegin(Delta.PhysicsEngines.PhysicsBody)">
  151. <summary>
  152. Method for access collision event from JitterPhysicsManager.
  153. </summary>
  154. <param name="other">Other body with which collision begin.</param>
  155. </member>
  156. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.FireCollisionEnd(Delta.PhysicsEngines.PhysicsBody)">
  157. <summary>
  158. Method for access collision event from JitterPhysicsManager.
  159. </summary>
  160. <param name="other">Other body with which collision end.</param>
  161. </member>
  162. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.SetIsStatic(System.Boolean)">
  163. <summary>
  164. Set if the body should be static or not.
  165. </summary>
  166. <param name="value">True if body should be static, otherwise False.
  167. </param>
  168. </member>
  169. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.SetIsActive(System.Boolean)">
  170. <summary>
  171. Set if the body should be active or not.
  172. </summary>
  173. <param name="value">True if body should be active, otherwise False.
  174. </param>
  175. </member>
  176. <member name="M:Delta.PhysicsEngines.Jitter.JitterBody.SetFriction(System.Single)">
  177. <summary>
  178. Set the friction of the body.
  179. </summary>
  180. <param name="value">Friction value to set.</param>
  181. </member>
  182. <member name="P:Delta.PhysicsEngines.Jitter.JitterBody.Body">
  183. <summary>
  184. Gets the body.
  185. </summary>
  186. </member>
  187. <member name="P:Delta.PhysicsEngines.Jitter.JitterBody.Position">
  188. <summary>
  189. Position given in world space.
  190. </summary>
  191. </member>
  192. <member name="P:Delta.PhysicsEngines.Jitter.JitterBody.Position2D">
  193. <summary>
  194. Position 2D given in world space (same as Position, just easier to
  195. access for 2D code not having to convert Position to a Point anymore).
  196. </summary>
  197. </member>
  198. <member name="P:Delta.PhysicsEngines.Jitter.JitterBody.RotationMatrix">
  199. <summary>
  200. Returns the rotation matrix from Jitter back for rendering.
  201. </summary>
  202. </member>
  203. <member name="P:Delta.PhysicsEngines.Jitter.JitterBody.LinearVelocity">
  204. <summary>
  205. The linear velocity of the body.
  206. </summary>
  207. </member>
  208. <member name="P:Delta.PhysicsEngines.Jitter.JitterBody.AngularVelocity">
  209. <summary>
  210. The angular velocity of the body.
  211. <remarks>
  212. For 2D physics simulation only X component is used.
  213. </remarks>
  214. </summary>
  215. </member>
  216. <member name="P:Delta.PhysicsEngines.Jitter.JitterBody.AngularVelocity2D">
  217. <summary>
  218. Angular velocity 2D as a float, for 2D only the .x component is used!
  219. </summary>
  220. </member>
  221. <member name="P:Delta.PhysicsEngines.Jitter.JitterBody.Mass">
  222. <summary>
  223. Gets or sets the mass. Usually in kilograms (kg).
  224. </summary>
  225. </member>
  226. <member name="P:Delta.PhysicsEngines.Jitter.JitterBody.Restitution">
  227. <summary>
  228. Gets the restitution of the body.
  229. </summary>
  230. </member>
  231. <member name="P:Delta.PhysicsEngines.Jitter.JitterBody.BoundingBox">
  232. <summary>
  233. Gets the BoundingBox of the body.
  234. <remarks>
  235. Used during 3D simulation.
  236. </remarks>
  237. </summary>
  238. </member>
  239. <member name="M:Delta.PhysicsEngines.Jitter.Helpers.CreateFrom(Delta.Rendering.Models.Mesh,Delta.Utilities.Datatypes.Matrix,System.Boolean)">
  240. <summary>
  241. Helper method used for creation of Jitter TriangleMeshShape by
  242. populating data with vertices and indices gathered from out Mesh.
  243. </summary>
  244. <param name="mesh">The mesh.</param>
  245. <param name="localSpaceMatrix">The local space matrix.</param>
  246. <param name="invertTriangles">
  247. if set to <c>true</c> we invert winding order of triangles.
  248. </param>
  249. <returns>
  250. New created jitter TriangleMeshShape created from Delta engine mesh.
  251. </returns>
  252. </member>
  253. <member name="T:Delta.PhysicsEngines.Jitter.JitterJoint">
  254. <summary>
  255. JItter joint implementation
  256. </summary>
  257. </member>
  258. <member name="M:Delta.PhysicsEngines.Jitter.JitterJoint.#ctor(Delta.PhysicsEngines.Jitter.JitterPhysics,Delta.PhysicsEngines.Enums.JointType,Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody,System.Object[])">
  259. <summary>
  260. Initializes a new instance of the <see cref="T:Delta.PhysicsEngines.Jitter.JitterJoint"/> class.
  261. </summary>
  262. <param name="physicsManager">The physics manager.</param>
  263. <param name="jointType">Type of the joint.</param>
  264. <param name="bodyA">The body A.</param>
  265. <param name="bodyB">The body B.</param>
  266. <param name="args">The args.</param>
  267. </member>
  268. <member name="M:Delta.PhysicsEngines.Jitter.JitterJoint.CreateJoint">
  269. <summary>
  270. Creates jitter joint.
  271. </summary>
  272. </member>
  273. <member name="P:Delta.PhysicsEngines.Jitter.JitterJoint.Constraint">
  274. <summary>
  275. Gets jitter Constraint
  276. </summary>
  277. </member>
  278. <member name="P:Delta.PhysicsEngines.Jitter.JitterJoint.Joint">
  279. <summary>
  280. Gets jitter Joint.
  281. </summary>
  282. </member>
  283. <member name="P:Delta.PhysicsEngines.Jitter.JitterJoint.Softness">
  284. <summary>
  285. Defines how big the applied impulses can get.
  286. </summary>
  287. <value>
  288. The softness.
  289. </value>
  290. </member>
  291. <member name="P:Delta.PhysicsEngines.Jitter.JitterJoint.Anchor1">
  292. <summary>
  293. The anchor 1 point in the world.
  294. </summary>
  295. <value>
  296. The anchor1.
  297. </value>
  298. </member>
  299. <member name="P:Delta.PhysicsEngines.Jitter.JitterJoint.Anchor2">
  300. <summary>
  301. The anchor 2 point in the world.
  302. </summary>
  303. <value>
  304. The anchor2.
  305. </value>
  306. </member>
  307. <member name="T:Delta.PhysicsEngines.Jitter.JitterPhysics">
  308. <summary>
  309. Jitter physics implementation.
  310. </summary>
  311. </member>
  312. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.#ctor">
  313. <summary>
  314. Initializes a new instance of the <see cref="!:JitterPhysicsManager"/> class.
  315. </summary>
  316. </member>
  317. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.IsShapeSupported(Delta.PhysicsEngines.Enums.ShapeType)">
  318. <summary>
  319. Gets whether the current physics module supports given shape type.
  320. </summary>
  321. <param name="shapeType">Type of the shape.</param>
  322. <returns>
  323. <c>true</c> if [is shape supported] [the specified shape type]; otherwise, <c>false</c>.
  324. </returns>
  325. </member>
  326. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.IsJointSupported(Delta.PhysicsEngines.Enums.JointType)">
  327. <summary>
  328. Gets whether the current physics module supports given joint type.
  329. </summary>
  330. <param name="jointType">Type of the shape.</param>
  331. <returns>
  332. <c>true</c> if the specified shape type is supported, <c>false</c> otherwise.
  333. </returns>
  334. </member>
  335. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.IsFeatureSupported(Delta.PhysicsEngines.Enums.FeatureSupport)">
  336. <summary>
  337. Gets whether the current physics module supports given feature.
  338. </summary>
  339. <param name="support">The support.</param>
  340. <returns>
  341. <c>true</c> if [is feature supported] [the specified support]; otherwise, <c>false</c>.
  342. </returns>
  343. </member>
  344. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.SetGroundPlane(System.Boolean,System.Single)">
  345. <summary>
  346. Implementation of SetGroundPlane
  347. </summary>
  348. <param name="enable">True to enable the ground plane, false otherwise.</param>
  349. <param name="height">The height of the plane.</param>
  350. </member>
  351. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.CreateGroundBody">
  352. <summary>
  353. Create the body that will be used as ground.
  354. </summary>
  355. </member>
  356. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.CreateBody(System.Boolean,Delta.PhysicsEngines.PhysicsShape,Delta.Utilities.Datatypes.Vector)">
  357. <summary>
  358. Creates a Jitter from base implementation.
  359. </summary>
  360. <param name="is2DBody">True if the body is 2D, false means that is 3D.</param>
  361. <param name="shape">The shape to attach to the new create body.</param>
  362. <param name="initialPosition">Initial position of the body.</param>
  363. <returns>New PhysicsBody instance or null if not supported.</returns>
  364. </member>
  365. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.CreateJoint(Delta.PhysicsEngines.Enums.JointType,Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody,System.Object[])">
  366. <summary>
  367. Creates a JitterJoint from base implementation.
  368. </summary>
  369. <param name="jointType">The type of joint to create.</param>
  370. <param name="bodyA">The first required body.</param>
  371. <param name="bodyB">The second [optional] body.</param>
  372. <param name="args">Array of args to pass to Joint implementation.</param>
  373. <returns>The new created PhysicsJoint.</returns>
  374. </member>
  375. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.RayCastImpl(Delta.Utilities.Datatypes.Ray,System.Boolean,Delta.PhysicsEngines.PhysicsBody@,Delta.Utilities.Datatypes.Vector@,System.Single@,System.Object@)">
  376. <summary>
  377. FindRayCast implementation.
  378. </summary>
  379. <param name="ray">The ray to perform.</param>
  380. <param name="checkGround">Whether to check agains ground too.</param>
  381. <param name="foundBody">PhysicsBody or null if no intersection happen.</param>
  382. <param name="surfaceNormal">
  383. The normals of the surfaces in the intersection points.
  384. </param>
  385. <param name="fraction">
  386. Intersection fraction value or zero if no intersection.
  387. </param>
  388. <param name="userData">Optional user data.</param>
  389. <returns>True if any intersection happen, false otherwise.</returns>
  390. </member>
  391. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.SetGravity(Delta.Utilities.Datatypes.Vector)">
  392. <summary>
  393. Sets gravity implementation.
  394. </summary>
  395. <param name="gravity">The 3D gravity vector.</param>
  396. </member>
  397. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.SetMultithreading(System.Boolean)">
  398. <summary>
  399. Sets multithreading on Jitter implementation.
  400. </summary>
  401. <param name="enable">True to enable, false otherwise.</param>
  402. </member>
  403. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.GetTotalPhysicsTime">
  404. <summary>
  405. Gets total physics simulation time.
  406. </summary>
  407. <returns>Total physics simulation time expressed in double.</returns>
  408. </member>
  409. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.UpdateSimulation(System.Single)">
  410. <summary>
  411. Update simulation implementation of Physics.
  412. </summary>
  413. </member>
  414. <member name="T:Delta.PhysicsEngines.Jitter.JitterPhysics.JitterPhysicsTests">
  415. <summary>
  416. Tests
  417. </summary>
  418. </member>
  419. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.JitterPhysicsTests.TestInitialization">
  420. <summary>
  421. Test whether initialization has been done.
  422. </summary>
  423. </member>
  424. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.JitterPhysicsTests.TestCreate3DBodyWithShape">
  425. <summary>
  426. Test creation of 3 body with shape.
  427. </summary>
  428. </member>
  429. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.JitterPhysicsTests.TestFeatureSupport">
  430. <summary>
  431. Test whether given feature is supoorted.
  432. </summary>
  433. </member>
  434. <member name="M:Delta.PhysicsEngines.Jitter.JitterPhysics.JitterPhysicsTests.TestShapeSupport">
  435. <summary>
  436. Test whether given shape is supoorted.
  437. </summary>
  438. </member>
  439. </members>
  440. </doc>