PageRenderTime 32ms CodeModel.GetById 28ms RepoModel.GetById 1ms app.codeStats 0ms

/Dlls/Delta.PhysicsEngines.xml

#
XML | 1370 lines | 1369 code | 0 blank | 1 comment | 0 complexity | 5971db8fb8d288a9965e7dc45e8b18f9 MD5 | raw file
Possible License(s): Apache-2.0
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>Delta.PhysicsEngines</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Delta.PhysicsEngines.Enums.CollisionGroup">
  8. <summary>
  9. Collision group category.
  10. </summary>
  11. <remarks>
  12. This is currently used in 2D physics simulation.
  13. </remarks>
  14. </member>
  15. <member name="T:Delta.PhysicsEngines.PhysicsBody">
  16. <summary>
  17. Represents body that performs physics collision.
  18. </summary>
  19. <remarks>
  20. Every body needs to have at least one shape, but depending
  21. on which Physics engine is used, some of them (like Jitter)
  22. supports multiple shapes.
  23. </remarks>
  24. </member>
  25. <member name="F:Delta.PhysicsEngines.PhysicsBody.isStatic">
  26. <summary>
  27. Initial static value of body.
  28. </summary>
  29. </member>
  30. <member name="F:Delta.PhysicsEngines.PhysicsBody.isActive">
  31. <summary>
  32. Initial active value of body.
  33. </summary>
  34. </member>
  35. <member name="F:Delta.PhysicsEngines.PhysicsBody.friction">
  36. <summary>
  37. Initial friction of body.
  38. </summary>
  39. </member>
  40. <member name="F:Delta.PhysicsEngines.PhysicsBody.mass">
  41. <summary>
  42. Mass field of this PhysicsBody.
  43. </summary>
  44. </member>
  45. <member name="F:Delta.PhysicsEngines.PhysicsBody.restitution">
  46. <summary>
  47. Restitution field of this PhysicsBody.
  48. </summary>
  49. </member>
  50. <member name="M:Delta.PhysicsEngines.PhysicsBody.#ctor(System.Boolean,Delta.PhysicsEngines.PhysicsShape,Delta.Utilities.Datatypes.Vector)">
  51. <summary>
  52. Creates a new instance of PhysicsBody.
  53. </summary>
  54. <remarks>
  55. Needs to be subclassed.
  56. </remarks>
  57. <param name="is2D">Whether the body to create is 2D or not.</param>
  58. <param name="shape">
  59. The <see cref="T:Delta.PhysicsEngines.PhysicsShape" /> to use during creation.
  60. </param>
  61. <param name="initialPosition">
  62. The initial position of the body.
  63. </param>
  64. </member>
  65. <member name="M:Delta.PhysicsEngines.PhysicsBody.Dispose">
  66. <summary>
  67. IDisposable implementation.
  68. </summary>
  69. </member>
  70. <member name="M:Delta.PhysicsEngines.PhysicsBody.Remove">
  71. <summary>
  72. Removes physics body from simulation.
  73. </summary>
  74. </member>
  75. <member name="M:Delta.PhysicsEngines.PhysicsBody.DrawDebug">
  76. <summary>
  77. Perform debug draw for this body.
  78. </summary>
  79. </member>
  80. <member name="M:Delta.PhysicsEngines.PhysicsBody.ApplyForce(Delta.Utilities.Datatypes.Vector)">
  81. <summary>
  82. Applies a force at the center of mass.
  83. </summary>
  84. <param name="force">
  85. Vector containing force data to apply to body in 3D space.
  86. </param>
  87. </member>
  88. <member name="M:Delta.PhysicsEngines.PhysicsBody.ApplyForce(Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">
  89. <summary>
  90. Apply a force at a world point. If the force is not
  91. applied at the center of mass, it will generate a torque and
  92. affect the angular velocity. This wakes up the body.
  93. </summary>
  94. <param name="force">
  95. Vector containing force data to apply to body in 3D space.
  96. </param>
  97. <param name="position">
  98. Relative position from where to apply force.
  99. </param>
  100. </member>
  101. <member name="M:Delta.PhysicsEngines.PhysicsBody.ApplyTorque(Delta.Utilities.Datatypes.Vector)">
  102. <summary>
  103. Apply a torque. This affects the angular velocity without affecting the
  104. linear velocity of the center of mass.
  105. </summary>
  106. <remarks>
  107. This wakes up the body.
  108. </remarks>
  109. <param name="torque">
  110. Vector containing torque data for both 2D and 3D shapes.
  111. </param>
  112. </member>
  113. <member name="M:Delta.PhysicsEngines.PhysicsBody.ApplyTorque(System.Single)">
  114. <summary>
  115. Apply a torque. This affects the angular velocity without affecting the
  116. linear velocity of the center of mass.
  117. </summary>
  118. <remarks>
  119. This wakes up the body.
  120. </remarks>
  121. <param name="torque">The torque value user usually for 2D simulation.</param>
  122. </member>
  123. <member name="M:Delta.PhysicsEngines.PhysicsBody.ApplyLinearImpulse(Delta.Utilities.Datatypes.Vector)">
  124. <summary>
  125. Apply an impulse at a point. This immediately modifies the velocity.
  126. </summary>
  127. <remarks>
  128. This wakes up the body.
  129. </remarks>
  130. <param name="impulse">The impulse vector in 3D space.</param>
  131. </member>
  132. <member name="M:Delta.PhysicsEngines.PhysicsBody.ApplyLinearImpulse(Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">
  133. <summary>
  134. Apply an impulse at a point. This immediately modifies the velocity.
  135. It also modifies the angular velocity if the point of application
  136. is not at the center of mass.
  137. </summary>
  138. <remarks>
  139. This wakes up the body.
  140. </remarks>
  141. <param name="impulse">The impulse vector in 3D space.</param>
  142. <param name="position">Relative position from where to apply.</param>
  143. </member>
  144. <member name="M:Delta.PhysicsEngines.PhysicsBody.ApplyAngularImpulse(Delta.Utilities.Datatypes.Vector)">
  145. <summary>
  146. Apply an angular impulse.
  147. </summary>
  148. <param name="impulse">
  149. Vector containing torque data for both 2D and 3D shapes.
  150. </param>
  151. </member>
  152. <member name="M:Delta.PhysicsEngines.PhysicsBody.ApplyAngularImpulse(System.Single)">
  153. <summary>
  154. Apply an angular impulse in 2D way.
  155. </summary>
  156. <param name="impulse">
  157. The angular impulse in units of kg*m*m/s.
  158. </param>
  159. </member>
  160. <member name="M:Delta.PhysicsEngines.PhysicsBody.OnCollisionBegin(Delta.PhysicsEngines.PhysicsBody)">
  161. <summary>
  162. Triggers to fire event when collision starts with other body.
  163. </summary>
  164. <param name="other">Body with which this one collides.</param>
  165. </member>
  166. <member name="M:Delta.PhysicsEngines.PhysicsBody.OnCollisionEnd(Delta.PhysicsEngines.PhysicsBody)">
  167. <summary>
  168. Triggers to fire event when collision ends with other body.
  169. </summary>
  170. <param name="other">Body with which this one collides.</param>
  171. </member>
  172. <member name="M:Delta.PhysicsEngines.PhysicsBody.SetIsStatic(System.Boolean)">
  173. <summary>
  174. Set static value by implementation.
  175. </summary>
  176. <param name="value">
  177. True to set whether the body is static false otherwise.
  178. </param>
  179. </member>
  180. <member name="M:Delta.PhysicsEngines.PhysicsBody.SetIsActive(System.Boolean)">
  181. <summary>
  182. Set active value by implementation.
  183. </summary>
  184. <param name="value">
  185. True to set whether the body is active false otherwise.
  186. </param>
  187. </member>
  188. <member name="M:Delta.PhysicsEngines.PhysicsBody.SetFriction(System.Single)">
  189. <summary>
  190. Set friction value by implementation.
  191. </summary>
  192. <param name="value">Friction value to apply to implemetation.</param>
  193. </member>
  194. <member name="M:Delta.PhysicsEngines.PhysicsBody.GetDebugInfo">
  195. <summary>
  196. Return optional debug information text with details about this body!
  197. </summary>
  198. <returns>Extra information about inertia, flags, etc.</returns>
  199. </member>
  200. <member name="P:Delta.PhysicsEngines.PhysicsBody.Is2D">
  201. <summary>
  202. Gets whether the Body is 2D or not.
  203. </summary>
  204. </member>
  205. <member name="P:Delta.PhysicsEngines.PhysicsBody.IsStatic">
  206. <summary>
  207. Gets or Sets whether the body is static.
  208. </summary>
  209. <remarks>By default is false.</remarks>
  210. </member>
  211. <member name="P:Delta.PhysicsEngines.PhysicsBody.IsActive">
  212. <summary>
  213. Enable/disable the object is active.
  214. </summary>
  215. <remarks>By default is true.</remarks>
  216. </member>
  217. <member name="P:Delta.PhysicsEngines.PhysicsBody.Restitution">
  218. <summary>
  219. Gets the restitution of the body.
  220. </summary>
  221. </member>
  222. <member name="P:Delta.PhysicsEngines.PhysicsBody.Shape">
  223. <summary>
  224. Get the shape of this body.
  225. </summary>
  226. </member>
  227. <member name="P:Delta.PhysicsEngines.PhysicsBody.InitialPosition">
  228. <summary>
  229. Gets the initial positin of the body
  230. </summary>
  231. </member>
  232. <member name="P:Delta.PhysicsEngines.PhysicsBody.Position">
  233. <summary>
  234. Position given in world space.
  235. </summary>
  236. </member>
  237. <member name="P:Delta.PhysicsEngines.PhysicsBody.Position2D">
  238. <summary>
  239. Position 2D given in world space (same as Position, just easier to
  240. access for 2D code not having to convert Position to a Point anymore).
  241. </summary>
  242. </member>
  243. <member name="P:Delta.PhysicsEngines.PhysicsBody.Rotation">
  244. <summary>
  245. Rotation angle in degrees for 2D bodies.
  246. </summary>
  247. <returns>Return the current world rotation angle in degree.</returns>
  248. </member>
  249. <member name="P:Delta.PhysicsEngines.PhysicsBody.RotationMatrix">
  250. <summary>
  251. Rotation matrix
  252. </summary>
  253. </member>
  254. <member name="P:Delta.PhysicsEngines.PhysicsBody.WorldMatrix">
  255. <summary>
  256. Returns the current world matrix for this body (with rotation and
  257. translation applied, ready for rendering).
  258. </summary>
  259. </member>
  260. <member name="P:Delta.PhysicsEngines.PhysicsBody.LinearVelocity">
  261. <summary>
  262. The velocity of the body.
  263. </summary>
  264. </member>
  265. <member name="P:Delta.PhysicsEngines.PhysicsBody.AngularVelocity">
  266. <summary>
  267. The angular velocity of the body.
  268. </summary>
  269. <remarks>
  270. For 2D physics simulation only X component is used.
  271. </remarks>
  272. </member>
  273. <member name="P:Delta.PhysicsEngines.PhysicsBody.AngularVelocity2D">
  274. <summary>
  275. Angular velocity 2D as a float, for 2D only the .x component is used!
  276. </summary>
  277. </member>
  278. <member name="P:Delta.PhysicsEngines.PhysicsBody.Mass">
  279. <summary>
  280. Gets or sets the mass. Usually in kilograms (kg).
  281. </summary>
  282. </member>
  283. <member name="P:Delta.PhysicsEngines.PhysicsBody.Friction">
  284. <summary>
  285. Get or set the coefficient of friction.
  286. </summary>
  287. </member>
  288. <member name="P:Delta.PhysicsEngines.PhysicsBody.BoundingBox">
  289. <summary>
  290. Gets the BoundingBox of the body.
  291. </summary>
  292. <remarks>
  293. Used during 3D simulation.
  294. </remarks>
  295. </member>
  296. <member name="P:Delta.PhysicsEngines.PhysicsBody.DebugColor">
  297. <summary>
  298. Gets or Sets the color for debug drawing process.
  299. </summary>
  300. </member>
  301. <member name="P:Delta.PhysicsEngines.PhysicsBody.Name">
  302. <summary>
  303. Optional property to store name of this body.
  304. </summary>
  305. </member>
  306. <member name="P:Delta.PhysicsEngines.PhysicsBody.UserData">
  307. <summary>
  308. Optional property to store custom data for the physics object like e.g.
  309. the owner, creator, etc. ('null' by default)
  310. </summary>
  311. </member>
  312. <member name="E:Delta.PhysicsEngines.PhysicsBody.CollisionBegin">
  313. <summary>
  314. Fired when collision starts between this body and another one.
  315. </summary>
  316. </member>
  317. <member name="E:Delta.PhysicsEngines.PhysicsBody.CollisionEnd">
  318. <summary>
  319. Fired when collision ends between this body and another one.
  320. </summary>
  321. </member>
  322. <member name="T:Delta.PhysicsEngines.PhysicsBody.CollisionEventHandler">
  323. <summary>
  324. Delegate used for handling collision between this body and another
  325. one.
  326. </summary>
  327. <param name="other">The body with which occurs collision.</param>
  328. </member>
  329. <member name="T:Delta.PhysicsEngines.Advanced.ForceFieldShape">
  330. <summary>
  331. Class that holds the shape of force field.
  332. </summary>
  333. </member>
  334. <member name="F:Delta.PhysicsEngines.Advanced.ForceFieldShape.Sphere">
  335. <summary>
  336. Gets the BoundingSphere used when force field shape is sphere.
  337. </summary>
  338. </member>
  339. <member name="M:Delta.PhysicsEngines.Advanced.ForceFieldShape.#ctor">
  340. <summary>
  341. Create infiinte volume force field shape.
  342. </summary>
  343. </member>
  344. <member name="M:Delta.PhysicsEngines.Advanced.ForceFieldShape.#ctor(Delta.Utilities.Datatypes.Vector,System.Single)">
  345. <summary>
  346. Create spherical force field instance.
  347. </summary>
  348. <param name="position">The position.</param>
  349. <param name="radius">The radius.</param>
  350. </member>
  351. <member name="M:Delta.PhysicsEngines.Advanced.ForceFieldShape.ForEachBody(Delta.PhysicsEngines.Advanced.ForceFieldShape.BodyDelegate)">
  352. <summary>
  353. Execute delegate for each body.
  354. return false within delegate to stop iteration.
  355. TODO: Warning, slow performance, needs to be optimized
  356. </summary>
  357. <param name="bodyDelegate">The body delegate.</param>
  358. </member>
  359. <member name="P:Delta.PhysicsEngines.Advanced.ForceFieldShape.ShapeType">
  360. <summary>
  361. Gets the type of the shape.
  362. </summary>
  363. </member>
  364. <member name="T:Delta.PhysicsEngines.Advanced.ForceFieldShape.BodyDelegate">
  365. <summary>
  366. Delegate using during iterating through bodies when applying force
  367. fields, return true to continue iterating, false otherwise.
  368. </summary>
  369. <param name="body">The PhysicsBody to procees.</param>
  370. <returns></returns>
  371. </member>
  372. <member name="T:Delta.PhysicsEngines.VisualShapes.VisualPhysicsCapsule">
  373. <summary>
  374. A physics capsule with a visual component
  375. </summary>
  376. </member>
  377. <member name="T:Delta.PhysicsEngines.VisualShapes.BaseVisualPhysicsShape">
  378. <summary>
  379. Base VisualPhysics shape representation for given body.
  380. Subclass for correct drawing.
  381. </summary>
  382. </member>
  383. <member name="M:Delta.PhysicsEngines.VisualShapes.BaseVisualPhysicsShape.Draw">
  384. <summary>
  385. Draws the sphere
  386. </summary>
  387. </member>
  388. <member name="M:Delta.PhysicsEngines.VisualShapes.BaseVisualPhysicsShape.UpdateTransform">
  389. <summary>
  390. Method for updating world transform for debug rendering.
  391. </summary>
  392. </member>
  393. <member name="P:Delta.PhysicsEngines.VisualShapes.BaseVisualPhysicsShape.IsStatic">
  394. <summary>
  395. Gets or Sets whether given body is static or not.
  396. </summary>
  397. </member>
  398. <member name="P:Delta.PhysicsEngines.VisualShapes.BaseVisualPhysicsShape.IsActive">
  399. <summary>
  400. Gets or Sets whether given body is active or not.
  401. </summary>
  402. </member>
  403. <member name="P:Delta.PhysicsEngines.VisualShapes.BaseVisualPhysicsShape.Body">
  404. <summary>
  405. Gets the PhysicsBody assigned.
  406. </summary>
  407. </member>
  408. <member name="P:Delta.PhysicsEngines.VisualShapes.BaseVisualPhysicsShape.DebugDrawColor">
  409. <summary>
  410. Debug draw color
  411. </summary>
  412. </member>
  413. <member name="M:Delta.PhysicsEngines.VisualShapes.VisualPhysicsCapsule.#ctor(Delta.Utilities.Datatypes.Vector,System.Single,System.Single,Delta.ContentSystem.Rendering.MaterialData)">
  414. <summary>
  415. Create a new instance of <see cref="T:Delta.PhysicsEngines.VisualShapes.VisualPhysicsCapsule" /></summary>
  416. <param name="position">The initial position of the body.</param>
  417. <param name="setLength">The length of the capsule.</param>
  418. <param name="setRadius">The radius of the capsule.</param>
  419. <param name="materialData">The material to use.</param>
  420. </member>
  421. <member name="M:Delta.PhysicsEngines.VisualShapes.VisualPhysicsCapsule.#ctor(Delta.Utilities.Datatypes.Vector,System.Single,System.Single)">
  422. <summary>
  423. Create a new instance of <see cref="T:Delta.PhysicsEngines.VisualShapes.VisualPhysicsCapsule" /></summary>
  424. <param name="position">The initial position of the body.</param>
  425. <param name="setLength">The length of the capsule.</param>
  426. <param name="setRadius">The radius of the capsule.</param>
  427. </member>
  428. <member name="T:Delta.PhysicsEngines.Advanced.Tornado">
  429. <summary>
  430. Performs Tornado force field moving of physics bodies.
  431. Tornado can be applied in clockwise or counter clockwise direction.
  432. </summary>
  433. </member>
  434. <member name="T:Delta.PhysicsEngines.Advanced.ForceField">
  435. <summary>
  436. Base class for creating a ForceField.
  437. Every force field can have its own <see cref="T:Delta.PhysicsEngines.Advanced.ForceFieldShape" /> and
  438. need be subclassed by implementation.
  439. <remarks>
  440. See <see cref="T:Delta.PhysicsEngines.Advanced.ExplosionForceField" />, <see cref="T:Delta.PhysicsEngines.Advanced.Tornado" />, <see cref="T:Delta.PhysicsEngines.Advanced.WindForceField" /></remarks></summary>
  441. </member>
  442. <member name="F:Delta.PhysicsEngines.Advanced.ForceField.Epsilon">
  443. <summary>
  444. Check if a body is closer than epsilon to the explosion center.
  445. This avoids unrealisticly high accelerations.
  446. </summary>
  447. </member>
  448. <member name="M:Delta.PhysicsEngines.Advanced.ForceField.#ctor(Delta.PhysicsEngines.Advanced.ForceFieldShape)">
  449. <summary>
  450. Create new instance of force field.
  451. </summary>
  452. <remarks>
  453. This method can be called only by implementation.
  454. </remarks>
  455. <param name="forceFieldShape">The force field shape.</param>
  456. </member>
  457. <member name="M:Delta.PhysicsEngines.Advanced.ForceField.AddToSimulation">
  458. <summary>
  459. Add already removed force field again to simulation.
  460. </summary>
  461. </member>
  462. <member name="M:Delta.PhysicsEngines.Advanced.ForceField.Apply">
  463. <summary>
  464. Apply the force to the affected bodies.
  465. </summary>
  466. </member>
  467. <member name="M:Delta.PhysicsEngines.Advanced.ForceField.ApplyForce(Delta.PhysicsEngines.PhysicsBody)">
  468. <summary>
  469. Apply force to single body.
  470. </summary>
  471. <param name="body">The body on which to appy force.</param>
  472. </member>
  473. <member name="P:Delta.PhysicsEngines.Advanced.ForceField.Shape">
  474. <summary>
  475. Gets the shape assigned to force field.
  476. </summary>
  477. </member>
  478. <member name="P:Delta.PhysicsEngines.Advanced.ForceField.ForceWakeUp">
  479. <summary>
  480. Gets or sets whether the force field will force affected bodies
  481. to wake up.
  482. </summary>
  483. </member>
  484. <member name="P:Delta.PhysicsEngines.Advanced.ForceField.UpdatesPerFrame">
  485. <summary>
  486. Gets whether given force field needs to be updated per frame update.
  487. <remarks>
  488. Tornado needs to be updates per frame simulation.
  489. </remarks></summary>
  490. </member>
  491. <member name="P:Delta.PhysicsEngines.Advanced.ForceField.IsEnabled">
  492. <summary>
  493. Gets or Sets whether given force field is enabled.
  494. </summary>
  495. </member>
  496. <member name="P:Delta.PhysicsEngines.Advanced.ForceField.IsRemoved">
  497. <summary>
  498. Gets whether given ForceField is removed from
  499. simulation.
  500. </summary>
  501. </member>
  502. <member name="M:Delta.PhysicsEngines.Advanced.Tornado.GetClosestPointOnSegmentToPoint(Delta.Utilities.Datatypes.Vector@,Delta.Utilities.Datatypes.Vector@,Delta.Utilities.Datatypes.Vector@,Delta.Utilities.Datatypes.Vector@)">
  503. <summary>
  504. Determines the closest point on the provided segment ab to point p.
  505. </summary>
  506. <param name="firstEndPoint">First endpoint of segment.</param>
  507. <param name="secondEndPoint">Second endpoint of segment.</param>
  508. <param name="comparisonPoint">Point for comparison.</param>
  509. <param name="closestPoint">Closest point on the edge to p.</param>
  510. </member>
  511. <member name="M:Delta.PhysicsEngines.Advanced.Tornado.#ctor(Delta.PhysicsEngines.Advanced.ForceFieldShape)">
  512. <summary>
  513. Create a new instance of Tornado.
  514. </summary>
  515. <param name="forceFieldShape">The force field shape.</param>
  516. </member>
  517. <member name="M:Delta.PhysicsEngines.Advanced.Tornado.#ctor(Delta.PhysicsEngines.Advanced.ForceFieldShape,Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector,System.Single,System.Boolean,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
  518. <summary>
  519. Create a new instance of Tornado.
  520. </summary>
  521. </member>
  522. <member name="M:Delta.PhysicsEngines.Advanced.Tornado.ApplyForce(Delta.PhysicsEngines.PhysicsBody)">
  523. <summary>
  524. Implementation of ApplyForce
  525. </summary>
  526. </member>
  527. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.Position">
  528. <summary>
  529. Gets or sets the position of the tornado.
  530. This is only the origin of the force; move the shape along with it if
  531. the position moves away from the shape.
  532. </summary>
  533. </member>
  534. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.Axis">
  535. <summary>
  536. Axis of rotation of the tornado.
  537. </summary>
  538. </member>
  539. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.BottomRadius">
  540. <summary>
  541. Radius of the tornado at the bottom.
  542. </summary>
  543. </member>
  544. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.Height">
  545. <summary>
  546. Height of the tornado; objects above or below the tornado will not be
  547. affected by its winds.
  548. </summary>
  549. </member>
  550. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.HorizontalForce">
  551. <summary>
  552. Circular force applied within the tornado.
  553. Force magnitude decreases as distance from axis increases past the
  554. radius.
  555. </summary>
  556. </member>
  557. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.HorizontalWindSpeed">
  558. <summary>
  559. Maximum horizontal wind speed of the tornado;
  560. objects will not be accelerated by the wind past this
  561. speed in the direction of the wind.
  562. </summary>
  563. </member>
  564. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.InwardForce">
  565. <summary>
  566. Magnitude of the inward-sucking force within the tornado, magnitude
  567. decreases as distance from the axis increases past the radius.
  568. </summary>
  569. </member>
  570. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.InwardSuctionSpeed">
  571. <summary>
  572. Maximum inward sucking wind speed, objects will not be accelerated by
  573. the wind past this speed inward.
  574. </summary>
  575. </member>
  576. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.SpinClockwise">
  577. <summary>
  578. Spin direction of the tornado, looking down from the top of the
  579. tornado (the furthest forward along the tornado axis).
  580. </summary>
  581. </member>
  582. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.TopRadius">
  583. <summary>
  584. Radius of the tornado at the top.
  585. </summary>
  586. </member>
  587. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.UpwardForce">
  588. <summary>
  589. Magnitude of upward-pushing force within the tornado. Magnitude
  590. decreases as distance from the axis increases past the radius.
  591. </summary>
  592. </member>
  593. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.UpwardSuctionSpeed">
  594. <summary>
  595. Maximum upward pushing wind speed, objects will not be accelerated
  596. by the wind past this speed upward.
  597. </summary>
  598. </member>
  599. <member name="P:Delta.PhysicsEngines.Advanced.Tornado.UpdatesPerFrame">
  600. <summary>
  601. Tornado needs to be updated every single frame.
  602. </summary>
  603. </member>
  604. <member name="T:Delta.PhysicsEngines.Physics">
  605. <summary>
  606. The base Physics class for high level handling of the engine physics
  607. features (both the 2d physics and 3d physics engine, with are
  608. fundamentally very different).
  609. Note: When creating this class we will also force the creation of the
  610. ContentManager first to force downloading the latest settings, which
  611. tells us which physics module to use.
  612. </summary>
  613. </member>
  614. <member name="F:Delta.PhysicsEngines.Physics.DefaultGravity">
  615. <summary>
  616. Gets default initial gravity for physics simulation.
  617. </summary>
  618. </member>
  619. <member name="M:Delta.PhysicsEngines.Physics.Clear">
  620. <summary>
  621. Removes every body and forcefield from physical world
  622. </summary>
  623. </member>
  624. <member name="M:Delta.PhysicsEngines.Physics.RemoveForceField(Delta.PhysicsEngines.Advanced.ForceField)">
  625. <summary>
  626. Remove given force field for current simulation.
  627. </summary>
  628. <remarks>
  629. ForceField needs to be updated per frame. I.E Tornado
  630. </remarks>
  631. <param name="forceField">The force field.</param>
  632. </member>
  633. <member name="M:Delta.PhysicsEngines.Physics.RemoveAllBodies">
  634. <summary>
  635. Removes all PhysicsBodies from simulation.
  636. </summary>
  637. <remarks>
  638. May be used to clean a physics world up.
  639. </remarks>
  640. </member>
  641. <member name="M:Delta.PhysicsEngines.Physics.RemoveAllJoints">
  642. <summary>
  643. Removes all PhysicsJoints from simulation.
  644. </summary>
  645. <remarks>
  646. May be used to clean a physics world up.
  647. </remarks>
  648. </member>
  649. <member name="M:Delta.PhysicsEngines.Physics.RemoveAllForceFields">
  650. <summary>
  651. Removes all current force fields.
  652. May be used to clean a physics world up.
  653. </summary>
  654. </member>
  655. <member name="M:Delta.PhysicsEngines.Physics.FindRayCast2D(Delta.Utilities.Datatypes.Point,Delta.Utilities.Datatypes.Point,Delta.PhysicsEngines.PhysicsBody@,Delta.Utilities.Datatypes.Point@,System.Single@)">
  656. <summary>
  657. Performs 2D ray cast check.
  658. </summary>
  659. <param name="point1">First point to check against.</param>
  660. <param name="point2">second point to check against.</param>
  661. <param name="body">Out body if any intersection happen.</param>
  662. <param name="point">
  663. Out intersection point if any intersection happen.
  664. </param>
  665. <param name="normal">Out normal if any intersection happen.</param>
  666. <param name="fraction">Out fraction if any intersection happen.</param>
  667. <returns>
  668. True if any intersection was found.
  669. </returns>
  670. </member>
  671. <member name="M:Delta.PhysicsEngines.Physics.FindRayCast(Delta.Utilities.Datatypes.Ray,System.Boolean,Delta.PhysicsEngines.PhysicsBody@,Delta.Utilities.Datatypes.Vector@,System.Single@)">
  672. <summary>
  673. Ray cast on the physics world and return all the objects that the ray
  674. hits.
  675. </summary>
  676. <param name="ray">The ray to perform.</param>
  677. <param name="checkGround">Whether to check agains ground too.</param>
  678. <param name="foundBody">PhysicsBody casted in any.</param>
  679. <param name="intersectionPoints">The 3D positions where the ray firsts
  680. intersects with each one of the objects</param>
  681. <param name="surfaceNormal">
  682. The normals of the surfaces in the intersection points.
  683. </param>
  684. <param name="fraction">
  685. Intersection fraction value or zero if no intersection.
  686. </param>
  687. <returns>
  688. True if the ray hit at least one object, false otherwise.
  689. </returns>
  690. </member>
  691. <member name="M:Delta.PhysicsEngines.Physics.FindRayCast(Delta.Utilities.Datatypes.Ray,System.Boolean,Delta.PhysicsEngines.PhysicsBody@,Delta.Utilities.Datatypes.Vector@,System.Single@,System.Object@)">
  692. <summary>
  693. Ray cast on the physics world and return all the objects that the ray
  694. hits.
  695. </summary>
  696. <param name="ray">The ray</param>
  697. <param name="checkGround">Whether to check agains ground too.</param>
  698. <param name="foundBody">The hit body if any.</param>
  699. <param name="intersectionPoint">The 3D position where the ray firsts
  700. intersects with each object.</param>
  701. <param name="surfaceNormal">The normal of the surface in the
  702. intersection point</param>
  703. <returns>True if the ray hit at least one object, false
  704. otherwise</returns>
  705. </member>
  706. <member name="M:Delta.PhysicsEngines.Physics.Create2DBody(Delta.PhysicsEngines.PhysicsShape,Delta.Utilities.Datatypes.Point)">
  707. <summary>
  708. Create a 2D physics body whether the module supports it.
  709. </summary>
  710. <param name="shape">PhysicsShape to attach to body.</param>
  711. <param name="initialPosition">Body initial position.</param>
  712. <returns>New created instance of PhysicsBody.</returns>
  713. </member>
  714. <member name="M:Delta.PhysicsEngines.Physics.Create3DBody(Delta.PhysicsEngines.PhysicsShape,Delta.Utilities.Datatypes.Vector)">
  715. <summary>
  716. Create a 3D physics body whether the module supports it.
  717. </summary>
  718. <param name="shape">PhysicsShape to attach to body.</param>
  719. <param name="initialPosition">Initial position of body.</param>
  720. <returns>The new create PhysicsBody.</returns>
  721. </member>
  722. <member name="M:Delta.PhysicsEngines.Physics.CreateCircle(Delta.Utilities.Datatypes.Point,System.Single,System.Single)">
  723. <summary>
  724. Creates Body with a Circle shape attached to it.
  725. </summary>
  726. <param name="initialPosition">The initial position of body.</param>
  727. <param name="radius">The radius of circle.</param>
  728. <param name="density">The density of body.</param>
  729. <returns>The new created body.</returns>
  730. </member>
  731. <member name="M:Delta.PhysicsEngines.Physics.CreateCircle(System.Single,System.Single)">
  732. <summary>
  733. Creates Body with a Circle shape attached to it.
  734. </summary>
  735. <param name="radius">The radius of circle.</param>
  736. <param name="density">The density of body.</param>
  737. <returns>The new created body.</returns>
  738. </member>
  739. <member name="M:Delta.PhysicsEngines.Physics.CreateRectangle(Delta.Utilities.Datatypes.Point,System.Single,System.Single,System.Single)">
  740. <summary>
  741. Creates Body with a Rectangle shape attached to it.
  742. </summary>
  743. <param name="initialPosition">The initial position of body.</param>
  744. <param name="width">The width of rectangle.</param>
  745. <param name="height">The height of rectangle.</param>
  746. <param name="density">The density of body.</param>
  747. <returns>The new created body.</returns>
  748. </member>
  749. <member name="M:Delta.PhysicsEngines.Physics.CreateRectangle(System.Single,System.Single,System.Single)">
  750. <summary>
  751. Creates Body with a Rectangle shape attached to it.
  752. </summary>
  753. <param name="width">The width of rectangle.</param>
  754. <param name="height">The height of rectangle.</param>
  755. <param name="density">The density of body.</param>
  756. <returns>The new created body.</returns>
  757. </member>
  758. <member name="M:Delta.PhysicsEngines.Physics.CreateRectangle(System.Single,System.Single,System.Single,Delta.Utilities.Datatypes.Point)">
  759. <summary>
  760. Creates Body with a Rectangle shape attached to it.
  761. </summary>
  762. <param name="width">The width of rectangle.</param>
  763. <param name="height">The height of rectangle.</param>
  764. <param name="density">The density of body.</param>
  765. <param name="offset">The Point offset of rectangle.</param>
  766. <returns>
  767. The create body with rectangle shape attached to it.
  768. </returns>
  769. </member>
  770. <member name="M:Delta.PhysicsEngines.Physics.CreateEllipse(Delta.Utilities.Datatypes.Point,System.Single,System.Single,System.Int32,System.Single)">
  771. <summary>
  772. Creates Body with an Ellipse shape attached to it.
  773. </summary>
  774. <param name="initialPosition">The initial Position</param>
  775. <param name="xRadius">The xRadius</param>
  776. <param name="yRadius">The yRadius</param>
  777. <param name="edges">Edges</param>
  778. <param name="density">Density</param>
  779. <returns>The new created body.</returns>
  780. </member>
  781. <member name="M:Delta.PhysicsEngines.Physics.CreateEllipse(System.Single,System.Single,System.Int32,System.Single)">
  782. <summary>
  783. Creates Body with an Ellipse shape attached to it.
  784. </summary>
  785. <param name="xRadius">The xRadius</param>
  786. <param name="yRadius">The yRadius</param>
  787. <param name="edges">Edges</param>
  788. <param name="density">Density</param>
  789. <returns>The new created body.</returns>
  790. </member>
  791. <member name="M:Delta.PhysicsEngines.Physics.CreatePolygon(Delta.Utilities.Datatypes.Point,System.Collections.Generic.IList{Delta.Utilities.Datatypes.Point},System.Single)">
  792. <summary>
  793. Creates Body with an polygon shape attached to it.
  794. </summary>
  795. <param name="initialPosition">The initial Position</param>
  796. <param name="vertices">Vertices</param>
  797. <param name="density">The Density</param>
  798. <returns>The new created body.</returns>
  799. </member>
  800. <member name="M:Delta.PhysicsEngines.Physics.CreatePolygon(System.Collections.Generic.IList{Delta.Utilities.Datatypes.Point},System.Single)">
  801. <summary>
  802. Creates Body with an polygon shape attached to it.
  803. </summary>
  804. <param name="vertices">Vertices</param>
  805. <param name="density">Density</param>
  806. <returns>The new created body.</returns>
  807. </member>
  808. <member name="M:Delta.PhysicsEngines.Physics.CreateCompoundPolygon(Delta.Utilities.Datatypes.Point,System.Collections.Generic.List{System.Collections.Generic.IList{Delta.Utilities.Datatypes.Point}},System.Single)">
  809. <summary>
  810. Creates Body with an compound polygon shape attached to it.
  811. </summary>
  812. <param name="initialPosition">Body initial position.</param>
  813. <param name="vertices">
  814. Vertices containing data for creation of compound shape.
  815. </param>
  816. <param name="density">The density of body.</param>
  817. <returns>The new created body.</returns>
  818. </member>
  819. <member name="M:Delta.PhysicsEngines.Physics.CreateCompoundPolygon(System.Collections.Generic.List{System.Collections.Generic.IList{Delta.Utilities.Datatypes.Point}},System.Single)">
  820. <summary>
  821. Creates Body with an compound polygon shape attached to it.
  822. </summary>
  823. <param name="vertices">
  824. Vertices containing data for creation of compound shape.
  825. </param>
  826. <param name="density">The density of body.</param>
  827. <returns>The new created body.</returns>
  828. </member>
  829. <member name="M:Delta.PhysicsEngines.Physics.CreateGear(Delta.Utilities.Datatypes.Point,System.Single,System.Int32,System.Single,System.Single,System.Single)">
  830. <summary>
  831. Creates Body with an gear shape attached to it.
  832. </summary>
  833. <param name="initialPosition">The initial Position</param>
  834. <param name="radius">The Radius</param>
  835. <param name="numberOfTeeth">The number of Teeth</param>
  836. <param name="tipPercentage"></param>
  837. <param name="toothHeight">The Height of the Tooth</param>
  838. <param name="density">Density</param>
  839. <returns>The new created body.</returns>
  840. </member>
  841. <member name="M:Delta.PhysicsEngines.Physics.CreateGear(System.Single,System.Int32,System.Single,System.Single,System.Single)">
  842. <summary>
  843. Creates Body with an gear shape attached to it.
  844. </summary>
  845. <param name="radius">The radius</param>
  846. <param name="numberOfTeeth">The number of Teeth</param>
  847. <param name="tipPercentage"></param>
  848. <param name="toothHeight">The height of the tooth</param>
  849. <param name="density">The Density</param>
  850. <returns>The new created body.</returns>
  851. </member>
  852. <member name="M:Delta.PhysicsEngines.Physics.CreateBox(Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">
  853. <summary>
  854. Creates Body with a box shape attached to it.
  855. </summary>
  856. <param name="initialPosition">The position where to create the sphere.</param>
  857. <param name="radius">The size of the box.
  858. Vector containing data in the given order:
  859. X = width, Y = depth, Z = height</param>
  860. <returns>The new created body.</returns>
  861. </member>
  862. <member name="M:Delta.PhysicsEngines.Physics.CreateBox(Delta.Utilities.Datatypes.Vector,System.Single,System.Single,System.Single)">
  863. <summary>
  864. Creates Body with a box shape attached to it.
  865. </summary>
  866. <param name="initialPosition">The position where to create the sphere.</param>
  867. <returns>The new created body</returns>
  868. </member>
  869. <member name="M:Delta.PhysicsEngines.Physics.CreateSphere(Delta.Utilities.Datatypes.Vector,System.Single)">
  870. <summary>
  871. Creates Body with a sphere shape attached to it.
  872. </summary>
  873. <param name="initialPosition">The position where to create the sphere.</param>
  874. <param name="radius">The radius of the sphere.</param>
  875. <returns>The new created body.</returns>
  876. </member>
  877. <member name="M:Delta.PhysicsEngines.Physics.CreateSphere(System.Single)">
  878. <summary>
  879. Creates Body with a sphere shape attached to it.
  880. </summary>
  881. <param name="radius">The radius of the sphere.</param>
  882. <returns>The new created Body</returns>
  883. </member>
  884. <member name="M:Delta.PhysicsEngines.Physics.CreateCapsule(Delta.Utilities.Datatypes.Vector,System.Single,System.Single)">
  885. <summary>
  886. Creates Body with a capsule shape attached to it.
  887. </summary>
  888. <param name="initialPosition">Position of the body.</param>
  889. <param name="length">
  890. The length of the capsule (exclusive the round endcaps).
  891. </param>
  892. <param name="radius">The radius of the endcaps.</param>
  893. <returns>The new created body.</returns>
  894. </member>
  895. <member name="M:Delta.PhysicsEngines.Physics.CreateCapsule(System.Single,System.Single)">
  896. <summary>
  897. Creates Body with a capsule shape attached to it.
  898. </summary>
  899. <param name="length">
  900. The length of the capsule (exclusive the round endcaps).
  901. </param>
  902. <param name="radius">The radius of the endcaps.</param>
  903. <returns>The new created body.</returns>
  904. </member>
  905. <member name="M:Delta.PhysicsEngines.Physics.CreateCone(Delta.Utilities.Datatypes.Vector,System.Single,System.Single)">
  906. <summary>
  907. Creates a body with cone shape attached to it.
  908. </summary>
  909. <param name="initialPosition">The position of the body.</param>
  910. <param name="height">The height of the cone.</param>
  911. <param name="radius">The radius of the cone base.</param>
  912. <returns>The new created body.</returns>
  913. </member>
  914. <member name="M:Delta.PhysicsEngines.Physics.CreateCone(System.Single,System.Single)">
  915. <summary>
  916. Creates a body with cone shape attached to it.
  917. </summary>
  918. <param name="height">The height of the cone.</param>
  919. <param name="radius">The radius of the cone base.</param>
  920. <returns>The new created body.</returns>
  921. </member>
  922. <member name="M:Delta.PhysicsEngines.Physics.CreateCylinder(Delta.Utilities.Datatypes.Vector,System.Single,System.Single)">
  923. <summary>
  924. Creates a body with cylinder shape attached to it.
  925. </summary>
  926. <param name="initialPosition">The initial position of the body.</param>
  927. <param name="height">The height of the cylinder.</param>
  928. <param name="radius">The radius of the cylinder.</param>
  929. <returns>The new created body.</returns>
  930. </member>
  931. <member name="M:Delta.PhysicsEngines.Physics.CreateCylinder(System.Single,System.Single)">
  932. <summary>
  933. Creates a body with cylinder shape attached to it.
  934. </summary>
  935. <param name="height">The height of the cylinder.</param>
  936. <param name="radius">The radius of the cylinder.</param>
  937. <returns>The new created body.</returns>
  938. </member>
  939. <member name="M:Delta.PhysicsEngines.Physics.CreateTriangleMesh(Delta.Utilities.Datatypes.Vector,Delta.Rendering.Models.Mesh,Delta.Utilities.Datatypes.Matrix,System.Boolean)">
  940. <summary>
  941. Creates a body with triangle shape from given mesh.
  942. </summary>
  943. <param name="initialPosition">The position of the body.</param>
  944. <param name="mesh">Mesh from which to retrieve vertices data.</param>
  945. <param name="localSpaceMatrix">Transformation matrix.</param>
  946. <param name="invertTriangles">Do we need to invert triangle
  947. winding order?</param>
  948. <returns>The new created body.</returns>
  949. </member>
  950. <member name="M:Delta.PhysicsEngines.Physics.CreateTriangleMesh(Delta.Rendering.Models.Mesh,Delta.Utilities.Datatypes.Matrix,System.Boolean)">
  951. <summary>
  952. Creates a body with triangle shape from given mesh.
  953. </summary>
  954. <param name="mesh">Mesh from which to retrieve vertices data.</param>
  955. <param name="localSpaceMatrix">Transformation matrix.</param>
  956. <param name="invertTriangles">Do we need to invert triangle winding
  957. order?</param>
  958. <returns>The new created body.</returns>
  959. </member>
  960. <member name="M:Delta.PhysicsEngines.Physics.CreateTerrain(Delta.Utilities.Datatypes.Vector,System.Single[0:,0:],System.Single,System.Single)">
  961. <summary>
  962. Creates a body with terrain shape attached to it.
  963. </summary>
  964. <param name="initialPosition">The initial position.</param>
  965. <param name="heights">An array containing the heights of the terrain surface.</param>
  966. <param name="scaleX">The x-scale factor. (The x-space between neighbour heights)</param>
  967. <param name="scaleY">The y-scale factor. (The y-space between neighbour heights)</param>
  968. <returns>The new created body.</returns>
  969. </member>
  970. <!-- Badly formed XML comment ignored for member "M:Delta.PhysicsEngines.Physics.CreateTerrain(System.Single[0:,0:],System.Single,System.Single)" -->
  971. <member name="M:Delta.PhysicsEngines.Physics.CreateController(Delta.PhysicsEngines.PhysicsBody,System.Single,System.Single,System.Single)">
  972. <summary>
  973. Create a new character controller.
  974. </summary>
  975. <param name="controlledObject">Controlled Object</param>
  976. <param name="setMoveSpeed">Set MoveSpeed</param>
  977. <param name="setJumpStrength">Jump Strenght</param>
  978. <param name="allowedGroundDistance">Allowed Grounddistance</param>
  979. <returns>The new created character controller</returns>
  980. </member>
  981. <member name="M:Delta.PhysicsEngines.Physics.CreateAngleJoint(Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody,System.Single)">
  982. <summary>
  983. Creates 2D angle joint.
  984. </summary>
  985. <param name="bodyA">Body A</param>
  986. <param name="bodyB">Body B</param>
  987. <param name="targetAngle">Target Angke</param>
  988. <returns>2D Angle Joint</returns>
  989. </member>
  990. <member name="M:Delta.PhysicsEngines.Physics.CreateFixedAngle(Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody)">
  991. <summary>
  992. Creates 3D fixed angle joint.
  993. </summary>
  994. <remarks>
  995. Constraints two bodies to always have the same relative
  996. orientation to each other.
  997. </remarks>
  998. <param name="bodyA">The fist body.</param>
  999. <param name="bodyB">The second body.</param>
  1000. <returns>New instance of PhysicsJoint or null if not supported.</returns>
  1001. </member>
  1002. <member name="M:Delta.PhysicsEngines.Physics.CreatePointOnLine(Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody,Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">
  1003. <summary>
  1004. Creates 3D point on line joint.
  1005. </summary>
  1006. <remarks>
  1007. The PointOnLineJoint restricts two linear degrees of freedom.
  1008. An infinite line is attached to entity A and a point is attached to entity B.
  1009. The constraint attempts to keep the point on the line.
  1010. </remarks>
  1011. <param name="bodyA">The fist body.</param>
  1012. <param name="bodyB">The second body.</param>
  1013. <param name="lineStartPointBody1">Start point position on line for body 1.</param>
  1014. <param name="pointBody2">Point reference on second body.</param>
  1015. <returns>New instance of PhysicsJoint or null if not supported.</returns>
  1016. </member>
  1017. <member name="M:Delta.PhysicsEngines.Physics.CreateSingleBodyPointOnLine(Delta.PhysicsEngines.PhysicsBody,Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">
  1018. <summary>
  1019. Creates 3D point on line joint with single body.
  1020. </summary>
  1021. <remarks>
  1022. The PointOnLineJoint restricts two linear degrees of freedom.
  1023. An infinite line is attached to entity A and a point is attached to entity B.
  1024. The constraint attempts to keep the point on the line.
  1025. </remarks>
  1026. <param name="bodyA">Body A</param>
  1027. <param name="localAnchor">The anchor point on the body in local (body)
  1028. coordinates.</param>
  1029. <param name="lineDirection">The axis defining the line in world space.</param>
  1030. <returns>New instance of PhysicsJoint or null if not supported.</returns>
  1031. </member>
  1032. <member name="M:Delta.PhysicsEngines.Physics.CreatePointOnPoint(Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody,Delta.Utilities.Datatypes.Vector)">
  1033. <summary>
  1034. Creates 3D point on point joint.
  1035. </summary>
  1036. <param name="bodyA">Body A</param>
  1037. <param name="bodyB">Body B</param>
  1038. <param name="anchor">Anchor</param>
  1039. <returns>New instance of PhysicsJoint or null if not supported.</returns>
  1040. </member>
  1041. <member name="M:Delta.PhysicsEngines.Physics.CreatePointPointDistance(Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody,Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">
  1042. <summary>
  1043. Creates 3D point to point distance joint.
  1044. </summary>
  1045. <param name="bodyA">Body A</param>
  1046. <param name="bodyB">Body B</param>
  1047. <param name="anchor1">Anchor 1</param>
  1048. <param name="anchor2">Anchor 2</param>
  1049. <returns>New instance of PhysicsJoint or null if not supported.</returns>
  1050. </member>
  1051. <member name="M:Delta.PhysicsEngines.Physics.CreateHinge(Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody,Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">
  1052. <summary>
  1053. Creates 3D hinge joint.
  1054. </summary>
  1055. <remarks>
  1056. See <see cref="!:http://en.wikipedia.org/wiki/Hinge_joint" /> or
  1057. <see cref="!:http://www.euclideanspace.com/physics/kinematics/joints/jointstructures/index.htm" />
  1058. for more info.
  1059. </remarks>
  1060. <param name="bodyA">The first body connected to the second one.</param>
  1061. <param name="bodyB">The second body connected to the first one.</param>
  1062. <param name="position">The position in world space where both bodies get connected.</param>
  1063. <param name="hingeAxis">The axis if the hinge.</param>
  1064. <returns>New instance of PhysicsJoint or null if not supported.</returns>
  1065. </member>
  1066. <member name="M:Delta.PhysicsEngines.Physics.CreatePrismatic(Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody,System.Single,System.Single,System.Single,System.Single)">
  1067. <summary>
  1068. Creates 3D prismatic joint.
  1069. </summary>
  1070. <remarks>
  1071. See <see cref="!:http://en.wikipedia.org/wiki/Hinge_joint" /> or
  1072. <see cref="!:http://www.euclideanspace.com/physics/kinematics/joints/jointstructures/index.htm" />
  1073. for more info.
  1074. </remarks>
  1075. <param name="bodyA">The first body connected to the second one.</param>
  1076. <param name="bodyB">The second body connected to the first one.</param>
  1077. <param name="minimumDistance">Minimum Distance</param>
  1078. <param name="maximumDistance">Maximum Distance</param>
  1079. <param name="minimumSoftness">Minimum Softness</param>
  1080. <param name="maximumSoftness">Maximum Softness</param>
  1081. <returns>New instance of PhysicsJoint or null if not supported.</returns>
  1082. </member>
  1083. <member name="M:Delta.PhysicsEngines.Physics.CreatePrismatic(Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody,System.Single,System.Single)">
  1084. <summary>
  1085. Creates 3D prismatic joint.
  1086. </summary>
  1087. <remarks>
  1088. See <see cref="!:http://en.wikipedia.org/wiki/Hinge_joint" /> or
  1089. <see cref="!:http://www.euclideanspace.com/physics/kinematics/joints/jointstructures/index.htm" />
  1090. for more info.
  1091. </remarks>
  1092. <param name="bodyA">The first body connected to the second one.</param>
  1093. <param name="bodyB">The second body connected to the first one.</param>
  1094. <param name="minimumDistance">Minimum Distance</param>
  1095. <param name="maximumDistance">Maximum Distance</param>
  1096. <returns>New instance of PhysicsJoint or null if not supported.</returns>
  1097. </member>
  1098. <member name="M:Delta.PhysicsEngines.Physics.ApplyExplosion(Delta.Utilities.Datatypes.Vector,System.Single)">
  1099. <summary>
  1100. Apply explosion. Use this for single effect explosions.
  1101. For repeated explosions, you may consider using
  1102. CreateExplosionForceField() and reusing it everytime (.Apply())
  1103. </summary>
  1104. <param name="position">The spawn position in 3D space.</param>
  1105. <param name="intensity">The intensity of the explosion.</param>
  1106. </member>
  1107. <member name="M:Delta.PhysicsEngines.Physics.CreateExplosionForceField(Delta.Utilities.Datatypes.Vector,System.Single)">
  1108. <summary>
  1109. Creates an explosion at given position with infinite bounds.
  1110. </summary>
  1111. <param name="position">The spawn position in 3D space.</param>
  1112. <param name="intensity">The intensity of the explosion.</param>
  1113. <returns>The new instance of ExplosionForceField.</returns>
  1114. </member>
  1115. <member name="M:Delta.PhysicsEngines.Physics.CreateExplosionForceField(Delta.Utilities.Datatypes.Vector,System.Single,System.Single)">
  1116. <summary>
  1117. Creates an explosion at given position.
  1118. </summary>
  1119. <remarks>
  1120. This creates ForceFieldShape of type Sphere.
  1121. </remarks>
  1122. <param name="position">The spawn position in 3D space.</param>
  1123. <param name="intensity">The intensity of the explosion.</param>
  1124. <param name="radius">The radius in which to apply explosion</param>
  1125. <returns>The new instance of ExplosionForceField.</returns>
  1126. </member>
  1127. <member name="M:Delta.PhysicsEngines.Physics.CreateWindForceField(Delta.Utilities.Datatypes.Vector,System.Single,System.Single)">
  1128. <summary>
  1129. Create wind force field
  1130. </summary>
  1131. <param name="baseWindForce">Base force of the wind.</param>
  1132. <param name="maxVariation">The variation of the force field.</param>
  1133. <param name="maxMass">Maximum mass (in kg) of the force field.</param>
  1134. <returns>The new instance of WindForceField.</returns>
  1135. </member>
  1136. <member name="M:Delta.PhysicsEngines.Physics.CreateTornado(Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector,System.Single)">
  1137. <summary>
  1138. Creates an tornado force field at given position.
  1139. </summary>
  1140. <param name="position">The spawn position in 3D space.</param>
  1141. <param name="axis">Axis of rotation of the tornado.</param>
  1142. <param name="height">
  1143. Height of the tornado; objects above or below the tornado
  1144. will not be affected by its winds.
  1145. </param>
  1146. <returns>The new instance of Tornado.</returns>
  1147. </member>
  1148. <member name="M:Delta.PhysicsEngines.Physics.CreateTornado(Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector)">
  1149. <summary>
  1150. Creates an tornado force field at given position.
  1151. </summary>
  1152. <param name="position">The spawn position in 3D space.</param>
  1153. <param name="axis">Axis of rotation of the tornado.</param>
  1154. <returns>The new instance of Tornado.</returns>
  1155. </member>
  1156. <member name="M:Delta.PhysicsEngines.Physics.CreateTornado(Delta.Utilities.Datatypes.Vector)">
  1157. <summary>
  1158. Creates a Tornado force field at given position.
  1159. </summary>
  1160. <param name="position">The spawn position in 3D space.</param>
  1161. <returns>The new instance of Tornado.</returns>
  1162. </member>
  1163. <member name="M:Delta.PhysicsEngines.Physics.CreateTornado(Delta.Utilities.Datatypes.Vector,Delta.Utilities.Datatypes.Vector,System.Single,System.Boolean,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single,System.Single)">
  1164. <summary>
  1165. Creates a Tornado force field at given position.
  1166. </summary>
  1167. <param name="position">The spawn position in 3D space.</param>
  1168. <param name="axis">Axis of rotation of the tornado.</param>
  1169. <param name="height">
  1170. Height of the tornado; objects above or below the tornado
  1171. will not be affected by its winds.
  1172. </param>
  1173. <param name="spinClockwise">
  1174. Spin direction of the tornado, looking down from the top of the
  1175. tornado (the furthest forward along the tornado axis).
  1176. </param>
  1177. <param name="horizontalWindSpeed">
  1178. Maximum horizontal wind speed of the tornado;
  1179. objects will not be accelerated by the wind past this
  1180. speed in the direction of the wind.
  1181. </param>
  1182. <param name="upwardSuctionSpeed">
  1183. Maximum upward pushing wind speed, objects will not be accelerated
  1184. by the wind past this speed upward.
  1185. </param>
  1186. <param name="inwardSuctionSpeed">
  1187. Maximum inward sucking wind speed, objects will not be accelerated by
  1188. the wind past this speed inward.
  1189. </param>
  1190. <param name="horizontalForce">
  1191. Circular force applied within the tornado.
  1192. Force magnitude decreases as distance from axis increases past the
  1193. radius.
  1194. </param>
  1195. <param name="upwardForce">
  1196. Magnitude of upward-pushing force within the tornado. Magnitude
  1197. decreases as distance from the axis increases past the radius.
  1198. </param>
  1199. <param name="inwardForce">
  1200. Maximum inward sucking wind speed, objects will not be accelerated by
  1201. the wind past this speed inward.
  1202. </param>
  1203. <param name="topRadius">
  1204. Radius of the tornado at the top.
  1205. </param>
  1206. <param name="bottomRadius">
  1207. Radius of the tornado at the bottom.
  1208. </param>
  1209. <returns>The new instance of Tornado.</returns>
  1210. </member>
  1211. <member name="F:Delta.PhysicsEngines.Physics.profilingInfo">
  1212. <summary>
  1213. Real time profile info
  1214. </summary>
  1215. </member>
  1216. <member name="F:Delta.PhysicsEngines.Physics.is2D">
  1217. <summary>
  1218. Whether given physics engine is 2D or 3D.
  1219. </summary>
  1220. </member>
  1221. <member name="F:Delta.PhysicsEngines.Physics.groundBody">
  1222. <summary>
  1223. Physics body of the body.
  1224. </summary>
  1225. </member>
  1226. <member name="M:Delta.PhysicsEngines.Physics.#ctor(System.Boolean,System.String)">
  1227. <summary>
  1228. Creates new instance of Physics engine.
  1229. </summary>
  1230. <remarks>
  1231. Needs to be implemented by subclass.
  1232. </remarks>
  1233. <param name="is2D">Whether given engine is 2D or 3D.</param>
  1234. <param name="setName">The name of the physics implementation.</param>
  1235. </member>
  1236. <member name="M:Delta.PhysicsEngines.Physics.Run">
  1237. <summary>
  1238. Performs dynamic module run.
  1239. This updates all physics stuff and debug drawing whether enabled.
  1240. </summary>
  1241. </member>
  1242. <member name="M:Delta.PhysicsEngines.Physics.SetGroundPlane(System.Boolean,System.Single)">
  1243. <summary>
  1244. Sets settings for ground plane.
  1245. </summary>
  1246. <param name="enable">True or false to enable plane.</param>
  1247. <param name="height">The height of the plane.</param>
  1248. </member>
  1249. <member name="M:Delta.PhysicsEngines.Physics.IsShapeSupported(Delta.PhysicsEngines.Enums.ShapeType)">
  1250. <summary>
  1251. Gets whether the current physics module supports given shape type.
  1252. </summary>
  1253. <param name="shapeType">Type of the shape.</param>
  1254. <returns>
  1255. <c>true</c> if the shape specified shape type is supported, <c>false</c> otherwise.
  1256. </returns>
  1257. </member>
  1258. <member name="M:Delta.PhysicsEngines.Physics.IsJointSupported(Delta.PhysicsEngines.Enums.JointType)">
  1259. <summary>
  1260. Gets whether the current physics module supports given joint type.
  1261. </summary>
  1262. <param name="jointType">Type of the joint.</param>
  1263. <returns>
  1264. <c>true</c> if the specified joint type is supported, <c>false</c> otherwise.
  1265. </returns>
  1266. </member>
  1267. <member name="M:Delta.PhysicsEngines.Physics.IsFeatureSupported(Delta.PhysicsEngines.Enums.FeatureSupport)">
  1268. <summary>
  1269. Gets whether the current physics module supports given feature.
  1270. </summary>
  1271. <param name="support">The feature support to check.</param>
  1272. <returns>
  1273. <c>true</c> if is feature supported <c>false</c> otherwise.
  1274. </returns>
  1275. </member>
  1276. <member name="M:Delta.PhysicsEngines.Physics.CreateBody(System.Boolean,Delta.PhysicsEngines.PhysicsShape,Delta.Utilities.Datatypes.Vector)">
  1277. <summary>
  1278. Implements the subclass creation of PhysicsBody.
  1279. </summary>
  1280. <param name="is2DBody">Whether the body to create is 2D or not.</param>
  1281. <param name="shape">
  1282. The <see cref="T:Delta.PhysicsEngines.PhysicsShape" /> to use during creation.
  1283. </param>
  1284. <param name="initialPosition">The initial position of the body.</param>
  1285. <returns>The new created PhysicsBody.</returns>
  1286. </member>
  1287. <member name="M:Delta.PhysicsEngines.Physics.CreateJoint(Delta.PhysicsEngines.Enums.JointType,Delta.PhysicsEngines.PhysicsBody,Delta.PhysicsEngines.PhysicsBody,System.Object[])">
  1288. <summary>
  1289. Joint creation method used by implementation.
  1290. </summary>
  1291. <param name="jointType">
  1292. The type of Joint (PointOnLine, PointOnPoint etc).
  1293. </param>
  1294. <param name="bodyA">The first body to use (requested).</param>
  1295. <param name="bodyB">The second body to use (optional).</param>
  1296. <param name="args">
  1297. Array of various parameters used on implementation side.
  1298. </param>
  1299. <returns>
  1300. The new creation PhysicsJoint.
  1301. </returns>
  1302. </member>
  1303. <member name="M:Delta.PhysicsEngines.Physics.RemoveBodyImpl(Delta.PhysicsEngines.PhysicsBody)">
  1304. <summary>
  1305. Implementation of RemoveBody by subclass.
  1306. </summary>
  1307. <param name="body">The body to remove.</param>
  1308. </member>
  1309. <member name="M:Delta.PhysicsEngines.Physics.RemoveJointImpl(Delta.PhysicsEngines.PhysicsJoint)">
  1310. <summary>
  1311. Implementation of RemoveJoint by subclass.
  1312. </summary>
  1313. <param name="joint">The joint to remove.</param>
  1314. </member>
  1315. <member name="M:Delta.PhysicsEngines.Physics.SetGravity(Delta.Utilities.Datatypes.Vector)">
  1316. <summary>
  1317. Set gravity by implementation.
  1318. </summary>
  1319. <param name="gravity">The gravity vector to apply.</param>
  1320. </member>
  1321. <member name="M:Delta.PhysicsEngines.Physics.SetMultithreading(System.Boolean)">
  1322. <summary>
  1323. Set multithreading by implementation.
  1324. </summary>
  1325. <param name="enable">True to enable false otherwise.</param>
  1326. </member>
  1327. <member name="M:Delta.PhysicsEngines.Physics.GetTotalPhysicsTime">
  1328. <summary>
  1329. Implementation of total physics time by subclass.
  1330. </summary>
  1331. <returns>
  1332. The total physics simulation time or 0.0 if not implemented.
  1333. </returns>
  1334. </member>
  1335. <member name="M:Delta.PhysicsEngines.Physics.RayCastImpl(Delta.Utilities.Datatypes.Ray,System.Boolean,Delta.PhysicsEngines.PhysicsBody@,Delta.Utilities.Datatypes.Vector@,System.Single@,System.Object@)">
  1336. <summary>
  1337. Ray cast implementation of subclass.
  1338. </summary>
  1339. <param name="ray">The ray to perform.</param>
  1340. <param name="checkGround">Whether to check against ground too.</param>
  1341. <param name="foundBody">Out body if any intersection or null.</param>
  1342. <param name="surfaceNormal">
  1343. Normal vector of intersection or zero if no intersection.
  1344. </param>
  1345. <param name="userData">
  1346. Optional user data to retrieve some more params.
  1347. </param>
  1348. <returns>
  1349. True if any intersection, false otherwise.
  1350. </returns>
  1351. </member>
  1352. <member name="M:Delta.PhysicsEngines.Physics.RayCastImpl2D(Delta.Utilities.Datatypes.Point,Delta.Utilities.Datatypes.Point,Delta.PhysicsEngines.PhysicsBody@,Delta.Utilities.Datatypes.Point@,System.Single@)">
  1353. <summary>
  1354. 2D ray cast implementation by subclass.
  1355. </summary>
  1356. <param name="point1">The first point to perform from.</param>
  1357. <param name="point2">The second point to perform from.</param>
  1358. <param name="body">Out physics body or null if not found.</param>
  1359. <param name="normal">Out normal or zero if no intersection found.</param>
  1360. <param name="fraction">The fraction of the ray cast.</param>
  1361. <returns>
  1362. True if any intersection, false otherwise.
  1363. </returns>
  1364. </member>
  1365. <member name="M:Delta.PhysicsEngines.Physics.CreateControllerImpl(Delta.PhysicsEngines.PhysicsBody,System.Single,System.Single,System.Single)">
  1366. <summary>
  1367. Implementation of CreateController by subcass.
  1368. </summary>
  1369. <param name="controllerBody">The body to be controlled.</param>
  1370. <param name="setMoveSpeed">Speed at which the PhysicsBody moves.</para