PageRenderTime 47ms CodeModel.GetById 20ms RepoModel.GetById 0ms app.codeStats 0ms

/Dlls/Delta.PhysicsEngines.Farseer.xml

#
XML | 412 lines | 412 code | 0 blank | 0 comment | 0 complexity | c36340d53ad6b5c27f68add8a8e28483 MD5 | raw file
Possible License(s): Apache-2.0
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Delta.PhysicsEngines.Farseer</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping">
  8. <summary>
  9. Class that managed mapping from-to Delta engine data types to farseer and
  10. vice versa.
  11. </summary>
  12. <remarks>
  13. Note: Farseer uses internally Microsoft.Xna.Vector2 inside but this does
  14. not mean that it self references XNA. They ported the XNA version inside
  15. Farseer.
  16. </remarks>
  17. </member>
  18. <member name="M:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping.Convert(Delta.Utilities.Datatypes.Vector@)">
  19. <summary>
  20. Convert Delta Engine Vector to Farseer Vector2.
  21. </summary>
  22. <param name="vector">The vector.</param>
  23. <returns>Farseer Vector2 created from Delta Engine Point.</returns>
  24. </member>
  25. <member name="M:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping.Convert(Delta.Utilities.Datatypes.Point@)">
  26. <summary>
  27. Convert Delta Engine Point to Farseer Vector2.
  28. </summary>
  29. <param name="point">The point.</param>
  30. <returns>Farseer Vector2 created from Delta Engine Point.</returns>
  31. </member>
  32. <member name="M:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping.Convert(Microsoft.Xna.Framework.Vector2,Delta.Utilities.Datatypes.Vector@)">
  33. <summary>
  34. Convert Farseer Vector2 to Delta engine vector.
  35. </summary>
  36. <param name="vector">The vector.</param>
  37. <param name="result">The converted Farseer vector.</param>
  38. </member>
  39. <member name="M:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping.Convert(Microsoft.Xna.Framework.Vector2@,Delta.Utilities.Datatypes.Point@)">
  40. <summary>
  41. Convert Farseer Vector2 to Delta engine Point.
  42. </summary>
  43. <param name="vector">The vector.</param>
  44. <param name="result">The converted Farseer vector.</param>
  45. </member>
  46. <member name="M:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping.Convert(System.Collections.Generic.IList{Delta.Utilities.Datatypes.Point})">
  47. <summary>
  48. Converts a list of DeltaEngine Point's to Farseer list of Point's.
  49. </summary>
  50. <param name="list">The list.</param>
  51. <returns>
  52. Farseer List of Vector2 created from Delta Engine list of points.
  53. </returns>
  54. </member>
  55. <member name="M:Delta.PhysicsEngines.Farseer.FarseerDatatypesMapping.Convert(System.Collections.Generic.List{System.Collections.Generic.IList{Delta.Utilities.Datatypes.Point}})">
  56. <summary>
  57. Convers a list of list Point to Farseer Vertices.
  58. </summary>
  59. <param name="arrayVert">The array vert.</param>
  60. <returns>
  61. Farseer Vertices created from Delta Engine list of points.
  62. </returns>
  63. </member>
  64. <member name="T:Delta.PhysicsEngines.Farseer.FarseerBody">
  65. <summary>
  66. Farseer body implementation.
  67. </summary>
  68. </member>
  69. <member name="F:Delta.PhysicsEngines.Farseer.FarseerBody.DefaultBoundingBox">
  70. <summary>
  71. Default bounding box.
  72. TODO: this is not used anywhere yet, fix this!
  73. </summary>
  74. </member>
  75. <member name="F:Delta.PhysicsEngines.Farseer.FarseerBody.farseerBody">
  76. <summary>
  77. Farseer body.
  78. </summary>
  79. </member>
  80. <member name="F:Delta.PhysicsEngines.Farseer.FarseerBody.farseerFixtures">
  81. <summary>
  82. List of Farseer fixtures.
  83. </summary>
  84. </member>
  85. <member name="F:Delta.PhysicsEngines.Farseer.FarseerBody.physicsManager">
  86. <summary>
  87. Our Farseer physics implementation.
  88. </summary>
  89. </member>
  90. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.#ctor(Delta.PhysicsEngines.Farseer.FarseerPhysics,Delta.PhysicsEngines.PhysicsShape,Delta.Utilities.Datatypes.Vector)">
  91. <summary>
  92. Initializes a new instance of the <see cref="T:Delta.PhysicsEngines.Farseer.FarseerBody"/> class.
  93. </summary>
  94. <param name="physicsManager">The physics manager.</param>
  95. <param name="shape">The shape.</param>
  96. <param name="initialPosition">Body initial position.</param>
  97. </member>
  98. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.Dispose">
  99. <summary>
  100. Handle disposing.
  101. </summary>
  102. </member>
  103. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.ApplyForce(Delta.Utilities.Datatypes.Vector)">
  104. <summary>
  105. Applies a force at the center of mass.
  106. </summary>
  107. <param name="force">
  108. Vector containing force data to apply to body in 3D space.
  109. </param>
  110. </member>
  111. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.ApplyForce(Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">
  112. <summary>
  113. Apply a force at a world point. If the force is not
  114. applied at the center of mass, it will generate a torque and
  115. affect the angular velocity. This wakes up the body.
  116. </summary>
  117. <param name="force">
  118. Vector containing force data to apply to body in 3D space.
  119. </param>
  120. <param name="position">
  121. Relative position from where to apply force.
  122. </param>
  123. </member>
  124. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.ApplyTorque(Delta.Utilities.Datatypes.Vector)">
  125. <summary>
  126. Apply a torque. This affects the angular velocity without affecting the
  127. linear velocity of the center of mass.
  128. </summary>
  129. <remarks>
  130. This wakes up the body.
  131. </remarks>
  132. <param name="torque">
  133. Vector containing torque data for both 2D and 3D shapes.
  134. </param>
  135. </member>
  136. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.ApplyLinearImpulse(Delta.Utilities.Datatypes.Vector)">
  137. <summary>
  138. Apply an impulse at a point. This immediately modifies the velocity.
  139. </summary>
  140. <remarks>
  141. This wakes up the body.
  142. </remarks>
  143. <param name="impulse">The impulse vector in 3D space.</param>
  144. </member>
  145. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.ApplyLinearImpulse(Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">
  146. <summary>
  147. Apply an impulse at a point. This immediately modifies the velocity.
  148. It also modifies the angular velocity if the point of application
  149. is not at the center of mass.
  150. </summary>
  151. <remarks>
  152. This wakes up the body.
  153. </remarks>
  154. <param name="impulse">The impulse vector in 3D space.</param>
  155. <param name="position">Relative position from where to apply.</param>
  156. </member>
  157. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.Remove">
  158. <summary>
  159. Remove
  160. </summary>
  161. </member>
  162. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.CreateShape">
  163. <summary>
  164. Creates shape from given properties.
  165. </summary>
  166. </member>
  167. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.GetSafeFloat(System.Collections.Generic.Dictionary{Delta.PhysicsEngines.PhysicsShape.PropertyType,System.Object},Delta.PhysicsEngines.PhysicsShape.PropertyType)">
  168. <summary>
  169. Private helper method to get a float value from the properties.
  170. </summary>
  171. <param name="properties">Shape properties.</param>
  172. <param name="type">Property type to get.</param>
  173. <returns>Float value from the properties.</returns>
  174. </member>
  175. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.CreateGear(System.Single,System.Int32,System.Single,System.Single,System.Single,FarseerPhysics.Dynamics.Body)">
  176. <summary>
  177. Helper method for creating gear fixture list.
  178. </summary>
  179. <param name="radius">The radius.</param>
  180. <param name="numberOfTeeth">The number of teeth.</param>
  181. <param name="tipPercentage">The tip percentage.</param>
  182. <param name="toothHeight">Height of the tooth.</param>
  183. <param name="density">The density.</param>
  184. <param name="body">The body.</param>
  185. <returns>List containing all fixtures used for Gear shape.</returns>
  186. </member>
  187. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.OnColliding(FarseerPhysics.Dynamics.Fixture,FarseerPhysics.Dynamics.Fixture,FarseerPhysics.Dynamics.Contacts.Contact)">
  188. <summary>
  189. On colliding farseeer handle event.
  190. </summary>
  191. <param name="fixtureA">Farseer fixture A.</param>
  192. <param name="fixtureB">Farseer fixture B.</param>
  193. <param name="contacts">Farseer contact data.</param>
  194. <returns>True to response on farseer collision event.</returns>
  195. </member>
  196. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.Initialize">
  197. <summary>
  198. Initialize
  199. </summary>
  200. </member>
  201. <member name="M:Delta.PhysicsEngines.Farseer.FarseerBody.GetDebugInfo">
  202. <summary>
  203. Return optional debug information text with details about this body!
  204. </summary>
  205. <returns>Extra information about inertia, flags, etc.</returns>
  206. </member>
  207. <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.Body">
  208. <summary>
  209. Gets the Farseer native body (read-only).
  210. </summary>
  211. </member>
  212. <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.Position">
  213. <summary>
  214. Position given in world space.
  215. </summary>
  216. </member>
  217. <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.Position2D">
  218. <summary>
  219. Position 2D
  220. </summary>
  221. </member>
  222. <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.Rotation">
  223. <summary>
  224. Rotation angle in degrees for 2D bodies.
  225. </summary>
  226. </member>
  227. <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.LinearVelocity">
  228. <summary>
  229. The velocity of the body.
  230. </summary>
  231. <value>
  232. The linear velocity.
  233. </value>
  234. </member>
  235. <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.AngularVelocity">
  236. <summary>
  237. Gets or Sets the angular velocity of the body.
  238. </summary>
  239. <remarks>
  240. For 2D physics simulation only X component is used.
  241. </remarks>
  242. </member>
  243. <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.AngularVelocity2D">
  244. <summary>
  245. Angular velocity 2D as a float, for 2D only the .x component is used!
  246. </summary>
  247. </member>
  248. <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.Mass">
  249. <summary>
  250. Gets or sets the mass. Usually in kilograms (kg).
  251. </summary>
  252. </member>
  253. <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.Restitution">
  254. <summary>
  255. Gets the restitution of the body.
  256. </summary>
  257. </member>
  258. <member name="P:Delta.PhysicsEngines.Farseer.FarseerBody.BoundingBox">
  259. <summary>
  260. Gets the BoundingBox of the body.
  261. </summary>
  262. </member>
  263. <member name="T:Delta.PhysicsEngines.Farseer.FarseerPhysics">
  264. <summary>
  265. Farseer3 physics manager for 2D physics
  266. </summary>
  267. </member>
  268. <member name="F:Delta.PhysicsEngines.Farseer.FarseerPhysics.ScaleFactor">
  269. <summary>
  270. Scale factor used for precision between DeltaEngine draw system and
  271. Farseer. This is important because Farseer thinks in pixels and the
  272. quadratic space between 0 and 1 is not enough precision for most
  273. Farseer operations. The ScaleFactor helps to scale quadratic space
  274. up to 1000 units for Farseer and to make all methods work correctly.
  275. </summary>
  276. </member>
  277. <member name="F:Delta.PhysicsEngines.Farseer.FarseerPhysics.InvScaleFactor">
  278. <summary>
  279. Inverse of ScaleFactor (1.0f / ScaleFactor)
  280. </summary>
  281. </member>
  282. <member name="F:Delta.PhysicsEngines.Farseer.FarseerPhysics.farseerPhysicsWorld">
  283. <summary>
  284. Farseer Physic World.
  285. </summary>
  286. </member>
  287. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.#ctor">
  288. <summary>
  289. Constructor
  290. </summary>
  291. </member>
  292. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.IsShapeSupported(Delta.PhysicsEngines.Enums.ShapeType)">
  293. <summary>
  294. Gets whether the current physics module supports given shape type.
  295. </summary>
  296. <param name="shapeType">Type of the shape.</param>
  297. <returns>
  298. <c>true</c> if [is shape supported] [the specified shape type]; otherwise, <c>false</c>.
  299. </returns>
  300. </member>
  301. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.IsJointSupported(Delta.PhysicsEngines.Enums.JointType)">
  302. <summary>
  303. Gets whether the current physics module supports given joint type.
  304. </summary>
  305. <param name="shapeType">Type of the shape.</param>
  306. <returns>
  307. <c>true</c> if [is joint supported] [the specified shape type]; otherwise, <c>false</c>.
  308. </returns>
  309. </member>
  310. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.IsFeatureSupported(Delta.PhysicsEngines.Enums.FeatureSupport)">
  311. <summary>
  312. Gets whether the current physics module supports given feature.
  313. </summary>
  314. <param name="support">The support.</param>
  315. <returns>
  316. <c>true</c> if the specific feature is supported, <c>false</c> otherwise.
  317. </returns>
  318. </member>
  319. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.SetGroundPlane(System.Boolean,System.Single)">
  320. <summary>
  321. Implementation of SetGroundPlane
  322. </summary>
  323. <param name="enable">True to enable, false otherwise.</param>
  324. <param name="height">The height of the plane.</param>
  325. </member>
  326. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.RayCastImpl(Delta.Utilities.Datatypes.Ray,System.Boolean,Delta.PhysicsEngines.PhysicsBody@,Delta.Utilities.Datatypes.Vector@,System.Single@,System.Object@)">
  327. <summary>
  328. Rays the cast impl.
  329. </summary>
  330. <param name="ray">The ray.</param>
  331. <param name="foundBody">The found body.</param>
  332. <param name="surfaceNormal">The surface normal.</param>
  333. <param name="fraction">The fraction.</param>
  334. <param name="userData">The user data.</param>
  335. <param name="checkGround">Whether to perform ray cast on 2D ground too.</param>
  336. <returns>True if any intersection happen, false otherwise.</returns>
  337. </member>
  338. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.RayCastImpl2D(Delta.Utilities.Datatypes.Point,Delta.Utilities.Datatypes.Point,Delta.PhysicsEngines.PhysicsBody@,Delta.Utilities.Datatypes.Point@,System.Single@)">
  339. <summary>
  340. Rays the cast impl 2D.
  341. </summary>
  342. <param name="point1">The point1.</param>
  343. <param name="point2">The point2.</param>
  344. <param name="outBody">The out body.</param>
  345. <param name="normal">The normal.</param>
  346. <param name="fraction">The fraction.</param>
  347. <returns>True if any intersection was found.</returns>
  348. </member>
  349. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.UpdateSimulation(System.Single)">
  350. <summary>
  351. Perform Farseer simulation step.
  352. </summary>
  353. </member>
  354. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.FindBodyByFixture(FarseerPhysics.Dynamics.Fixture)">
  355. <summary>
  356. Find a farseer object by body.
  357. </summary>
  358. <param name="fixtureToFind">Farseer fixture to search for.</param>
  359. <returns>Farseer physics body or null if not found.</returns>
  360. </member>
  361. <member name="T:Delta.PhysicsEngines.Farseer.FarseerPhysics.FarseerPhysicsTests">
  362. <summary>
  363. Tests
  364. </summary>
  365. </member>
  366. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.FarseerPhysicsTests.TestInitialization">
  367. <summary>
  368. Test whether initialization has been done.
  369. </summary>
  370. </member>
  371. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.FarseerPhysicsTests.TestCreate2DBodyWithShape">
  372. <summary>
  373. Test creation of 2D body with shape.
  374. </summary>
  375. </member>
  376. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.FarseerPhysicsTests.TestFeatureSupport">
  377. <summary>
  378. Test whether given feature is supoorted.
  379. </summary>
  380. </member>
  381. <member name="M:Delta.PhysicsEngines.Farseer.FarseerPhysics.FarseerPhysicsTests.TestShapeSupport">
  382. <summary>
  383. Test whether given shape is supoorted.
  384. </summary>
  385. </member>
  386. <member name="T:Delta.PhysicsEngines.Farseer.FarseerJoint">
  387. <summary>
  388. Farseer joint implementation.
  389. </summary>
  390. </member>
  391. <member name="M:Delta.PhysicsEngines.Farseer.FarseerJoint.#ctor(Delta.PhysicsEngines.Farseer.FarseerPhysics,Delta.PhysicsEngines.Enums.JointType,Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody,System.Object[])">
  392. <summary>
  393. Creates a new instance of the <see cref="T:Delta.PhysicsEngines.Farseer.FarseerJoint"/> class.
  394. </summary>
  395. <param name="physicsManager">The physics manager.</param>
  396. <param name="jointType">Type of the joint.</param>
  397. <param name="bodyA">The body A.</param>
  398. <param name="bodyB">The body B.</param>
  399. <param name="args">The args.</param>
  400. </member>
  401. <member name="M:Delta.PhysicsEngines.Farseer.FarseerJoint.CreateJoint">
  402. <summary>
  403. Create joint from properties.
  404. </summary>
  405. </member>
  406. <member name="P:Delta.PhysicsEngines.Farseer.FarseerJoint.Joint">
  407. <summary>
  408. Gets farseer joint object.
  409. </summary>
  410. </member>
  411. </members>
  412. </doc>