{ "files": [ "src/behaviors/attractor.js", "src/behaviors/body-collision-detection.js", "src/behaviors/body-impulse-response.js", "src/behaviors/constant-acceleration.js", "src/behaviors/edge-collision-detection.js", "src/behaviors/interactive.js", "src/behaviors/newtonian.js", "src/behaviors/sweep-prune.js", "src/behaviors/verlet-constraints.js", "src/bodies/circle.js", "src/bodies/compound.js", "src/bodies/convex-polygon.js", "src/bodies/point.js", "src/bodies/rectangle.js", "src/core/behavior.js", "src/core/body.js", "src/core/geometry-helpers.js", "src/core/geometry.js", "src/core/integrator.js", "src/core/query.js", "src/core/renderer.js", "src/core/world.js", "src/geometries/circle.js", "src/geometries/compound.js", "src/geometries/convex-polygon.js", "src/geometries/point.js", "src/geometries/rectangle.js", "src/integrators/improved-euler.js", "src/integrators/velocity-verlet-alt.js", "src/integrators/velocity-verlet.js", "src/integrators/verlet.js", "src/intro.js", "src/math/aabb.js", "src/math/gjk.js", "src/math/statistics.js", "src/math/transform.js", "src/math/vector.js", "src/outro.js", "src/renderers/canvas.js", "src/renderers/debug.js", "src/renderers/dom.js", "src/renderers/pixi-renderer.js", "src/util/decorator.js", "src/util/helpers.js", "src/util/noconflict.js", "src/util/pubsub.js", "src/util/scratchpad.js", "src/util/ticker.js" ], "list": { "AttractorBehavior": { "id": "AttractorBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('attractor')`.\n\nAttractor behavior attracts bodies to a specific point.\n\nAdditional options include:\n- pos: The position of the attraction point\n- strength: How strong the attraction is (default: `1`)\n- order: The power of the inverse distance (default: `2` because that is newtonian gravity... inverse square)\n- max: The maximum distance in which to apply the attraction (default: Infinity)\n- min: The minimum distance above which to apply the attraction (default: very small non-zero)", "short_description": "`Physics.behavior('attractor')`.\n", "line": 15, "aliases": [], "children": [ { "id": "AttractorBehavior#position", "type": "instance method", "signatures": [ { "arguments": [ { "name": "pos", "optional": true, "types": [ "Vectorish" ], "description": " The position to set\n\n " } ], "returns": [ { "type": "Object", "description": " Returns the [[Vectorish]] position if no arguments provided\n\n " }, { "type": "this", "description": " For chaining\n\n " } ] } ], "arguments": [ { "name": "pos", "types": [ "Vectorish" ], "description": " The position to set\n\n " } ], "returns": [ { "type": "Object", "description": " Returns the [[Vectorish]] position if no arguments provided\n\n " }, { "type": "this", "description": " For chaining\n\n " } ], "description": "Get or set the position of the attractor.", "short_description": "Get or set the position of the attractor.", "line": 56, "aliases": [], "children": [], "file": "src/behaviors/attractor.js", "name": "position", "name_prefix": "AttractorBehavior#", "path": "AttractorBehavior.prototype.position", "outFile": "attractor.html#AttractorBehavior.prototype.position" } ], "file": "src/behaviors/attractor.js", "subclasses": [], "name": "AttractorBehavior", "path": "AttractorBehavior", "outFile": "attractor.html" }, "AttractorBehavior#position": { "id": "AttractorBehavior#position", "type": "instance method", "signatures": [ { "arguments": [ { "name": "pos", "optional": true, "types": [ "Vectorish" ], "description": " The position to set\n\n " } ], "returns": [ { "type": "Object", "description": " Returns the [[Vectorish]] position if no arguments provided\n\n " }, { "type": "this", "description": " For chaining\n\n " } ] } ], "arguments": [ { "name": "pos", "types": [ "Vectorish" ], "description": " The position to set\n\n " } ], "returns": [ { "type": "Object", "description": " Returns the [[Vectorish]] position if no arguments provided\n\n " }, { "type": "this", "description": " For chaining\n\n " } ], "description": "Get or set the position of the attractor.", "short_description": "Get or set the position of the attractor.", "line": 56, "aliases": [], "children": [], "file": "src/behaviors/attractor.js", "name": "position", "name_prefix": "AttractorBehavior#", "path": "AttractorBehavior.prototype.position", "outFile": "attractor.html#AttractorBehavior.prototype.position" }, "BodyCollisionDetectionBehavior": { "id": "BodyCollisionDetectionBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('body-collision-detection')`.\n\nDetect collisions of bodies.\n\nPublishes collision events to the world as a group of detected collisions per iteration.\n\nThe event data will have a `.collisions` property that is an array of collisions of the form:\n\n```javascript\n{\n bodyA: // the first body\n bodyB: // the second body\n norm: // the normal vector (Vectorish)\n mtv: // the minimum transit vector. (the direction and length needed to extract bodyB from bodyA)\n pos: // the collision point relative to bodyA\n overlap: // the amount bodyA overlaps bodyB\n}\n```\n\nAdditional options include:\n- check: channel to listen to for collision candidates (default: `collisions:candidates`). set to `true` to force check every pair of bodies in the world\n- channel: channel to publish events to (default: `collisions:detected`)", "short_description": "`Physics.behavior('body-collision-detection')`.\n", "line": 27, "aliases": [], "children": [ { "id": "BodyCollisionDetectionBehavior#check", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ], "internal": true, "description": "Event callback to check pairs of objects that have been flagged by broad phase for possible collisions.", "short_description": "Event callback to check pairs of objects that have been flagged by broad phase for possible collisions.", "line": 366, "aliases": [], "children": [], "file": "src/behaviors/body-collision-detection.js", "name": "check", "name_prefix": "BodyCollisionDetectionBehavior#", "path": "BodyCollisionDetectionBehavior.prototype.check", "outFile": "body-collision-detection.html#BodyCollisionDetectionBehavior.prototype.check" }, { "id": "BodyCollisionDetectionBehavior#checkAll", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ], "internal": true, "description": "Event callback to check all pairs of objects in the list for collisions", "short_description": "Event callback to check all pairs of objects in the list for collisions", "line": 428, "aliases": [], "children": [], "file": "src/behaviors/body-collision-detection.js", "name": "checkAll", "name_prefix": "BodyCollisionDetectionBehavior#", "path": "BodyCollisionDetectionBehavior.prototype.checkAll", "outFile": "body-collision-detection.html#BodyCollisionDetectionBehavior.prototype.checkAll" } ], "file": "src/behaviors/body-collision-detection.js", "subclasses": [], "name": "BodyCollisionDetectionBehavior", "path": "BodyCollisionDetectionBehavior", "outFile": "body-collision-detection.html" }, "BodyCollisionDetectionBehavior#check": { "id": "BodyCollisionDetectionBehavior#check", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ], "internal": true, "description": "Event callback to check pairs of objects that have been flagged by broad phase for possible collisions.", "short_description": "Event callback to check pairs of objects that have been flagged by broad phase for possible collisions.", "line": 366, "aliases": [], "children": [], "file": "src/behaviors/body-collision-detection.js", "name": "check", "name_prefix": "BodyCollisionDetectionBehavior#", "path": "BodyCollisionDetectionBehavior.prototype.check", "outFile": "body-collision-detection.html#BodyCollisionDetectionBehavior.prototype.check" }, "BodyCollisionDetectionBehavior#checkAll": { "id": "BodyCollisionDetectionBehavior#checkAll", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ], "internal": true, "description": "Event callback to check all pairs of objects in the list for collisions", "short_description": "Event callback to check all pairs of objects in the list for collisions", "line": 428, "aliases": [], "children": [], "file": "src/behaviors/body-collision-detection.js", "name": "checkAll", "name_prefix": "BodyCollisionDetectionBehavior#", "path": "BodyCollisionDetectionBehavior.prototype.checkAll", "outFile": "body-collision-detection.html#BodyCollisionDetectionBehavior.prototype.checkAll" }, "BodyImpulseResponseBehavior": { "id": "BodyImpulseResponseBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('body-impulse-response')`.\n\nResponds to collisions by applying impulses.\n\nAdditional options include:\n- check: channel to listen to for collisions (default: `collisions:detected`).\n- mtvThreshold: apply partial extraction of bodies if the minimum transit vector is less than this value ( default: `1`)\n this will depend on your simulation characteristic length scale\n- bodyExtractDropoff: every body overlap correction (underneith mtvThreshold) will only extract by this fraction (0..1). Helps with stablizing contacts. (default: `0.5`)\n- forceWakeupAboveOverlapThreshold: force bodies to wake up if the overlap is above mtvThreshold ( default: `true` )", "short_description": "`Physics.behavior('body-impulse-response')`.\n", "line": 15, "aliases": [], "children": [ { "id": "BodyImpulseResponseBehavior#collideBodes", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodyA", "types": [ "Object" ], "description": " First Body\n\n " }, { "name": "bodyB", "types": [ "Object" ], "description": " Second body\n\n " }, { "name": "normal", "types": [ "Vector" ], "description": " Normal vector of the collision surface\n\n " }, { "name": "point", "types": [ "Vector" ], "description": " Contact point of the collision\n\n " }, { "name": "mtrans", "types": [ "Vector" ], "description": " Minimum transit vector that is the smallest displacement to separate the bodies\n\n " }, { "name": "contact", "types": [ "Boolean" ], "description": " Are the bodies in resting contact relative to each other\n\n " } ] } ], "arguments": [ { "name": "bodyA", "types": [ "Object" ], "description": " First Body\n\n " }, { "name": "bodyB", "types": [ "Object" ], "description": " Second body\n\n " }, { "name": "normal", "types": [ "Vector" ], "description": " Normal vector of the collision surface\n\n " }, { "name": "point", "types": [ "Vector" ], "description": " Contact point of the collision\n\n " }, { "name": "mtrans", "types": [ "Vector" ], "description": " Minimum transit vector that is the smallest displacement to separate the bodies\n\n " }, { "name": "contact", "types": [ "Boolean" ], "description": " Are the bodies in resting contact relative to each other\n\n " } ], "internal": true, "description": "Collide two bodies by modifying their positions and velocities to conserve momentum", "short_description": "Collide two bodies by modifying their positions and velocities to conserve momentum", "line": 88, "aliases": [], "children": [], "file": "src/behaviors/body-impulse-response.js", "name": "collideBodes", "name_prefix": "BodyImpulseResponseBehavior#", "path": "BodyImpulseResponseBehavior.prototype.collideBodes", "outFile": "body-impulse-response.html#BodyImpulseResponseBehavior.prototype.collideBodes" }, { "id": "BodyImpulseResponseBehavior#respond", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " event data\n\n " } ], "internal": true, "description": "Event callback to respond to collision data.", "short_description": "Event callback to respond to collision data.", "line": 281, "aliases": [], "children": [], "file": "src/behaviors/body-impulse-response.js", "name": "respond", "name_prefix": "BodyImpulseResponseBehavior#", "path": "BodyImpulseResponseBehavior.prototype.respond", "outFile": "body-impulse-response.html#BodyImpulseResponseBehavior.prototype.respond" } ], "file": "src/behaviors/body-impulse-response.js", "subclasses": [], "name": "BodyImpulseResponseBehavior", "path": "BodyImpulseResponseBehavior", "outFile": "body-impulse-response.html" }, "BodyImpulseResponseBehavior#collideBodes": { "id": "BodyImpulseResponseBehavior#collideBodes", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodyA", "types": [ "Object" ], "description": " First Body\n\n " }, { "name": "bodyB", "types": [ "Object" ], "description": " Second body\n\n " }, { "name": "normal", "types": [ "Vector" ], "description": " Normal vector of the collision surface\n\n " }, { "name": "point", "types": [ "Vector" ], "description": " Contact point of the collision\n\n " }, { "name": "mtrans", "types": [ "Vector" ], "description": " Minimum transit vector that is the smallest displacement to separate the bodies\n\n " }, { "name": "contact", "types": [ "Boolean" ], "description": " Are the bodies in resting contact relative to each other\n\n " } ] } ], "arguments": [ { "name": "bodyA", "types": [ "Object" ], "description": " First Body\n\n " }, { "name": "bodyB", "types": [ "Object" ], "description": " Second body\n\n " }, { "name": "normal", "types": [ "Vector" ], "description": " Normal vector of the collision surface\n\n " }, { "name": "point", "types": [ "Vector" ], "description": " Contact point of the collision\n\n " }, { "name": "mtrans", "types": [ "Vector" ], "description": " Minimum transit vector that is the smallest displacement to separate the bodies\n\n " }, { "name": "contact", "types": [ "Boolean" ], "description": " Are the bodies in resting contact relative to each other\n\n " } ], "internal": true, "description": "Collide two bodies by modifying their positions and velocities to conserve momentum", "short_description": "Collide two bodies by modifying their positions and velocities to conserve momentum", "line": 88, "aliases": [], "children": [], "file": "src/behaviors/body-impulse-response.js", "name": "collideBodes", "name_prefix": "BodyImpulseResponseBehavior#", "path": "BodyImpulseResponseBehavior.prototype.collideBodes", "outFile": "body-impulse-response.html#BodyImpulseResponseBehavior.prototype.collideBodes" }, "BodyImpulseResponseBehavior#respond": { "id": "BodyImpulseResponseBehavior#respond", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " event data\n\n " } ], "internal": true, "description": "Event callback to respond to collision data.", "short_description": "Event callback to respond to collision data.", "line": 281, "aliases": [], "children": [], "file": "src/behaviors/body-impulse-response.js", "name": "respond", "name_prefix": "BodyImpulseResponseBehavior#", "path": "BodyImpulseResponseBehavior.prototype.respond", "outFile": "body-impulse-response.html#BodyImpulseResponseBehavior.prototype.respond" }, "ConstantAccelerationBehavior": { "id": "ConstantAccelerationBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('constant-acceleration')`.\n\nConstant acceleration behavior.\n\nBasically the \"gravity\" behavior. Used to give \"earth-like gravity\" to the world.\n\nAdditional options include:\n- acc: The acceleration vector (Vectorish). (default: `{ x: 0, y: 0.0004 }`)", "short_description": "`Physics.behavior('constant-acceleration')`.\n", "line": 13, "aliases": [], "children": [ { "id": "ConstantAccelerationBehavior#setAcceleration", "type": "instance method", "signatures": [ { "arguments": [ { "name": "acc", "types": [ "Vectorish" ], "description": " The acceleration vector\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "acc", "types": [ "Vectorish" ], "description": " The acceleration vector\n\n " } ], "description": "Set the acceleration of the behavior.", "short_description": "Set the acceleration of the behavior.", "line": 41, "aliases": [], "children": [], "file": "src/behaviors/constant-acceleration.js", "name": "setAcceleration", "name_prefix": "ConstantAccelerationBehavior#", "path": "ConstantAccelerationBehavior.prototype.setAcceleration", "outFile": "constant-acceleration.html#ConstantAccelerationBehavior.prototype.setAcceleration" } ], "file": "src/behaviors/constant-acceleration.js", "subclasses": [], "name": "ConstantAccelerationBehavior", "path": "ConstantAccelerationBehavior", "outFile": "constant-acceleration.html" }, "ConstantAccelerationBehavior#setAcceleration": { "id": "ConstantAccelerationBehavior#setAcceleration", "type": "instance method", "signatures": [ { "arguments": [ { "name": "acc", "types": [ "Vectorish" ], "description": " The acceleration vector\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "acc", "types": [ "Vectorish" ], "description": " The acceleration vector\n\n " } ], "description": "Set the acceleration of the behavior.", "short_description": "Set the acceleration of the behavior.", "line": 41, "aliases": [], "children": [], "file": "src/behaviors/constant-acceleration.js", "name": "setAcceleration", "name_prefix": "ConstantAccelerationBehavior#", "path": "ConstantAccelerationBehavior.prototype.setAcceleration", "outFile": "constant-acceleration.html#ConstantAccelerationBehavior.prototype.setAcceleration" }, "EdgeCollisionDetectionBehavior": { "id": "EdgeCollisionDetectionBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('edge-collision-detection')`.\n\nUsed to detect collisions with the boundaries of an AABB.\n\nAdditional options include:\n- aabb: The [[Physics.aabb]] bounds to use as the constraining boundary\n- restitution: The restitution of the boundary walls (default: `0.99`)\n- cof: The coefficient of friction of the boundary walls (default: `1`)\n- channel: The channel to publish collisions to. (default: 'collisions:detected')", "short_description": "`Physics.behavior('edge-collision-detection')`.\n", "line": 14, "aliases": [], "children": [ { "id": "EdgeCollisionDetectionBehavior#checkAll", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to check all bodies for collisions with the edge", "short_description": "Event callback to check all bodies for collisions with the edge", "line": 227, "aliases": [], "children": [], "file": "src/behaviors/edge-collision-detection.js", "name": "checkAll", "name_prefix": "EdgeCollisionDetectionBehavior#", "path": "EdgeCollisionDetectionBehavior.prototype.checkAll", "outFile": "edge-collision-detection.html#EdgeCollisionDetectionBehavior.prototype.checkAll" }, { "id": "EdgeCollisionDetectionBehavior#setAABB", "type": "instance method", "signatures": [ { "arguments": [ { "name": "aabb", "types": [ "Physics.aabb" ], "description": " The aabb to use as the boundary\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "aabb", "types": [ "Physics.aabb" ], "description": " The aabb to use as the boundary\n\n " } ], "description": "Set the boundaries of the edge.", "short_description": "Set the boundaries of the edge.", "line": 189, "aliases": [], "children": [], "file": "src/behaviors/edge-collision-detection.js", "name": "setAABB", "name_prefix": "EdgeCollisionDetectionBehavior#", "path": "EdgeCollisionDetectionBehavior.prototype.setAABB", "outFile": "edge-collision-detection.html#EdgeCollisionDetectionBehavior.prototype.setAABB" } ], "file": "src/behaviors/edge-collision-detection.js", "subclasses": [], "name": "EdgeCollisionDetectionBehavior", "path": "EdgeCollisionDetectionBehavior", "outFile": "edge-collision-detection.html" }, "EdgeCollisionDetectionBehavior#setAABB": { "id": "EdgeCollisionDetectionBehavior#setAABB", "type": "instance method", "signatures": [ { "arguments": [ { "name": "aabb", "types": [ "Physics.aabb" ], "description": " The aabb to use as the boundary\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "aabb", "types": [ "Physics.aabb" ], "description": " The aabb to use as the boundary\n\n " } ], "description": "Set the boundaries of the edge.", "short_description": "Set the boundaries of the edge.", "line": 189, "aliases": [], "children": [], "file": "src/behaviors/edge-collision-detection.js", "name": "setAABB", "name_prefix": "EdgeCollisionDetectionBehavior#", "path": "EdgeCollisionDetectionBehavior.prototype.setAABB", "outFile": "edge-collision-detection.html#EdgeCollisionDetectionBehavior.prototype.setAABB" }, "EdgeCollisionDetectionBehavior#checkAll": { "id": "EdgeCollisionDetectionBehavior#checkAll", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to check all bodies for collisions with the edge", "short_description": "Event callback to check all bodies for collisions with the edge", "line": 227, "aliases": [], "children": [], "file": "src/behaviors/edge-collision-detection.js", "name": "checkAll", "name_prefix": "EdgeCollisionDetectionBehavior#", "path": "EdgeCollisionDetectionBehavior.prototype.checkAll", "outFile": "edge-collision-detection.html#EdgeCollisionDetectionBehavior.prototype.checkAll" }, "InteractiveBehavior": { "id": "InteractiveBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('interactive')`.\n\nUser interaction helper.\n\nUsed to get mouse/touch events and add grab interactions.\n\nAdditional options include:\n- el: The element of the renderer. What you input as the `el` for the renderer.\n- moveThrottle: The min time between move events (default: `10`).\n- minVel: The minimum velocity clamp [[Vectorish]] (default: { x: -5, y: -5 }) to restrict velocity a user can give to a body\n- maxVel: The maximum velocity clamp [[Vectorish]] (default: { x: 5, y: 5 }) to restrict velocity a user can give to a body\n\nThe behavior also triggers the following events on the world:\n```javascript\n// a body has been grabbed\nworld.on('interact:grab', function( data ){\n data.x; // the x coord\n data.y; // the y coord\n data.body; // the body that was grabbed\n});\n// no body was grabbed, but the renderer area was clicked, or touched\nworld.on('interact:poke', function( data ){\n data.x; // the x coord\n data.y; // the y coord\n});\n// when a mouse or pointer moves\nworld.on('interact:move', function( data ){\n data.x; // the x coord\n data.y; // the y coord\n data.body; // the grabbed body that was moved (if applicable)\n});\n// when the viewport is released (mouseup, touchend)\nworld.on('interact:release', function( data ){\n data.x; // the x coord\n data.y; // the y coord\n data.body; // the body that was grabbed (if applicable)\n});\n```\n\nThe behavior also sets body.isGrabbed = true for any grabbed bodies while they are grabbed.", "short_description": "`Physics.behavior('interactive')`.\n", "line": 45, "aliases": [], "children": [], "file": "src/behaviors/interactive.js", "subclasses": [], "name": "InteractiveBehavior", "path": "InteractiveBehavior", "outFile": "interactive.html" }, "NewtonianBehavior": { "id": "NewtonianBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('newtonian')`.\n\nNewtonian attraction between bodies (inverse square law).\n\nAdditional options include:\n- strength: The strength of the interaction between bodies. (default: `1`)\n- max: The maximum distance between bodies at which to apply the behavior. (default: `false`... infinite)\n- min: The minimum distance between bodies at which to apply the behavior. (default: `false`... autocalculate)", "short_description": "`Physics.behavior('newtonian')`.\n", "line": 13, "aliases": [], "children": [], "file": "src/behaviors/newtonian.js", "subclasses": [], "name": "NewtonianBehavior", "path": "NewtonianBehavior", "outFile": "newtonian.html" }, "SweepPruneBehavior": { "id": "SweepPruneBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('sweep-prune')`.\n\nSweep and Prune implementation for broad phase collision detection.\n\nThis massively improves the speed of collision detection. It's set up to always be used with [[BodyCollisionDetection]], and [[BodyImpulseResponse]].\n\nAdditional options include:\n- channel: The channel to publish collision candidates to. (default: `collisions:candidates`)", "short_description": "`Physics.behavior('sweep-prune')`.\n", "line": 13, "aliases": [], "children": [ { "id": "SweepPruneBehavior#broadPhase", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " The candidate data of overlapping aabbs\n\n " } ], "internal": true, "description": "Execute the broad phase and get candidate collisions", "short_description": "Execute the broad phase and get candidate collisions", "line": 95, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "broadPhase", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.broadPhase", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.broadPhase" }, { "id": "SweepPruneBehavior#checkOverlaps", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " List of candidate collisions\n\n " } ], "internal": true, "description": "Check each axis for overlaps of bodies AABBs", "short_description": "Check each axis for overlaps of bodies AABBs", "line": 257, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "checkOverlaps", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.checkOverlaps", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.checkOverlaps" }, { "id": "SweepPruneBehavior#clear", "type": "instance method", "signatures": [ { "arguments": [] } ], "description": "Refresh tracking data", "short_description": "Refresh tracking data", "line": 52, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "clear", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.clear", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.clear" }, { "id": "SweepPruneBehavior#getPair", "type": "instance method", "signatures": [ { "arguments": [ { "name": "tr1", "types": [ "Object" ], "description": " First tracker\n\n " }, { "name": "tr2", "types": [ "Object" ], "description": " Second tracker\n\n " }, { "name": "doCreate", "types": [ "Boolean" ], "description": " Create if not found\n\n " } ], "returns": [ { "type": "Object", "description": " Pair object or null if not found\n\n " } ] } ], "arguments": [ { "name": "tr1", "types": [ "Object" ], "description": " First tracker\n\n " }, { "name": "tr2", "types": [ "Object" ], "description": " Second tracker\n\n " }, { "name": "doCreate", "types": [ "Boolean" ], "description": " Create if not found\n\n " } ], "returns": [ { "type": "Object", "description": " Pair object or null if not found\n\n " } ], "internal": true, "description": "Get a pair object for the tracker objects", "short_description": "Get a pair object for the tracker objects", "line": 181, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "getPair", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.getPair", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.getPair" }, { "id": "SweepPruneBehavior#sortIntervalLists", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Simple insertion sort for each axis", "short_description": "Simple insertion sort for each axis", "line": 112, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "sortIntervalLists", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.sortIntervalLists", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.sortIntervalLists" }, { "id": "SweepPruneBehavior#sweep", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to sweep and publish event if any candidate collisions are found", "short_description": "Event callback to sweep and publish event if any candidate collisions are found", "line": 487, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "sweep", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.sweep", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.sweep" }, { "id": "SweepPruneBehavior#trackBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to add body to list of those tracked by sweep and prune", "short_description": "Event callback to add body to list of those tracked by sweep and prune", "line": 393, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "trackBody", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.trackBody", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.trackBody" }, { "id": "SweepPruneBehavior#untrackBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to remove body from list of those tracked", "short_description": "Event callback to remove body from list of those tracked", "line": 432, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "untrackBody", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.untrackBody", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.untrackBody" }, { "id": "SweepPruneBehavior#updateIntervals", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Update position intervals on each axis", "short_description": "Update position intervals on each axis", "line": 364, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "updateIntervals", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.updateIntervals", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.updateIntervals" } ], "file": "src/behaviors/sweep-prune.js", "subclasses": [], "name": "SweepPruneBehavior", "path": "SweepPruneBehavior", "outFile": "sweep-prune.html" }, "SweepPruneBehavior#clear": { "id": "SweepPruneBehavior#clear", "type": "instance method", "signatures": [ { "arguments": [] } ], "description": "Refresh tracking data", "short_description": "Refresh tracking data", "line": 52, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "clear", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.clear", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.clear" }, "SweepPruneBehavior#broadPhase": { "id": "SweepPruneBehavior#broadPhase", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " The candidate data of overlapping aabbs\n\n " } ], "internal": true, "description": "Execute the broad phase and get candidate collisions", "short_description": "Execute the broad phase and get candidate collisions", "line": 95, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "broadPhase", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.broadPhase", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.broadPhase" }, "SweepPruneBehavior#sortIntervalLists": { "id": "SweepPruneBehavior#sortIntervalLists", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Simple insertion sort for each axis", "short_description": "Simple insertion sort for each axis", "line": 112, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "sortIntervalLists", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.sortIntervalLists", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.sortIntervalLists" }, "SweepPruneBehavior#getPair": { "id": "SweepPruneBehavior#getPair", "type": "instance method", "signatures": [ { "arguments": [ { "name": "tr1", "types": [ "Object" ], "description": " First tracker\n\n " }, { "name": "tr2", "types": [ "Object" ], "description": " Second tracker\n\n " }, { "name": "doCreate", "types": [ "Boolean" ], "description": " Create if not found\n\n " } ], "returns": [ { "type": "Object", "description": " Pair object or null if not found\n\n " } ] } ], "arguments": [ { "name": "tr1", "types": [ "Object" ], "description": " First tracker\n\n " }, { "name": "tr2", "types": [ "Object" ], "description": " Second tracker\n\n " }, { "name": "doCreate", "types": [ "Boolean" ], "description": " Create if not found\n\n " } ], "returns": [ { "type": "Object", "description": " Pair object or null if not found\n\n " } ], "internal": true, "description": "Get a pair object for the tracker objects", "short_description": "Get a pair object for the tracker objects", "line": 181, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "getPair", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.getPair", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.getPair" }, "SweepPruneBehavior#checkOverlaps": { "id": "SweepPruneBehavior#checkOverlaps", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " List of candidate collisions\n\n " } ], "internal": true, "description": "Check each axis for overlaps of bodies AABBs", "short_description": "Check each axis for overlaps of bodies AABBs", "line": 257, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "checkOverlaps", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.checkOverlaps", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.checkOverlaps" }, "SweepPruneBehavior#updateIntervals": { "id": "SweepPruneBehavior#updateIntervals", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Update position intervals on each axis", "short_description": "Update position intervals on each axis", "line": 364, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "updateIntervals", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.updateIntervals", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.updateIntervals" }, "SweepPruneBehavior#trackBody": { "id": "SweepPruneBehavior#trackBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to add body to list of those tracked by sweep and prune", "short_description": "Event callback to add body to list of those tracked by sweep and prune", "line": 393, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "trackBody", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.trackBody", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.trackBody" }, "SweepPruneBehavior#untrackBody": { "id": "SweepPruneBehavior#untrackBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to remove body from list of those tracked", "short_description": "Event callback to remove body from list of those tracked", "line": 432, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "untrackBody", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.untrackBody", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.untrackBody" }, "SweepPruneBehavior#sweep": { "id": "SweepPruneBehavior#sweep", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to sweep and publish event if any candidate collisions are found", "short_description": "Event callback to sweep and publish event if any candidate collisions are found", "line": 487, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "sweep", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.sweep", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.sweep" }, "VerletConstraintsBehavior": { "id": "VerletConstraintsBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('verlet-constraints')`.\n\nVerlet constraints manager.\n\nHandles distance constraints, and angle constraints\n\nAdditional options include:\n- iterations: The number of iterations to take to relax the constraints. (default: `2`)", "short_description": "`Physics.behavior('verlet-constraints')`.\n", "line": 13, "aliases": [], "children": [ { "id": "VerletConstraintsBehavior#angleConstraint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "bodyC", "types": [ "Body" ], "description": " Third body\n\n " }, { "name": "stiffness", "optional": true, "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetAngle", "optional": true, "types": [ "Number" ], "description": " Target angle. Defaults to the current angle between bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ] } ], "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "bodyC", "types": [ "Body" ], "description": " Third body\n\n " }, { "name": "stiffness", "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetAngle", "types": [ "Number" ], "description": " Target angle. Defaults to the current angle between bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ], "description": "Constrain three bodies to a target relative angle\n\nReturns constraint data that can be used to remove the constraint later.\n\n- `.bodyA`, `.bodyB`, and `.bodyC` are references to the bodies\n- `.type` is the type of constraint\n- `.id` is the string ID of the constraint\n- `.stiffness` is the stiffness\n- `.targetAngle` is the target angle", "short_description": "Constrain three bodies to a target relative angle\n", "line": 129, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "angleConstraint", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.angleConstraint", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.angleConstraint" }, { "id": "VerletConstraintsBehavior#distanceConstraint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "stiffness", "optional": true, "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetLength", "optional": true, "types": [ "Number" ], "description": " Target length. defaults to current distance between the bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ] } ], "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "stiffness", "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetLength", "types": [ "Number" ], "description": " Target length. defaults to current distance between the bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ], "description": "Constrain two bodies to a target relative distance.\n\nReturns constraint data that can be used to remove the constraint later.\n\n- `.bodyA` and `.bodyB` are references to the bodies\n- `.type` is the type of constraint\n- `.id` is the string ID of the constraint\n- `.stiffness` is the stiffness\n- `.targetLength` is the target length", "short_description": "Constrain two bodies to a target relative distance.\n", "line": 86, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "distanceConstraint", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.distanceConstraint", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.distanceConstraint" }, { "id": "VerletConstraintsBehavior#drop", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Remove all constraints", "short_description": "Remove all constraints", "line": 60, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "drop", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.drop", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.drop" }, { "id": "VerletConstraintsBehavior#getConstraints", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Object" } ] } ], "returns": [ { "type": "Object", "description": " The object containing copied arrays of the constraints\n\n " } ], "description": "Get all constraints.", "short_description": "Get all constraints.", "line": 419, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "getConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.getConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.getConstraints" }, { "id": "VerletConstraintsBehavior#remove", "type": "instance method", "signatures": [ { "arguments": [ { "name": "constraintData", "types": [ "Object" ], "description": " The constraint data returned when creating a constraint\n\n " } ], "returns": [ { "type": "this" } ] }, { "arguments": [ { "name": "constraintId", "types": [ "String" ], "description": " The constraint id\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "constraintData", "types": [ "Object" ], "description": " The constraint data returned when creating a constraint\n\n " }, { "name": "constraintId", "types": [ "String" ], "description": " The constraint id\n\n " } ], "description": "Remove a constraint", "short_description": "Remove a constraint", "line": 160, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "remove", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.remove", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.remove" }, { "id": "VerletConstraintsBehavior#resolve", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Resolve all constraints.", "short_description": "Resolve all constraints.", "line": 399, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "resolve", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.resolve", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.resolve" }, { "id": "VerletConstraintsBehavior#resolveAngleConstraints", "type": "instance method", "signatures": [ { "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ] } ], "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ], "internal": true, "description": "Resolve angle constraints.", "short_description": "Resolve angle constraints.", "line": 205, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "resolveAngleConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.resolveAngleConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.resolveAngleConstraints" }, { "id": "VerletConstraintsBehavior#resolveDistanceConstraints", "type": "instance method", "signatures": [ { "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ] } ], "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ], "internal": true, "description": "Resolve distance constraints.", "short_description": "Resolve distance constraints.", "line": 330, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "resolveDistanceConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.resolveDistanceConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.resolveDistanceConstraints" }, { "id": "VerletConstraintsBehavior#shuffleConstraints", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Mix up the constraints.", "short_description": "Mix up the constraints.", "line": 388, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "shuffleConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.shuffleConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.shuffleConstraints" } ], "file": "src/behaviors/verlet-constraints.js", "subclasses": [], "name": "VerletConstraintsBehavior", "path": "VerletConstraintsBehavior", "outFile": "verlet-constraints.html" }, "VerletConstraintsBehavior#drop": { "id": "VerletConstraintsBehavior#drop", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Remove all constraints", "short_description": "Remove all constraints", "line": 60, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "drop", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.drop", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.drop" }, "VerletConstraintsBehavior#distanceConstraint": { "id": "VerletConstraintsBehavior#distanceConstraint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "stiffness", "optional": true, "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetLength", "optional": true, "types": [ "Number" ], "description": " Target length. defaults to current distance between the bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ] } ], "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "stiffness", "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetLength", "types": [ "Number" ], "description": " Target length. defaults to current distance between the bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ], "description": "Constrain two bodies to a target relative distance.\n\nReturns constraint data that can be used to remove the constraint later.\n\n- `.bodyA` and `.bodyB` are references to the bodies\n- `.type` is the type of constraint\n- `.id` is the string ID of the constraint\n- `.stiffness` is the stiffness\n- `.targetLength` is the target length", "short_description": "Constrain two bodies to a target relative distance.\n", "line": 86, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "distanceConstraint", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.distanceConstraint", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.distanceConstraint" }, "VerletConstraintsBehavior#angleConstraint": { "id": "VerletConstraintsBehavior#angleConstraint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "bodyC", "types": [ "Body" ], "description": " Third body\n\n " }, { "name": "stiffness", "optional": true, "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetAngle", "optional": true, "types": [ "Number" ], "description": " Target angle. Defaults to the current angle between bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ] } ], "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "bodyC", "types": [ "Body" ], "description": " Third body\n\n " }, { "name": "stiffness", "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetAngle", "types": [ "Number" ], "description": " Target angle. Defaults to the current angle between bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ], "description": "Constrain three bodies to a target relative angle\n\nReturns constraint data that can be used to remove the constraint later.\n\n- `.bodyA`, `.bodyB`, and `.bodyC` are references to the bodies\n- `.type` is the type of constraint\n- `.id` is the string ID of the constraint\n- `.stiffness` is the stiffness\n- `.targetAngle` is the target angle", "short_description": "Constrain three bodies to a target relative angle\n", "line": 129, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "angleConstraint", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.angleConstraint", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.angleConstraint" }, "VerletConstraintsBehavior#remove": { "id": "VerletConstraintsBehavior#remove", "type": "instance method", "signatures": [ { "arguments": [ { "name": "constraintData", "types": [ "Object" ], "description": " The constraint data returned when creating a constraint\n\n " } ], "returns": [ { "type": "this" } ] }, { "arguments": [ { "name": "constraintId", "types": [ "String" ], "description": " The constraint id\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "constraintData", "types": [ "Object" ], "description": " The constraint data returned when creating a constraint\n\n " }, { "name": "constraintId", "types": [ "String" ], "description": " The constraint id\n\n " } ], "description": "Remove a constraint", "short_description": "Remove a constraint", "line": 160, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "remove", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.remove", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.remove" }, "VerletConstraintsBehavior#resolveAngleConstraints": { "id": "VerletConstraintsBehavior#resolveAngleConstraints", "type": "instance method", "signatures": [ { "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ] } ], "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ], "internal": true, "description": "Resolve angle constraints.", "short_description": "Resolve angle constraints.", "line": 205, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "resolveAngleConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.resolveAngleConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.resolveAngleConstraints" }, "VerletConstraintsBehavior#resolveDistanceConstraints": { "id": "VerletConstraintsBehavior#resolveDistanceConstraints", "type": "instance method", "signatures": [ { "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ] } ], "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ], "internal": true, "description": "Resolve distance constraints.", "short_description": "Resolve distance constraints.", "line": 330, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "resolveDistanceConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.resolveDistanceConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.resolveDistanceConstraints" }, "VerletConstraintsBehavior#shuffleConstraints": { "id": "VerletConstraintsBehavior#shuffleConstraints", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Mix up the constraints.", "short_description": "Mix up the constraints.", "line": 388, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "shuffleConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.shuffleConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.shuffleConstraints" }, "VerletConstraintsBehavior#resolve": { "id": "VerletConstraintsBehavior#resolve", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Resolve all constraints.", "short_description": "Resolve all constraints.", "line": 399, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "resolve", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.resolve", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.resolve" }, "VerletConstraintsBehavior#getConstraints": { "id": "VerletConstraintsBehavior#getConstraints", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Object" } ] } ], "returns": [ { "type": "Object", "description": " The object containing copied arrays of the constraints\n\n " } ], "description": "Get all constraints.", "short_description": "Get all constraints.", "line": 419, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "getConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.getConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.getConstraints" }, "CircleBody": { "id": "CircleBody", "type": "class", "superclass": "Body", "description": "Physics.body('circle')\n\nThe circle body has a circular shape.\n\nAdditional options include:\n- radius: the radius\n\nExample:\n\n```javascript\nvar round = Physics.body('circle', {\n x: 30,\n y: 20,\n radius: 5\n});\n```", "short_description": "Physics.body('circle')\n", "line": 24, "aliases": [], "children": [], "file": "src/bodies/circle.js", "subclasses": [], "name": "CircleBody", "path": "CircleBody", "outFile": "circle.html" }, "CompoundBody": { "id": "CompoundBody", "type": "class", "superclass": "Body", "description": "Physics.body('compound')\n\nNot a body in itself. It's a container to group other bodies. The position of the body is the center of mass.\nIt must have at least one child before being added to the world.\n\nAdditional config options:\n\n- children: Array of [[Body]] objects.\n\nExample:\n\n```javascript\nvar thing = Physics.body('compound', {\n // place the center of mass at (300, 200)\n x: 300,\n y: 200,\n // the center of mass is automatically calculated and used to position the shape\n children: [\n body1,\n body2,\n // ...\n ]\n});\n```", "short_description": "Physics.body('compound')\n", "line": 32, "aliases": [], "children": [ { "id": "CompoundBody#addChild", "type": "instance method", "signatures": [ { "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The child to add\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The child to add\n\n " } ], "description": "Add a body as a child.", "short_description": "Add a body as a child.", "line": 68, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "addChild", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.addChild", "outFile": "compound.html#CompoundBody.prototype.addChild" }, { "id": "CompoundBody#addChildren", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of children to add\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of children to add\n\n " } ], "description": "Add an array of children to the compound.", "short_description": "Add an array of children to the compound.", "line": 80, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "addChildren", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.addChildren", "outFile": "compound.html#CompoundBody.prototype.addChildren" }, { "id": "CompoundBody#clear", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Remove all children.", "short_description": "Remove all children.", "line": 142, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "clear", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.clear", "outFile": "compound.html#CompoundBody.prototype.clear" }, { "id": "CompoundBody#refreshGeometry", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "If the children's positions change, `refreshGeometry()` should be called to fix the shape.", "short_description": "If the children's positions change, `refreshGeometry()` should be called to fix the shape.", "line": 159, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "refreshGeometry", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.refreshGeometry", "outFile": "compound.html#CompoundBody.prototype.refreshGeometry" } ], "file": "src/bodies/compound.js", "subclasses": [], "name": "CompoundBody", "path": "CompoundBody", "outFile": "compound.html" }, "CompoundBody#addChild": { "id": "CompoundBody#addChild", "type": "instance method", "signatures": [ { "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The child to add\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The child to add\n\n " } ], "description": "Add a body as a child.", "short_description": "Add a body as a child.", "line": 68, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "addChild", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.addChild", "outFile": "compound.html#CompoundBody.prototype.addChild" }, "CompoundBody#addChildren": { "id": "CompoundBody#addChildren", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of children to add\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of children to add\n\n " } ], "description": "Add an array of children to the compound.", "short_description": "Add an array of children to the compound.", "line": 80, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "addChildren", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.addChildren", "outFile": "compound.html#CompoundBody.prototype.addChildren" }, "CompoundBody#clear": { "id": "CompoundBody#clear", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Remove all children.", "short_description": "Remove all children.", "line": 142, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "clear", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.clear", "outFile": "compound.html#CompoundBody.prototype.clear" }, "CompoundBody#refreshGeometry": { "id": "CompoundBody#refreshGeometry", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "If the children's positions change, `refreshGeometry()` should be called to fix the shape.", "short_description": "If the children's positions change, `refreshGeometry()` should be called to fix the shape.", "line": 159, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "refreshGeometry", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.refreshGeometry", "outFile": "compound.html#CompoundBody.prototype.refreshGeometry" }, "ConvexPolygonBody": { "id": "ConvexPolygonBody", "type": "class", "superclass": "Body", "description": "Physics.body('convex-polygon')\n\nBody for convex polygons. The position of the body is the centroid of the polygon.\n\nAdditional config options:\n\n- vertices: Array of [[Vectorish]] objects representing the polygon vertices in clockwise (or counterclockwise) order.\n\nExample:\n\n```javascript\nvar pentagon = Physics.body('convex-polygon', {\n // place the centroid of the polygon at (300, 200)\n x: 300,\n y: 200,\n // the centroid is automatically calculated and used to position the shape\n vertices: [\n { x: 0, y: -30 },\n { x: -29, y: -9 },\n { x: -18, y: 24 },\n { x: 18, y: 24 },\n { x: 29, y: -9 }\n ]\n});\n```", "short_description": "Physics.body('convex-polygon')\n", "line": 33, "aliases": [], "children": [], "file": "src/bodies/convex-polygon.js", "subclasses": [], "name": "ConvexPolygonBody", "path": "ConvexPolygonBody", "outFile": "convex-polygon.html" }, "PointBody": { "id": "PointBody", "type": "class", "superclass": "Body", "alias_of": "Body", "description": "Physics.body('point')\n\nThe point body represents a point.", "short_description": "Physics.body('point')\n", "line": 8, "aliases": [], "children": [], "file": "src/bodies/point.js", "subclasses": [], "name": "PointBody", "path": "PointBody", "outFile": "point.html" }, "RectangleBody": { "id": "RectangleBody", "type": "class", "superclass": "Body", "description": "Physics.body('rectangle')\n\nBody for rectangles. The position of the body is the centroid of the rectangle.\n\nAdditional config options:\n\n- width: The width\n- height: The height\n\nExample:\n\n```javascript\nvar rect = Physics.body('rectangle', {\n // place the centroid of the rectangle at (300, 200)\n x: 300,\n y: 200,\n width: 30,\n height: 40\n});\n```", "short_description": "Physics.body('rectangle')\n", "line": 28, "aliases": [], "children": [], "file": "src/bodies/rectangle.js", "subclasses": [], "name": "RectangleBody", "path": "RectangleBody", "outFile": "rectangle.html" }, "Physics.behavior": { "id": "Physics.behavior", "type": "class method", "signatures": [ { "arguments": [ { "name": "name", "types": [ "String" ], "description": " The name of the behavior to create\n\n " }, { "name": "options", "optional": true, "types": [ "Object" ], "description": " The configuration for that behavior ( depends on behavior ).\n\n Available options and defaults:\n\n \n\n ```javascript\n\n {\n\n priority: 0 // the priority of this body\n\n }\n\n ```\n\n " } ], "returns": [ { "type": "Behavior" } ] } ], "arguments": [ { "name": "name", "types": [ "String" ], "description": " The name of the behavior to create\n\n " }, { "name": "options", "types": [ "Object" ], "description": " The configuration for that behavior ( depends on behavior ).\n\n Available options and defaults:\n\n \n\n ```javascript\n\n {\n\n priority: 0 // the priority of this body\n\n }\n\n ```\n\n " } ], "related_to": "Physics.util.decorator", "description": "Factory function for creating Behaviors.\n\nVisit [the PhysicsJS wiki on Behaviors](https://github.com/wellcaffeinated/PhysicsJS/wiki/Behaviors)\nfor usage documentation.", "short_description": "Factory function for creating Behaviors.\n", "line": 24, "aliases": [], "children": [ { "id": "Behavior", "type": "class", "belongs_to": "Physics.behavior", "description": "The base class for behaviors created by [[Physics.behavior]] factory function.", "short_description": "The base class for behaviors created by [[Physics.behavior]] factory function.", "line": 31, "aliases": [], "children": [ { "id": "Behavior#applyTo", "type": "instance method", "signatures": [ { "arguments": [ { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to apply this behavior to. Specify `true` for all objects in world.\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to apply this behavior to. Specify `true` for all objects in world.\n\n " } ], "description": "Apply the behavior to a group of bodies.", "short_description": "Apply the behavior to a group of bodies.", "line": 66, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "applyTo", "name_prefix": "Behavior#", "path": "Behavior.prototype.applyTo", "outFile": "behavior.html#Behavior.prototype.applyTo" }, { "id": "Behavior#behave", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The pubsub `integrate:positions` event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The pubsub `integrate:positions` event data\n\n " } ], "description": "Default method run on every world integration.\n\nYou _must_ extend this when creating a behavior,\nunless you extend the [[Behavior#connect]] and [[Behavior#disconnect]] methods.", "short_description": "Default method run on every world integration.\n", "line": 151, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "behave", "name_prefix": "Behavior#", "path": "Behavior.prototype.behave", "outFile": "behavior.html#Behavior.prototype.behave" }, { "id": "Behavior#connect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to connect to\n\n " } ] } ], "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to connect to\n\n " } ], "description": "Connect to a world.\n\nExtend this when creating behaviors if you need to specify pubsub management.\nAutomatically called when added to world by the [[Behavior#setWorld]] method.", "short_description": "Connect to a world.\n", "line": 119, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "connect", "name_prefix": "Behavior#", "path": "Behavior.prototype.connect", "outFile": "behavior.html#Behavior.prototype.connect" }, { "id": "Behavior#disconnect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to disconnect from\n\n " } ] } ], "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to disconnect from\n\n " } ], "description": "Disconnect from a world.\n\nExtend this when creating behaviors if you need to specify pubsub management.\nAutomatically called when added to world by the [[Behavior#setWorld]] method.", "short_description": "Disconnect from a world.\n", "line": 135, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "disconnect", "name_prefix": "Behavior#", "path": "Behavior.prototype.disconnect", "outFile": "behavior.html#Behavior.prototype.disconnect" }, { "id": "Behavior#getTargets", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " The array of bodies (by reference!) this behavior is applied to.\n\n " } ], "description": "Get the array of bodies (by reference!) this behavior is applied to.", "short_description": "Get the array of bodies (by reference!) this behavior is applied to.", "line": 82, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "getTargets", "name_prefix": "Behavior#", "path": "Behavior.prototype.getTargets", "outFile": "behavior.html#Behavior.prototype.getTargets" }, { "id": "Behavior#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 38, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "init", "name_prefix": "Behavior#", "path": "Behavior.prototype.init", "outFile": "behavior.html#Behavior.prototype.init" }, { "id": "Behavior#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this instance.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this instance.\n", "line": 56, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "options", "name_prefix": "Behavior#", "path": "Behavior.prototype.options", "outFile": "behavior.html#Behavior.prototype.options" }, { "id": "Behavior#setWorld", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "description": "Set which world to apply to.\n\nUsually this is called internally. Shouldn't be a need to call this yourself usually.", "short_description": "Set which world to apply to.\n", "line": 95, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "setWorld", "name_prefix": "Behavior#", "path": "Behavior.prototype.setWorld", "outFile": "behavior.html#Behavior.prototype.setWorld" }, { "id": "AttractorBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('attractor')`.\n\nAttractor behavior attracts bodies to a specific point.\n\nAdditional options include:\n- pos: The position of the attraction point\n- strength: How strong the attraction is (default: `1`)\n- order: The power of the inverse distance (default: `2` because that is newtonian gravity... inverse square)\n- max: The maximum distance in which to apply the attraction (default: Infinity)\n- min: The minimum distance above which to apply the attraction (default: very small non-zero)", "short_description": "`Physics.behavior('attractor')`.\n", "line": 15, "aliases": [], "children": [ { "id": "AttractorBehavior#position", "type": "instance method", "signatures": [ { "arguments": [ { "name": "pos", "optional": true, "types": [ "Vectorish" ], "description": " The position to set\n\n " } ], "returns": [ { "type": "Object", "description": " Returns the [[Vectorish]] position if no arguments provided\n\n " }, { "type": "this", "description": " For chaining\n\n " } ] } ], "arguments": [ { "name": "pos", "types": [ "Vectorish" ], "description": " The position to set\n\n " } ], "returns": [ { "type": "Object", "description": " Returns the [[Vectorish]] position if no arguments provided\n\n " }, { "type": "this", "description": " For chaining\n\n " } ], "description": "Get or set the position of the attractor.", "short_description": "Get or set the position of the attractor.", "line": 56, "aliases": [], "children": [], "file": "src/behaviors/attractor.js", "name": "position", "name_prefix": "AttractorBehavior#", "path": "AttractorBehavior.prototype.position", "outFile": "attractor.html#AttractorBehavior.prototype.position" } ], "file": "src/behaviors/attractor.js", "subclasses": [], "name": "AttractorBehavior", "path": "AttractorBehavior", "outFile": "attractor.html" }, { "id": "BodyCollisionDetectionBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('body-collision-detection')`.\n\nDetect collisions of bodies.\n\nPublishes collision events to the world as a group of detected collisions per iteration.\n\nThe event data will have a `.collisions` property that is an array of collisions of the form:\n\n```javascript\n{\n bodyA: // the first body\n bodyB: // the second body\n norm: // the normal vector (Vectorish)\n mtv: // the minimum transit vector. (the direction and length needed to extract bodyB from bodyA)\n pos: // the collision point relative to bodyA\n overlap: // the amount bodyA overlaps bodyB\n}\n```\n\nAdditional options include:\n- check: channel to listen to for collision candidates (default: `collisions:candidates`). set to `true` to force check every pair of bodies in the world\n- channel: channel to publish events to (default: `collisions:detected`)", "short_description": "`Physics.behavior('body-collision-detection')`.\n", "line": 27, "aliases": [], "children": [ { "id": "BodyCollisionDetectionBehavior#check", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ], "internal": true, "description": "Event callback to check pairs of objects that have been flagged by broad phase for possible collisions.", "short_description": "Event callback to check pairs of objects that have been flagged by broad phase for possible collisions.", "line": 366, "aliases": [], "children": [], "file": "src/behaviors/body-collision-detection.js", "name": "check", "name_prefix": "BodyCollisionDetectionBehavior#", "path": "BodyCollisionDetectionBehavior.prototype.check", "outFile": "body-collision-detection.html#BodyCollisionDetectionBehavior.prototype.check" }, { "id": "BodyCollisionDetectionBehavior#checkAll", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ], "internal": true, "description": "Event callback to check all pairs of objects in the list for collisions", "short_description": "Event callback to check all pairs of objects in the list for collisions", "line": 428, "aliases": [], "children": [], "file": "src/behaviors/body-collision-detection.js", "name": "checkAll", "name_prefix": "BodyCollisionDetectionBehavior#", "path": "BodyCollisionDetectionBehavior.prototype.checkAll", "outFile": "body-collision-detection.html#BodyCollisionDetectionBehavior.prototype.checkAll" } ], "file": "src/behaviors/body-collision-detection.js", "subclasses": [], "name": "BodyCollisionDetectionBehavior", "path": "BodyCollisionDetectionBehavior", "outFile": "body-collision-detection.html" }, { "id": "BodyImpulseResponseBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('body-impulse-response')`.\n\nResponds to collisions by applying impulses.\n\nAdditional options include:\n- check: channel to listen to for collisions (default: `collisions:detected`).\n- mtvThreshold: apply partial extraction of bodies if the minimum transit vector is less than this value ( default: `1`)\n this will depend on your simulation characteristic length scale\n- bodyExtractDropoff: every body overlap correction (underneith mtvThreshold) will only extract by this fraction (0..1). Helps with stablizing contacts. (default: `0.5`)\n- forceWakeupAboveOverlapThreshold: force bodies to wake up if the overlap is above mtvThreshold ( default: `true` )", "short_description": "`Physics.behavior('body-impulse-response')`.\n", "line": 15, "aliases": [], "children": [ { "id": "BodyImpulseResponseBehavior#collideBodes", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodyA", "types": [ "Object" ], "description": " First Body\n\n " }, { "name": "bodyB", "types": [ "Object" ], "description": " Second body\n\n " }, { "name": "normal", "types": [ "Vector" ], "description": " Normal vector of the collision surface\n\n " }, { "name": "point", "types": [ "Vector" ], "description": " Contact point of the collision\n\n " }, { "name": "mtrans", "types": [ "Vector" ], "description": " Minimum transit vector that is the smallest displacement to separate the bodies\n\n " }, { "name": "contact", "types": [ "Boolean" ], "description": " Are the bodies in resting contact relative to each other\n\n " } ] } ], "arguments": [ { "name": "bodyA", "types": [ "Object" ], "description": " First Body\n\n " }, { "name": "bodyB", "types": [ "Object" ], "description": " Second body\n\n " }, { "name": "normal", "types": [ "Vector" ], "description": " Normal vector of the collision surface\n\n " }, { "name": "point", "types": [ "Vector" ], "description": " Contact point of the collision\n\n " }, { "name": "mtrans", "types": [ "Vector" ], "description": " Minimum transit vector that is the smallest displacement to separate the bodies\n\n " }, { "name": "contact", "types": [ "Boolean" ], "description": " Are the bodies in resting contact relative to each other\n\n " } ], "internal": true, "description": "Collide two bodies by modifying their positions and velocities to conserve momentum", "short_description": "Collide two bodies by modifying their positions and velocities to conserve momentum", "line": 88, "aliases": [], "children": [], "file": "src/behaviors/body-impulse-response.js", "name": "collideBodes", "name_prefix": "BodyImpulseResponseBehavior#", "path": "BodyImpulseResponseBehavior.prototype.collideBodes", "outFile": "body-impulse-response.html#BodyImpulseResponseBehavior.prototype.collideBodes" }, { "id": "BodyImpulseResponseBehavior#respond", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " event data\n\n " } ], "internal": true, "description": "Event callback to respond to collision data.", "short_description": "Event callback to respond to collision data.", "line": 281, "aliases": [], "children": [], "file": "src/behaviors/body-impulse-response.js", "name": "respond", "name_prefix": "BodyImpulseResponseBehavior#", "path": "BodyImpulseResponseBehavior.prototype.respond", "outFile": "body-impulse-response.html#BodyImpulseResponseBehavior.prototype.respond" } ], "file": "src/behaviors/body-impulse-response.js", "subclasses": [], "name": "BodyImpulseResponseBehavior", "path": "BodyImpulseResponseBehavior", "outFile": "body-impulse-response.html" }, { "id": "ConstantAccelerationBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('constant-acceleration')`.\n\nConstant acceleration behavior.\n\nBasically the \"gravity\" behavior. Used to give \"earth-like gravity\" to the world.\n\nAdditional options include:\n- acc: The acceleration vector (Vectorish). (default: `{ x: 0, y: 0.0004 }`)", "short_description": "`Physics.behavior('constant-acceleration')`.\n", "line": 13, "aliases": [], "children": [ { "id": "ConstantAccelerationBehavior#setAcceleration", "type": "instance method", "signatures": [ { "arguments": [ { "name": "acc", "types": [ "Vectorish" ], "description": " The acceleration vector\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "acc", "types": [ "Vectorish" ], "description": " The acceleration vector\n\n " } ], "description": "Set the acceleration of the behavior.", "short_description": "Set the acceleration of the behavior.", "line": 41, "aliases": [], "children": [], "file": "src/behaviors/constant-acceleration.js", "name": "setAcceleration", "name_prefix": "ConstantAccelerationBehavior#", "path": "ConstantAccelerationBehavior.prototype.setAcceleration", "outFile": "constant-acceleration.html#ConstantAccelerationBehavior.prototype.setAcceleration" } ], "file": "src/behaviors/constant-acceleration.js", "subclasses": [], "name": "ConstantAccelerationBehavior", "path": "ConstantAccelerationBehavior", "outFile": "constant-acceleration.html" }, { "id": "EdgeCollisionDetectionBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('edge-collision-detection')`.\n\nUsed to detect collisions with the boundaries of an AABB.\n\nAdditional options include:\n- aabb: The [[Physics.aabb]] bounds to use as the constraining boundary\n- restitution: The restitution of the boundary walls (default: `0.99`)\n- cof: The coefficient of friction of the boundary walls (default: `1`)\n- channel: The channel to publish collisions to. (default: 'collisions:detected')", "short_description": "`Physics.behavior('edge-collision-detection')`.\n", "line": 14, "aliases": [], "children": [ { "id": "EdgeCollisionDetectionBehavior#checkAll", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to check all bodies for collisions with the edge", "short_description": "Event callback to check all bodies for collisions with the edge", "line": 227, "aliases": [], "children": [], "file": "src/behaviors/edge-collision-detection.js", "name": "checkAll", "name_prefix": "EdgeCollisionDetectionBehavior#", "path": "EdgeCollisionDetectionBehavior.prototype.checkAll", "outFile": "edge-collision-detection.html#EdgeCollisionDetectionBehavior.prototype.checkAll" }, { "id": "EdgeCollisionDetectionBehavior#setAABB", "type": "instance method", "signatures": [ { "arguments": [ { "name": "aabb", "types": [ "Physics.aabb" ], "description": " The aabb to use as the boundary\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "aabb", "types": [ "Physics.aabb" ], "description": " The aabb to use as the boundary\n\n " } ], "description": "Set the boundaries of the edge.", "short_description": "Set the boundaries of the edge.", "line": 189, "aliases": [], "children": [], "file": "src/behaviors/edge-collision-detection.js", "name": "setAABB", "name_prefix": "EdgeCollisionDetectionBehavior#", "path": "EdgeCollisionDetectionBehavior.prototype.setAABB", "outFile": "edge-collision-detection.html#EdgeCollisionDetectionBehavior.prototype.setAABB" } ], "file": "src/behaviors/edge-collision-detection.js", "subclasses": [], "name": "EdgeCollisionDetectionBehavior", "path": "EdgeCollisionDetectionBehavior", "outFile": "edge-collision-detection.html" }, { "id": "InteractiveBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('interactive')`.\n\nUser interaction helper.\n\nUsed to get mouse/touch events and add grab interactions.\n\nAdditional options include:\n- el: The element of the renderer. What you input as the `el` for the renderer.\n- moveThrottle: The min time between move events (default: `10`).\n- minVel: The minimum velocity clamp [[Vectorish]] (default: { x: -5, y: -5 }) to restrict velocity a user can give to a body\n- maxVel: The maximum velocity clamp [[Vectorish]] (default: { x: 5, y: 5 }) to restrict velocity a user can give to a body\n\nThe behavior also triggers the following events on the world:\n```javascript\n// a body has been grabbed\nworld.on('interact:grab', function( data ){\n data.x; // the x coord\n data.y; // the y coord\n data.body; // the body that was grabbed\n});\n// no body was grabbed, but the renderer area was clicked, or touched\nworld.on('interact:poke', function( data ){\n data.x; // the x coord\n data.y; // the y coord\n});\n// when a mouse or pointer moves\nworld.on('interact:move', function( data ){\n data.x; // the x coord\n data.y; // the y coord\n data.body; // the grabbed body that was moved (if applicable)\n});\n// when the viewport is released (mouseup, touchend)\nworld.on('interact:release', function( data ){\n data.x; // the x coord\n data.y; // the y coord\n data.body; // the body that was grabbed (if applicable)\n});\n```\n\nThe behavior also sets body.isGrabbed = true for any grabbed bodies while they are grabbed.", "short_description": "`Physics.behavior('interactive')`.\n", "line": 45, "aliases": [], "children": [], "file": "src/behaviors/interactive.js", "subclasses": [], "name": "InteractiveBehavior", "path": "InteractiveBehavior", "outFile": "interactive.html" }, { "id": "NewtonianBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('newtonian')`.\n\nNewtonian attraction between bodies (inverse square law).\n\nAdditional options include:\n- strength: The strength of the interaction between bodies. (default: `1`)\n- max: The maximum distance between bodies at which to apply the behavior. (default: `false`... infinite)\n- min: The minimum distance between bodies at which to apply the behavior. (default: `false`... autocalculate)", "short_description": "`Physics.behavior('newtonian')`.\n", "line": 13, "aliases": [], "children": [], "file": "src/behaviors/newtonian.js", "subclasses": [], "name": "NewtonianBehavior", "path": "NewtonianBehavior", "outFile": "newtonian.html" }, { "id": "SweepPruneBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('sweep-prune')`.\n\nSweep and Prune implementation for broad phase collision detection.\n\nThis massively improves the speed of collision detection. It's set up to always be used with [[BodyCollisionDetection]], and [[BodyImpulseResponse]].\n\nAdditional options include:\n- channel: The channel to publish collision candidates to. (default: `collisions:candidates`)", "short_description": "`Physics.behavior('sweep-prune')`.\n", "line": 13, "aliases": [], "children": [ { "id": "SweepPruneBehavior#broadPhase", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " The candidate data of overlapping aabbs\n\n " } ], "internal": true, "description": "Execute the broad phase and get candidate collisions", "short_description": "Execute the broad phase and get candidate collisions", "line": 95, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "broadPhase", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.broadPhase", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.broadPhase" }, { "id": "SweepPruneBehavior#checkOverlaps", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " List of candidate collisions\n\n " } ], "internal": true, "description": "Check each axis for overlaps of bodies AABBs", "short_description": "Check each axis for overlaps of bodies AABBs", "line": 257, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "checkOverlaps", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.checkOverlaps", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.checkOverlaps" }, { "id": "SweepPruneBehavior#clear", "type": "instance method", "signatures": [ { "arguments": [] } ], "description": "Refresh tracking data", "short_description": "Refresh tracking data", "line": 52, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "clear", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.clear", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.clear" }, { "id": "SweepPruneBehavior#getPair", "type": "instance method", "signatures": [ { "arguments": [ { "name": "tr1", "types": [ "Object" ], "description": " First tracker\n\n " }, { "name": "tr2", "types": [ "Object" ], "description": " Second tracker\n\n " }, { "name": "doCreate", "types": [ "Boolean" ], "description": " Create if not found\n\n " } ], "returns": [ { "type": "Object", "description": " Pair object or null if not found\n\n " } ] } ], "arguments": [ { "name": "tr1", "types": [ "Object" ], "description": " First tracker\n\n " }, { "name": "tr2", "types": [ "Object" ], "description": " Second tracker\n\n " }, { "name": "doCreate", "types": [ "Boolean" ], "description": " Create if not found\n\n " } ], "returns": [ { "type": "Object", "description": " Pair object or null if not found\n\n " } ], "internal": true, "description": "Get a pair object for the tracker objects", "short_description": "Get a pair object for the tracker objects", "line": 181, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "getPair", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.getPair", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.getPair" }, { "id": "SweepPruneBehavior#sortIntervalLists", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Simple insertion sort for each axis", "short_description": "Simple insertion sort for each axis", "line": 112, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "sortIntervalLists", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.sortIntervalLists", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.sortIntervalLists" }, { "id": "SweepPruneBehavior#sweep", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to sweep and publish event if any candidate collisions are found", "short_description": "Event callback to sweep and publish event if any candidate collisions are found", "line": 487, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "sweep", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.sweep", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.sweep" }, { "id": "SweepPruneBehavior#trackBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to add body to list of those tracked by sweep and prune", "short_description": "Event callback to add body to list of those tracked by sweep and prune", "line": 393, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "trackBody", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.trackBody", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.trackBody" }, { "id": "SweepPruneBehavior#untrackBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to remove body from list of those tracked", "short_description": "Event callback to remove body from list of those tracked", "line": 432, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "untrackBody", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.untrackBody", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.untrackBody" }, { "id": "SweepPruneBehavior#updateIntervals", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Update position intervals on each axis", "short_description": "Update position intervals on each axis", "line": 364, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "updateIntervals", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.updateIntervals", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.updateIntervals" } ], "file": "src/behaviors/sweep-prune.js", "subclasses": [], "name": "SweepPruneBehavior", "path": "SweepPruneBehavior", "outFile": "sweep-prune.html" }, { "id": "VerletConstraintsBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('verlet-constraints')`.\n\nVerlet constraints manager.\n\nHandles distance constraints, and angle constraints\n\nAdditional options include:\n- iterations: The number of iterations to take to relax the constraints. (default: `2`)", "short_description": "`Physics.behavior('verlet-constraints')`.\n", "line": 13, "aliases": [], "children": [ { "id": "VerletConstraintsBehavior#angleConstraint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "bodyC", "types": [ "Body" ], "description": " Third body\n\n " }, { "name": "stiffness", "optional": true, "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetAngle", "optional": true, "types": [ "Number" ], "description": " Target angle. Defaults to the current angle between bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ] } ], "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "bodyC", "types": [ "Body" ], "description": " Third body\n\n " }, { "name": "stiffness", "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetAngle", "types": [ "Number" ], "description": " Target angle. Defaults to the current angle between bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ], "description": "Constrain three bodies to a target relative angle\n\nReturns constraint data that can be used to remove the constraint later.\n\n- `.bodyA`, `.bodyB`, and `.bodyC` are references to the bodies\n- `.type` is the type of constraint\n- `.id` is the string ID of the constraint\n- `.stiffness` is the stiffness\n- `.targetAngle` is the target angle", "short_description": "Constrain three bodies to a target relative angle\n", "line": 129, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "angleConstraint", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.angleConstraint", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.angleConstraint" }, { "id": "VerletConstraintsBehavior#distanceConstraint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "stiffness", "optional": true, "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetLength", "optional": true, "types": [ "Number" ], "description": " Target length. defaults to current distance between the bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ] } ], "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "stiffness", "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetLength", "types": [ "Number" ], "description": " Target length. defaults to current distance between the bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ], "description": "Constrain two bodies to a target relative distance.\n\nReturns constraint data that can be used to remove the constraint later.\n\n- `.bodyA` and `.bodyB` are references to the bodies\n- `.type` is the type of constraint\n- `.id` is the string ID of the constraint\n- `.stiffness` is the stiffness\n- `.targetLength` is the target length", "short_description": "Constrain two bodies to a target relative distance.\n", "line": 86, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "distanceConstraint", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.distanceConstraint", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.distanceConstraint" }, { "id": "VerletConstraintsBehavior#drop", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Remove all constraints", "short_description": "Remove all constraints", "line": 60, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "drop", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.drop", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.drop" }, { "id": "VerletConstraintsBehavior#getConstraints", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Object" } ] } ], "returns": [ { "type": "Object", "description": " The object containing copied arrays of the constraints\n\n " } ], "description": "Get all constraints.", "short_description": "Get all constraints.", "line": 419, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "getConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.getConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.getConstraints" }, { "id": "VerletConstraintsBehavior#remove", "type": "instance method", "signatures": [ { "arguments": [ { "name": "constraintData", "types": [ "Object" ], "description": " The constraint data returned when creating a constraint\n\n " } ], "returns": [ { "type": "this" } ] }, { "arguments": [ { "name": "constraintId", "types": [ "String" ], "description": " The constraint id\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "constraintData", "types": [ "Object" ], "description": " The constraint data returned when creating a constraint\n\n " }, { "name": "constraintId", "types": [ "String" ], "description": " The constraint id\n\n " } ], "description": "Remove a constraint", "short_description": "Remove a constraint", "line": 160, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "remove", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.remove", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.remove" }, { "id": "VerletConstraintsBehavior#resolve", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Resolve all constraints.", "short_description": "Resolve all constraints.", "line": 399, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "resolve", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.resolve", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.resolve" }, { "id": "VerletConstraintsBehavior#resolveAngleConstraints", "type": "instance method", "signatures": [ { "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ] } ], "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ], "internal": true, "description": "Resolve angle constraints.", "short_description": "Resolve angle constraints.", "line": 205, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "resolveAngleConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.resolveAngleConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.resolveAngleConstraints" }, { "id": "VerletConstraintsBehavior#resolveDistanceConstraints", "type": "instance method", "signatures": [ { "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ] } ], "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ], "internal": true, "description": "Resolve distance constraints.", "short_description": "Resolve distance constraints.", "line": 330, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "resolveDistanceConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.resolveDistanceConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.resolveDistanceConstraints" }, { "id": "VerletConstraintsBehavior#shuffleConstraints", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Mix up the constraints.", "short_description": "Mix up the constraints.", "line": 388, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "shuffleConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.shuffleConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.shuffleConstraints" } ], "file": "src/behaviors/verlet-constraints.js", "subclasses": [], "name": "VerletConstraintsBehavior", "path": "VerletConstraintsBehavior", "outFile": "verlet-constraints.html" } ], "file": "src/core/behavior.js", "subclasses": [ "AttractorBehavior", "BodyCollisionDetectionBehavior", "BodyImpulseResponseBehavior", "ConstantAccelerationBehavior", "EdgeCollisionDetectionBehavior", "InteractiveBehavior", "NewtonianBehavior", "SweepPruneBehavior", "VerletConstraintsBehavior" ], "name": "Behavior", "path": "Behavior", "outFile": "behavior.html" } ], "file": "src/core/behavior.js", "name": "behavior", "name_prefix": "Physics.", "path": "Physics.behavior", "outFile": "behavior.html#Physics.behavior" }, "Behavior": { "id": "Behavior", "type": "class", "belongs_to": "Physics.behavior", "description": "The base class for behaviors created by [[Physics.behavior]] factory function.", "short_description": "The base class for behaviors created by [[Physics.behavior]] factory function.", "line": 31, "aliases": [], "children": [ { "id": "Behavior#applyTo", "type": "instance method", "signatures": [ { "arguments": [ { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to apply this behavior to. Specify `true` for all objects in world.\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to apply this behavior to. Specify `true` for all objects in world.\n\n " } ], "description": "Apply the behavior to a group of bodies.", "short_description": "Apply the behavior to a group of bodies.", "line": 66, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "applyTo", "name_prefix": "Behavior#", "path": "Behavior.prototype.applyTo", "outFile": "behavior.html#Behavior.prototype.applyTo" }, { "id": "Behavior#behave", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The pubsub `integrate:positions` event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The pubsub `integrate:positions` event data\n\n " } ], "description": "Default method run on every world integration.\n\nYou _must_ extend this when creating a behavior,\nunless you extend the [[Behavior#connect]] and [[Behavior#disconnect]] methods.", "short_description": "Default method run on every world integration.\n", "line": 151, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "behave", "name_prefix": "Behavior#", "path": "Behavior.prototype.behave", "outFile": "behavior.html#Behavior.prototype.behave" }, { "id": "Behavior#connect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to connect to\n\n " } ] } ], "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to connect to\n\n " } ], "description": "Connect to a world.\n\nExtend this when creating behaviors if you need to specify pubsub management.\nAutomatically called when added to world by the [[Behavior#setWorld]] method.", "short_description": "Connect to a world.\n", "line": 119, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "connect", "name_prefix": "Behavior#", "path": "Behavior.prototype.connect", "outFile": "behavior.html#Behavior.prototype.connect" }, { "id": "Behavior#disconnect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to disconnect from\n\n " } ] } ], "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to disconnect from\n\n " } ], "description": "Disconnect from a world.\n\nExtend this when creating behaviors if you need to specify pubsub management.\nAutomatically called when added to world by the [[Behavior#setWorld]] method.", "short_description": "Disconnect from a world.\n", "line": 135, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "disconnect", "name_prefix": "Behavior#", "path": "Behavior.prototype.disconnect", "outFile": "behavior.html#Behavior.prototype.disconnect" }, { "id": "Behavior#getTargets", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " The array of bodies (by reference!) this behavior is applied to.\n\n " } ], "description": "Get the array of bodies (by reference!) this behavior is applied to.", "short_description": "Get the array of bodies (by reference!) this behavior is applied to.", "line": 82, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "getTargets", "name_prefix": "Behavior#", "path": "Behavior.prototype.getTargets", "outFile": "behavior.html#Behavior.prototype.getTargets" }, { "id": "Behavior#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 38, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "init", "name_prefix": "Behavior#", "path": "Behavior.prototype.init", "outFile": "behavior.html#Behavior.prototype.init" }, { "id": "Behavior#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this instance.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this instance.\n", "line": 56, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "options", "name_prefix": "Behavior#", "path": "Behavior.prototype.options", "outFile": "behavior.html#Behavior.prototype.options" }, { "id": "Behavior#setWorld", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "description": "Set which world to apply to.\n\nUsually this is called internally. Shouldn't be a need to call this yourself usually.", "short_description": "Set which world to apply to.\n", "line": 95, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "setWorld", "name_prefix": "Behavior#", "path": "Behavior.prototype.setWorld", "outFile": "behavior.html#Behavior.prototype.setWorld" }, { "id": "AttractorBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('attractor')`.\n\nAttractor behavior attracts bodies to a specific point.\n\nAdditional options include:\n- pos: The position of the attraction point\n- strength: How strong the attraction is (default: `1`)\n- order: The power of the inverse distance (default: `2` because that is newtonian gravity... inverse square)\n- max: The maximum distance in which to apply the attraction (default: Infinity)\n- min: The minimum distance above which to apply the attraction (default: very small non-zero)", "short_description": "`Physics.behavior('attractor')`.\n", "line": 15, "aliases": [], "children": [ { "id": "AttractorBehavior#position", "type": "instance method", "signatures": [ { "arguments": [ { "name": "pos", "optional": true, "types": [ "Vectorish" ], "description": " The position to set\n\n " } ], "returns": [ { "type": "Object", "description": " Returns the [[Vectorish]] position if no arguments provided\n\n " }, { "type": "this", "description": " For chaining\n\n " } ] } ], "arguments": [ { "name": "pos", "types": [ "Vectorish" ], "description": " The position to set\n\n " } ], "returns": [ { "type": "Object", "description": " Returns the [[Vectorish]] position if no arguments provided\n\n " }, { "type": "this", "description": " For chaining\n\n " } ], "description": "Get or set the position of the attractor.", "short_description": "Get or set the position of the attractor.", "line": 56, "aliases": [], "children": [], "file": "src/behaviors/attractor.js", "name": "position", "name_prefix": "AttractorBehavior#", "path": "AttractorBehavior.prototype.position", "outFile": "attractor.html#AttractorBehavior.prototype.position" } ], "file": "src/behaviors/attractor.js", "subclasses": [], "name": "AttractorBehavior", "path": "AttractorBehavior", "outFile": "attractor.html" }, { "id": "BodyCollisionDetectionBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('body-collision-detection')`.\n\nDetect collisions of bodies.\n\nPublishes collision events to the world as a group of detected collisions per iteration.\n\nThe event data will have a `.collisions` property that is an array of collisions of the form:\n\n```javascript\n{\n bodyA: // the first body\n bodyB: // the second body\n norm: // the normal vector (Vectorish)\n mtv: // the minimum transit vector. (the direction and length needed to extract bodyB from bodyA)\n pos: // the collision point relative to bodyA\n overlap: // the amount bodyA overlaps bodyB\n}\n```\n\nAdditional options include:\n- check: channel to listen to for collision candidates (default: `collisions:candidates`). set to `true` to force check every pair of bodies in the world\n- channel: channel to publish events to (default: `collisions:detected`)", "short_description": "`Physics.behavior('body-collision-detection')`.\n", "line": 27, "aliases": [], "children": [ { "id": "BodyCollisionDetectionBehavior#check", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ], "internal": true, "description": "Event callback to check pairs of objects that have been flagged by broad phase for possible collisions.", "short_description": "Event callback to check pairs of objects that have been flagged by broad phase for possible collisions.", "line": 366, "aliases": [], "children": [], "file": "src/behaviors/body-collision-detection.js", "name": "check", "name_prefix": "BodyCollisionDetectionBehavior#", "path": "BodyCollisionDetectionBehavior.prototype.check", "outFile": "body-collision-detection.html#BodyCollisionDetectionBehavior.prototype.check" }, { "id": "BodyCollisionDetectionBehavior#checkAll", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The event data\n\n " } ], "internal": true, "description": "Event callback to check all pairs of objects in the list for collisions", "short_description": "Event callback to check all pairs of objects in the list for collisions", "line": 428, "aliases": [], "children": [], "file": "src/behaviors/body-collision-detection.js", "name": "checkAll", "name_prefix": "BodyCollisionDetectionBehavior#", "path": "BodyCollisionDetectionBehavior.prototype.checkAll", "outFile": "body-collision-detection.html#BodyCollisionDetectionBehavior.prototype.checkAll" } ], "file": "src/behaviors/body-collision-detection.js", "subclasses": [], "name": "BodyCollisionDetectionBehavior", "path": "BodyCollisionDetectionBehavior", "outFile": "body-collision-detection.html" }, { "id": "BodyImpulseResponseBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('body-impulse-response')`.\n\nResponds to collisions by applying impulses.\n\nAdditional options include:\n- check: channel to listen to for collisions (default: `collisions:detected`).\n- mtvThreshold: apply partial extraction of bodies if the minimum transit vector is less than this value ( default: `1`)\n this will depend on your simulation characteristic length scale\n- bodyExtractDropoff: every body overlap correction (underneith mtvThreshold) will only extract by this fraction (0..1). Helps with stablizing contacts. (default: `0.5`)\n- forceWakeupAboveOverlapThreshold: force bodies to wake up if the overlap is above mtvThreshold ( default: `true` )", "short_description": "`Physics.behavior('body-impulse-response')`.\n", "line": 15, "aliases": [], "children": [ { "id": "BodyImpulseResponseBehavior#collideBodes", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodyA", "types": [ "Object" ], "description": " First Body\n\n " }, { "name": "bodyB", "types": [ "Object" ], "description": " Second body\n\n " }, { "name": "normal", "types": [ "Vector" ], "description": " Normal vector of the collision surface\n\n " }, { "name": "point", "types": [ "Vector" ], "description": " Contact point of the collision\n\n " }, { "name": "mtrans", "types": [ "Vector" ], "description": " Minimum transit vector that is the smallest displacement to separate the bodies\n\n " }, { "name": "contact", "types": [ "Boolean" ], "description": " Are the bodies in resting contact relative to each other\n\n " } ] } ], "arguments": [ { "name": "bodyA", "types": [ "Object" ], "description": " First Body\n\n " }, { "name": "bodyB", "types": [ "Object" ], "description": " Second body\n\n " }, { "name": "normal", "types": [ "Vector" ], "description": " Normal vector of the collision surface\n\n " }, { "name": "point", "types": [ "Vector" ], "description": " Contact point of the collision\n\n " }, { "name": "mtrans", "types": [ "Vector" ], "description": " Minimum transit vector that is the smallest displacement to separate the bodies\n\n " }, { "name": "contact", "types": [ "Boolean" ], "description": " Are the bodies in resting contact relative to each other\n\n " } ], "internal": true, "description": "Collide two bodies by modifying their positions and velocities to conserve momentum", "short_description": "Collide two bodies by modifying their positions and velocities to conserve momentum", "line": 88, "aliases": [], "children": [], "file": "src/behaviors/body-impulse-response.js", "name": "collideBodes", "name_prefix": "BodyImpulseResponseBehavior#", "path": "BodyImpulseResponseBehavior.prototype.collideBodes", "outFile": "body-impulse-response.html#BodyImpulseResponseBehavior.prototype.collideBodes" }, { "id": "BodyImpulseResponseBehavior#respond", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " event data\n\n " } ], "internal": true, "description": "Event callback to respond to collision data.", "short_description": "Event callback to respond to collision data.", "line": 281, "aliases": [], "children": [], "file": "src/behaviors/body-impulse-response.js", "name": "respond", "name_prefix": "BodyImpulseResponseBehavior#", "path": "BodyImpulseResponseBehavior.prototype.respond", "outFile": "body-impulse-response.html#BodyImpulseResponseBehavior.prototype.respond" } ], "file": "src/behaviors/body-impulse-response.js", "subclasses": [], "name": "BodyImpulseResponseBehavior", "path": "BodyImpulseResponseBehavior", "outFile": "body-impulse-response.html" }, { "id": "ConstantAccelerationBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('constant-acceleration')`.\n\nConstant acceleration behavior.\n\nBasically the \"gravity\" behavior. Used to give \"earth-like gravity\" to the world.\n\nAdditional options include:\n- acc: The acceleration vector (Vectorish). (default: `{ x: 0, y: 0.0004 }`)", "short_description": "`Physics.behavior('constant-acceleration')`.\n", "line": 13, "aliases": [], "children": [ { "id": "ConstantAccelerationBehavior#setAcceleration", "type": "instance method", "signatures": [ { "arguments": [ { "name": "acc", "types": [ "Vectorish" ], "description": " The acceleration vector\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "acc", "types": [ "Vectorish" ], "description": " The acceleration vector\n\n " } ], "description": "Set the acceleration of the behavior.", "short_description": "Set the acceleration of the behavior.", "line": 41, "aliases": [], "children": [], "file": "src/behaviors/constant-acceleration.js", "name": "setAcceleration", "name_prefix": "ConstantAccelerationBehavior#", "path": "ConstantAccelerationBehavior.prototype.setAcceleration", "outFile": "constant-acceleration.html#ConstantAccelerationBehavior.prototype.setAcceleration" } ], "file": "src/behaviors/constant-acceleration.js", "subclasses": [], "name": "ConstantAccelerationBehavior", "path": "ConstantAccelerationBehavior", "outFile": "constant-acceleration.html" }, { "id": "EdgeCollisionDetectionBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('edge-collision-detection')`.\n\nUsed to detect collisions with the boundaries of an AABB.\n\nAdditional options include:\n- aabb: The [[Physics.aabb]] bounds to use as the constraining boundary\n- restitution: The restitution of the boundary walls (default: `0.99`)\n- cof: The coefficient of friction of the boundary walls (default: `1`)\n- channel: The channel to publish collisions to. (default: 'collisions:detected')", "short_description": "`Physics.behavior('edge-collision-detection')`.\n", "line": 14, "aliases": [], "children": [ { "id": "EdgeCollisionDetectionBehavior#checkAll", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to check all bodies for collisions with the edge", "short_description": "Event callback to check all bodies for collisions with the edge", "line": 227, "aliases": [], "children": [], "file": "src/behaviors/edge-collision-detection.js", "name": "checkAll", "name_prefix": "EdgeCollisionDetectionBehavior#", "path": "EdgeCollisionDetectionBehavior.prototype.checkAll", "outFile": "edge-collision-detection.html#EdgeCollisionDetectionBehavior.prototype.checkAll" }, { "id": "EdgeCollisionDetectionBehavior#setAABB", "type": "instance method", "signatures": [ { "arguments": [ { "name": "aabb", "types": [ "Physics.aabb" ], "description": " The aabb to use as the boundary\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "aabb", "types": [ "Physics.aabb" ], "description": " The aabb to use as the boundary\n\n " } ], "description": "Set the boundaries of the edge.", "short_description": "Set the boundaries of the edge.", "line": 189, "aliases": [], "children": [], "file": "src/behaviors/edge-collision-detection.js", "name": "setAABB", "name_prefix": "EdgeCollisionDetectionBehavior#", "path": "EdgeCollisionDetectionBehavior.prototype.setAABB", "outFile": "edge-collision-detection.html#EdgeCollisionDetectionBehavior.prototype.setAABB" } ], "file": "src/behaviors/edge-collision-detection.js", "subclasses": [], "name": "EdgeCollisionDetectionBehavior", "path": "EdgeCollisionDetectionBehavior", "outFile": "edge-collision-detection.html" }, { "id": "InteractiveBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('interactive')`.\n\nUser interaction helper.\n\nUsed to get mouse/touch events and add grab interactions.\n\nAdditional options include:\n- el: The element of the renderer. What you input as the `el` for the renderer.\n- moveThrottle: The min time between move events (default: `10`).\n- minVel: The minimum velocity clamp [[Vectorish]] (default: { x: -5, y: -5 }) to restrict velocity a user can give to a body\n- maxVel: The maximum velocity clamp [[Vectorish]] (default: { x: 5, y: 5 }) to restrict velocity a user can give to a body\n\nThe behavior also triggers the following events on the world:\n```javascript\n// a body has been grabbed\nworld.on('interact:grab', function( data ){\n data.x; // the x coord\n data.y; // the y coord\n data.body; // the body that was grabbed\n});\n// no body was grabbed, but the renderer area was clicked, or touched\nworld.on('interact:poke', function( data ){\n data.x; // the x coord\n data.y; // the y coord\n});\n// when a mouse or pointer moves\nworld.on('interact:move', function( data ){\n data.x; // the x coord\n data.y; // the y coord\n data.body; // the grabbed body that was moved (if applicable)\n});\n// when the viewport is released (mouseup, touchend)\nworld.on('interact:release', function( data ){\n data.x; // the x coord\n data.y; // the y coord\n data.body; // the body that was grabbed (if applicable)\n});\n```\n\nThe behavior also sets body.isGrabbed = true for any grabbed bodies while they are grabbed.", "short_description": "`Physics.behavior('interactive')`.\n", "line": 45, "aliases": [], "children": [], "file": "src/behaviors/interactive.js", "subclasses": [], "name": "InteractiveBehavior", "path": "InteractiveBehavior", "outFile": "interactive.html" }, { "id": "NewtonianBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('newtonian')`.\n\nNewtonian attraction between bodies (inverse square law).\n\nAdditional options include:\n- strength: The strength of the interaction between bodies. (default: `1`)\n- max: The maximum distance between bodies at which to apply the behavior. (default: `false`... infinite)\n- min: The minimum distance between bodies at which to apply the behavior. (default: `false`... autocalculate)", "short_description": "`Physics.behavior('newtonian')`.\n", "line": 13, "aliases": [], "children": [], "file": "src/behaviors/newtonian.js", "subclasses": [], "name": "NewtonianBehavior", "path": "NewtonianBehavior", "outFile": "newtonian.html" }, { "id": "SweepPruneBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('sweep-prune')`.\n\nSweep and Prune implementation for broad phase collision detection.\n\nThis massively improves the speed of collision detection. It's set up to always be used with [[BodyCollisionDetection]], and [[BodyImpulseResponse]].\n\nAdditional options include:\n- channel: The channel to publish collision candidates to. (default: `collisions:candidates`)", "short_description": "`Physics.behavior('sweep-prune')`.\n", "line": 13, "aliases": [], "children": [ { "id": "SweepPruneBehavior#broadPhase", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " The candidate data of overlapping aabbs\n\n " } ], "internal": true, "description": "Execute the broad phase and get candidate collisions", "short_description": "Execute the broad phase and get candidate collisions", "line": 95, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "broadPhase", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.broadPhase", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.broadPhase" }, { "id": "SweepPruneBehavior#checkOverlaps", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " List of candidate collisions\n\n " } ], "internal": true, "description": "Check each axis for overlaps of bodies AABBs", "short_description": "Check each axis for overlaps of bodies AABBs", "line": 257, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "checkOverlaps", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.checkOverlaps", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.checkOverlaps" }, { "id": "SweepPruneBehavior#clear", "type": "instance method", "signatures": [ { "arguments": [] } ], "description": "Refresh tracking data", "short_description": "Refresh tracking data", "line": 52, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "clear", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.clear", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.clear" }, { "id": "SweepPruneBehavior#getPair", "type": "instance method", "signatures": [ { "arguments": [ { "name": "tr1", "types": [ "Object" ], "description": " First tracker\n\n " }, { "name": "tr2", "types": [ "Object" ], "description": " Second tracker\n\n " }, { "name": "doCreate", "types": [ "Boolean" ], "description": " Create if not found\n\n " } ], "returns": [ { "type": "Object", "description": " Pair object or null if not found\n\n " } ] } ], "arguments": [ { "name": "tr1", "types": [ "Object" ], "description": " First tracker\n\n " }, { "name": "tr2", "types": [ "Object" ], "description": " Second tracker\n\n " }, { "name": "doCreate", "types": [ "Boolean" ], "description": " Create if not found\n\n " } ], "returns": [ { "type": "Object", "description": " Pair object or null if not found\n\n " } ], "internal": true, "description": "Get a pair object for the tracker objects", "short_description": "Get a pair object for the tracker objects", "line": 181, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "getPair", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.getPair", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.getPair" }, { "id": "SweepPruneBehavior#sortIntervalLists", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Simple insertion sort for each axis", "short_description": "Simple insertion sort for each axis", "line": 112, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "sortIntervalLists", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.sortIntervalLists", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.sortIntervalLists" }, { "id": "SweepPruneBehavior#sweep", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to sweep and publish event if any candidate collisions are found", "short_description": "Event callback to sweep and publish event if any candidate collisions are found", "line": 487, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "sweep", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.sweep", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.sweep" }, { "id": "SweepPruneBehavior#trackBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to add body to list of those tracked by sweep and prune", "short_description": "Event callback to add body to list of those tracked by sweep and prune", "line": 393, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "trackBody", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.trackBody", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.trackBody" }, { "id": "SweepPruneBehavior#untrackBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " Event data\n\n " } ], "internal": true, "description": "Event callback to remove body from list of those tracked", "short_description": "Event callback to remove body from list of those tracked", "line": 432, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "untrackBody", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.untrackBody", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.untrackBody" }, { "id": "SweepPruneBehavior#updateIntervals", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Update position intervals on each axis", "short_description": "Update position intervals on each axis", "line": 364, "aliases": [], "children": [], "file": "src/behaviors/sweep-prune.js", "name": "updateIntervals", "name_prefix": "SweepPruneBehavior#", "path": "SweepPruneBehavior.prototype.updateIntervals", "outFile": "sweep-prune.html#SweepPruneBehavior.prototype.updateIntervals" } ], "file": "src/behaviors/sweep-prune.js", "subclasses": [], "name": "SweepPruneBehavior", "path": "SweepPruneBehavior", "outFile": "sweep-prune.html" }, { "id": "VerletConstraintsBehavior", "type": "class", "superclass": "Behavior", "description": "`Physics.behavior('verlet-constraints')`.\n\nVerlet constraints manager.\n\nHandles distance constraints, and angle constraints\n\nAdditional options include:\n- iterations: The number of iterations to take to relax the constraints. (default: `2`)", "short_description": "`Physics.behavior('verlet-constraints')`.\n", "line": 13, "aliases": [], "children": [ { "id": "VerletConstraintsBehavior#angleConstraint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "bodyC", "types": [ "Body" ], "description": " Third body\n\n " }, { "name": "stiffness", "optional": true, "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetAngle", "optional": true, "types": [ "Number" ], "description": " Target angle. Defaults to the current angle between bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ] } ], "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "bodyC", "types": [ "Body" ], "description": " Third body\n\n " }, { "name": "stiffness", "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetAngle", "types": [ "Number" ], "description": " Target angle. Defaults to the current angle between bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ], "description": "Constrain three bodies to a target relative angle\n\nReturns constraint data that can be used to remove the constraint later.\n\n- `.bodyA`, `.bodyB`, and `.bodyC` are references to the bodies\n- `.type` is the type of constraint\n- `.id` is the string ID of the constraint\n- `.stiffness` is the stiffness\n- `.targetAngle` is the target angle", "short_description": "Constrain three bodies to a target relative angle\n", "line": 129, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "angleConstraint", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.angleConstraint", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.angleConstraint" }, { "id": "VerletConstraintsBehavior#distanceConstraint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "stiffness", "optional": true, "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetLength", "optional": true, "types": [ "Number" ], "description": " Target length. defaults to current distance between the bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ] } ], "arguments": [ { "name": "bodyA", "types": [ "Body" ], "description": " First body\n\n " }, { "name": "bodyB", "types": [ "Body" ], "description": " Second body\n\n " }, { "name": "stiffness", "types": [ "Number" ], "description": " A number between 0 and 1 that represents the stiffness of the constraint. Defaults to: `0.5`\n\n " }, { "name": "targetLength", "types": [ "Number" ], "description": " Target length. defaults to current distance between the bodies\n\n " } ], "returns": [ { "type": "Object", "description": " The constraint data object\n\n " } ], "description": "Constrain two bodies to a target relative distance.\n\nReturns constraint data that can be used to remove the constraint later.\n\n- `.bodyA` and `.bodyB` are references to the bodies\n- `.type` is the type of constraint\n- `.id` is the string ID of the constraint\n- `.stiffness` is the stiffness\n- `.targetLength` is the target length", "short_description": "Constrain two bodies to a target relative distance.\n", "line": 86, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "distanceConstraint", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.distanceConstraint", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.distanceConstraint" }, { "id": "VerletConstraintsBehavior#drop", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Remove all constraints", "short_description": "Remove all constraints", "line": 60, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "drop", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.drop", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.drop" }, { "id": "VerletConstraintsBehavior#getConstraints", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Object" } ] } ], "returns": [ { "type": "Object", "description": " The object containing copied arrays of the constraints\n\n " } ], "description": "Get all constraints.", "short_description": "Get all constraints.", "line": 419, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "getConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.getConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.getConstraints" }, { "id": "VerletConstraintsBehavior#remove", "type": "instance method", "signatures": [ { "arguments": [ { "name": "constraintData", "types": [ "Object" ], "description": " The constraint data returned when creating a constraint\n\n " } ], "returns": [ { "type": "this" } ] }, { "arguments": [ { "name": "constraintId", "types": [ "String" ], "description": " The constraint id\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "constraintData", "types": [ "Object" ], "description": " The constraint data returned when creating a constraint\n\n " }, { "name": "constraintId", "types": [ "String" ], "description": " The constraint id\n\n " } ], "description": "Remove a constraint", "short_description": "Remove a constraint", "line": 160, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "remove", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.remove", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.remove" }, { "id": "VerletConstraintsBehavior#resolve", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Resolve all constraints.", "short_description": "Resolve all constraints.", "line": 399, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "resolve", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.resolve", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.resolve" }, { "id": "VerletConstraintsBehavior#resolveAngleConstraints", "type": "instance method", "signatures": [ { "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ] } ], "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ], "internal": true, "description": "Resolve angle constraints.", "short_description": "Resolve angle constraints.", "line": 205, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "resolveAngleConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.resolveAngleConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.resolveAngleConstraints" }, { "id": "VerletConstraintsBehavior#resolveDistanceConstraints", "type": "instance method", "signatures": [ { "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ] } ], "arguments": [ { "name": "coef", "types": [ "Number" ], "description": " Coefficient for this resolution phase\n\n " } ], "internal": true, "description": "Resolve distance constraints.", "short_description": "Resolve distance constraints.", "line": 330, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "resolveDistanceConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.resolveDistanceConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.resolveDistanceConstraints" }, { "id": "VerletConstraintsBehavior#shuffleConstraints", "type": "instance method", "signatures": [ { "arguments": [] } ], "internal": true, "description": "Mix up the constraints.", "short_description": "Mix up the constraints.", "line": 388, "aliases": [], "children": [], "file": "src/behaviors/verlet-constraints.js", "name": "shuffleConstraints", "name_prefix": "VerletConstraintsBehavior#", "path": "VerletConstraintsBehavior.prototype.shuffleConstraints", "outFile": "verlet-constraints.html#VerletConstraintsBehavior.prototype.shuffleConstraints" } ], "file": "src/behaviors/verlet-constraints.js", "subclasses": [], "name": "VerletConstraintsBehavior", "path": "VerletConstraintsBehavior", "outFile": "verlet-constraints.html" } ], "file": "src/core/behavior.js", "subclasses": [ "AttractorBehavior", "BodyCollisionDetectionBehavior", "BodyImpulseResponseBehavior", "ConstantAccelerationBehavior", "EdgeCollisionDetectionBehavior", "InteractiveBehavior", "NewtonianBehavior", "SweepPruneBehavior", "VerletConstraintsBehavior" ], "name": "Behavior", "path": "Behavior", "outFile": "behavior.html" }, "Behavior#init": { "id": "Behavior#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 38, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "init", "name_prefix": "Behavior#", "path": "Behavior.prototype.init", "outFile": "behavior.html#Behavior.prototype.init" }, "Behavior#options": { "id": "Behavior#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this instance.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this instance.\n", "line": 56, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "options", "name_prefix": "Behavior#", "path": "Behavior.prototype.options", "outFile": "behavior.html#Behavior.prototype.options" }, "Behavior#applyTo": { "id": "Behavior#applyTo", "type": "instance method", "signatures": [ { "arguments": [ { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to apply this behavior to. Specify `true` for all objects in world.\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to apply this behavior to. Specify `true` for all objects in world.\n\n " } ], "description": "Apply the behavior to a group of bodies.", "short_description": "Apply the behavior to a group of bodies.", "line": 66, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "applyTo", "name_prefix": "Behavior#", "path": "Behavior.prototype.applyTo", "outFile": "behavior.html#Behavior.prototype.applyTo" }, "Behavior#getTargets": { "id": "Behavior#getTargets", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " The array of bodies (by reference!) this behavior is applied to.\n\n " } ], "description": "Get the array of bodies (by reference!) this behavior is applied to.", "short_description": "Get the array of bodies (by reference!) this behavior is applied to.", "line": 82, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "getTargets", "name_prefix": "Behavior#", "path": "Behavior.prototype.getTargets", "outFile": "behavior.html#Behavior.prototype.getTargets" }, "Behavior#setWorld": { "id": "Behavior#setWorld", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "description": "Set which world to apply to.\n\nUsually this is called internally. Shouldn't be a need to call this yourself usually.", "short_description": "Set which world to apply to.\n", "line": 95, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "setWorld", "name_prefix": "Behavior#", "path": "Behavior.prototype.setWorld", "outFile": "behavior.html#Behavior.prototype.setWorld" }, "Behavior#connect": { "id": "Behavior#connect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to connect to\n\n " } ] } ], "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to connect to\n\n " } ], "description": "Connect to a world.\n\nExtend this when creating behaviors if you need to specify pubsub management.\nAutomatically called when added to world by the [[Behavior#setWorld]] method.", "short_description": "Connect to a world.\n", "line": 119, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "connect", "name_prefix": "Behavior#", "path": "Behavior.prototype.connect", "outFile": "behavior.html#Behavior.prototype.connect" }, "Behavior#disconnect": { "id": "Behavior#disconnect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to disconnect from\n\n " } ] } ], "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to disconnect from\n\n " } ], "description": "Disconnect from a world.\n\nExtend this when creating behaviors if you need to specify pubsub management.\nAutomatically called when added to world by the [[Behavior#setWorld]] method.", "short_description": "Disconnect from a world.\n", "line": 135, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "disconnect", "name_prefix": "Behavior#", "path": "Behavior.prototype.disconnect", "outFile": "behavior.html#Behavior.prototype.disconnect" }, "Behavior#behave": { "id": "Behavior#behave", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The pubsub `integrate:positions` event data\n\n " } ] } ], "arguments": [ { "name": "data", "types": [ "Object" ], "description": " The pubsub `integrate:positions` event data\n\n " } ], "description": "Default method run on every world integration.\n\nYou _must_ extend this when creating a behavior,\nunless you extend the [[Behavior#connect]] and [[Behavior#disconnect]] methods.", "short_description": "Default method run on every world integration.\n", "line": 151, "aliases": [], "children": [], "file": "src/core/behavior.js", "name": "behave", "name_prefix": "Behavior#", "path": "Behavior.prototype.behave", "outFile": "behavior.html#Behavior.prototype.behave" }, "Physics.body": { "id": "Physics.body", "type": "class method", "signatures": [ { "arguments": [ { "name": "name", "types": [ "String" ], "description": " The name of the body to create\n\n " }, { "name": "options", "optional": true, "types": [ "Object" ], "description": " The configuration for that body ( depends on body ).\n\n Available options and defaults:\n\n\n\n ```javascript\n\n {\n\n // is the body hidden (not to be rendered)?\n\n hidden: false,\n\n // is the body `dynamic`, `kinematic` or `static`?\n\n // http://www.box2d.org/manual.html#_Toc258082973\n\n treatment: 'dynamic',\n\n // body mass\n\n mass: 1.0,\n\n // body restitution. How \"bouncy\" is it?\n\n restitution: 1.0,\n\n // what is its coefficient of friction with another surface with COF = 1?\n\n cof: 0.8,\n\n // what is the view object (mixed) that should be used when rendering?\n\n view: null,\n\n // the vector offsetting the geometry from its center of mass\n\n offset: Physics.vector(0,0)\n\n }\n\n ```\n\n " } ], "returns": [ { "type": "Body" } ] } ], "arguments": [ { "name": "name", "types": [ "String" ], "description": " The name of the body to create\n\n " }, { "name": "options", "types": [ "Object" ], "description": " The configuration for that body ( depends on body ).\n\n Available options and defaults:\n\n\n\n ```javascript\n\n {\n\n // is the body hidden (not to be rendered)?\n\n hidden: false,\n\n // is the body `dynamic`, `kinematic` or `static`?\n\n // http://www.box2d.org/manual.html#_Toc258082973\n\n treatment: 'dynamic',\n\n // body mass\n\n mass: 1.0,\n\n // body restitution. How \"bouncy\" is it?\n\n restitution: 1.0,\n\n // what is its coefficient of friction with another surface with COF = 1?\n\n cof: 0.8,\n\n // what is the view object (mixed) that should be used when rendering?\n\n view: null,\n\n // the vector offsetting the geometry from its center of mass\n\n offset: Physics.vector(0,0)\n\n }\n\n ```\n\n " } ], "related_to": "Physics.util.decorator", "description": "Factory function for creating Bodies.\n\nVisit [the PhysicsJS wiki on Bodies](https://github.com/wellcaffeinated/PhysicsJS/wiki/Bodies)\nfor usage documentation.", "short_description": "Factory function for creating Bodies.\n", "line": 58, "aliases": [], "children": [ { "id": "Body", "type": "class", "belongs_to": "Physics.body", "description": "The base class for bodies created by [[Physics.body]] factory function.", "short_description": "The base class for bodies created by [[Physics.body]] factory function.", "line": 65, "aliases": [ "PointBody" ], "children": [ { "id": "Body#aabb", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Object" } ] } ], "returns": [ { "type": "Object", "description": " The aabb of this body\n\n " } ], "related_to": "Physics.aabb", "description": "Get the Axis aligned bounding box for the body in its current position and rotation", "short_description": "Get the Axis aligned bounding box for the body in its current position and rotation", "line": 458, "aliases": [], "children": [], "file": "src/core/body.js", "name": "aabb", "name_prefix": "Body#", "path": "Body.prototype.aabb", "outFile": "body.html#Body.prototype.aabb" }, { "id": "Body#accelerate", "type": "instance method", "signatures": [ { "arguments": [ { "name": "acc", "types": [ "Physics.vector" ], "description": " The acceleration vector\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "acc", "types": [ "Physics.vector" ], "description": " The acceleration vector\n\n " } ], "description": "Accelerate the body by adding supplied vector to its current acceleration", "short_description": "Accelerate the body by adding supplied vector to its current acceleration", "line": 395, "aliases": [], "children": [], "file": "src/core/body.js", "name": "accelerate", "name_prefix": "Body#", "path": "Body.prototype.accelerate", "outFile": "body.html#Body.prototype.accelerate" }, { "id": "Body#applyForce", "type": "instance method", "signatures": [ { "arguments": [ { "name": "force", "types": [ "Vectorish" ], "description": " The force vector\n\n " }, { "name": "p", "optional": true, "types": [ "Vectorish" ], "description": " The point vector from the COM at which to apply the force\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "force", "types": [ "Vectorish" ], "description": " The force vector\n\n " }, { "name": "p", "types": [ "Vectorish" ], "description": " The point vector from the COM at which to apply the force\n\n " } ], "description": "Apply a force at center of mass, or at point `p` relative to the center of mass", "short_description": "Apply a force at center of mass, or at point `p` relative to the center of mass", "line": 411, "aliases": [], "children": [], "file": "src/core/body.js", "name": "applyForce", "name_prefix": "Body#", "path": "Body.prototype.applyForce", "outFile": "body.html#Body.prototype.applyForce" }, { "id": "Body#cof", "type": "constant", "signatures": [ { "returns": [ { "type": "0.8" } ] } ], "description": "The coefficient of friction of the body.\n\nIt's how much \"slide\" it has during collisions.\n\nA `cof` of `0` will really slidy.\n\nA `cof` of `1` has no slide.\n\nThis is a very simplistic implementation at the moment.\nWhat would be better is to have both static and kinetic\nfriction. But that's not done yet.", "short_description": "The coefficient of friction of the body.\n", "line": 218, "aliases": [], "children": [], "file": "src/core/body.js", "name": "cof", "name_prefix": "Body#", "path": "Body.prototype.cof", "outFile": "body.html#Body.prototype.cof" }, { "id": "Body#geometry", "type": "namespace", "related_to": "Physics.geometry", "description": "The geometry for this body.\n\nBy default it is a `point` geometry which gets overridden.", "short_description": "The geometry for this body.\n", "line": 171, "aliases": [], "children": [], "file": "src/core/body.js", "name": "geometry", "name_prefix": "Body#", "path": "Body.prototype.geometry", "outFile": "body.html#Body.prototype.geometry" }, { "id": "Body#getGlobalOffset", "type": "instance method", "signatures": [ { "arguments": [ { "name": "out", "optional": true, "types": [ "Physics.vector" ], "description": " A vector to use to put the result into. One is created if `out` isn't specified.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The offset in global coordinates\n\n " } ] } ], "arguments": [ { "name": "out", "types": [ "Physics.vector" ], "description": " A vector to use to put the result into. One is created if `out` isn't specified.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The offset in global coordinates\n\n " } ], "related_to": "Body#offset", "description": "Get the body offset vector (from the center of mass) for the body's shape in global coordinates.", "short_description": "Get the body offset vector (from the center of mass) for the body's shape in global coordinates.", "line": 445, "aliases": [], "children": [], "file": "src/core/body.js", "name": "getGlobalOffset", "name_prefix": "Body#", "path": "Body.prototype.getGlobalOffset", "outFile": "body.html#Body.prototype.getGlobalOffset" }, { "id": "Body#hidden", "type": "constant", "signatures": [ { "returns": [ { "type": "false" } ] } ], "description": "Determines whether the body should be hidden by the renderer.", "short_description": "Determines whether the body should be hidden by the renderer.", "line": 237, "aliases": [], "children": [], "file": "src/core/body.js", "name": "hidden", "name_prefix": "Body#", "path": "Body.prototype.hidden", "outFile": "body.html#Body.prototype.hidden" }, { "id": "Body#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 72, "aliases": [], "children": [], "file": "src/core/body.js", "name": "init", "name_prefix": "Body#", "path": "Body.prototype.init", "outFile": "body.html#Body.prototype.init" }, { "id": "Body#mass", "type": "constant", "signatures": [ { "returns": [ { "type": "1" } ] } ], "description": "The mass.", "short_description": "The mass.", "line": 178, "aliases": [], "children": [], "file": "src/core/body.js", "name": "mass", "name_prefix": "Body#", "path": "Body.prototype.mass", "outFile": "body.html#Body.prototype.mass" }, { "id": "Body#offset", "type": "namespace", "description": "The vector offsetting the body's shape from its center of mass.", "short_description": "The vector offsetting the body's shape from its center of mass.", "line": 184, "aliases": [], "children": [], "file": "src/core/body.js", "name": "offset", "name_prefix": "Body#", "path": "Body.prototype.offset", "outFile": "body.html#Body.prototype.offset" }, { "id": "Body#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this instance.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this instance.\n", "line": 93, "aliases": [], "children": [], "file": "src/core/body.js", "name": "options", "name_prefix": "Body#", "path": "Body.prototype.options", "outFile": "body.html#Body.prototype.options" }, { "id": "Body#recalc", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Recalculate properties.\n\nIntended to be overridden by subclasses. Call when body physical properties are changed.", "short_description": "Recalculate properties.\n", "line": 503, "aliases": [], "children": [], "file": "src/core/body.js", "name": "recalc", "name_prefix": "Body#", "path": "Body.prototype.recalc", "outFile": "body.html#Body.prototype.recalc" }, { "id": "Body#restitution", "type": "constant", "signatures": [ { "returns": [ { "type": "1" } ] } ], "description": "The restitution.\n\nThis is the \"bounciness\" of the body.\nIt's a number between `0` and `1`.\n\nA restitution of 1 is the bounciest.\n\nA restitution of 0 is not bouncy.\n\nWhen colliding the restitutions of bodies are\nmultiplied together to get the restitution between two\nbodies.", "short_description": "The restitution.\n", "line": 202, "aliases": [], "children": [], "file": "src/core/body.js", "name": "restitution", "name_prefix": "Body#", "path": "Body.prototype.restitution", "outFile": "body.html#Body.prototype.restitution" }, { "id": "Body#setWorld", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "description": "Set which world to apply to.\n\nUsually this is called internally. Shouldn't be a need to call this yourself usually.", "short_description": "Set which world to apply to.\n", "line": 374, "aliases": [], "children": [], "file": "src/core/body.js", "name": "setWorld", "name_prefix": "Body#", "path": "Body.prototype.setWorld", "outFile": "body.html#Body.prototype.setWorld" }, { "id": "Body#sleep", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dt", "optional": true, "types": [ "Number" ], "description": " Time to advance the idle time\n\n " } ], "returns": [ { "type": "Boolean" } ] } ], "arguments": [ { "name": "dt", "types": [ "Number" ], "description": " Time to advance the idle time\n\n " }, { "name": "dt", "types": [ "Boolean" ], "description": " If `true`, the body will be forced to sleep. If `false`, the body will be forced to awake.\n\n " } ], "description": "Get and/or set whether the body is asleep.\n\nIf called with a time (in ms), the time will be added to the idle time and sleep conditions will be checked.", "short_description": "Get and/or set whether the body is asleep.\n", "line": 271, "aliases": [], "children": [], "file": "src/core/body.js", "name": "sleep", "name_prefix": "Body#", "path": "Body.prototype.sleep", "outFile": "body.html#Body.prototype.sleep" }, { "id": "Body#sleepCheck", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dt", "optional": true, "types": [ "Number" ], "description": " Time to advance the idle time\n\n " } ] } ], "arguments": [ { "name": "dt", "types": [ "Number" ], "description": " Time to advance the idle time\n\n " } ], "description": "Check if the body should be sleeping.\n\nCall with no arguments if some event could possibly wake up the body. This will force the body to recheck.", "short_description": "Check if the body should be sleeping.\n", "line": 303, "aliases": [], "children": [], "file": "src/core/body.js", "name": "sleepCheck", "name_prefix": "Body#", "path": "Body.prototype.sleepCheck", "outFile": "body.html#Body.prototype.sleepCheck" }, { "id": "Body#state", "type": "namespace", "description": "The physical state container.\n\n- ``this.state.pos`` ([[Physics.vector]]) The position vector.\n- ``this.state.vel`` ([[Physics.vector]]) The velocity vector.\n- ``this.state.acc`` ([[Physics.vector]]) The acceleration vector.\n- ``this.state.angular.pos`` ([[Number]]) The angular position (in radians, positive is clockwise starting along the x axis)\n- ``this.state.angular.vel`` ([[Number]]) The angular velocity\n- ``this.state.angular.acc`` ([[Number]]) The angular acceleration\n\nProperties from the previous timestep are stored in:\n```javascript\nthis.state.old; // .pos, .vel, ...\n```", "short_description": "The physical state container.\n", "line": 117, "aliases": [], "children": [], "file": "src/core/body.js", "name": "state", "name_prefix": "Body#", "path": "Body.prototype.state", "outFile": "body.html#Body.prototype.state" }, { "id": "Body#styles", "type": "namespace", "related_to": "Physics.renderer", "description": "The styles the renderer should use for creating the view.\n\nThe styles depend on the renderer. See [[Renderer#createView]] for style options.", "short_description": "The styles the renderer should use for creating the view.\n", "line": 260, "aliases": [], "children": [], "file": "src/core/body.js", "name": "styles", "name_prefix": "Body#", "path": "Body.prototype.styles", "outFile": "body.html#Body.prototype.styles" }, { "id": "Body#toBodyCoords", "type": "instance method", "signatures": [ { "arguments": [ { "name": "v", "types": [ "Physics.vector" ], "description": " The vector to transform\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The transformed vector\n\n " } ] } ], "arguments": [ { "name": "v", "types": [ "Physics.vector" ], "description": " The vector to transform\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The transformed vector\n\n " } ], "description": "Transform a vector into coordinates relative to this body.", "short_description": "Transform a vector into coordinates relative to this body.", "line": 481, "aliases": [], "children": [], "file": "src/core/body.js", "name": "toBodyCoords", "name_prefix": "Body#", "path": "Body.prototype.toBodyCoords", "outFile": "body.html#Body.prototype.toBodyCoords" }, { "id": "Body#toWorldCoords", "type": "instance method", "signatures": [ { "arguments": [ { "name": "v", "types": [ "Physics.vector" ], "description": " The vector to transform\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The transformed vector\n\n " } ] } ], "arguments": [ { "name": "v", "types": [ "Physics.vector" ], "description": " The vector to transform\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The transformed vector\n\n " } ], "description": "Transform a vector from body coordinates into world coordinates.", "short_description": "Transform a vector from body coordinates into world coordinates.", "line": 492, "aliases": [], "children": [], "file": "src/core/body.js", "name": "toWorldCoords", "name_prefix": "Body#", "path": "Body.prototype.toWorldCoords", "outFile": "body.html#Body.prototype.toWorldCoords" }, { "id": "Body#treatment", "type": "constant", "signatures": [ { "returns": [ { "type": "String" } ] } ], "description": "How the body is treated by the simulation.\n\nThe body can be `dynamic`, `kinematic` or `static` as\ndescribed by the [analogous box2d docs](http://www.box2d.org/manual.html#_Toc258082973).\n\n* _dynamic_ bodies are treated \"normally\". They are integrated, and collide, and all that.\n* _kinematic_ bodies are bodies that move at a specified velocity. Other bodies collide with them, but they don't bounce off of other bodies.\n* _static_ bodies just stand still. They are like obstacles.", "short_description": "How the body is treated by the simulation.\n", "line": 231, "aliases": [], "children": [], "file": "src/core/body.js", "name": "treatment", "name_prefix": "Body#", "path": "Body.prototype.treatment", "outFile": "body.html#Body.prototype.treatment" }, { "id": "Body#uid", "type": "constant", "signatures": [ { "returns": [ { "type": "Number" } ] } ], "description": "The unique id for the body", "short_description": "The unique id for the body", "line": 162, "aliases": [], "children": [], "file": "src/core/body.js", "name": "uid", "name_prefix": "Body#", "path": "Body.prototype.uid", "outFile": "body.html#Body.prototype.uid" }, { "id": "Body#view", "type": "constant", "signatures": [ { "returns": [ { "type": "it_depends" } ] } ], "related_to": "Physics.renderer", "description": "Storage for use by the renderer.\n\nThe type of renderer will put different things in the view property.\nBasically, this is how the body \"looks\". It could be a HTMLElement, or\nan Image, etc...\n\nIf your body changes appearance (shape), you should modify this somehow\notherwise the renderer will keep using this same view. If you're letting\nthe renderer create the view for you, just set this to `undefined` if the\nbody gets modified in shape during the simulation.", "short_description": "Storage for use by the renderer.\n", "line": 252, "aliases": [], "children": [], "file": "src/core/body.js", "name": "view", "name_prefix": "Body#", "path": "Body.prototype.view", "outFile": "body.html#Body.prototype.view" }, { "id": "Body.getCOM", "type": "class method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of bodies\n\n " }, { "name": "com", "optional": true, "types": [ "Physics.vector" ], "description": " The vector to put result into. A new vector will be created if not provided.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The center of mass position\n\n " } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of bodies\n\n " }, { "name": "com", "types": [ "Physics.vector" ], "description": " The vector to put result into. A new vector will be created if not provided.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The center of mass position\n\n " } ], "description": "Get center of mass position from list of bodies.", "short_description": "Get center of mass position from list of bodies.", "line": 517, "aliases": [], "children": [], "file": "src/core/body.js", "name": "getCOM", "name_prefix": "Body.", "path": "Body.getCOM", "outFile": "body.html#Body.getCOM" }, { "id": "CircleBody", "type": "class", "superclass": "Body", "description": "Physics.body('circle')\n\nThe circle body has a circular shape.\n\nAdditional options include:\n- radius: the radius\n\nExample:\n\n```javascript\nvar round = Physics.body('circle', {\n x: 30,\n y: 20,\n radius: 5\n});\n```", "short_description": "Physics.body('circle')\n", "line": 24, "aliases": [], "children": [], "file": "src/bodies/circle.js", "subclasses": [], "name": "CircleBody", "path": "CircleBody", "outFile": "circle.html" }, { "id": "CompoundBody", "type": "class", "superclass": "Body", "description": "Physics.body('compound')\n\nNot a body in itself. It's a container to group other bodies. The position of the body is the center of mass.\nIt must have at least one child before being added to the world.\n\nAdditional config options:\n\n- children: Array of [[Body]] objects.\n\nExample:\n\n```javascript\nvar thing = Physics.body('compound', {\n // place the center of mass at (300, 200)\n x: 300,\n y: 200,\n // the center of mass is automatically calculated and used to position the shape\n children: [\n body1,\n body2,\n // ...\n ]\n});\n```", "short_description": "Physics.body('compound')\n", "line": 32, "aliases": [], "children": [ { "id": "CompoundBody#addChild", "type": "instance method", "signatures": [ { "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The child to add\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The child to add\n\n " } ], "description": "Add a body as a child.", "short_description": "Add a body as a child.", "line": 68, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "addChild", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.addChild", "outFile": "compound.html#CompoundBody.prototype.addChild" }, { "id": "CompoundBody#addChildren", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of children to add\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of children to add\n\n " } ], "description": "Add an array of children to the compound.", "short_description": "Add an array of children to the compound.", "line": 80, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "addChildren", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.addChildren", "outFile": "compound.html#CompoundBody.prototype.addChildren" }, { "id": "CompoundBody#clear", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Remove all children.", "short_description": "Remove all children.", "line": 142, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "clear", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.clear", "outFile": "compound.html#CompoundBody.prototype.clear" }, { "id": "CompoundBody#refreshGeometry", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "If the children's positions change, `refreshGeometry()` should be called to fix the shape.", "short_description": "If the children's positions change, `refreshGeometry()` should be called to fix the shape.", "line": 159, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "refreshGeometry", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.refreshGeometry", "outFile": "compound.html#CompoundBody.prototype.refreshGeometry" } ], "file": "src/bodies/compound.js", "subclasses": [], "name": "CompoundBody", "path": "CompoundBody", "outFile": "compound.html" }, { "id": "ConvexPolygonBody", "type": "class", "superclass": "Body", "description": "Physics.body('convex-polygon')\n\nBody for convex polygons. The position of the body is the centroid of the polygon.\n\nAdditional config options:\n\n- vertices: Array of [[Vectorish]] objects representing the polygon vertices in clockwise (or counterclockwise) order.\n\nExample:\n\n```javascript\nvar pentagon = Physics.body('convex-polygon', {\n // place the centroid of the polygon at (300, 200)\n x: 300,\n y: 200,\n // the centroid is automatically calculated and used to position the shape\n vertices: [\n { x: 0, y: -30 },\n { x: -29, y: -9 },\n { x: -18, y: 24 },\n { x: 18, y: 24 },\n { x: 29, y: -9 }\n ]\n});\n```", "short_description": "Physics.body('convex-polygon')\n", "line": 33, "aliases": [], "children": [], "file": "src/bodies/convex-polygon.js", "subclasses": [], "name": "ConvexPolygonBody", "path": "ConvexPolygonBody", "outFile": "convex-polygon.html" }, { "id": "PointBody", "type": "class", "superclass": "Body", "alias_of": "Body", "description": "Physics.body('point')\n\nThe point body represents a point.", "short_description": "Physics.body('point')\n", "line": 8, "aliases": [], "children": [], "file": "src/bodies/point.js", "subclasses": [], "name": "PointBody", "path": "PointBody", "outFile": "point.html" }, { "id": "RectangleBody", "type": "class", "superclass": "Body", "description": "Physics.body('rectangle')\n\nBody for rectangles. The position of the body is the centroid of the rectangle.\n\nAdditional config options:\n\n- width: The width\n- height: The height\n\nExample:\n\n```javascript\nvar rect = Physics.body('rectangle', {\n // place the centroid of the rectangle at (300, 200)\n x: 300,\n y: 200,\n width: 30,\n height: 40\n});\n```", "short_description": "Physics.body('rectangle')\n", "line": 28, "aliases": [], "children": [], "file": "src/bodies/rectangle.js", "subclasses": [], "name": "RectangleBody", "path": "RectangleBody", "outFile": "rectangle.html" } ], "file": "src/core/body.js", "subclasses": [ "CircleBody", "CompoundBody", "ConvexPolygonBody", "PointBody", "RectangleBody" ], "name": "Body", "path": "Body", "outFile": "body.html" } ], "file": "src/core/body.js", "name": "body", "name_prefix": "Physics.", "path": "Physics.body", "outFile": "body.html#Physics.body" }, "Body": { "id": "Body", "type": "class", "belongs_to": "Physics.body", "description": "The base class for bodies created by [[Physics.body]] factory function.", "short_description": "The base class for bodies created by [[Physics.body]] factory function.", "line": 65, "aliases": [ "PointBody" ], "children": [ { "id": "Body#aabb", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Object" } ] } ], "returns": [ { "type": "Object", "description": " The aabb of this body\n\n " } ], "related_to": "Physics.aabb", "description": "Get the Axis aligned bounding box for the body in its current position and rotation", "short_description": "Get the Axis aligned bounding box for the body in its current position and rotation", "line": 458, "aliases": [], "children": [], "file": "src/core/body.js", "name": "aabb", "name_prefix": "Body#", "path": "Body.prototype.aabb", "outFile": "body.html#Body.prototype.aabb" }, { "id": "Body#accelerate", "type": "instance method", "signatures": [ { "arguments": [ { "name": "acc", "types": [ "Physics.vector" ], "description": " The acceleration vector\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "acc", "types": [ "Physics.vector" ], "description": " The acceleration vector\n\n " } ], "description": "Accelerate the body by adding supplied vector to its current acceleration", "short_description": "Accelerate the body by adding supplied vector to its current acceleration", "line": 395, "aliases": [], "children": [], "file": "src/core/body.js", "name": "accelerate", "name_prefix": "Body#", "path": "Body.prototype.accelerate", "outFile": "body.html#Body.prototype.accelerate" }, { "id": "Body#applyForce", "type": "instance method", "signatures": [ { "arguments": [ { "name": "force", "types": [ "Vectorish" ], "description": " The force vector\n\n " }, { "name": "p", "optional": true, "types": [ "Vectorish" ], "description": " The point vector from the COM at which to apply the force\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "force", "types": [ "Vectorish" ], "description": " The force vector\n\n " }, { "name": "p", "types": [ "Vectorish" ], "description": " The point vector from the COM at which to apply the force\n\n " } ], "description": "Apply a force at center of mass, or at point `p` relative to the center of mass", "short_description": "Apply a force at center of mass, or at point `p` relative to the center of mass", "line": 411, "aliases": [], "children": [], "file": "src/core/body.js", "name": "applyForce", "name_prefix": "Body#", "path": "Body.prototype.applyForce", "outFile": "body.html#Body.prototype.applyForce" }, { "id": "Body#cof", "type": "constant", "signatures": [ { "returns": [ { "type": "0.8" } ] } ], "description": "The coefficient of friction of the body.\n\nIt's how much \"slide\" it has during collisions.\n\nA `cof` of `0` will really slidy.\n\nA `cof` of `1` has no slide.\n\nThis is a very simplistic implementation at the moment.\nWhat would be better is to have both static and kinetic\nfriction. But that's not done yet.", "short_description": "The coefficient of friction of the body.\n", "line": 218, "aliases": [], "children": [], "file": "src/core/body.js", "name": "cof", "name_prefix": "Body#", "path": "Body.prototype.cof", "outFile": "body.html#Body.prototype.cof" }, { "id": "Body#geometry", "type": "namespace", "related_to": "Physics.geometry", "description": "The geometry for this body.\n\nBy default it is a `point` geometry which gets overridden.", "short_description": "The geometry for this body.\n", "line": 171, "aliases": [], "children": [], "file": "src/core/body.js", "name": "geometry", "name_prefix": "Body#", "path": "Body.prototype.geometry", "outFile": "body.html#Body.prototype.geometry" }, { "id": "Body#getGlobalOffset", "type": "instance method", "signatures": [ { "arguments": [ { "name": "out", "optional": true, "types": [ "Physics.vector" ], "description": " A vector to use to put the result into. One is created if `out` isn't specified.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The offset in global coordinates\n\n " } ] } ], "arguments": [ { "name": "out", "types": [ "Physics.vector" ], "description": " A vector to use to put the result into. One is created if `out` isn't specified.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The offset in global coordinates\n\n " } ], "related_to": "Body#offset", "description": "Get the body offset vector (from the center of mass) for the body's shape in global coordinates.", "short_description": "Get the body offset vector (from the center of mass) for the body's shape in global coordinates.", "line": 445, "aliases": [], "children": [], "file": "src/core/body.js", "name": "getGlobalOffset", "name_prefix": "Body#", "path": "Body.prototype.getGlobalOffset", "outFile": "body.html#Body.prototype.getGlobalOffset" }, { "id": "Body#hidden", "type": "constant", "signatures": [ { "returns": [ { "type": "false" } ] } ], "description": "Determines whether the body should be hidden by the renderer.", "short_description": "Determines whether the body should be hidden by the renderer.", "line": 237, "aliases": [], "children": [], "file": "src/core/body.js", "name": "hidden", "name_prefix": "Body#", "path": "Body.prototype.hidden", "outFile": "body.html#Body.prototype.hidden" }, { "id": "Body#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 72, "aliases": [], "children": [], "file": "src/core/body.js", "name": "init", "name_prefix": "Body#", "path": "Body.prototype.init", "outFile": "body.html#Body.prototype.init" }, { "id": "Body#mass", "type": "constant", "signatures": [ { "returns": [ { "type": "1" } ] } ], "description": "The mass.", "short_description": "The mass.", "line": 178, "aliases": [], "children": [], "file": "src/core/body.js", "name": "mass", "name_prefix": "Body#", "path": "Body.prototype.mass", "outFile": "body.html#Body.prototype.mass" }, { "id": "Body#offset", "type": "namespace", "description": "The vector offsetting the body's shape from its center of mass.", "short_description": "The vector offsetting the body's shape from its center of mass.", "line": 184, "aliases": [], "children": [], "file": "src/core/body.js", "name": "offset", "name_prefix": "Body#", "path": "Body.prototype.offset", "outFile": "body.html#Body.prototype.offset" }, { "id": "Body#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this instance.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this instance.\n", "line": 93, "aliases": [], "children": [], "file": "src/core/body.js", "name": "options", "name_prefix": "Body#", "path": "Body.prototype.options", "outFile": "body.html#Body.prototype.options" }, { "id": "Body#recalc", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Recalculate properties.\n\nIntended to be overridden by subclasses. Call when body physical properties are changed.", "short_description": "Recalculate properties.\n", "line": 503, "aliases": [], "children": [], "file": "src/core/body.js", "name": "recalc", "name_prefix": "Body#", "path": "Body.prototype.recalc", "outFile": "body.html#Body.prototype.recalc" }, { "id": "Body#restitution", "type": "constant", "signatures": [ { "returns": [ { "type": "1" } ] } ], "description": "The restitution.\n\nThis is the \"bounciness\" of the body.\nIt's a number between `0` and `1`.\n\nA restitution of 1 is the bounciest.\n\nA restitution of 0 is not bouncy.\n\nWhen colliding the restitutions of bodies are\nmultiplied together to get the restitution between two\nbodies.", "short_description": "The restitution.\n", "line": 202, "aliases": [], "children": [], "file": "src/core/body.js", "name": "restitution", "name_prefix": "Body#", "path": "Body.prototype.restitution", "outFile": "body.html#Body.prototype.restitution" }, { "id": "Body#setWorld", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "description": "Set which world to apply to.\n\nUsually this is called internally. Shouldn't be a need to call this yourself usually.", "short_description": "Set which world to apply to.\n", "line": 374, "aliases": [], "children": [], "file": "src/core/body.js", "name": "setWorld", "name_prefix": "Body#", "path": "Body.prototype.setWorld", "outFile": "body.html#Body.prototype.setWorld" }, { "id": "Body#sleep", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dt", "optional": true, "types": [ "Number" ], "description": " Time to advance the idle time\n\n " } ], "returns": [ { "type": "Boolean" } ] } ], "arguments": [ { "name": "dt", "types": [ "Number" ], "description": " Time to advance the idle time\n\n " }, { "name": "dt", "types": [ "Boolean" ], "description": " If `true`, the body will be forced to sleep. If `false`, the body will be forced to awake.\n\n " } ], "description": "Get and/or set whether the body is asleep.\n\nIf called with a time (in ms), the time will be added to the idle time and sleep conditions will be checked.", "short_description": "Get and/or set whether the body is asleep.\n", "line": 271, "aliases": [], "children": [], "file": "src/core/body.js", "name": "sleep", "name_prefix": "Body#", "path": "Body.prototype.sleep", "outFile": "body.html#Body.prototype.sleep" }, { "id": "Body#sleepCheck", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dt", "optional": true, "types": [ "Number" ], "description": " Time to advance the idle time\n\n " } ] } ], "arguments": [ { "name": "dt", "types": [ "Number" ], "description": " Time to advance the idle time\n\n " } ], "description": "Check if the body should be sleeping.\n\nCall with no arguments if some event could possibly wake up the body. This will force the body to recheck.", "short_description": "Check if the body should be sleeping.\n", "line": 303, "aliases": [], "children": [], "file": "src/core/body.js", "name": "sleepCheck", "name_prefix": "Body#", "path": "Body.prototype.sleepCheck", "outFile": "body.html#Body.prototype.sleepCheck" }, { "id": "Body#state", "type": "namespace", "description": "The physical state container.\n\n- ``this.state.pos`` ([[Physics.vector]]) The position vector.\n- ``this.state.vel`` ([[Physics.vector]]) The velocity vector.\n- ``this.state.acc`` ([[Physics.vector]]) The acceleration vector.\n- ``this.state.angular.pos`` ([[Number]]) The angular position (in radians, positive is clockwise starting along the x axis)\n- ``this.state.angular.vel`` ([[Number]]) The angular velocity\n- ``this.state.angular.acc`` ([[Number]]) The angular acceleration\n\nProperties from the previous timestep are stored in:\n```javascript\nthis.state.old; // .pos, .vel, ...\n```", "short_description": "The physical state container.\n", "line": 117, "aliases": [], "children": [], "file": "src/core/body.js", "name": "state", "name_prefix": "Body#", "path": "Body.prototype.state", "outFile": "body.html#Body.prototype.state" }, { "id": "Body#styles", "type": "namespace", "related_to": "Physics.renderer", "description": "The styles the renderer should use for creating the view.\n\nThe styles depend on the renderer. See [[Renderer#createView]] for style options.", "short_description": "The styles the renderer should use for creating the view.\n", "line": 260, "aliases": [], "children": [], "file": "src/core/body.js", "name": "styles", "name_prefix": "Body#", "path": "Body.prototype.styles", "outFile": "body.html#Body.prototype.styles" }, { "id": "Body#toBodyCoords", "type": "instance method", "signatures": [ { "arguments": [ { "name": "v", "types": [ "Physics.vector" ], "description": " The vector to transform\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The transformed vector\n\n " } ] } ], "arguments": [ { "name": "v", "types": [ "Physics.vector" ], "description": " The vector to transform\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The transformed vector\n\n " } ], "description": "Transform a vector into coordinates relative to this body.", "short_description": "Transform a vector into coordinates relative to this body.", "line": 481, "aliases": [], "children": [], "file": "src/core/body.js", "name": "toBodyCoords", "name_prefix": "Body#", "path": "Body.prototype.toBodyCoords", "outFile": "body.html#Body.prototype.toBodyCoords" }, { "id": "Body#toWorldCoords", "type": "instance method", "signatures": [ { "arguments": [ { "name": "v", "types": [ "Physics.vector" ], "description": " The vector to transform\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The transformed vector\n\n " } ] } ], "arguments": [ { "name": "v", "types": [ "Physics.vector" ], "description": " The vector to transform\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The transformed vector\n\n " } ], "description": "Transform a vector from body coordinates into world coordinates.", "short_description": "Transform a vector from body coordinates into world coordinates.", "line": 492, "aliases": [], "children": [], "file": "src/core/body.js", "name": "toWorldCoords", "name_prefix": "Body#", "path": "Body.prototype.toWorldCoords", "outFile": "body.html#Body.prototype.toWorldCoords" }, { "id": "Body#treatment", "type": "constant", "signatures": [ { "returns": [ { "type": "String" } ] } ], "description": "How the body is treated by the simulation.\n\nThe body can be `dynamic`, `kinematic` or `static` as\ndescribed by the [analogous box2d docs](http://www.box2d.org/manual.html#_Toc258082973).\n\n* _dynamic_ bodies are treated \"normally\". They are integrated, and collide, and all that.\n* _kinematic_ bodies are bodies that move at a specified velocity. Other bodies collide with them, but they don't bounce off of other bodies.\n* _static_ bodies just stand still. They are like obstacles.", "short_description": "How the body is treated by the simulation.\n", "line": 231, "aliases": [], "children": [], "file": "src/core/body.js", "name": "treatment", "name_prefix": "Body#", "path": "Body.prototype.treatment", "outFile": "body.html#Body.prototype.treatment" }, { "id": "Body#uid", "type": "constant", "signatures": [ { "returns": [ { "type": "Number" } ] } ], "description": "The unique id for the body", "short_description": "The unique id for the body", "line": 162, "aliases": [], "children": [], "file": "src/core/body.js", "name": "uid", "name_prefix": "Body#", "path": "Body.prototype.uid", "outFile": "body.html#Body.prototype.uid" }, { "id": "Body#view", "type": "constant", "signatures": [ { "returns": [ { "type": "it_depends" } ] } ], "related_to": "Physics.renderer", "description": "Storage for use by the renderer.\n\nThe type of renderer will put different things in the view property.\nBasically, this is how the body \"looks\". It could be a HTMLElement, or\nan Image, etc...\n\nIf your body changes appearance (shape), you should modify this somehow\notherwise the renderer will keep using this same view. If you're letting\nthe renderer create the view for you, just set this to `undefined` if the\nbody gets modified in shape during the simulation.", "short_description": "Storage for use by the renderer.\n", "line": 252, "aliases": [], "children": [], "file": "src/core/body.js", "name": "view", "name_prefix": "Body#", "path": "Body.prototype.view", "outFile": "body.html#Body.prototype.view" }, { "id": "Body.getCOM", "type": "class method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of bodies\n\n " }, { "name": "com", "optional": true, "types": [ "Physics.vector" ], "description": " The vector to put result into. A new vector will be created if not provided.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The center of mass position\n\n " } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of bodies\n\n " }, { "name": "com", "types": [ "Physics.vector" ], "description": " The vector to put result into. A new vector will be created if not provided.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The center of mass position\n\n " } ], "description": "Get center of mass position from list of bodies.", "short_description": "Get center of mass position from list of bodies.", "line": 517, "aliases": [], "children": [], "file": "src/core/body.js", "name": "getCOM", "name_prefix": "Body.", "path": "Body.getCOM", "outFile": "body.html#Body.getCOM" }, { "id": "CircleBody", "type": "class", "superclass": "Body", "description": "Physics.body('circle')\n\nThe circle body has a circular shape.\n\nAdditional options include:\n- radius: the radius\n\nExample:\n\n```javascript\nvar round = Physics.body('circle', {\n x: 30,\n y: 20,\n radius: 5\n});\n```", "short_description": "Physics.body('circle')\n", "line": 24, "aliases": [], "children": [], "file": "src/bodies/circle.js", "subclasses": [], "name": "CircleBody", "path": "CircleBody", "outFile": "circle.html" }, { "id": "CompoundBody", "type": "class", "superclass": "Body", "description": "Physics.body('compound')\n\nNot a body in itself. It's a container to group other bodies. The position of the body is the center of mass.\nIt must have at least one child before being added to the world.\n\nAdditional config options:\n\n- children: Array of [[Body]] objects.\n\nExample:\n\n```javascript\nvar thing = Physics.body('compound', {\n // place the center of mass at (300, 200)\n x: 300,\n y: 200,\n // the center of mass is automatically calculated and used to position the shape\n children: [\n body1,\n body2,\n // ...\n ]\n});\n```", "short_description": "Physics.body('compound')\n", "line": 32, "aliases": [], "children": [ { "id": "CompoundBody#addChild", "type": "instance method", "signatures": [ { "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The child to add\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The child to add\n\n " } ], "description": "Add a body as a child.", "short_description": "Add a body as a child.", "line": 68, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "addChild", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.addChild", "outFile": "compound.html#CompoundBody.prototype.addChild" }, { "id": "CompoundBody#addChildren", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of children to add\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of children to add\n\n " } ], "description": "Add an array of children to the compound.", "short_description": "Add an array of children to the compound.", "line": 80, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "addChildren", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.addChildren", "outFile": "compound.html#CompoundBody.prototype.addChildren" }, { "id": "CompoundBody#clear", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Remove all children.", "short_description": "Remove all children.", "line": 142, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "clear", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.clear", "outFile": "compound.html#CompoundBody.prototype.clear" }, { "id": "CompoundBody#refreshGeometry", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "If the children's positions change, `refreshGeometry()` should be called to fix the shape.", "short_description": "If the children's positions change, `refreshGeometry()` should be called to fix the shape.", "line": 159, "aliases": [], "children": [], "file": "src/bodies/compound.js", "name": "refreshGeometry", "name_prefix": "CompoundBody#", "path": "CompoundBody.prototype.refreshGeometry", "outFile": "compound.html#CompoundBody.prototype.refreshGeometry" } ], "file": "src/bodies/compound.js", "subclasses": [], "name": "CompoundBody", "path": "CompoundBody", "outFile": "compound.html" }, { "id": "ConvexPolygonBody", "type": "class", "superclass": "Body", "description": "Physics.body('convex-polygon')\n\nBody for convex polygons. The position of the body is the centroid of the polygon.\n\nAdditional config options:\n\n- vertices: Array of [[Vectorish]] objects representing the polygon vertices in clockwise (or counterclockwise) order.\n\nExample:\n\n```javascript\nvar pentagon = Physics.body('convex-polygon', {\n // place the centroid of the polygon at (300, 200)\n x: 300,\n y: 200,\n // the centroid is automatically calculated and used to position the shape\n vertices: [\n { x: 0, y: -30 },\n { x: -29, y: -9 },\n { x: -18, y: 24 },\n { x: 18, y: 24 },\n { x: 29, y: -9 }\n ]\n});\n```", "short_description": "Physics.body('convex-polygon')\n", "line": 33, "aliases": [], "children": [], "file": "src/bodies/convex-polygon.js", "subclasses": [], "name": "ConvexPolygonBody", "path": "ConvexPolygonBody", "outFile": "convex-polygon.html" }, { "id": "PointBody", "type": "class", "superclass": "Body", "alias_of": "Body", "description": "Physics.body('point')\n\nThe point body represents a point.", "short_description": "Physics.body('point')\n", "line": 8, "aliases": [], "children": [], "file": "src/bodies/point.js", "subclasses": [], "name": "PointBody", "path": "PointBody", "outFile": "point.html" }, { "id": "RectangleBody", "type": "class", "superclass": "Body", "description": "Physics.body('rectangle')\n\nBody for rectangles. The position of the body is the centroid of the rectangle.\n\nAdditional config options:\n\n- width: The width\n- height: The height\n\nExample:\n\n```javascript\nvar rect = Physics.body('rectangle', {\n // place the centroid of the rectangle at (300, 200)\n x: 300,\n y: 200,\n width: 30,\n height: 40\n});\n```", "short_description": "Physics.body('rectangle')\n", "line": 28, "aliases": [], "children": [], "file": "src/bodies/rectangle.js", "subclasses": [], "name": "RectangleBody", "path": "RectangleBody", "outFile": "rectangle.html" } ], "file": "src/core/body.js", "subclasses": [ "CircleBody", "CompoundBody", "ConvexPolygonBody", "PointBody", "RectangleBody" ], "name": "Body", "path": "Body", "outFile": "body.html" }, "Body#init": { "id": "Body#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 72, "aliases": [], "children": [], "file": "src/core/body.js", "name": "init", "name_prefix": "Body#", "path": "Body.prototype.init", "outFile": "body.html#Body.prototype.init" }, "Body#options": { "id": "Body#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this instance.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this instance.\n", "line": 93, "aliases": [], "children": [], "file": "src/core/body.js", "name": "options", "name_prefix": "Body#", "path": "Body.prototype.options", "outFile": "body.html#Body.prototype.options" }, "Body#state": { "id": "Body#state", "type": "namespace", "description": "The physical state container.\n\n- ``this.state.pos`` ([[Physics.vector]]) The position vector.\n- ``this.state.vel`` ([[Physics.vector]]) The velocity vector.\n- ``this.state.acc`` ([[Physics.vector]]) The acceleration vector.\n- ``this.state.angular.pos`` ([[Number]]) The angular position (in radians, positive is clockwise starting along the x axis)\n- ``this.state.angular.vel`` ([[Number]]) The angular velocity\n- ``this.state.angular.acc`` ([[Number]]) The angular acceleration\n\nProperties from the previous timestep are stored in:\n```javascript\nthis.state.old; // .pos, .vel, ...\n```", "short_description": "The physical state container.\n", "line": 117, "aliases": [], "children": [], "file": "src/core/body.js", "name": "state", "name_prefix": "Body#", "path": "Body.prototype.state", "outFile": "body.html#Body.prototype.state" }, "Body#uid": { "id": "Body#uid", "type": "constant", "signatures": [ { "returns": [ { "type": "Number" } ] } ], "description": "The unique id for the body", "short_description": "The unique id for the body", "line": 162, "aliases": [], "children": [], "file": "src/core/body.js", "name": "uid", "name_prefix": "Body#", "path": "Body.prototype.uid", "outFile": "body.html#Body.prototype.uid" }, "Body#geometry": { "id": "Body#geometry", "type": "namespace", "related_to": "Physics.geometry", "description": "The geometry for this body.\n\nBy default it is a `point` geometry which gets overridden.", "short_description": "The geometry for this body.\n", "line": 171, "aliases": [], "children": [], "file": "src/core/body.js", "name": "geometry", "name_prefix": "Body#", "path": "Body.prototype.geometry", "outFile": "body.html#Body.prototype.geometry" }, "Body#mass": { "id": "Body#mass", "type": "constant", "signatures": [ { "returns": [ { "type": "1" } ] } ], "description": "The mass.", "short_description": "The mass.", "line": 178, "aliases": [], "children": [], "file": "src/core/body.js", "name": "mass", "name_prefix": "Body#", "path": "Body.prototype.mass", "outFile": "body.html#Body.prototype.mass" }, "Body#offset": { "id": "Body#offset", "type": "namespace", "description": "The vector offsetting the body's shape from its center of mass.", "short_description": "The vector offsetting the body's shape from its center of mass.", "line": 184, "aliases": [], "children": [], "file": "src/core/body.js", "name": "offset", "name_prefix": "Body#", "path": "Body.prototype.offset", "outFile": "body.html#Body.prototype.offset" }, "Body#restitution": { "id": "Body#restitution", "type": "constant", "signatures": [ { "returns": [ { "type": "1" } ] } ], "description": "The restitution.\n\nThis is the \"bounciness\" of the body.\nIt's a number between `0` and `1`.\n\nA restitution of 1 is the bounciest.\n\nA restitution of 0 is not bouncy.\n\nWhen colliding the restitutions of bodies are\nmultiplied together to get the restitution between two\nbodies.", "short_description": "The restitution.\n", "line": 202, "aliases": [], "children": [], "file": "src/core/body.js", "name": "restitution", "name_prefix": "Body#", "path": "Body.prototype.restitution", "outFile": "body.html#Body.prototype.restitution" }, "Body#cof": { "id": "Body#cof", "type": "constant", "signatures": [ { "returns": [ { "type": "0.8" } ] } ], "description": "The coefficient of friction of the body.\n\nIt's how much \"slide\" it has during collisions.\n\nA `cof` of `0` will really slidy.\n\nA `cof` of `1` has no slide.\n\nThis is a very simplistic implementation at the moment.\nWhat would be better is to have both static and kinetic\nfriction. But that's not done yet.", "short_description": "The coefficient of friction of the body.\n", "line": 218, "aliases": [], "children": [], "file": "src/core/body.js", "name": "cof", "name_prefix": "Body#", "path": "Body.prototype.cof", "outFile": "body.html#Body.prototype.cof" }, "Body#treatment": { "id": "Body#treatment", "type": "constant", "signatures": [ { "returns": [ { "type": "String" } ] } ], "description": "How the body is treated by the simulation.\n\nThe body can be `dynamic`, `kinematic` or `static` as\ndescribed by the [analogous box2d docs](http://www.box2d.org/manual.html#_Toc258082973).\n\n* _dynamic_ bodies are treated \"normally\". They are integrated, and collide, and all that.\n* _kinematic_ bodies are bodies that move at a specified velocity. Other bodies collide with them, but they don't bounce off of other bodies.\n* _static_ bodies just stand still. They are like obstacles.", "short_description": "How the body is treated by the simulation.\n", "line": 231, "aliases": [], "children": [], "file": "src/core/body.js", "name": "treatment", "name_prefix": "Body#", "path": "Body.prototype.treatment", "outFile": "body.html#Body.prototype.treatment" }, "Body#hidden": { "id": "Body#hidden", "type": "constant", "signatures": [ { "returns": [ { "type": "false" } ] } ], "description": "Determines whether the body should be hidden by the renderer.", "short_description": "Determines whether the body should be hidden by the renderer.", "line": 237, "aliases": [], "children": [], "file": "src/core/body.js", "name": "hidden", "name_prefix": "Body#", "path": "Body.prototype.hidden", "outFile": "body.html#Body.prototype.hidden" }, "Body#view": { "id": "Body#view", "type": "constant", "signatures": [ { "returns": [ { "type": "it_depends" } ] } ], "related_to": "Physics.renderer", "description": "Storage for use by the renderer.\n\nThe type of renderer will put different things in the view property.\nBasically, this is how the body \"looks\". It could be a HTMLElement, or\nan Image, etc...\n\nIf your body changes appearance (shape), you should modify this somehow\notherwise the renderer will keep using this same view. If you're letting\nthe renderer create the view for you, just set this to `undefined` if the\nbody gets modified in shape during the simulation.", "short_description": "Storage for use by the renderer.\n", "line": 252, "aliases": [], "children": [], "file": "src/core/body.js", "name": "view", "name_prefix": "Body#", "path": "Body.prototype.view", "outFile": "body.html#Body.prototype.view" }, "Body#styles": { "id": "Body#styles", "type": "namespace", "related_to": "Physics.renderer", "description": "The styles the renderer should use for creating the view.\n\nThe styles depend on the renderer. See [[Renderer#createView]] for style options.", "short_description": "The styles the renderer should use for creating the view.\n", "line": 260, "aliases": [], "children": [], "file": "src/core/body.js", "name": "styles", "name_prefix": "Body#", "path": "Body.prototype.styles", "outFile": "body.html#Body.prototype.styles" }, "Body#sleep": { "id": "Body#sleep", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dt", "optional": true, "types": [ "Number" ], "description": " Time to advance the idle time\n\n " } ], "returns": [ { "type": "Boolean" } ] } ], "arguments": [ { "name": "dt", "types": [ "Number" ], "description": " Time to advance the idle time\n\n " }, { "name": "dt", "types": [ "Boolean" ], "description": " If `true`, the body will be forced to sleep. If `false`, the body will be forced to awake.\n\n " } ], "description": "Get and/or set whether the body is asleep.\n\nIf called with a time (in ms), the time will be added to the idle time and sleep conditions will be checked.", "short_description": "Get and/or set whether the body is asleep.\n", "line": 271, "aliases": [], "children": [], "file": "src/core/body.js", "name": "sleep", "name_prefix": "Body#", "path": "Body.prototype.sleep", "outFile": "body.html#Body.prototype.sleep" }, "Body#sleepCheck": { "id": "Body#sleepCheck", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dt", "optional": true, "types": [ "Number" ], "description": " Time to advance the idle time\n\n " } ] } ], "arguments": [ { "name": "dt", "types": [ "Number" ], "description": " Time to advance the idle time\n\n " } ], "description": "Check if the body should be sleeping.\n\nCall with no arguments if some event could possibly wake up the body. This will force the body to recheck.", "short_description": "Check if the body should be sleeping.\n", "line": 303, "aliases": [], "children": [], "file": "src/core/body.js", "name": "sleepCheck", "name_prefix": "Body#", "path": "Body.prototype.sleepCheck", "outFile": "body.html#Body.prototype.sleepCheck" }, "Body#setWorld": { "id": "Body#setWorld", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "description": "Set which world to apply to.\n\nUsually this is called internally. Shouldn't be a need to call this yourself usually.", "short_description": "Set which world to apply to.\n", "line": 374, "aliases": [], "children": [], "file": "src/core/body.js", "name": "setWorld", "name_prefix": "Body#", "path": "Body.prototype.setWorld", "outFile": "body.html#Body.prototype.setWorld" }, "Body#accelerate": { "id": "Body#accelerate", "type": "instance method", "signatures": [ { "arguments": [ { "name": "acc", "types": [ "Physics.vector" ], "description": " The acceleration vector\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "acc", "types": [ "Physics.vector" ], "description": " The acceleration vector\n\n " } ], "description": "Accelerate the body by adding supplied vector to its current acceleration", "short_description": "Accelerate the body by adding supplied vector to its current acceleration", "line": 395, "aliases": [], "children": [], "file": "src/core/body.js", "name": "accelerate", "name_prefix": "Body#", "path": "Body.prototype.accelerate", "outFile": "body.html#Body.prototype.accelerate" }, "Body#applyForce": { "id": "Body#applyForce", "type": "instance method", "signatures": [ { "arguments": [ { "name": "force", "types": [ "Vectorish" ], "description": " The force vector\n\n " }, { "name": "p", "optional": true, "types": [ "Vectorish" ], "description": " The point vector from the COM at which to apply the force\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "force", "types": [ "Vectorish" ], "description": " The force vector\n\n " }, { "name": "p", "types": [ "Vectorish" ], "description": " The point vector from the COM at which to apply the force\n\n " } ], "description": "Apply a force at center of mass, or at point `p` relative to the center of mass", "short_description": "Apply a force at center of mass, or at point `p` relative to the center of mass", "line": 411, "aliases": [], "children": [], "file": "src/core/body.js", "name": "applyForce", "name_prefix": "Body#", "path": "Body.prototype.applyForce", "outFile": "body.html#Body.prototype.applyForce" }, "Body#getGlobalOffset": { "id": "Body#getGlobalOffset", "type": "instance method", "signatures": [ { "arguments": [ { "name": "out", "optional": true, "types": [ "Physics.vector" ], "description": " A vector to use to put the result into. One is created if `out` isn't specified.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The offset in global coordinates\n\n " } ] } ], "arguments": [ { "name": "out", "types": [ "Physics.vector" ], "description": " A vector to use to put the result into. One is created if `out` isn't specified.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The offset in global coordinates\n\n " } ], "related_to": "Body#offset", "description": "Get the body offset vector (from the center of mass) for the body's shape in global coordinates.", "short_description": "Get the body offset vector (from the center of mass) for the body's shape in global coordinates.", "line": 445, "aliases": [], "children": [], "file": "src/core/body.js", "name": "getGlobalOffset", "name_prefix": "Body#", "path": "Body.prototype.getGlobalOffset", "outFile": "body.html#Body.prototype.getGlobalOffset" }, "Body#aabb": { "id": "Body#aabb", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Object" } ] } ], "returns": [ { "type": "Object", "description": " The aabb of this body\n\n " } ], "related_to": "Physics.aabb", "description": "Get the Axis aligned bounding box for the body in its current position and rotation", "short_description": "Get the Axis aligned bounding box for the body in its current position and rotation", "line": 458, "aliases": [], "children": [], "file": "src/core/body.js", "name": "aabb", "name_prefix": "Body#", "path": "Body.prototype.aabb", "outFile": "body.html#Body.prototype.aabb" }, "Body#toBodyCoords": { "id": "Body#toBodyCoords", "type": "instance method", "signatures": [ { "arguments": [ { "name": "v", "types": [ "Physics.vector" ], "description": " The vector to transform\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The transformed vector\n\n " } ] } ], "arguments": [ { "name": "v", "types": [ "Physics.vector" ], "description": " The vector to transform\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The transformed vector\n\n " } ], "description": "Transform a vector into coordinates relative to this body.", "short_description": "Transform a vector into coordinates relative to this body.", "line": 481, "aliases": [], "children": [], "file": "src/core/body.js", "name": "toBodyCoords", "name_prefix": "Body#", "path": "Body.prototype.toBodyCoords", "outFile": "body.html#Body.prototype.toBodyCoords" }, "Body#toWorldCoords": { "id": "Body#toWorldCoords", "type": "instance method", "signatures": [ { "arguments": [ { "name": "v", "types": [ "Physics.vector" ], "description": " The vector to transform\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The transformed vector\n\n " } ] } ], "arguments": [ { "name": "v", "types": [ "Physics.vector" ], "description": " The vector to transform\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The transformed vector\n\n " } ], "description": "Transform a vector from body coordinates into world coordinates.", "short_description": "Transform a vector from body coordinates into world coordinates.", "line": 492, "aliases": [], "children": [], "file": "src/core/body.js", "name": "toWorldCoords", "name_prefix": "Body#", "path": "Body.prototype.toWorldCoords", "outFile": "body.html#Body.prototype.toWorldCoords" }, "Body#recalc": { "id": "Body#recalc", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Recalculate properties.\n\nIntended to be overridden by subclasses. Call when body physical properties are changed.", "short_description": "Recalculate properties.\n", "line": 503, "aliases": [], "children": [], "file": "src/core/body.js", "name": "recalc", "name_prefix": "Body#", "path": "Body.prototype.recalc", "outFile": "body.html#Body.prototype.recalc" }, "Body.getCOM": { "id": "Body.getCOM", "type": "class method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of bodies\n\n " }, { "name": "com", "optional": true, "types": [ "Physics.vector" ], "description": " The vector to put result into. A new vector will be created if not provided.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The center of mass position\n\n " } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " The list of bodies\n\n " }, { "name": "com", "types": [ "Physics.vector" ], "description": " The vector to put result into. A new vector will be created if not provided.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The center of mass position\n\n " } ], "description": "Get center of mass position from list of bodies.", "short_description": "Get center of mass position from list of bodies.", "line": 517, "aliases": [], "children": [], "file": "src/core/body.js", "name": "getCOM", "name_prefix": "Body.", "path": "Body.getCOM", "outFile": "body.html#Body.getCOM" }, "Physics.geometry.regularPolygonVertices": { "id": "Physics.geometry.regularPolygonVertices", "type": "class method", "signatures": [ { "arguments": [ { "name": "sides", "types": [ "Number" ], "description": " Number of sides the polygon has\n\n " }, { "name": "radius", "types": [ "Number" ], "description": " Size from center to a vertex\n\n " } ], "returns": [ { "type": "Array", "description": " A list of [[Vectorish]] objects representing the vertices\n\n " } ] } ], "arguments": [ { "name": "sides", "types": [ "Number" ], "description": " Number of sides the polygon has\n\n " }, { "name": "radius", "types": [ "Number" ], "description": " Size from center to a vertex\n\n " } ], "returns": [ { "type": "Array", "description": " A list of [[Vectorish]] objects representing the vertices\n\n " } ], "description": "Generate a list of vertices for a regular polygon of any number of sides.", "short_description": "Generate a list of vertices for a regular polygon of any number of sides.", "line": 13, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "regularPolygonVertices", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.regularPolygonVertices", "outFile": "geometry-helpers.html#Physics.geometry.regularPolygonVertices" }, "Physics.geometry.isPolygonConvex": { "id": "Physics.geometry.isPolygonConvex", "type": "class method", "signatures": [ { "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Boolean", "description": " `true` if the polygon is convex. `false` otherwise.\n\n " } ] } ], "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Boolean", "description": " `true` if the polygon is convex. `false` otherwise.\n\n " } ], "description": "Determine if polygon hull is convex", "short_description": "Determine if polygon hull is convex", "line": 39, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "isPolygonConvex", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.isPolygonConvex", "outFile": "geometry-helpers.html#Physics.geometry.isPolygonConvex" }, "Physics.geometry.getPolygonMOI": { "id": "Physics.geometry.getPolygonMOI", "type": "class method", "signatures": [ { "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Number", "description": " The polygon's moment of inertia\n\n " } ] } ], "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Number", "description": " The polygon's moment of inertia\n\n " } ], "description": "Gets the moment of inertia of a convex polygon\n\nSee [List of moments of inertia](http://en.wikipedia.org/wiki/List_of_moments_of_inertia)\nfor more information.\n\n_Note_: we make the following assumpations:\n* mass is unitary (== 1)\n* axis of rotation is the origin", "short_description": "Gets the moment of inertia of a convex polygon\n", "line": 104, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "getPolygonMOI", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.getPolygonMOI", "outFile": "geometry-helpers.html#Physics.geometry.getPolygonMOI" }, "Physics.geometry.isPointInPolygon": { "id": "Physics.geometry.isPointInPolygon", "type": "class method", "signatures": [ { "arguments": [ { "name": "pt", "types": [ "Vectorish" ], "description": " The point to test\n\n " }, { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Boolean", "description": " `true` if point `pt` is inside the polygon\n\n " } ] } ], "arguments": [ { "name": "pt", "types": [ "Vectorish" ], "description": " The point to test\n\n " }, { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Boolean", "description": " `true` if point `pt` is inside the polygon\n\n " } ], "description": "Check if point is inside polygon hull.", "short_description": "Check if point is inside polygon hull.", "line": 155, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "isPointInPolygon", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.isPointInPolygon", "outFile": "geometry-helpers.html#Physics.geometry.isPointInPolygon" }, "Physics.geometry.getPolygonArea": { "id": "Physics.geometry.getPolygonArea", "type": "class method", "signatures": [ { "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Number", "description": " The area (positive for clockwise ordering)\n\n " } ] } ], "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Number", "description": " The area (positive for clockwise ordering)\n\n " } ], "description": "Get the signed area of the polygon.", "short_description": "Get the signed area of the polygon.", "line": 202, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "getPolygonArea", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.getPolygonArea", "outFile": "geometry-helpers.html#Physics.geometry.getPolygonArea" }, "Physics.geometry.getPolygonCentroid": { "id": "Physics.geometry.getPolygonCentroid", "type": "class method", "signatures": [ { "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The centroid\n\n " } ] } ], "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The centroid\n\n " } ], "description": "Get the coordinates of the centroid.", "short_description": "Get the coordinates of the centroid.", "line": 240, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "getPolygonCentroid", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.getPolygonCentroid", "outFile": "geometry-helpers.html#Physics.geometry.getPolygonCentroid" }, "Physics.geometry.nearestPointOnLine": { "id": "Physics.geometry.nearestPointOnLine", "type": "class method", "signatures": [ { "arguments": [ { "name": "pt", "types": [ "Vectorish" ], "description": " The point\n\n " }, { "name": "linePt1", "types": [ "Vectorish" ], "description": " The first endpoint of the line\n\n " }, { "name": "linePt2", "types": [ "Vectorish" ], "description": " The second endpoint of the line\n\n " } ], "returns": [ { "type": "Vector", "description": " The closest point\n\n " } ] } ], "arguments": [ { "name": "pt", "types": [ "Vectorish" ], "description": " The point\n\n " }, { "name": "linePt1", "types": [ "Vectorish" ], "description": " The first endpoint of the line\n\n " }, { "name": "linePt2", "types": [ "Vectorish" ], "description": " The second endpoint of the line\n\n " } ], "returns": [ { "type": "Vector", "description": " The closest point\n\n " } ], "description": "Get the closest point on a discrete line to specified point.", "short_description": "Get the closest point on a discrete line to specified point.", "line": 291, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "nearestPointOnLine", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.nearestPointOnLine", "outFile": "geometry-helpers.html#Physics.geometry.nearestPointOnLine" }, "Physics.geometry": { "id": "Physics.geometry", "type": "class method", "signatures": [ { "arguments": [ { "name": "name", "types": [ "String" ], "description": " The name of the geometry to create\n\n " }, { "name": "options", "optional": true, "types": [ "Object" ], "description": " The configuration for that geometry ( depends on geometry ).\n\n " } ], "returns": [ { "type": "Geometry" } ] } ], "arguments": [ { "name": "name", "types": [ "String" ], "description": " The name of the geometry to create\n\n " }, { "name": "options", "types": [ "Object" ], "description": " The configuration for that geometry ( depends on geometry ).\n\n " } ], "related_to": "Physics.util.decorator", "description": "Factory function for creating Geometries.\n\nVisit [the PhysicsJS wiki on Geometries](https://github.com/wellcaffeinated/PhysicsJS/wiki/Geometries)\nfor usage documentation.", "short_description": "Factory function for creating Geometries.\n", "line": 12, "aliases": [], "children": [ { "id": "Physics.geometry.getPolygonArea", "type": "class method", "signatures": [ { "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Number", "description": " The area (positive for clockwise ordering)\n\n " } ] } ], "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Number", "description": " The area (positive for clockwise ordering)\n\n " } ], "description": "Get the signed area of the polygon.", "short_description": "Get the signed area of the polygon.", "line": 202, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "getPolygonArea", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.getPolygonArea", "outFile": "geometry-helpers.html#Physics.geometry.getPolygonArea" }, { "id": "Physics.geometry.getPolygonCentroid", "type": "class method", "signatures": [ { "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The centroid\n\n " } ] } ], "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The centroid\n\n " } ], "description": "Get the coordinates of the centroid.", "short_description": "Get the coordinates of the centroid.", "line": 240, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "getPolygonCentroid", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.getPolygonCentroid", "outFile": "geometry-helpers.html#Physics.geometry.getPolygonCentroid" }, { "id": "Physics.geometry.getPolygonMOI", "type": "class method", "signatures": [ { "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Number", "description": " The polygon's moment of inertia\n\n " } ] } ], "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Number", "description": " The polygon's moment of inertia\n\n " } ], "description": "Gets the moment of inertia of a convex polygon\n\nSee [List of moments of inertia](http://en.wikipedia.org/wiki/List_of_moments_of_inertia)\nfor more information.\n\n_Note_: we make the following assumpations:\n* mass is unitary (== 1)\n* axis of rotation is the origin", "short_description": "Gets the moment of inertia of a convex polygon\n", "line": 104, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "getPolygonMOI", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.getPolygonMOI", "outFile": "geometry-helpers.html#Physics.geometry.getPolygonMOI" }, { "id": "Physics.geometry.isPointInPolygon", "type": "class method", "signatures": [ { "arguments": [ { "name": "pt", "types": [ "Vectorish" ], "description": " The point to test\n\n " }, { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Boolean", "description": " `true` if point `pt` is inside the polygon\n\n " } ] } ], "arguments": [ { "name": "pt", "types": [ "Vectorish" ], "description": " The point to test\n\n " }, { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Boolean", "description": " `true` if point `pt` is inside the polygon\n\n " } ], "description": "Check if point is inside polygon hull.", "short_description": "Check if point is inside polygon hull.", "line": 155, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "isPointInPolygon", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.isPointInPolygon", "outFile": "geometry-helpers.html#Physics.geometry.isPointInPolygon" }, { "id": "Physics.geometry.isPolygonConvex", "type": "class method", "signatures": [ { "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Boolean", "description": " `true` if the polygon is convex. `false` otherwise.\n\n " } ] } ], "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Array of ([[Vectorish]]) vertices\n\n " } ], "returns": [ { "type": "Boolean", "description": " `true` if the polygon is convex. `false` otherwise.\n\n " } ], "description": "Determine if polygon hull is convex", "short_description": "Determine if polygon hull is convex", "line": 39, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "isPolygonConvex", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.isPolygonConvex", "outFile": "geometry-helpers.html#Physics.geometry.isPolygonConvex" }, { "id": "Physics.geometry.nearestPointOnLine", "type": "class method", "signatures": [ { "arguments": [ { "name": "pt", "types": [ "Vectorish" ], "description": " The point\n\n " }, { "name": "linePt1", "types": [ "Vectorish" ], "description": " The first endpoint of the line\n\n " }, { "name": "linePt2", "types": [ "Vectorish" ], "description": " The second endpoint of the line\n\n " } ], "returns": [ { "type": "Vector", "description": " The closest point\n\n " } ] } ], "arguments": [ { "name": "pt", "types": [ "Vectorish" ], "description": " The point\n\n " }, { "name": "linePt1", "types": [ "Vectorish" ], "description": " The first endpoint of the line\n\n " }, { "name": "linePt2", "types": [ "Vectorish" ], "description": " The second endpoint of the line\n\n " } ], "returns": [ { "type": "Vector", "description": " The closest point\n\n " } ], "description": "Get the closest point on a discrete line to specified point.", "short_description": "Get the closest point on a discrete line to specified point.", "line": 291, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "nearestPointOnLine", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.nearestPointOnLine", "outFile": "geometry-helpers.html#Physics.geometry.nearestPointOnLine" }, { "id": "Physics.geometry.regularPolygonVertices", "type": "class method", "signatures": [ { "arguments": [ { "name": "sides", "types": [ "Number" ], "description": " Number of sides the polygon has\n\n " }, { "name": "radius", "types": [ "Number" ], "description": " Size from center to a vertex\n\n " } ], "returns": [ { "type": "Array", "description": " A list of [[Vectorish]] objects representing the vertices\n\n " } ] } ], "arguments": [ { "name": "sides", "types": [ "Number" ], "description": " Number of sides the polygon has\n\n " }, { "name": "radius", "types": [ "Number" ], "description": " Size from center to a vertex\n\n " } ], "returns": [ { "type": "Array", "description": " A list of [[Vectorish]] objects representing the vertices\n\n " } ], "description": "Generate a list of vertices for a regular polygon of any number of sides.", "short_description": "Generate a list of vertices for a regular polygon of any number of sides.", "line": 13, "aliases": [], "children": [], "file": "src/core/geometry-helpers.js", "name": "regularPolygonVertices", "name_prefix": "Physics.geometry.", "path": "Physics.geometry.regularPolygonVertices", "outFile": "geometry-helpers.html#Physics.geometry.regularPolygonVertices" }, { "id": "Geometry", "type": "class", "belongs_to": "Physics.geometry", "description": "The base class for geometries created by [[Physics.geometry]] factory function.", "short_description": "The base class for geometries created by [[Physics.geometry]] factory function.", "line": 19, "aliases": [ "PointGeometry" ], "children": [ { "id": "Geometry#aabb", "type": "instance method", "signatures": [ { "arguments": [ { "name": "angle", "types": [ "Number" ], "description": " The angle to rotate the geometry\n\n " } ], "returns": [ { "type": "Object", "description": " Bounding box values\n\n " } ] } ], "arguments": [ { "name": "angle", "types": [ "Number" ], "description": " The angle to rotate the geometry\n\n " } ], "returns": [ { "type": "Object", "description": " Bounding box values\n\n " } ], "related_to": "Physics.aabb", "description": "Get axis-aligned bounding box for this object (rotated by angle if specified).", "short_description": "Get axis-aligned bounding box for this object (rotated by angle if specified).", "line": 57, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "aabb", "name_prefix": "Geometry#", "path": "Geometry.prototype.aabb", "outFile": "geometry.html#Geometry.prototype.aabb" }, { "id": "Geometry#getFarthestCorePoint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dir", "types": [ "Physics.vector" ], "description": " Direction to look\n\n " }, { "name": "result", "optional": true, "types": [ "Physics.vector" ], "description": " A vector to write result to. Speeds up calculations.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The farthest hull point in local coordinates\n\n " } ] } ], "arguments": [ { "name": "dir", "types": [ "Physics.vector" ], "description": " Direction to look\n\n " }, { "name": "result", "types": [ "Physics.vector" ], "description": " A vector to write result to. Speeds up calculations.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The farthest hull point in local coordinates\n\n " } ], "related_to": "Geometry#getFarthestHullPoint", "description": "Get farthest point on the core shape of this geometry\nalong the direction vector `dir`\nreturns local coordinates. Replaces result if provided.\n\nThis does almost the same thing as [[Geometry#getFarthestHullPoint]]\nbut shrinks the shape by subtracting \"margin\" from it.\nReturn the position of the point on the \"core\" shape.", "short_description": "Get farthest point on the core shape of this geometry\nalong the direction vector `dir`\nreturns local coordinates. Replaces result if provided.\n", "line": 104, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "getFarthestCorePoint", "name_prefix": "Geometry#", "path": "Geometry.prototype.getFarthestCorePoint", "outFile": "geometry.html#Geometry.prototype.getFarthestCorePoint" }, { "id": "Geometry#getFarthestHullPoint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dir", "types": [ "Physics.vector" ], "description": " Direction to look\n\n " }, { "name": "result", "optional": true, "types": [ "Physics.vector" ], "description": " A vector to write result to. Speeds up calculations.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The farthest hull point in local coordinates\n\n " } ] } ], "arguments": [ { "name": "dir", "types": [ "Physics.vector" ], "description": " Direction to look\n\n " }, { "name": "result", "types": [ "Physics.vector" ], "description": " A vector to write result to. Speeds up calculations.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The farthest hull point in local coordinates\n\n " } ], "description": "Get farthest point on the hull of this geometry\nalong the direction vector `dir`\nreturns local coordinates. Replaces result if provided.\n\nAssume all coordinates are relative to the geometry\ncentroid (IE: in the body frame).\n\nThis should take a direction vector then it should\ncalculate the location (in that frame of reference)\nof the point on the perimeter (hull) if you traveled\nin a straight line from the centroid in the provided\ndirection. The result should be returned/set just like\nit is in the other geometries.", "short_description": "Get farthest point on the hull of this geometry\nalong the direction vector `dir`\nreturns local coordinates. Replaces result if provided.\n", "line": 82, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "getFarthestHullPoint", "name_prefix": "Geometry#", "path": "Geometry.prototype.getFarthestHullPoint", "outFile": "geometry.html#Geometry.prototype.getFarthestHullPoint" }, { "id": "Geometry#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 26, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "init", "name_prefix": "Geometry#", "path": "Geometry.prototype.init", "outFile": "geometry.html#Geometry.prototype.init" }, { "id": "Geometry#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this instance.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this instance.\n", "line": 44, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "options", "name_prefix": "Geometry#", "path": "Geometry.prototype.options", "outFile": "geometry.html#Geometry.prototype.options" }, { "id": "CircleGeometry", "type": "class", "superclass": "Geometry", "description": "Physics.geometry('circle')\n\nThe circle geometry has a circular shape.\n\nAdditional options include:\n- radius: the radius\n\nExample:\n\n```javascript\nvar round = Physics.body('circle', {\n x: 30,\n y: 20,\n radius: 5\n});\n```", "short_description": "Physics.geometry('circle')\n", "line": 21, "aliases": [], "children": [], "file": "src/geometries/circle.js", "subclasses": [], "name": "CircleGeometry", "path": "CircleGeometry", "outFile": "circle.html" }, { "id": "CompoundGeometry", "type": "class", "superclass": "Geometry", "description": "Physics.geometry('compound')\n\nGeometry for compound shapes.\n\nExample:\n\n```javascript\nvar thing = Physics.geometry('compound');\nthing.addChild( child, pos, rotation );\n```", "short_description": "Physics.geometry('compound')\n", "line": 15, "aliases": [], "children": [ { "id": "CompoundGeometry#addChild", "type": "instance method", "signatures": [ { "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " The child to add.\n\n " }, { "name": "pos", "types": [ "Physics.vector" ], "description": " The position to add the child at.\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " The child to add.\n\n " }, { "name": "pos", "types": [ "Physics.vector" ], "description": " The position to add the child at.\n\n " }, { "name": "angle", "types": [ "Number" ], "description": " The rotation angle\n\n " } ], "description": "Add a child at relative position.", "short_description": "Add a child at relative position.", "line": 45, "aliases": [], "children": [], "file": "src/geometries/compound.js", "name": "addChild", "name_prefix": "CompoundGeometry#", "path": "CompoundGeometry.prototype.addChild", "outFile": "compound.html#CompoundGeometry.prototype.addChild" }, { "id": "CompoundGeometry#clear", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Remove all children.", "short_description": "Remove all children.", "line": 62, "aliases": [], "children": [], "file": "src/geometries/compound.js", "name": "clear", "name_prefix": "CompoundGeometry#", "path": "CompoundGeometry.prototype.clear", "outFile": "compound.html#CompoundGeometry.prototype.clear" } ], "file": "src/geometries/compound.js", "subclasses": [], "name": "CompoundGeometry", "path": "CompoundGeometry", "outFile": "compound.html" }, { "id": "ConvexPolygonGeometry", "type": "class", "superclass": "Geometry", "description": "Physics.geometry('convex-polygon')\n\nGeometry for convex polygons.\n\nAdditional config options:\n\n- vertices: Array of [[Vectorish]] objects representing the polygon vertices in clockwise (or counterclockwise) order.\n\nExample:\n\n```javascript\nvar pentagon = Physics.geometry('convex-polygon', {\n // the centroid is automatically calculated and used to position the shape\n vertices: [\n { x: 0, y: -30 },\n { x: -29, y: -9 },\n { x: -18, y: 24 },\n { x: 18, y: 24 },\n { x: 29, y: -9 }\n ]\n});\n```", "short_description": "Physics.geometry('convex-polygon')\n", "line": 27, "aliases": [], "children": [ { "id": "ConvexPolygonGeometry#setVertices", "type": "instance method", "signatures": [ { "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Vertices represented by an array of [[Vectorish]] objects, in either clockwise or counterclockwise order\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Vertices represented by an array of [[Vectorish]] objects, in either clockwise or counterclockwise order\n\n " } ], "description": "Set the vertices of this polygon.", "short_description": "Set the vertices of this polygon.", "line": 61, "aliases": [], "children": [], "file": "src/geometries/convex-polygon.js", "name": "setVertices", "name_prefix": "ConvexPolygonGeometry#", "path": "ConvexPolygonGeometry.prototype.setVertices", "outFile": "convex-polygon.html#ConvexPolygonGeometry.prototype.setVertices" } ], "file": "src/geometries/convex-polygon.js", "subclasses": [], "name": "ConvexPolygonGeometry", "path": "ConvexPolygonGeometry", "outFile": "convex-polygon.html" }, { "id": "PointGeometry", "type": "class", "superclass": "Geometry", "alias_of": "Geometry", "description": "Physics.geometry('point')\n\nThe point geometry represents a point.", "short_description": "Physics.geometry('point')\n", "line": 8, "aliases": [], "children": [], "file": "src/geometries/point.js", "subclasses": [], "name": "PointGeometry", "path": "PointGeometry", "outFile": "point.html" }, { "id": "RectangleGeometry", "type": "class", "superclass": "Geometry", "description": "Physics.geometry('rectangle')\n\nGeometry for rectangles.\n\nAdditional config options:\n\n- width: The width\n- height: The height\n\nExample:\n\n```javascript\nvar rectGeo = Physics.geometry('rectangle', {\n width: 30,\n height: 40\n});\n```", "short_description": "Physics.geometry('rectangle')\n", "line": 22, "aliases": [], "children": [ { "id": "RectangleGeometry#height", "type": "constant", "signatures": [ { "returns": [ { "type": "Number" } ] } ], "description": "The height", "short_description": "The height", "line": 51, "aliases": [], "children": [], "file": "src/geometries/rectangle.js", "name": "height", "name_prefix": "RectangleGeometry#", "path": "RectangleGeometry.prototype.height", "outFile": "rectangle.html#RectangleGeometry.prototype.height" }, { "id": "RectangleGeometry#width", "type": "constant", "signatures": [ { "returns": [ { "type": "Number" } ] } ], "description": "The width", "short_description": "The width", "line": 45, "aliases": [], "children": [], "file": "src/geometries/rectangle.js", "name": "width", "name_prefix": "RectangleGeometry#", "path": "RectangleGeometry.prototype.width", "outFile": "rectangle.html#RectangleGeometry.prototype.width" } ], "file": "src/geometries/rectangle.js", "subclasses": [], "name": "RectangleGeometry", "path": "RectangleGeometry", "outFile": "rectangle.html" } ], "file": "src/core/geometry.js", "subclasses": [ "CircleGeometry", "CompoundGeometry", "ConvexPolygonGeometry", "PointGeometry", "RectangleGeometry" ], "name": "Geometry", "path": "Geometry", "outFile": "geometry.html" } ], "file": "src/core/geometry.js", "name": "geometry", "name_prefix": "Physics.", "path": "Physics.geometry", "outFile": "geometry.html#Physics.geometry" }, "Geometry": { "id": "Geometry", "type": "class", "belongs_to": "Physics.geometry", "description": "The base class for geometries created by [[Physics.geometry]] factory function.", "short_description": "The base class for geometries created by [[Physics.geometry]] factory function.", "line": 19, "aliases": [ "PointGeometry" ], "children": [ { "id": "Geometry#aabb", "type": "instance method", "signatures": [ { "arguments": [ { "name": "angle", "types": [ "Number" ], "description": " The angle to rotate the geometry\n\n " } ], "returns": [ { "type": "Object", "description": " Bounding box values\n\n " } ] } ], "arguments": [ { "name": "angle", "types": [ "Number" ], "description": " The angle to rotate the geometry\n\n " } ], "returns": [ { "type": "Object", "description": " Bounding box values\n\n " } ], "related_to": "Physics.aabb", "description": "Get axis-aligned bounding box for this object (rotated by angle if specified).", "short_description": "Get axis-aligned bounding box for this object (rotated by angle if specified).", "line": 57, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "aabb", "name_prefix": "Geometry#", "path": "Geometry.prototype.aabb", "outFile": "geometry.html#Geometry.prototype.aabb" }, { "id": "Geometry#getFarthestCorePoint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dir", "types": [ "Physics.vector" ], "description": " Direction to look\n\n " }, { "name": "result", "optional": true, "types": [ "Physics.vector" ], "description": " A vector to write result to. Speeds up calculations.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The farthest hull point in local coordinates\n\n " } ] } ], "arguments": [ { "name": "dir", "types": [ "Physics.vector" ], "description": " Direction to look\n\n " }, { "name": "result", "types": [ "Physics.vector" ], "description": " A vector to write result to. Speeds up calculations.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The farthest hull point in local coordinates\n\n " } ], "related_to": "Geometry#getFarthestHullPoint", "description": "Get farthest point on the core shape of this geometry\nalong the direction vector `dir`\nreturns local coordinates. Replaces result if provided.\n\nThis does almost the same thing as [[Geometry#getFarthestHullPoint]]\nbut shrinks the shape by subtracting \"margin\" from it.\nReturn the position of the point on the \"core\" shape.", "short_description": "Get farthest point on the core shape of this geometry\nalong the direction vector `dir`\nreturns local coordinates. Replaces result if provided.\n", "line": 104, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "getFarthestCorePoint", "name_prefix": "Geometry#", "path": "Geometry.prototype.getFarthestCorePoint", "outFile": "geometry.html#Geometry.prototype.getFarthestCorePoint" }, { "id": "Geometry#getFarthestHullPoint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dir", "types": [ "Physics.vector" ], "description": " Direction to look\n\n " }, { "name": "result", "optional": true, "types": [ "Physics.vector" ], "description": " A vector to write result to. Speeds up calculations.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The farthest hull point in local coordinates\n\n " } ] } ], "arguments": [ { "name": "dir", "types": [ "Physics.vector" ], "description": " Direction to look\n\n " }, { "name": "result", "types": [ "Physics.vector" ], "description": " A vector to write result to. Speeds up calculations.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The farthest hull point in local coordinates\n\n " } ], "description": "Get farthest point on the hull of this geometry\nalong the direction vector `dir`\nreturns local coordinates. Replaces result if provided.\n\nAssume all coordinates are relative to the geometry\ncentroid (IE: in the body frame).\n\nThis should take a direction vector then it should\ncalculate the location (in that frame of reference)\nof the point on the perimeter (hull) if you traveled\nin a straight line from the centroid in the provided\ndirection. The result should be returned/set just like\nit is in the other geometries.", "short_description": "Get farthest point on the hull of this geometry\nalong the direction vector `dir`\nreturns local coordinates. Replaces result if provided.\n", "line": 82, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "getFarthestHullPoint", "name_prefix": "Geometry#", "path": "Geometry.prototype.getFarthestHullPoint", "outFile": "geometry.html#Geometry.prototype.getFarthestHullPoint" }, { "id": "Geometry#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 26, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "init", "name_prefix": "Geometry#", "path": "Geometry.prototype.init", "outFile": "geometry.html#Geometry.prototype.init" }, { "id": "Geometry#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this instance.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this instance.\n", "line": 44, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "options", "name_prefix": "Geometry#", "path": "Geometry.prototype.options", "outFile": "geometry.html#Geometry.prototype.options" }, { "id": "CircleGeometry", "type": "class", "superclass": "Geometry", "description": "Physics.geometry('circle')\n\nThe circle geometry has a circular shape.\n\nAdditional options include:\n- radius: the radius\n\nExample:\n\n```javascript\nvar round = Physics.body('circle', {\n x: 30,\n y: 20,\n radius: 5\n});\n```", "short_description": "Physics.geometry('circle')\n", "line": 21, "aliases": [], "children": [], "file": "src/geometries/circle.js", "subclasses": [], "name": "CircleGeometry", "path": "CircleGeometry", "outFile": "circle.html" }, { "id": "CompoundGeometry", "type": "class", "superclass": "Geometry", "description": "Physics.geometry('compound')\n\nGeometry for compound shapes.\n\nExample:\n\n```javascript\nvar thing = Physics.geometry('compound');\nthing.addChild( child, pos, rotation );\n```", "short_description": "Physics.geometry('compound')\n", "line": 15, "aliases": [], "children": [ { "id": "CompoundGeometry#addChild", "type": "instance method", "signatures": [ { "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " The child to add.\n\n " }, { "name": "pos", "types": [ "Physics.vector" ], "description": " The position to add the child at.\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " The child to add.\n\n " }, { "name": "pos", "types": [ "Physics.vector" ], "description": " The position to add the child at.\n\n " }, { "name": "angle", "types": [ "Number" ], "description": " The rotation angle\n\n " } ], "description": "Add a child at relative position.", "short_description": "Add a child at relative position.", "line": 45, "aliases": [], "children": [], "file": "src/geometries/compound.js", "name": "addChild", "name_prefix": "CompoundGeometry#", "path": "CompoundGeometry.prototype.addChild", "outFile": "compound.html#CompoundGeometry.prototype.addChild" }, { "id": "CompoundGeometry#clear", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "this" } ] } ], "description": "Remove all children.", "short_description": "Remove all children.", "line": 62, "aliases": [], "children": [], "file": "src/geometries/compound.js", "name": "clear", "name_prefix": "CompoundGeometry#", "path": "CompoundGeometry.prototype.clear", "outFile": "compound.html#CompoundGeometry.prototype.clear" } ], "file": "src/geometries/compound.js", "subclasses": [], "name": "CompoundGeometry", "path": "CompoundGeometry", "outFile": "compound.html" }, { "id": "ConvexPolygonGeometry", "type": "class", "superclass": "Geometry", "description": "Physics.geometry('convex-polygon')\n\nGeometry for convex polygons.\n\nAdditional config options:\n\n- vertices: Array of [[Vectorish]] objects representing the polygon vertices in clockwise (or counterclockwise) order.\n\nExample:\n\n```javascript\nvar pentagon = Physics.geometry('convex-polygon', {\n // the centroid is automatically calculated and used to position the shape\n vertices: [\n { x: 0, y: -30 },\n { x: -29, y: -9 },\n { x: -18, y: 24 },\n { x: 18, y: 24 },\n { x: 29, y: -9 }\n ]\n});\n```", "short_description": "Physics.geometry('convex-polygon')\n", "line": 27, "aliases": [], "children": [ { "id": "ConvexPolygonGeometry#setVertices", "type": "instance method", "signatures": [ { "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Vertices represented by an array of [[Vectorish]] objects, in either clockwise or counterclockwise order\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "hull", "types": [ "Array" ], "description": " Vertices represented by an array of [[Vectorish]] objects, in either clockwise or counterclockwise order\n\n " } ], "description": "Set the vertices of this polygon.", "short_description": "Set the vertices of this polygon.", "line": 61, "aliases": [], "children": [], "file": "src/geometries/convex-polygon.js", "name": "setVertices", "name_prefix": "ConvexPolygonGeometry#", "path": "ConvexPolygonGeometry.prototype.setVertices", "outFile": "convex-polygon.html#ConvexPolygonGeometry.prototype.setVertices" } ], "file": "src/geometries/convex-polygon.js", "subclasses": [], "name": "ConvexPolygonGeometry", "path": "ConvexPolygonGeometry", "outFile": "convex-polygon.html" }, { "id": "PointGeometry", "type": "class", "superclass": "Geometry", "alias_of": "Geometry", "description": "Physics.geometry('point')\n\nThe point geometry represents a point.", "short_description": "Physics.geometry('point')\n", "line": 8, "aliases": [], "children": [], "file": "src/geometries/point.js", "subclasses": [], "name": "PointGeometry", "path": "PointGeometry", "outFile": "point.html" }, { "id": "RectangleGeometry", "type": "class", "superclass": "Geometry", "description": "Physics.geometry('rectangle')\n\nGeometry for rectangles.\n\nAdditional config options:\n\n- width: The width\n- height: The height\n\nExample:\n\n```javascript\nvar rectGeo = Physics.geometry('rectangle', {\n width: 30,\n height: 40\n});\n```", "short_description": "Physics.geometry('rectangle')\n", "line": 22, "aliases": [], "children": [ { "id": "RectangleGeometry#height", "type": "constant", "signatures": [ { "returns": [ { "type": "Number" } ] } ], "description": "The height", "short_description": "The height", "line": 51, "aliases": [], "children": [], "file": "src/geometries/rectangle.js", "name": "height", "name_prefix": "RectangleGeometry#", "path": "RectangleGeometry.prototype.height", "outFile": "rectangle.html#RectangleGeometry.prototype.height" }, { "id": "RectangleGeometry#width", "type": "constant", "signatures": [ { "returns": [ { "type": "Number" } ] } ], "description": "The width", "short_description": "The width", "line": 45, "aliases": [], "children": [], "file": "src/geometries/rectangle.js", "name": "width", "name_prefix": "RectangleGeometry#", "path": "RectangleGeometry.prototype.width", "outFile": "rectangle.html#RectangleGeometry.prototype.width" } ], "file": "src/geometries/rectangle.js", "subclasses": [], "name": "RectangleGeometry", "path": "RectangleGeometry", "outFile": "rectangle.html" } ], "file": "src/core/geometry.js", "subclasses": [ "CircleGeometry", "CompoundGeometry", "ConvexPolygonGeometry", "PointGeometry", "RectangleGeometry" ], "name": "Geometry", "path": "Geometry", "outFile": "geometry.html" }, "Geometry#init": { "id": "Geometry#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 26, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "init", "name_prefix": "Geometry#", "path": "Geometry.prototype.init", "outFile": "geometry.html#Geometry.prototype.init" }, "Geometry#options": { "id": "Geometry#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this instance.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this instance.\n", "line": 44, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "options", "name_prefix": "Geometry#", "path": "Geometry.prototype.options", "outFile": "geometry.html#Geometry.prototype.options" }, "Geometry#aabb": { "id": "Geometry#aabb", "type": "instance method", "signatures": [ { "arguments": [ { "name": "angle", "types": [ "Number" ], "description": " The angle to rotate the geometry\n\n " } ], "returns": [ { "type": "Object", "description": " Bounding box values\n\n " } ] } ], "arguments": [ { "name": "angle", "types": [ "Number" ], "description": " The angle to rotate the geometry\n\n " } ], "returns": [ { "type": "Object", "description": " Bounding box values\n\n " } ], "related_to": "Physics.aabb", "description": "Get axis-aligned bounding box for this object (rotated by angle if specified).", "short_description": "Get axis-aligned bounding box for this object (rotated by angle if specified).", "line": 57, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "aabb", "name_prefix": "Geometry#", "path": "Geometry.prototype.aabb", "outFile": "geometry.html#Geometry.prototype.aabb" }, "Geometry#getFarthestHullPoint": { "id": "Geometry#getFarthestHullPoint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dir", "types": [ "Physics.vector" ], "description": " Direction to look\n\n " }, { "name": "result", "optional": true, "types": [ "Physics.vector" ], "description": " A vector to write result to. Speeds up calculations.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The farthest hull point in local coordinates\n\n " } ] } ], "arguments": [ { "name": "dir", "types": [ "Physics.vector" ], "description": " Direction to look\n\n " }, { "name": "result", "types": [ "Physics.vector" ], "description": " A vector to write result to. Speeds up calculations.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The farthest hull point in local coordinates\n\n " } ], "description": "Get farthest point on the hull of this geometry\nalong the direction vector `dir`\nreturns local coordinates. Replaces result if provided.\n\nAssume all coordinates are relative to the geometry\ncentroid (IE: in the body frame).\n\nThis should take a direction vector then it should\ncalculate the location (in that frame of reference)\nof the point on the perimeter (hull) if you traveled\nin a straight line from the centroid in the provided\ndirection. The result should be returned/set just like\nit is in the other geometries.", "short_description": "Get farthest point on the hull of this geometry\nalong the direction vector `dir`\nreturns local coordinates. Replaces result if provided.\n", "line": 82, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "getFarthestHullPoint", "name_prefix": "Geometry#", "path": "Geometry.prototype.getFarthestHullPoint", "outFile": "geometry.html#Geometry.prototype.getFarthestHullPoint" }, "Geometry#getFarthestCorePoint": { "id": "Geometry#getFarthestCorePoint", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dir", "types": [ "Physics.vector" ], "description": " Direction to look\n\n " }, { "name": "result", "optional": true, "types": [ "Physics.vector" ], "description": " A vector to write result to. Speeds up calculations.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The farthest hull point in local coordinates\n\n " } ] } ], "arguments": [ { "name": "dir", "types": [ "Physics.vector" ], "description": " Direction to look\n\n " }, { "name": "result", "types": [ "Physics.vector" ], "description": " A vector to write result to. Speeds up calculations.\n\n " } ], "returns": [ { "type": "Physics.vector", "description": " The farthest hull point in local coordinates\n\n " } ], "related_to": "Geometry#getFarthestHullPoint", "description": "Get farthest point on the core shape of this geometry\nalong the direction vector `dir`\nreturns local coordinates. Replaces result if provided.\n\nThis does almost the same thing as [[Geometry#getFarthestHullPoint]]\nbut shrinks the shape by subtracting \"margin\" from it.\nReturn the position of the point on the \"core\" shape.", "short_description": "Get farthest point on the core shape of this geometry\nalong the direction vector `dir`\nreturns local coordinates. Replaces result if provided.\n", "line": 104, "aliases": [], "children": [], "file": "src/core/geometry.js", "name": "getFarthestCorePoint", "name_prefix": "Geometry#", "path": "Geometry.prototype.getFarthestCorePoint", "outFile": "geometry.html#Geometry.prototype.getFarthestCorePoint" }, "Physics.integrator": { "id": "Physics.integrator", "type": "class method", "signatures": [ { "arguments": [ { "name": "name", "types": [ "String" ], "description": " The name of the integrator to create\n\n " }, { "name": "options", "optional": true, "types": [ "Object" ], "description": " The configuration for that integrator ( depends on integrator ).\n\n Available options and defaults:\n\n\n\n ```javascript\n\n {\n\n // drag applied during integration\n\n // 0 means vacuum\n\n // 0.9 means molasses\n\n drag: 0\n\n }\n\n ```\n\n " } ], "returns": [ { "type": "Integrator" } ] } ], "arguments": [ { "name": "name", "types": [ "String" ], "description": " The name of the integrator to create\n\n " }, { "name": "options", "types": [ "Object" ], "description": " The configuration for that integrator ( depends on integrator ).\n\n Available options and defaults:\n\n\n\n ```javascript\n\n {\n\n // drag applied during integration\n\n // 0 means vacuum\n\n // 0.9 means molasses\n\n drag: 0\n\n }\n\n ```\n\n " } ], "related_to": "Physics.util.decorator", "description": "Factory function for creating Integrators.\n\nVisit [the PhysicsJS wiki on Integrators](https://github.com/wellcaffeinated/PhysicsJS/wiki/Integrators)\nfor usage documentation.", "short_description": "Factory function for creating Integrators.\n", "line": 31, "aliases": [], "children": [ { "id": "Integrator", "type": "class", "belongs_to": "Physics.integrator", "description": "The base class for integrators created by [[Physics.integrator]] factory function.", "short_description": "The base class for integrators created by [[Physics.integrator]] factory function.", "line": 38, "aliases": [], "children": [ { "id": "Integrator#connect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to connect to\n\n " } ] } ], "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to connect to\n\n " } ], "description": "Connect to a world.\n\nExtend this when creating integrators if you need to specify pubsub management.\nAutomatically called when added to world by the [[Integrator#setWorld]] method.", "short_description": "Connect to a world.\n", "line": 134, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "connect", "name_prefix": "Integrator#", "path": "Integrator.prototype.connect", "outFile": "integrator.html#Integrator.prototype.connect" }, { "id": "Integrator#disconnect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to disconnect from\n\n " } ] } ], "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to disconnect from\n\n " } ], "description": "Disconnect from a world.\n\nExtend this when creating integrators if you need to specify pubsub management.\nAutomatically called when added to world by the [[Integrator#setWorld]] method.", "short_description": "Disconnect from a world.\n", "line": 145, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "disconnect", "name_prefix": "Integrator#", "path": "Integrator.prototype.disconnect", "outFile": "integrator.html#Integrator.prototype.disconnect" }, { "id": "Integrator#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 45, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "init", "name_prefix": "Integrator#", "path": "Integrator.prototype.init", "outFile": "integrator.html#Integrator.prototype.init" }, { "id": "Integrator#integrate", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ], "description": "Integrate bodies by timestep.\n\nWill emit `integrate:velocities` and `integrate:positions`\nevents on the world.", "short_description": "Integrate bodies by timestep.\n", "line": 44, "aliases": [], "children": [], "file": "src/integrators/velocity-verlet.js", "name": "integrate", "name_prefix": "Integrator#", "path": "Integrator.prototype.integrate", "outFile": "velocity-verlet.html#Integrator.prototype.integrate" }, { "id": "Integrator#integratePositions", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ], "description": "Just integrate the positions.\n\nCalled after [[Integrator#integrateVelocities]].\n\nShould be overridden when creating integrators.", "short_description": "Just integrate the positions.\n", "line": 172, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "integratePositions", "name_prefix": "Integrator#", "path": "Integrator.prototype.integratePositions", "outFile": "integrator.html#Integrator.prototype.integratePositions" }, { "id": "Integrator#integrateVelocities", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ], "description": "Just integrate the velocities.\n\nShould be overridden when creating integrators.", "short_description": "Just integrate the velocities.\n", "line": 156, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "integrateVelocities", "name_prefix": "Integrator#", "path": "Integrator.prototype.integrateVelocities", "outFile": "integrator.html#Integrator.prototype.integrateVelocities" }, { "id": "Integrator#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this instance.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this instance.\n", "line": 63, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "options", "name_prefix": "Integrator#", "path": "Integrator.prototype.options", "outFile": "integrator.html#Integrator.prototype.options" }, { "id": "Integrator#setWorld", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "description": "Set which world to apply to.\n\nUsually this is called internally. Shouldn't be a need to call this yourself usually.", "short_description": "Set which world to apply to.\n", "line": 75, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "setWorld", "name_prefix": "Integrator#", "path": "Integrator.prototype.setWorld", "outFile": "integrator.html#Integrator.prototype.setWorld" }, { "id": "ImprovedEuler", "type": "class", "superclass": "Integrator", "description": "`Physics.integrator('improved-euler')`.\n\nThe improved euler integrator.", "short_description": "`Physics.integrator('improved-euler')`.\n", "line": 11, "aliases": [], "children": [], "file": "src/integrators/improved-euler.js", "subclasses": [], "name": "ImprovedEuler", "path": "ImprovedEuler", "outFile": "improved-euler.html" }, { "id": "VelocityVerlet", "type": "class", "superclass": "Integrator", "description": "`Physics.integrator('velocity-verlet')`.\n\nThe velocity-verlet integrator.", "short_description": "`Physics.integrator('velocity-verlet')`.\n", "line": 26, "aliases": [], "children": [], "file": "src/integrators/velocity-verlet.js", "subclasses": [], "name": "VelocityVerlet", "path": "VelocityVerlet", "outFile": "velocity-verlet.html" }, { "id": "Verlet", "type": "class", "superclass": "Integrator", "description": "`Physics.integrator('verlet')`.\n\nThe verlet integrator.", "short_description": "`Physics.integrator('verlet')`.\n", "line": 26, "aliases": [], "children": [], "file": "src/integrators/verlet.js", "subclasses": [], "name": "Verlet", "path": "Verlet", "outFile": "verlet.html" } ], "file": "src/core/integrator.js", "subclasses": [ "ImprovedEuler", "VelocityVerlet", "Verlet" ], "name": "Integrator", "path": "Integrator", "outFile": "integrator.html" } ], "file": "src/core/integrator.js", "name": "integrator", "name_prefix": "Physics.", "path": "Physics.integrator", "outFile": "integrator.html#Physics.integrator" }, "Integrator": { "id": "Integrator", "type": "class", "belongs_to": "Physics.integrator", "description": "The base class for integrators created by [[Physics.integrator]] factory function.", "short_description": "The base class for integrators created by [[Physics.integrator]] factory function.", "line": 38, "aliases": [], "children": [ { "id": "Integrator#connect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to connect to\n\n " } ] } ], "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to connect to\n\n " } ], "description": "Connect to a world.\n\nExtend this when creating integrators if you need to specify pubsub management.\nAutomatically called when added to world by the [[Integrator#setWorld]] method.", "short_description": "Connect to a world.\n", "line": 134, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "connect", "name_prefix": "Integrator#", "path": "Integrator.prototype.connect", "outFile": "integrator.html#Integrator.prototype.connect" }, { "id": "Integrator#disconnect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to disconnect from\n\n " } ] } ], "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to disconnect from\n\n " } ], "description": "Disconnect from a world.\n\nExtend this when creating integrators if you need to specify pubsub management.\nAutomatically called when added to world by the [[Integrator#setWorld]] method.", "short_description": "Disconnect from a world.\n", "line": 145, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "disconnect", "name_prefix": "Integrator#", "path": "Integrator.prototype.disconnect", "outFile": "integrator.html#Integrator.prototype.disconnect" }, { "id": "Integrator#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 45, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "init", "name_prefix": "Integrator#", "path": "Integrator.prototype.init", "outFile": "integrator.html#Integrator.prototype.init" }, { "id": "Integrator#integrate", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ], "description": "Integrate bodies by timestep.\n\nWill emit `integrate:velocities` and `integrate:positions`\nevents on the world.", "short_description": "Integrate bodies by timestep.\n", "line": 44, "aliases": [], "children": [], "file": "src/integrators/velocity-verlet.js", "name": "integrate", "name_prefix": "Integrator#", "path": "Integrator.prototype.integrate", "outFile": "velocity-verlet.html#Integrator.prototype.integrate" }, { "id": "Integrator#integratePositions", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ], "description": "Just integrate the positions.\n\nCalled after [[Integrator#integrateVelocities]].\n\nShould be overridden when creating integrators.", "short_description": "Just integrate the positions.\n", "line": 172, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "integratePositions", "name_prefix": "Integrator#", "path": "Integrator.prototype.integratePositions", "outFile": "integrator.html#Integrator.prototype.integratePositions" }, { "id": "Integrator#integrateVelocities", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ], "description": "Just integrate the velocities.\n\nShould be overridden when creating integrators.", "short_description": "Just integrate the velocities.\n", "line": 156, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "integrateVelocities", "name_prefix": "Integrator#", "path": "Integrator.prototype.integrateVelocities", "outFile": "integrator.html#Integrator.prototype.integrateVelocities" }, { "id": "Integrator#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this instance.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this instance.\n", "line": 63, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "options", "name_prefix": "Integrator#", "path": "Integrator.prototype.options", "outFile": "integrator.html#Integrator.prototype.options" }, { "id": "Integrator#setWorld", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "description": "Set which world to apply to.\n\nUsually this is called internally. Shouldn't be a need to call this yourself usually.", "short_description": "Set which world to apply to.\n", "line": 75, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "setWorld", "name_prefix": "Integrator#", "path": "Integrator.prototype.setWorld", "outFile": "integrator.html#Integrator.prototype.setWorld" }, { "id": "ImprovedEuler", "type": "class", "superclass": "Integrator", "description": "`Physics.integrator('improved-euler')`.\n\nThe improved euler integrator.", "short_description": "`Physics.integrator('improved-euler')`.\n", "line": 11, "aliases": [], "children": [], "file": "src/integrators/improved-euler.js", "subclasses": [], "name": "ImprovedEuler", "path": "ImprovedEuler", "outFile": "improved-euler.html" }, { "id": "VelocityVerlet", "type": "class", "superclass": "Integrator", "description": "`Physics.integrator('velocity-verlet')`.\n\nThe velocity-verlet integrator.", "short_description": "`Physics.integrator('velocity-verlet')`.\n", "line": 26, "aliases": [], "children": [], "file": "src/integrators/velocity-verlet.js", "subclasses": [], "name": "VelocityVerlet", "path": "VelocityVerlet", "outFile": "velocity-verlet.html" }, { "id": "Verlet", "type": "class", "superclass": "Integrator", "description": "`Physics.integrator('verlet')`.\n\nThe verlet integrator.", "short_description": "`Physics.integrator('verlet')`.\n", "line": 26, "aliases": [], "children": [], "file": "src/integrators/verlet.js", "subclasses": [], "name": "Verlet", "path": "Verlet", "outFile": "verlet.html" } ], "file": "src/core/integrator.js", "subclasses": [ "ImprovedEuler", "VelocityVerlet", "Verlet" ], "name": "Integrator", "path": "Integrator", "outFile": "integrator.html" }, "Integrator#init": { "id": "Integrator#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 45, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "init", "name_prefix": "Integrator#", "path": "Integrator.prototype.init", "outFile": "integrator.html#Integrator.prototype.init" }, "Integrator#options": { "id": "Integrator#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this instance.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this instance.\n", "line": 63, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "options", "name_prefix": "Integrator#", "path": "Integrator.prototype.options", "outFile": "integrator.html#Integrator.prototype.options" }, "Integrator#setWorld": { "id": "Integrator#setWorld", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "description": "Set which world to apply to.\n\nUsually this is called internally. Shouldn't be a need to call this yourself usually.", "short_description": "Set which world to apply to.\n", "line": 75, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "setWorld", "name_prefix": "Integrator#", "path": "Integrator.prototype.setWorld", "outFile": "integrator.html#Integrator.prototype.setWorld" }, "Integrator#integrate": { "id": "Integrator#integrate", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ], "description": "Integrate bodies by timestep.\n\nWill emit `integrate:velocities` and `integrate:positions`\nevents on the world.", "short_description": "Integrate bodies by timestep.\n", "line": 44, "aliases": [], "children": [], "file": "src/integrators/velocity-verlet.js", "name": "integrate", "name_prefix": "Integrator#", "path": "Integrator.prototype.integrate", "outFile": "velocity-verlet.html#Integrator.prototype.integrate" }, "Integrator#connect": { "id": "Integrator#connect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to connect to\n\n " } ] } ], "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to connect to\n\n " } ], "description": "Connect to a world.\n\nExtend this when creating integrators if you need to specify pubsub management.\nAutomatically called when added to world by the [[Integrator#setWorld]] method.", "short_description": "Connect to a world.\n", "line": 134, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "connect", "name_prefix": "Integrator#", "path": "Integrator.prototype.connect", "outFile": "integrator.html#Integrator.prototype.connect" }, "Integrator#disconnect": { "id": "Integrator#disconnect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to disconnect from\n\n " } ] } ], "arguments": [ { "name": "world", "types": [ "Physics.world" ], "description": " The world to disconnect from\n\n " } ], "description": "Disconnect from a world.\n\nExtend this when creating integrators if you need to specify pubsub management.\nAutomatically called when added to world by the [[Integrator#setWorld]] method.", "short_description": "Disconnect from a world.\n", "line": 145, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "disconnect", "name_prefix": "Integrator#", "path": "Integrator.prototype.disconnect", "outFile": "integrator.html#Integrator.prototype.disconnect" }, "Integrator#integrateVelocities": { "id": "Integrator#integrateVelocities", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ], "description": "Just integrate the velocities.\n\nShould be overridden when creating integrators.", "short_description": "Just integrate the velocities.\n", "line": 156, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "integrateVelocities", "name_prefix": "Integrator#", "path": "Integrator.prototype.integrateVelocities", "outFile": "integrator.html#Integrator.prototype.integrateVelocities" }, "Integrator#integratePositions": { "id": "Integrator#integratePositions", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " List of bodies to integrate\n\n " }, { "name": "dt", "types": [ "Number" ], "description": " Timestep size\n\n " } ], "description": "Just integrate the positions.\n\nCalled after [[Integrator#integrateVelocities]].\n\nShould be overridden when creating integrators.", "short_description": "Just integrate the positions.\n", "line": 172, "aliases": [], "children": [], "file": "src/core/integrator.js", "name": "integratePositions", "name_prefix": "Integrator#", "path": "Integrator.prototype.integratePositions", "outFile": "integrator.html#Integrator.prototype.integratePositions" }, "wrapRule": { "id": "wrapRule", "type": "method", "signatures": [ { "arguments": [ { "name": "fn", "arguments": [ { "name": "propVal" } ], "callback": true, "types": [ "Function" ], "description": " The test function\n\n " }, { "name": "prop", "types": [ "String" ], "description": " The property name to test\n\n " } ], "returns": [ { "type": "Function" } ] } ], "arguments": [ { "name": "fn", "types": [ "Function" ], "description": " The test function\n\n " }, { "name": "prop", "types": [ "String" ], "description": " The property name to test\n\n " }, { "name": "propVal", "types": [ "Mixed" ], "description": " The property value\n\n " } ], "hide": true, "description": "Get test function to test on sub property.", "short_description": "Get test function to test on sub property.", "line": 18, "aliases": [], "children": [], "file": "src/core/query.js", "name": "wrapRule", "path": "wrapRule", "outFile": "query.html#wrapRule" }, "$eq": { "id": "$eq", "type": "utility", "signatures": [ { "arguments": [ { "name": "toMatch", "types": [ "Mixed" ], "description": " The value to match\n\n " }, { "name": "prop", "optional": true, "types": [ "String" ], "description": " The property name to test\n\n " } ], "returns": [ { "type": "Function" } ] } ], "arguments": [ { "name": "toMatch", "types": [ "Mixed" ], "description": " The value to match\n\n " }, { "name": "prop", "types": [ "String" ], "description": " The property name to test\n\n " } ], "hide": true, "description": "Get an equality test function.", "short_description": "Get an equality test function.", "line": 31, "aliases": [], "children": [], "file": "src/core/query.js", "name": "$eq", "path": "$eq", "outFile": "query.html#$eq" }, "$ne": { "id": "$ne", "type": "utility", "signatures": [ { "arguments": [ { "name": "toMatch", "types": [ "Mixed" ], "description": " The value to match\n\n " }, { "name": "prop", "optional": true, "types": [ "String" ], "description": " The property name to test\n\n " } ], "returns": [ { "type": "Function" } ] } ], "arguments": [ { "name": "toMatch", "types": [ "Mixed" ], "description": " The value to match\n\n " }, { "name": "prop", "types": [ "String" ], "description": " The property name to test\n\n " } ], "hide": true, "description": "Get a NOT equality test function.", "short_description": "Get a NOT equality test function.", "line": 82, "aliases": [], "children": [], "file": "src/core/query.js", "name": "$ne", "path": "$ne", "outFile": "query.html#$ne" }, "$in": { "id": "$in", "type": "utility", "signatures": [ { "arguments": [ { "name": "toMatch", "types": [ "Array" ], "description": " The array to match\n\n " }, { "name": "prop", "optional": true, "types": [ "String" ], "description": " The property name to test\n\n " } ], "returns": [ { "type": "Function" } ] } ], "arguments": [ { "name": "toMatch", "types": [ "Array" ], "description": " The array to match\n\n " }, { "name": "prop", "types": [ "String" ], "description": " The property name to test\n\n " } ], "hide": true, "description": "Get a test function for matching ANY in array", "short_description": "Get a test function for matching ANY in array", "line": 96, "aliases": [], "children": [], "file": "src/core/query.js", "name": "$in", "path": "$in", "outFile": "query.html#$in" }, "$nin": { "id": "$nin", "type": "utility", "signatures": [ { "arguments": [ { "name": "toMatch", "types": [ "Array" ], "description": " The array to match\n\n " }, { "name": "prop", "optional": true, "types": [ "String" ], "description": " The property name to test\n\n " } ], "returns": [ { "type": "Function" } ] } ], "arguments": [ { "name": "toMatch", "types": [ "Array" ], "description": " The array to match\n\n " }, { "name": "prop", "types": [ "String" ], "description": " The property name to test\n\n " } ], "hide": true, "description": "Get a test function for matching NOT ANY in array", "short_description": "Get a test function for matching NOT ANY in array", "line": 135, "aliases": [], "children": [], "file": "src/core/query.js", "name": "$nin", "path": "$nin", "outFile": "query.html#$nin" }, "$at": { "id": "$at", "type": "utility", "signatures": [ { "arguments": [ { "name": "point", "types": [ "Vectorish" ], "description": " The point to check\n\n " } ], "returns": [ { "type": "Function" } ] } ], "arguments": [ { "name": "point", "types": [ "Vectorish" ], "description": " The point to check\n\n " } ], "hide": true, "description": "Get a test function to match any body who's aabb intersects point", "short_description": "Get a test function to match any body who's aabb intersects point", "line": 148, "aliases": [], "children": [], "file": "src/core/query.js", "name": "$at", "path": "$at", "outFile": "query.html#$at" }, "$and": { "id": "$and", "type": "utility", "signatures": [ { "arguments": [ { "name": "first", "types": [ "Function" ], "description": " First function node. `first.next` should have the next function, and so on.\n\n " } ], "returns": [ { "type": "Function" } ] } ], "arguments": [ { "name": "first", "types": [ "Function" ], "description": " First function node. `first.next` should have the next function, and so on.\n\n " } ], "hide": true, "description": "Get an AND test function.", "short_description": "Get an AND test function.", "line": 162, "aliases": [], "children": [], "file": "src/core/query.js", "name": "$and", "path": "$and", "outFile": "query.html#$and" }, "$or": { "id": "$or", "type": "utility", "signatures": [ { "arguments": [ { "name": "first", "types": [ "Function" ], "description": " First function node. `first.next` should have the next function, and so on.\n\n " } ], "returns": [ { "type": "Function" } ] } ], "arguments": [ { "name": "first", "types": [ "Function" ], "description": " First function node. `first.next` should have the next function, and so on.\n\n " } ], "hide": true, "description": "Get an OR test function.", "short_description": "Get an OR test function.", "line": 182, "aliases": [], "children": [], "file": "src/core/query.js", "name": "$or", "path": "$or", "outFile": "query.html#$or" }, "Physics.query": { "id": "Physics.query", "type": "class method", "signatures": [ { "arguments": [ { "name": "rules", "types": [ "Object" ], "description": " The mongodb-like search rules. (See description).\n\n " } ], "returns": [ { "type": "Function", "description": " The test function\n\n " } ] } ], "arguments": [ { "name": "rules", "types": [ "Object" ], "description": " The mongodb-like search rules. (See description).\n\n " } ], "returns": [ { "type": "Function", "description": " The test function\n\n " } ], "related_to": "Physics.world#find", "description": "Creates a function that can be used to perform tests on objects.\n\nThe test function will return a [[Boolean]]; `true` if the object matches the tests.\n\nQuery rules are mongodb-like. You can specify a hash of values to match like this:\n\n```javascript\n{\n foo: 'bar',\n baz: 2,\n some: {\n nested: 'value'\n }\n}\n```\n\nAnd they will all need to match (it's an AND rule).\n\nYou can also use operators for more versatility. The operators you can use include:\n\n- $eq: Test if some property is equal to a value (this is done by default, and is thus redundant)\n- $ne: Test if some property is _NOT_ equal to a value\n- $in: Test if some value (or array of values) is one of the specified array of values\n- $nin: Test if some value (or array of values) is _NOT_ one of the specified array of values\n- $at: Test if a body's [[Physics.aabb]] includes specified point. It's a primative hit-test.\n\nExample:\n\n```javascript\nvar wheelsArray = [];\n\nvar queryFn = Physics.query({\n name: 'circle', // only circles\n $nin: wheelsArray, // not in the wheelsArray\n labels: { $in: [ 'player', 'monster' ] } // that have player OR monster labels\n});\n\nvar obj = {\n name: 'circle',\n labels: [ 'round' ]\n};\n\nqueryFn( obj ); // -> false\n// give it a player tag\nobj.labels.push('player');\nqueryFn( obj ); // -> true\n// put it inside the wheelsArray\nwheelsArray.push( obj );\nqueryFn( obj ); // -> false\n```", "short_description": "Creates a function that can be used to perform tests on objects.\n", "line": 262, "aliases": [], "children": [], "file": "src/core/query.js", "name": "query", "name_prefix": "Physics.", "path": "Physics.query", "outFile": "query.html#Physics.query" }, "Physics.renderer": { "id": "Physics.renderer", "type": "class method", "signatures": [ { "arguments": [ { "name": "name", "types": [ "String" ], "description": " The name of the renderer to create\n\n " }, { "name": "options", "optional": true, "types": [ "Object" ], "description": " The configuration for that renderer ( depends on renderer ).\n\n Available options and defaults:\n\n\n\n ```javascript\n\n {\n\n // draw meta data (fps, steps, etc)\n\n meta: false,\n\n // refresh rate of meta info\n\n metaRefresh: 200,\n\n\n\n // width of viewport\n\n width: 600,\n\n // height of viewport\n\n height: 600\n\n // automatically resize the renderer\n\n autoResize: true\n\n }\n\n ```\n\n " } ], "returns": [ { "type": "Renderer" } ] } ], "arguments": [ { "name": "name", "types": [ "String" ], "description": " The name of the renderer to create\n\n " }, { "name": "options", "types": [ "Object" ], "description": " The configuration for that renderer ( depends on renderer ).\n\n Available options and defaults:\n\n\n\n ```javascript\n\n {\n\n // draw meta data (fps, steps, etc)\n\n meta: false,\n\n // refresh rate of meta info\n\n metaRefresh: 200,\n\n\n\n // width of viewport\n\n width: 600,\n\n // height of viewport\n\n height: 600\n\n // automatically resize the renderer\n\n autoResize: true\n\n }\n\n ```\n\n " } ], "related_to": "Physics.util.decorator", "description": "Factory function for creating Renderers.\n\nVisit [the PhysicsJS wiki on Renderers](https://github.com/wellcaffeinated/PhysicsJS/wiki/Renderers)\nfor usage documentation.", "short_description": "Factory function for creating Renderers.\n", "line": 44, "aliases": [], "children": [ { "id": "Renderer", "type": "class", "belongs_to": "Physics.renderer", "description": "The base class for renderers created by [[Physics.renderer]] factory function.", "short_description": "The base class for renderers created by [[Physics.renderer]] factory function.", "line": 51, "aliases": [], "children": [ { "id": "Renderer#createView", "type": "instance method", "signatures": [ { "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " geometry The geometry\n\n " }, { "name": "styles", "types": [ "Object", "String" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "Mixed", "description": " Whatever the renderer needs to render the body.\n\n " } ] } ], "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " geometry The geometry\n\n " }, { "name": "styles", "types": [ "Object", "String" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "Mixed", "description": " Whatever the renderer needs to render the body.\n\n " } ], "description": "Create a view for the specified geometry.\n\nThe view is used to render the body. It is a cached version\nof the body that gets moved and rotated according to the simulation.\n\nThe styles are used to modify the appearance of the view.\nThey depend on the renderer.\n\nOverride this when creating renderers.", "short_description": "Create a view for the specified geometry.\n", "line": 182, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "createView", "name_prefix": "Renderer#", "path": "Renderer.prototype.createView", "outFile": "renderer.html#Renderer.prototype.createView" }, { "id": "Renderer#drawBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "body", "types": [ "Object" ], "description": " The body to draw\n\n " }, { "name": "view", "types": [ "Object" ], "description": " The view for the body\n\n " } ] } ], "arguments": [ { "name": "body", "types": [ "Object" ], "description": " The body to draw\n\n " }, { "name": "view", "types": [ "Object" ], "description": " The view for the body\n\n " } ], "description": "Draw specified body using specified view.\n\nOverride this when creating renderers.", "short_description": "Draw specified body using specified view.\n", "line": 226, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "drawBody", "name_prefix": "Renderer#", "path": "Renderer.prototype.drawBody", "outFile": "renderer.html#Renderer.prototype.drawBody" }, { "id": "Renderer#drawMeta", "type": "instance method", "signatures": [ { "arguments": [ { "name": "meta", "types": [ "Object" ], "description": " The meta data\n\n " } ] } ], "arguments": [ { "name": "meta", "types": [ "Object" ], "description": " The meta data\n\n " } ], "description": "Draw the meta data.\n\nThe meta data will look like this:\n\n```javascript\nmeta = {\n fps: 60, // the frames per second\n ipf: 4 // the number of iterations per frame\n};\n```\n\nOverride this when creating renderers.", "short_description": "Draw the meta data.\n", "line": 209, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "drawMeta", "name_prefix": "Renderer#", "path": "Renderer.prototype.drawMeta", "outFile": "renderer.html#Renderer.prototype.drawMeta" }, { "id": "Renderer#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 58, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "init", "name_prefix": "Renderer#", "path": "Renderer.prototype.init", "outFile": "renderer.html#Renderer.prototype.init" }, { "id": "Renderer#render", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " Array of bodies in the world (by reference!)\n\n " }, { "name": "meta", "types": [ "Object" ], "description": " meta information\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " Array of bodies in the world (by reference!)\n\n " }, { "name": "meta", "types": [ "Object" ], "description": " meta information\n\n " } ], "description": "Render the world bodies and meta. Called by world.render()", "short_description": "Render the world bodies and meta. Called by world.render()", "line": 129, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "render", "name_prefix": "Renderer#", "path": "Renderer.prototype.render", "outFile": "renderer.html#Renderer.prototype.render" }, { "id": "Renderer#resize", "type": "instance method", "signatures": [ { "arguments": [ { "name": "width", "optional": true, "types": [ "Number" ], "description": " The width in px\n\n " }, { "name": "height", "optional": true, "types": [ "Number" ], "description": " The height in px\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "width", "types": [ "Number" ], "description": " The width in px\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The height in px\n\n " } ], "description": "Set the dimensions of the renderer.\n\nIf no dimensions are specified it will auto resize.", "short_description": "Set the dimensions of the renderer.\n", "line": 87, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "resize", "name_prefix": "Renderer#", "path": "Renderer.prototype.resize", "outFile": "renderer.html#Renderer.prototype.resize" }, { "id": "Renderer#setWorld", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "description": "Set which world to apply to.\n\nUsually this is called internally. Shouldn't be a need to call this yourself usually.", "short_description": "Set which world to apply to.\n", "line": 107, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "setWorld", "name_prefix": "Renderer#", "path": "Renderer.prototype.setWorld", "outFile": "renderer.html#Renderer.prototype.setWorld" }, { "id": "CanvasRenderer", "type": "class", "superclass": "Renderer", "description": "Physics.renderer('canvas')\n\nRenderer that uses HTMLCanvas to render the world bodies.\n\nAdditional config options:\n\n- metaEl: HTMLElement to write meta information like FPS and IPF into. (default: autogenerated)\n- offset: Offset the shapes by this amount. (default: `{ x: 0, y: 0 }`)\n- styles: Styles to use to draw the shapes. (see below)\n\nThe styles property should contain _default_ styles for each shape you want to draw.\n\nExample:\n\n```javascript\nstyles: {\n\n 'circle' : {\n strokeStyle: '#542437',\n lineWidth: 1,\n fillStyle: '#542437',\n angleIndicator: 'white'\n },\n\n 'convex-polygon' : {\n strokeStyle: '#542437',\n lineWidth: 1,\n fillStyle: '#542437',\n angleIndicator: 'white'\n }\n}\n```\n\nStyles can also be defined on a per-body basis. Use the \"styles\" property for a body:\n\nExample:\n\n```javascript\nPhysics.body('circle', {\n // ...\n styles: {\n strokeStyle: '#542437',\n lineWidth: 1,\n fillStyle: '#542437',\n angleIndicator: 'white'\n }\n});\n```\n\nYou can also define an image to use for a body:\n\nExample:\n\n```javascript\nPhysics.body('circle', {\n // ...\n styles: {\n src: 'path/to/image.jpg',\n width: 40,\n height: 50\n }\n});\n```", "short_description": "Physics.renderer('canvas')\n", "line": 68, "aliases": [], "children": [ { "id": "CanvasRenderer#addLayer", "type": "instance method", "signatures": [ { "arguments": [ { "name": "id", "types": [ "String" ], "description": " The id for the layer\n\n " }, { "name": "el", "optional": true, "types": [ "HTMLElement" ], "description": " The canvas element to use for this layer\n\n " }, { "name": "opts", "optional": true, "types": [ "Object" ], "description": " The options for this layer (see below)\n\n " } ], "returns": [ { "type": "Layer" } ] } ], "arguments": [ { "name": "id", "types": [ "String" ], "description": " The id for the layer\n\n " }, { "name": "el", "types": [ "HTMLElement" ], "description": " The canvas element to use for this layer\n\n " }, { "name": "opts", "types": [ "Object" ], "description": " The options for this layer (see below)\n\n " } ], "description": "Create a new layer.\n\nLayers can have the following options:\n\n- width: The width\n- height: The height\n- manual: Draw manually (default: `false`)\n- autoResize: Automatically resize the layer when the renderer's [[CanvasRenderer#resize]] method is called. (default: `true`)\n- follow: A [[Body]]. Offset this layer's rendering to follow a body's position. (default: `null`)\n- offset: The offset [[Vectorish]] for this layer. (default: `null`)\n- scale: Scale the layer by this amount. (default: `1`)\n- zIndex: The zIndex for the layer's HTMLElement. (default: `1`)", "short_description": "Create a new layer.\n", "line": 226, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "addLayer", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.addLayer", "outFile": "canvas.html#CanvasRenderer.prototype.addLayer" }, { "id": "CanvasRenderer#draw", "type": "instance method", "signatures": [ { "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " The shape to draw\n\n " }, { "name": "styles", "optional": true, "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "optional": true, "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " }, { "name": "offset", "optional": true, "types": [ "Vectorish" ], "description": " The offset from center\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " The shape to draw\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " }, { "name": "offset", "types": [ "Vectorish" ], "description": " The offset from center\n\n " } ], "description": "Draw a geometry to a context.", "short_description": "Draw a geometry to a context.", "line": 630, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "draw", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.draw", "outFile": "canvas.html#CanvasRenderer.prototype.draw" }, { "id": "CanvasRenderer#drawCircle", "type": "instance method", "signatures": [ { "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "r", "types": [ "Number" ], "description": " The circle radius\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "optional": true, "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ] } ], "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "r", "types": [ "Number" ], "description": " The circle radius\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ], "description": "Draw a circle to specified canvas context.", "short_description": "Draw a circle to specified canvas context.", "line": 514, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "drawCircle", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.drawCircle", "outFile": "canvas.html#CanvasRenderer.prototype.drawCircle" }, { "id": "CanvasRenderer#drawLine", "type": "instance method", "signatures": [ { "arguments": [ { "name": "from", "types": [ "Vectorish" ], "description": " The starting pt\n\n " }, { "name": "to", "types": [ "Vectorish" ], "description": " The ending pt\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "optional": true, "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ] } ], "arguments": [ { "name": "from", "types": [ "Vectorish" ], "description": " The starting pt\n\n " }, { "name": "to", "types": [ "Vectorish" ], "description": " The ending pt\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ], "description": "Draw a line onto specified canvas context.", "short_description": "Draw a line onto specified canvas context.", "line": 599, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "drawLine", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.drawLine", "outFile": "canvas.html#CanvasRenderer.prototype.drawLine" }, { "id": "CanvasRenderer#drawPolygon", "type": "instance method", "signatures": [ { "arguments": [ { "name": "verts", "types": [ "Array" ], "description": " Array of [[Vectorish]] vertices\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "optional": true, "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ] } ], "arguments": [ { "name": "verts", "types": [ "Array" ], "description": " Array of [[Vectorish]] vertices\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ], "description": "Draw a polygon to specified canvas context.", "short_description": "Draw a polygon to specified canvas context.", "line": 534, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "drawPolygon", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.drawPolygon", "outFile": "canvas.html#CanvasRenderer.prototype.drawPolygon" }, { "id": "CanvasRenderer#drawRect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "width", "types": [ "Number" ], "description": " The width\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The height\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "optional": true, "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ] } ], "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "width", "types": [ "Number" ], "description": " The width\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The height\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ], "description": "Draw a rectangle to specified canvas context.", "short_description": "Draw a rectangle to specified canvas context.", "line": 575, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "drawRect", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.drawRect", "outFile": "canvas.html#CanvasRenderer.prototype.drawRect" }, { "id": "CanvasRenderer#layer", "type": "instance method", "signatures": [ { "arguments": [ { "name": "id", "types": [ "String" ], "description": " The id for the layer\n\n " } ], "returns": [ { "type": "Layer" } ] } ], "arguments": [ { "name": "id", "types": [ "String" ], "description": " The id for the layer\n\n " } ], "description": "Get the layer by id.", "short_description": "Get the layer by id.", "line": 198, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "layer", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.layer", "outFile": "canvas.html#CanvasRenderer.prototype.layer" }, { "id": "CanvasRenderer#removeLayer", "type": "instance method", "signatures": [ { "arguments": [ { "name": "id", "types": [ "String" ], "description": " The id for the layer\n\n " } ], "returns": [ { "type": "this" } ] }, { "arguments": [ { "name": "layer", "types": [ "Layer" ], "description": " The layer\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "id", "types": [ "String" ], "description": " The id for the layer\n\n " }, { "name": "layer", "types": [ "Layer" ], "description": " The layer\n\n " } ], "description": "Remove a layer.", "short_description": "Remove a layer.", "line": 444, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "removeLayer", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.removeLayer", "outFile": "canvas.html#CanvasRenderer.prototype.removeLayer" }, { "id": "CanvasRenderer#resize", "type": "instance method", "signatures": [ { "arguments": [ { "name": "width", "types": [ "Number" ], "description": " The width\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The height\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "width", "types": [ "Number" ], "description": " The width\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The height\n\n " } ], "description": "Resize all layer canvases that have the `autoResize` option set to `true`.", "short_description": "Resize all layer canvases that have the `autoResize` option set to `true`.", "line": 464, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "resize", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.resize", "outFile": "canvas.html#CanvasRenderer.prototype.resize" }, { "id": "CanvasRenderer#setStyle", "type": "instance method", "signatures": [ { "arguments": [ { "name": "styles", "types": [ "Object", "String" ], "description": " Styles to set on the canvas context\n\n " }, { "name": "ctx", "optional": true, "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ] } ], "arguments": [ { "name": "styles", "types": [ "Object", "String" ], "description": " Styles to set on the canvas context\n\n " }, { "name": "ctx", "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ], "description": "Set styles on the specified canvas context (or main context).", "short_description": "Set styles on the specified canvas context (or main context).", "line": 488, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "setStyle", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.setStyle", "outFile": "canvas.html#CanvasRenderer.prototype.setStyle" }, { "id": "Layer", "type": "class", "belongs_to": "CanvasRenderer", "description": "A rendering layer for the canvas renderer.\n\nCreate by calling [[CanvasRenderer#addLayer]].", "short_description": "A rendering layer for the canvas renderer.\n", "line": 235, "aliases": [], "children": [ { "id": "Layer#addToStack", "type": "instance method", "signatures": [ { "arguments": [ { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to add\n\n " } ], "returns": [ { "type": "this" } ] }, { "arguments": [ { "name": "body", "types": [ "Body" ], "description": " Body to add\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "body", "types": [ "Body" ], "description": " Body to add\n\n " }, { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to add\n\n " } ], "description": "Add body (bodies) to the rendering stack for this layer.\n\nBodies must be added to the stack in order to be rendered by this layer UNLESS it is the \"main\" layer.", "short_description": "Add body (bodies) to the rendering stack for this layer.\n", "line": 324, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "addToStack", "name_prefix": "Layer#", "path": "Layer.prototype.addToStack", "outFile": "canvas.html#Layer.prototype.addToStack" }, { "id": "Layer#bodies", "type": "constant", "signatures": [ { "returns": [ { "type": "Array" } ] } ], "description": "The Bodies this layer is rendering.\n\nThe \"main\" layer will render all world bodies if it's empty.", "short_description": "The Bodies this layer is rendering.\n", "line": 300, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "bodies", "name_prefix": "Layer#", "path": "Layer.prototype.bodies", "outFile": "canvas.html#Layer.prototype.bodies" }, { "id": "Layer#el", "type": "constant", "signatures": [ { "returns": [ { "type": "HTMLElement" } ] } ], "description": "The layer's Canvas", "short_description": "The layer's Canvas", "line": 251, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "el", "name_prefix": "Layer#", "path": "Layer.prototype.el", "outFile": "canvas.html#Layer.prototype.el" }, { "id": "Layer#id", "type": "constant", "signatures": [ { "returns": [ { "type": "String" } ] } ], "description": "The layer's ID", "short_description": "The layer's ID", "line": 245, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "id", "name_prefix": "Layer#", "path": "Layer.prototype.id", "outFile": "canvas.html#Layer.prototype.id" }, { "id": "Layer#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this layer.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this layer.\n", "line": 267, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "options", "name_prefix": "Layer#", "path": "Layer.prototype.options", "outFile": "canvas.html#Layer.prototype.options" }, { "id": "Layer#removeFromStack", "type": "instance method", "signatures": [ { "arguments": [ { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to remove\n\n " } ], "returns": [ { "type": "this" } ] }, { "arguments": [ { "name": "body", "types": [ "Body" ], "description": " Body to remove\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "body", "types": [ "Body" ], "description": " Body to remove\n\n " }, { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to remove\n\n " } ], "description": "Remove body (bodies) from the rendering stack for this layer.", "short_description": "Remove body (bodies) from the rendering stack for this layer.", "line": 342, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "removeFromStack", "name_prefix": "Layer#", "path": "Layer.prototype.removeFromStack", "outFile": "canvas.html#Layer.prototype.removeFromStack" }, { "id": "Layer#render", "type": "instance method", "signatures": [ { "arguments": [ { "name": "clear", "optional": true, "types": [ "Boolean" ], "description": " Clear the canvas (default: `true`)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "clear", "types": [ "Boolean" ], "description": " Clear the canvas (default: `true`)\n\n " } ], "description": "Render the bodies in this layer's stack.\n\nIf you want you can replace this function with your own to do custom rendering.\n\nExample:\n\n```javascript\nlayer.render = myCustomRenderFn;\n```", "short_description": "Render the bodies in this layer's stack.\n", "line": 373, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "render", "name_prefix": "Layer#", "path": "Layer.prototype.render", "outFile": "canvas.html#Layer.prototype.render" }, { "id": "Layer#reset", "type": "instance method", "signatures": [ { "arguments": [ { "name": "arr", "optional": true, "types": [ "Array" ], "description": " Array to replace the current stack of Bodies.\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "arr", "types": [ "Array" ], "description": " Array to replace the current stack of Bodies.\n\n " } ], "description": "Reset the stack.", "short_description": "Reset the stack.", "line": 308, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "reset", "name_prefix": "Layer#", "path": "Layer.prototype.reset", "outFile": "canvas.html#Layer.prototype.reset" } ], "file": "src/renderers/canvas.js", "subclasses": [], "name": "Layer", "path": "Layer", "outFile": "canvas.html" } ], "file": "src/renderers/canvas.js", "subclasses": [], "name": "CanvasRenderer", "path": "CanvasRenderer", "outFile": "canvas.html" }, { "id": "DebugRenderer", "type": "class", "superclass": "Renderer", "description": "Physics.renderer('debug')\n\nExtends canvas renderer with special debugging functionality.\n\nAdditional config options:\n\n- metaEl: HTMLElement to write meta information like FPS and IPF into. (default: autogenerated)\n- offset: Offset the shapes by this amount. (default: `{ x: 0, y: 0 }`)\n- styles: Styles to use to draw the shapes. (see below)\n- drawAABB: whether or not to draw bounding boxes. (default: `true`)\n- drawRealPosition: whether or not to draw the non-interpolated position of bodies. (default: `false`)\n- drawIntervals: whether or not to draw the broadphase (sweep-prune) intervals. (default: `false`)\n- drawContacts: whether or not to draw contact points. (default: `false`)\n- drawSleepState: whether or not to highlight sleeping bodies. (default: `false`)\n- drawBodyState: whether or not to show body position and velocity. (default: `false`)\n- aabbColor: the color of AABBs\n- realBodyStyle: styles used to draw the image of the body at its true non-interpolated position\n- intervalMinColor: color of interval minima\n- intervalMaxColor: color of interval maxima\n- mtvColor: color of minimum transit vector for contacts (overlaps)\n- contactColor: color of contact points\n\nThe styles property should contain _default_ styles for each shape you want to draw.\n\nExample:\n\n```javascript\nstyles: {\n\n 'circle' : {\n strokeStyle: '#542437',\n lineWidth: 1,\n fillStyle: '#542437',\n angleIndicator: 'white'\n },\n\n 'convex-polygon' : {\n strokeStyle: '#542437',\n lineWidth: 1,\n fillStyle: '#542437',\n angleIndicator: 'white'\n }\n}\n```", "short_description": "Physics.renderer('debug')\n", "line": 52, "aliases": [], "children": [], "file": "src/renderers/debug.js", "subclasses": [], "name": "DebugRenderer", "path": "DebugRenderer", "outFile": "debug.html" }, { "id": "DomRenderer", "type": "class", "superclass": "Renderer", "description": "Physics.renderer('dom')\n\nRenderer that manipulates DOM elements according to the physics simulation. Very primative...", "short_description": "Physics.renderer('dom')\n", "line": 8, "aliases": [], "children": [ { "id": "DomRenderer#attach", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "HTMLElement", "Object" ], "description": " DOM node or event data (`data.body`)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "data", "types": [ "HTMLElement", "Object" ], "description": " DOM node or event data (`data.body`)\n\n " } ], "description": "Event callback to attach a node to the viewport", "short_description": "Event callback to attach a node to the viewport", "line": 242, "aliases": [], "children": [], "file": "src/renderers/dom.js", "name": "attach", "name_prefix": "DomRenderer#", "path": "DomRenderer.prototype.attach", "outFile": "dom.html#DomRenderer.prototype.attach" }, { "id": "DomRenderer#circleProperties", "type": "instance method", "signatures": [ { "arguments": [ { "name": "el", "types": [ "HTMLElement" ], "description": " The element\n\n " }, { "name": "geometry", "types": [ "Geometry" ], "description": " The body's geometry\n\n " } ] } ], "arguments": [ { "name": "el", "types": [ "HTMLElement" ], "description": " The element\n\n " }, { "name": "geometry", "types": [ "Geometry" ], "description": " The body's geometry\n\n " } ], "internal": true, "description": "Set dom element style properties for a circle.", "short_description": "Set dom element style properties for a circle.", "line": 136, "aliases": [], "children": [], "file": "src/renderers/dom.js", "name": "circleProperties", "name_prefix": "DomRenderer#", "path": "DomRenderer.prototype.circleProperties", "outFile": "dom.html#DomRenderer.prototype.circleProperties" }, { "id": "DomRenderer#detach", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "HTMLElement", "Object" ], "description": " DOM node or event data (`data.body`)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "data", "types": [ "HTMLElement", "Object" ], "description": " DOM node or event data (`data.body`)\n\n " } ], "description": "Event callback to detach a node from the DOM", "short_description": "Event callback to detach a node from the DOM", "line": 221, "aliases": [], "children": [], "file": "src/renderers/dom.js", "name": "detach", "name_prefix": "DomRenderer#", "path": "DomRenderer.prototype.detach", "outFile": "dom.html#DomRenderer.prototype.detach" }, { "id": "DomRenderer#pointProperties", "type": "instance method", "signatures": [ { "arguments": [ { "name": "el", "types": [ "HTMLElement" ], "description": " The element\n\n " }, { "name": "geometry", "types": [ "Geometry" ], "description": " The body's geometry\n\n " } ] } ], "arguments": [ { "name": "el", "types": [ "HTMLElement" ], "description": " The element\n\n " }, { "name": "geometry", "types": [ "Geometry" ], "description": " The body's geometry\n\n " } ], "internal": true, "description": "Set dom element style properties for a point.", "short_description": "Set dom element style properties for a point.", "line": 120, "aliases": [], "children": [], "file": "src/renderers/dom.js", "name": "pointProperties", "name_prefix": "DomRenderer#", "path": "DomRenderer.prototype.pointProperties", "outFile": "dom.html#DomRenderer.prototype.pointProperties" }, { "id": "DomRenderer#rectangleProperties", "type": "instance method", "signatures": [ { "arguments": [ { "name": "el", "types": [ "HTMLElement" ], "description": " The element\n\n " }, { "name": "geometry", "types": [ "Geometry" ], "description": " The body's geometry\n\n " } ] } ], "arguments": [ { "name": "el", "types": [ "HTMLElement" ], "description": " The element\n\n " }, { "name": "geometry", "types": [ "Geometry" ], "description": " The body's geometry\n\n " } ], "internal": true, "description": "Set dom element style properties for a rectangle.", "short_description": "Set dom element style properties for a rectangle.", "line": 154, "aliases": [], "children": [], "file": "src/renderers/dom.js", "name": "rectangleProperties", "name_prefix": "DomRenderer#", "path": "DomRenderer.prototype.rectangleProperties", "outFile": "dom.html#DomRenderer.prototype.rectangleProperties" } ], "file": "src/renderers/dom.js", "subclasses": [], "name": "DomRenderer", "path": "DomRenderer", "outFile": "dom.html" }, { "id": "PixiRenderer", "type": "class", "superclass": "Renderer", "description": "Physics.renderer('pixi')\n\nRenderer that uses the PIXI.js library. [Documentation can be found here](https://github.com/wellcaffeinated/PhysicsJS/wiki/PIXI-Renderer).\n\nAdditional config options:\n\n- metaEl: HTMLElement to write meta information like FPS and IPF into. (default: autogenerated)\n- offset: Offset the shapes by this amount. (default: `{ x: 0, y: 0 }`)\n- styles: Styles to use to draw the shapes. (see below)\n\nThe styles property should contain _default_ styles for each shape you want to draw.\n\nExample:\n\n```javascript\nstyles: {\n // Defines the default canvas colour\n 'color': '0x66FF99',\n\n 'circle' : {\n strokeStyle: '0xE8900C',\n lineWidth: 3,\n fillStyle: '0xD5DE4C',\n angleIndicator: '0xE8900C',\n strokeAlpha: 1,\n fillAlpha: 1\n },\n\n 'convex-polygon' : {\n strokeStyle: '0xE8900C',\n lineWidth: 3,\n fillStyle: '0xD5DE4C',\n angleIndicator: '0xE8900C'\n }\n}\n```\n\nStyles can also be defined on a per-body basis. Use the \"styles\" property for a body:\n\nExample:\n\n```javascript\nPhysics.body('circle', {\n // ...\n styles: {\n strokeStyle: '0x542437',\n lineWidth: 1,\n fillStyle: '0x542437',\n angleIndicator: '0xFFFFFF'\n }\n});\n```\n\nYou can also define an image to use for a body:\n\nExample:\n\n```javascript\nPhysics.body('circle', {\n // ...\n styles: {\n src: 'path/to/image.jpg',\n width: 40,\n height: 50,\n anchor: { x: 0.5, y: 0.5 }\n }\n});\n```", "short_description": "Physics.renderer('pixi')\n", "line": 76, "aliases": [], "children": [ { "id": "PixiRenderer#attach", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "PIXI.Graphics", "Object" ], "description": " Graphics object or event data (`data.body`)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "data", "types": [ "PIXI.Graphics", "Object" ], "description": " Graphics object or event data (`data.body`)\n\n " } ], "description": "Event callback to attach a child to the stage", "short_description": "Event callback to attach a child to the stage", "line": 239, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "attach", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.attach", "outFile": "pixi-renderer.html#PixiRenderer.prototype.attach" }, { "id": "PixiRenderer#centerAnchor", "type": "instance method", "signatures": [ { "arguments": [ { "name": "view", "types": [ "PIXI.DisplayObject" ], "description": " The view to center\n\n " } ] } ], "arguments": [ { "name": "view", "types": [ "PIXI.DisplayObject" ], "description": " The view to center\n\n " } ], "description": "Centers the anchor to {x: 0.5, y: 0.5} of a view", "short_description": "Centers the anchor to {x: 0.5, y: 0.5} of a view", "line": 622, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "centerAnchor", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.centerAnchor", "outFile": "pixi-renderer.html#PixiRenderer.prototype.centerAnchor" }, { "id": "PixiRenderer#createCircle", "type": "instance method", "signatures": [ { "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "r", "types": [ "Number" ], "description": " The circle radius\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a circle.\n\n " } ] } ], "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "r", "types": [ "Number" ], "description": " The circle radius\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a circle.\n\n " } ], "description": "Create a circle for use in PIXI stage", "short_description": "Create a circle for use in PIXI stage", "line": 362, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "createCircle", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.createCircle", "outFile": "pixi-renderer.html#PixiRenderer.prototype.createCircle" }, { "id": "PixiRenderer#createDisplay", "type": "instance method", "signatures": [ { "arguments": [ { "name": "type", "types": [ "String" ], "description": " The type of PIXI.DisplayObject to make\n\n " }, { "name": "options", "types": [ "Object" ], "description": " Options to apply to the view.\n\n " } ], "returns": [ { "type": "PIXI.DisplayObject", "description": " An object that is renderable.\n\n " } ] } ], "arguments": [ { "name": "type", "types": [ "String" ], "description": " The type of PIXI.DisplayObject to make\n\n " }, { "name": "options", "types": [ "Object" ], "description": " Options to apply to the view.\n\n " } ], "returns": [ { "type": "PIXI.DisplayObject", "description": " An object that is renderable.\n\n " } ], "description": "Create a PIXI sprite or movie clip.", "short_description": "Create a PIXI sprite or movie clip.", "line": 563, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "createDisplay", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.createDisplay", "outFile": "pixi-renderer.html#PixiRenderer.prototype.createDisplay" }, { "id": "PixiRenderer#createLine", "type": "instance method", "signatures": [ { "arguments": [ { "name": "from", "types": [ "Vectorish" ], "description": " Starting point\n\n " }, { "name": "to", "types": [ "Vectorish" ], "description": " Ending point\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a polygon.\n\n " } ] } ], "arguments": [ { "name": "from", "types": [ "Vectorish" ], "description": " Starting point\n\n " }, { "name": "to", "types": [ "Vectorish" ], "description": " Ending point\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a polygon.\n\n " } ], "description": "Create a line for use in PIXI stage", "short_description": "Create a line for use in PIXI stage", "line": 441, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "createLine", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.createLine", "outFile": "pixi-renderer.html#PixiRenderer.prototype.createLine" }, { "id": "PixiRenderer#createPolygon", "type": "instance method", "signatures": [ { "arguments": [ { "name": "verts", "types": [ "Array" ], "description": " Array of [[Vectorish]] vertices\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a polygon.\n\n " } ] } ], "arguments": [ { "name": "verts", "types": [ "Array" ], "description": " Array of [[Vectorish]] vertices\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a polygon.\n\n " } ], "description": "Create a polygon for use in PIXI stage", "short_description": "Create a polygon for use in PIXI stage", "line": 399, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "createPolygon", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.createPolygon", "outFile": "pixi-renderer.html#PixiRenderer.prototype.createPolygon" }, { "id": "PixiRenderer#createRect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "r", "types": [ "Number" ], "description": " The rectangle width\n\n " }, { "name": "styles", "types": [ "Number" ], "description": " The rectangle height\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a circle.\n\n " } ] } ], "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "width", "types": [ "Number" ], "description": " The rectangle width\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The rectangle height\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a circle.\n\n " } ], "description": "Create a rectangle for use in PIXI stage", "short_description": "Create a rectangle for use in PIXI stage", "line": 382, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "createRect", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.createRect", "outFile": "pixi-renderer.html#PixiRenderer.prototype.createRect" }, { "id": "PixiRenderer#detach", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "PIXI.Graphics", "Object" ], "description": " Graphics object or event data (`data.body`)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "data", "types": [ "PIXI.Graphics", "Object" ], "description": " Graphics object or event data (`data.body`)\n\n " } ], "description": "Event callback to detach a child from the stage", "short_description": "Event callback to detach a child from the stage", "line": 220, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "detach", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.detach", "outFile": "pixi-renderer.html#PixiRenderer.prototype.detach" }, { "id": "PixiRenderer#drawBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The body to draw\n\n " }, { "name": "view", "types": [ "DisplayObject" ], "description": " The pixi display object\n\n " } ] } ], "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The body to draw\n\n " }, { "name": "view", "types": [ "DisplayObject" ], "description": " The pixi display object\n\n " } ], "description": "Draw a PIXI.DisplayObject to the stage.", "short_description": "Draw a PIXI.DisplayObject to the stage.", "line": 287, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "drawBody", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.drawBody", "outFile": "pixi-renderer.html#PixiRenderer.prototype.drawBody" }, { "id": "PixiRenderer#loadSpriteSheets", "type": "instance method", "signatures": [ { "arguments": [ { "name": "assetsToLoad", "types": [ "Array" ], "description": " Array of spritesheets to load\n\n " }, { "name": "callback", "types": [ "Function" ], "description": " Function to call when loading is complete\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "assetsToLoad", "types": [ "Array" ], "description": " Array of spritesheets to load\n\n " }, { "name": "callback", "types": [ "Function" ], "description": " Function to call when loading is complete\n\n " } ], "description": "Loads textures defined in a spritesheet", "short_description": "Loads textures defined in a spritesheet", "line": 259, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "loadSpriteSheets", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.loadSpriteSheets", "outFile": "pixi-renderer.html#PixiRenderer.prototype.loadSpriteSheets" }, { "id": "PixiRenderer#setStyles", "type": "instance method", "signatures": [ { "arguments": [ { "name": "graphics", "types": [ "PIXI.Graphics" ], "description": " The graphics object to set styles on\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object\n\n " } ] } ], "arguments": [ { "name": "graphics", "types": [ "PIXI.Graphics" ], "description": " The graphics object to set styles on\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object\n\n " } ], "description": "Set styles on pixi graphics object", "short_description": "Set styles on pixi graphics object", "line": 322, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "setStyles", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.setStyles", "outFile": "pixi-renderer.html#PixiRenderer.prototype.setStyles" } ], "file": "src/renderers/pixi-renderer.js", "subclasses": [], "name": "PixiRenderer", "path": "PixiRenderer", "outFile": "pixi-renderer.html" } ], "file": "src/core/renderer.js", "subclasses": [ "CanvasRenderer", "DebugRenderer", "DomRenderer", "PixiRenderer" ], "name": "Renderer", "path": "Renderer", "outFile": "renderer.html" } ], "file": "src/core/renderer.js", "name": "renderer", "name_prefix": "Physics.", "path": "Physics.renderer", "outFile": "renderer.html#Physics.renderer" }, "Renderer": { "id": "Renderer", "type": "class", "belongs_to": "Physics.renderer", "description": "The base class for renderers created by [[Physics.renderer]] factory function.", "short_description": "The base class for renderers created by [[Physics.renderer]] factory function.", "line": 51, "aliases": [], "children": [ { "id": "Renderer#createView", "type": "instance method", "signatures": [ { "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " geometry The geometry\n\n " }, { "name": "styles", "types": [ "Object", "String" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "Mixed", "description": " Whatever the renderer needs to render the body.\n\n " } ] } ], "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " geometry The geometry\n\n " }, { "name": "styles", "types": [ "Object", "String" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "Mixed", "description": " Whatever the renderer needs to render the body.\n\n " } ], "description": "Create a view for the specified geometry.\n\nThe view is used to render the body. It is a cached version\nof the body that gets moved and rotated according to the simulation.\n\nThe styles are used to modify the appearance of the view.\nThey depend on the renderer.\n\nOverride this when creating renderers.", "short_description": "Create a view for the specified geometry.\n", "line": 182, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "createView", "name_prefix": "Renderer#", "path": "Renderer.prototype.createView", "outFile": "renderer.html#Renderer.prototype.createView" }, { "id": "Renderer#drawBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "body", "types": [ "Object" ], "description": " The body to draw\n\n " }, { "name": "view", "types": [ "Object" ], "description": " The view for the body\n\n " } ] } ], "arguments": [ { "name": "body", "types": [ "Object" ], "description": " The body to draw\n\n " }, { "name": "view", "types": [ "Object" ], "description": " The view for the body\n\n " } ], "description": "Draw specified body using specified view.\n\nOverride this when creating renderers.", "short_description": "Draw specified body using specified view.\n", "line": 226, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "drawBody", "name_prefix": "Renderer#", "path": "Renderer.prototype.drawBody", "outFile": "renderer.html#Renderer.prototype.drawBody" }, { "id": "Renderer#drawMeta", "type": "instance method", "signatures": [ { "arguments": [ { "name": "meta", "types": [ "Object" ], "description": " The meta data\n\n " } ] } ], "arguments": [ { "name": "meta", "types": [ "Object" ], "description": " The meta data\n\n " } ], "description": "Draw the meta data.\n\nThe meta data will look like this:\n\n```javascript\nmeta = {\n fps: 60, // the frames per second\n ipf: 4 // the number of iterations per frame\n};\n```\n\nOverride this when creating renderers.", "short_description": "Draw the meta data.\n", "line": 209, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "drawMeta", "name_prefix": "Renderer#", "path": "Renderer.prototype.drawMeta", "outFile": "renderer.html#Renderer.prototype.drawMeta" }, { "id": "Renderer#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 58, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "init", "name_prefix": "Renderer#", "path": "Renderer.prototype.init", "outFile": "renderer.html#Renderer.prototype.init" }, { "id": "Renderer#render", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " Array of bodies in the world (by reference!)\n\n " }, { "name": "meta", "types": [ "Object" ], "description": " meta information\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " Array of bodies in the world (by reference!)\n\n " }, { "name": "meta", "types": [ "Object" ], "description": " meta information\n\n " } ], "description": "Render the world bodies and meta. Called by world.render()", "short_description": "Render the world bodies and meta. Called by world.render()", "line": 129, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "render", "name_prefix": "Renderer#", "path": "Renderer.prototype.render", "outFile": "renderer.html#Renderer.prototype.render" }, { "id": "Renderer#resize", "type": "instance method", "signatures": [ { "arguments": [ { "name": "width", "optional": true, "types": [ "Number" ], "description": " The width in px\n\n " }, { "name": "height", "optional": true, "types": [ "Number" ], "description": " The height in px\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "width", "types": [ "Number" ], "description": " The width in px\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The height in px\n\n " } ], "description": "Set the dimensions of the renderer.\n\nIf no dimensions are specified it will auto resize.", "short_description": "Set the dimensions of the renderer.\n", "line": 87, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "resize", "name_prefix": "Renderer#", "path": "Renderer.prototype.resize", "outFile": "renderer.html#Renderer.prototype.resize" }, { "id": "Renderer#setWorld", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "description": "Set which world to apply to.\n\nUsually this is called internally. Shouldn't be a need to call this yourself usually.", "short_description": "Set which world to apply to.\n", "line": 107, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "setWorld", "name_prefix": "Renderer#", "path": "Renderer.prototype.setWorld", "outFile": "renderer.html#Renderer.prototype.setWorld" }, { "id": "CanvasRenderer", "type": "class", "superclass": "Renderer", "description": "Physics.renderer('canvas')\n\nRenderer that uses HTMLCanvas to render the world bodies.\n\nAdditional config options:\n\n- metaEl: HTMLElement to write meta information like FPS and IPF into. (default: autogenerated)\n- offset: Offset the shapes by this amount. (default: `{ x: 0, y: 0 }`)\n- styles: Styles to use to draw the shapes. (see below)\n\nThe styles property should contain _default_ styles for each shape you want to draw.\n\nExample:\n\n```javascript\nstyles: {\n\n 'circle' : {\n strokeStyle: '#542437',\n lineWidth: 1,\n fillStyle: '#542437',\n angleIndicator: 'white'\n },\n\n 'convex-polygon' : {\n strokeStyle: '#542437',\n lineWidth: 1,\n fillStyle: '#542437',\n angleIndicator: 'white'\n }\n}\n```\n\nStyles can also be defined on a per-body basis. Use the \"styles\" property for a body:\n\nExample:\n\n```javascript\nPhysics.body('circle', {\n // ...\n styles: {\n strokeStyle: '#542437',\n lineWidth: 1,\n fillStyle: '#542437',\n angleIndicator: 'white'\n }\n});\n```\n\nYou can also define an image to use for a body:\n\nExample:\n\n```javascript\nPhysics.body('circle', {\n // ...\n styles: {\n src: 'path/to/image.jpg',\n width: 40,\n height: 50\n }\n});\n```", "short_description": "Physics.renderer('canvas')\n", "line": 68, "aliases": [], "children": [ { "id": "CanvasRenderer#addLayer", "type": "instance method", "signatures": [ { "arguments": [ { "name": "id", "types": [ "String" ], "description": " The id for the layer\n\n " }, { "name": "el", "optional": true, "types": [ "HTMLElement" ], "description": " The canvas element to use for this layer\n\n " }, { "name": "opts", "optional": true, "types": [ "Object" ], "description": " The options for this layer (see below)\n\n " } ], "returns": [ { "type": "Layer" } ] } ], "arguments": [ { "name": "id", "types": [ "String" ], "description": " The id for the layer\n\n " }, { "name": "el", "types": [ "HTMLElement" ], "description": " The canvas element to use for this layer\n\n " }, { "name": "opts", "types": [ "Object" ], "description": " The options for this layer (see below)\n\n " } ], "description": "Create a new layer.\n\nLayers can have the following options:\n\n- width: The width\n- height: The height\n- manual: Draw manually (default: `false`)\n- autoResize: Automatically resize the layer when the renderer's [[CanvasRenderer#resize]] method is called. (default: `true`)\n- follow: A [[Body]]. Offset this layer's rendering to follow a body's position. (default: `null`)\n- offset: The offset [[Vectorish]] for this layer. (default: `null`)\n- scale: Scale the layer by this amount. (default: `1`)\n- zIndex: The zIndex for the layer's HTMLElement. (default: `1`)", "short_description": "Create a new layer.\n", "line": 226, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "addLayer", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.addLayer", "outFile": "canvas.html#CanvasRenderer.prototype.addLayer" }, { "id": "CanvasRenderer#draw", "type": "instance method", "signatures": [ { "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " The shape to draw\n\n " }, { "name": "styles", "optional": true, "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "optional": true, "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " }, { "name": "offset", "optional": true, "types": [ "Vectorish" ], "description": " The offset from center\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " The shape to draw\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " }, { "name": "offset", "types": [ "Vectorish" ], "description": " The offset from center\n\n " } ], "description": "Draw a geometry to a context.", "short_description": "Draw a geometry to a context.", "line": 630, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "draw", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.draw", "outFile": "canvas.html#CanvasRenderer.prototype.draw" }, { "id": "CanvasRenderer#drawCircle", "type": "instance method", "signatures": [ { "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "r", "types": [ "Number" ], "description": " The circle radius\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "optional": true, "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ] } ], "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "r", "types": [ "Number" ], "description": " The circle radius\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ], "description": "Draw a circle to specified canvas context.", "short_description": "Draw a circle to specified canvas context.", "line": 514, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "drawCircle", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.drawCircle", "outFile": "canvas.html#CanvasRenderer.prototype.drawCircle" }, { "id": "CanvasRenderer#drawLine", "type": "instance method", "signatures": [ { "arguments": [ { "name": "from", "types": [ "Vectorish" ], "description": " The starting pt\n\n " }, { "name": "to", "types": [ "Vectorish" ], "description": " The ending pt\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "optional": true, "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ] } ], "arguments": [ { "name": "from", "types": [ "Vectorish" ], "description": " The starting pt\n\n " }, { "name": "to", "types": [ "Vectorish" ], "description": " The ending pt\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ], "description": "Draw a line onto specified canvas context.", "short_description": "Draw a line onto specified canvas context.", "line": 599, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "drawLine", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.drawLine", "outFile": "canvas.html#CanvasRenderer.prototype.drawLine" }, { "id": "CanvasRenderer#drawPolygon", "type": "instance method", "signatures": [ { "arguments": [ { "name": "verts", "types": [ "Array" ], "description": " Array of [[Vectorish]] vertices\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "optional": true, "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ] } ], "arguments": [ { "name": "verts", "types": [ "Array" ], "description": " Array of [[Vectorish]] vertices\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ], "description": "Draw a polygon to specified canvas context.", "short_description": "Draw a polygon to specified canvas context.", "line": 534, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "drawPolygon", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.drawPolygon", "outFile": "canvas.html#CanvasRenderer.prototype.drawPolygon" }, { "id": "CanvasRenderer#drawRect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "width", "types": [ "Number" ], "description": " The width\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The height\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "optional": true, "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ] } ], "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "width", "types": [ "Number" ], "description": " The width\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The height\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " }, { "name": "ctx", "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ], "description": "Draw a rectangle to specified canvas context.", "short_description": "Draw a rectangle to specified canvas context.", "line": 575, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "drawRect", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.drawRect", "outFile": "canvas.html#CanvasRenderer.prototype.drawRect" }, { "id": "CanvasRenderer#layer", "type": "instance method", "signatures": [ { "arguments": [ { "name": "id", "types": [ "String" ], "description": " The id for the layer\n\n " } ], "returns": [ { "type": "Layer" } ] } ], "arguments": [ { "name": "id", "types": [ "String" ], "description": " The id for the layer\n\n " } ], "description": "Get the layer by id.", "short_description": "Get the layer by id.", "line": 198, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "layer", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.layer", "outFile": "canvas.html#CanvasRenderer.prototype.layer" }, { "id": "CanvasRenderer#removeLayer", "type": "instance method", "signatures": [ { "arguments": [ { "name": "id", "types": [ "String" ], "description": " The id for the layer\n\n " } ], "returns": [ { "type": "this" } ] }, { "arguments": [ { "name": "layer", "types": [ "Layer" ], "description": " The layer\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "id", "types": [ "String" ], "description": " The id for the layer\n\n " }, { "name": "layer", "types": [ "Layer" ], "description": " The layer\n\n " } ], "description": "Remove a layer.", "short_description": "Remove a layer.", "line": 444, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "removeLayer", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.removeLayer", "outFile": "canvas.html#CanvasRenderer.prototype.removeLayer" }, { "id": "CanvasRenderer#resize", "type": "instance method", "signatures": [ { "arguments": [ { "name": "width", "types": [ "Number" ], "description": " The width\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The height\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "width", "types": [ "Number" ], "description": " The width\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The height\n\n " } ], "description": "Resize all layer canvases that have the `autoResize` option set to `true`.", "short_description": "Resize all layer canvases that have the `autoResize` option set to `true`.", "line": 464, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "resize", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.resize", "outFile": "canvas.html#CanvasRenderer.prototype.resize" }, { "id": "CanvasRenderer#setStyle", "type": "instance method", "signatures": [ { "arguments": [ { "name": "styles", "types": [ "Object", "String" ], "description": " Styles to set on the canvas context\n\n " }, { "name": "ctx", "optional": true, "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ] } ], "arguments": [ { "name": "styles", "types": [ "Object", "String" ], "description": " Styles to set on the canvas context\n\n " }, { "name": "ctx", "types": [ "Canvas2DContext" ], "description": " The canvas context\n\n " } ], "description": "Set styles on the specified canvas context (or main context).", "short_description": "Set styles on the specified canvas context (or main context).", "line": 488, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "setStyle", "name_prefix": "CanvasRenderer#", "path": "CanvasRenderer.prototype.setStyle", "outFile": "canvas.html#CanvasRenderer.prototype.setStyle" }, { "id": "Layer", "type": "class", "belongs_to": "CanvasRenderer", "description": "A rendering layer for the canvas renderer.\n\nCreate by calling [[CanvasRenderer#addLayer]].", "short_description": "A rendering layer for the canvas renderer.\n", "line": 235, "aliases": [], "children": [ { "id": "Layer#addToStack", "type": "instance method", "signatures": [ { "arguments": [ { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to add\n\n " } ], "returns": [ { "type": "this" } ] }, { "arguments": [ { "name": "body", "types": [ "Body" ], "description": " Body to add\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "body", "types": [ "Body" ], "description": " Body to add\n\n " }, { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to add\n\n " } ], "description": "Add body (bodies) to the rendering stack for this layer.\n\nBodies must be added to the stack in order to be rendered by this layer UNLESS it is the \"main\" layer.", "short_description": "Add body (bodies) to the rendering stack for this layer.\n", "line": 324, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "addToStack", "name_prefix": "Layer#", "path": "Layer.prototype.addToStack", "outFile": "canvas.html#Layer.prototype.addToStack" }, { "id": "Layer#bodies", "type": "constant", "signatures": [ { "returns": [ { "type": "Array" } ] } ], "description": "The Bodies this layer is rendering.\n\nThe \"main\" layer will render all world bodies if it's empty.", "short_description": "The Bodies this layer is rendering.\n", "line": 300, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "bodies", "name_prefix": "Layer#", "path": "Layer.prototype.bodies", "outFile": "canvas.html#Layer.prototype.bodies" }, { "id": "Layer#el", "type": "constant", "signatures": [ { "returns": [ { "type": "HTMLElement" } ] } ], "description": "The layer's Canvas", "short_description": "The layer's Canvas", "line": 251, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "el", "name_prefix": "Layer#", "path": "Layer.prototype.el", "outFile": "canvas.html#Layer.prototype.el" }, { "id": "Layer#id", "type": "constant", "signatures": [ { "returns": [ { "type": "String" } ] } ], "description": "The layer's ID", "short_description": "The layer's ID", "line": 245, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "id", "name_prefix": "Layer#", "path": "Layer.prototype.id", "outFile": "canvas.html#Layer.prototype.id" }, { "id": "Layer#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The options to set as an object\n\n " } ], "returns": [ { "type": "Object", "description": " The options\n\n " } ], "related_to": "Physics.util.options", "description": "Set options on this layer.\n\nAccess options directly from the options object.\n\nExample:\n\n```javascript\nthis.options.someOption;\n```", "short_description": "Set options on this layer.\n", "line": 267, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "options", "name_prefix": "Layer#", "path": "Layer.prototype.options", "outFile": "canvas.html#Layer.prototype.options" }, { "id": "Layer#removeFromStack", "type": "instance method", "signatures": [ { "arguments": [ { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to remove\n\n " } ], "returns": [ { "type": "this" } ] }, { "arguments": [ { "name": "body", "types": [ "Body" ], "description": " Body to remove\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "body", "types": [ "Body" ], "description": " Body to remove\n\n " }, { "name": "arr", "types": [ "Array" ], "description": " Array of bodies to remove\n\n " } ], "description": "Remove body (bodies) from the rendering stack for this layer.", "short_description": "Remove body (bodies) from the rendering stack for this layer.", "line": 342, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "removeFromStack", "name_prefix": "Layer#", "path": "Layer.prototype.removeFromStack", "outFile": "canvas.html#Layer.prototype.removeFromStack" }, { "id": "Layer#render", "type": "instance method", "signatures": [ { "arguments": [ { "name": "clear", "optional": true, "types": [ "Boolean" ], "description": " Clear the canvas (default: `true`)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "clear", "types": [ "Boolean" ], "description": " Clear the canvas (default: `true`)\n\n " } ], "description": "Render the bodies in this layer's stack.\n\nIf you want you can replace this function with your own to do custom rendering.\n\nExample:\n\n```javascript\nlayer.render = myCustomRenderFn;\n```", "short_description": "Render the bodies in this layer's stack.\n", "line": 373, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "render", "name_prefix": "Layer#", "path": "Layer.prototype.render", "outFile": "canvas.html#Layer.prototype.render" }, { "id": "Layer#reset", "type": "instance method", "signatures": [ { "arguments": [ { "name": "arr", "optional": true, "types": [ "Array" ], "description": " Array to replace the current stack of Bodies.\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "arr", "types": [ "Array" ], "description": " Array to replace the current stack of Bodies.\n\n " } ], "description": "Reset the stack.", "short_description": "Reset the stack.", "line": 308, "aliases": [], "children": [], "file": "src/renderers/canvas.js", "name": "reset", "name_prefix": "Layer#", "path": "Layer.prototype.reset", "outFile": "canvas.html#Layer.prototype.reset" } ], "file": "src/renderers/canvas.js", "subclasses": [], "name": "Layer", "path": "Layer", "outFile": "canvas.html" } ], "file": "src/renderers/canvas.js", "subclasses": [], "name": "CanvasRenderer", "path": "CanvasRenderer", "outFile": "canvas.html" }, { "id": "DebugRenderer", "type": "class", "superclass": "Renderer", "description": "Physics.renderer('debug')\n\nExtends canvas renderer with special debugging functionality.\n\nAdditional config options:\n\n- metaEl: HTMLElement to write meta information like FPS and IPF into. (default: autogenerated)\n- offset: Offset the shapes by this amount. (default: `{ x: 0, y: 0 }`)\n- styles: Styles to use to draw the shapes. (see below)\n- drawAABB: whether or not to draw bounding boxes. (default: `true`)\n- drawRealPosition: whether or not to draw the non-interpolated position of bodies. (default: `false`)\n- drawIntervals: whether or not to draw the broadphase (sweep-prune) intervals. (default: `false`)\n- drawContacts: whether or not to draw contact points. (default: `false`)\n- drawSleepState: whether or not to highlight sleeping bodies. (default: `false`)\n- drawBodyState: whether or not to show body position and velocity. (default: `false`)\n- aabbColor: the color of AABBs\n- realBodyStyle: styles used to draw the image of the body at its true non-interpolated position\n- intervalMinColor: color of interval minima\n- intervalMaxColor: color of interval maxima\n- mtvColor: color of minimum transit vector for contacts (overlaps)\n- contactColor: color of contact points\n\nThe styles property should contain _default_ styles for each shape you want to draw.\n\nExample:\n\n```javascript\nstyles: {\n\n 'circle' : {\n strokeStyle: '#542437',\n lineWidth: 1,\n fillStyle: '#542437',\n angleIndicator: 'white'\n },\n\n 'convex-polygon' : {\n strokeStyle: '#542437',\n lineWidth: 1,\n fillStyle: '#542437',\n angleIndicator: 'white'\n }\n}\n```", "short_description": "Physics.renderer('debug')\n", "line": 52, "aliases": [], "children": [], "file": "src/renderers/debug.js", "subclasses": [], "name": "DebugRenderer", "path": "DebugRenderer", "outFile": "debug.html" }, { "id": "DomRenderer", "type": "class", "superclass": "Renderer", "description": "Physics.renderer('dom')\n\nRenderer that manipulates DOM elements according to the physics simulation. Very primative...", "short_description": "Physics.renderer('dom')\n", "line": 8, "aliases": [], "children": [ { "id": "DomRenderer#attach", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "HTMLElement", "Object" ], "description": " DOM node or event data (`data.body`)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "data", "types": [ "HTMLElement", "Object" ], "description": " DOM node or event data (`data.body`)\n\n " } ], "description": "Event callback to attach a node to the viewport", "short_description": "Event callback to attach a node to the viewport", "line": 242, "aliases": [], "children": [], "file": "src/renderers/dom.js", "name": "attach", "name_prefix": "DomRenderer#", "path": "DomRenderer.prototype.attach", "outFile": "dom.html#DomRenderer.prototype.attach" }, { "id": "DomRenderer#circleProperties", "type": "instance method", "signatures": [ { "arguments": [ { "name": "el", "types": [ "HTMLElement" ], "description": " The element\n\n " }, { "name": "geometry", "types": [ "Geometry" ], "description": " The body's geometry\n\n " } ] } ], "arguments": [ { "name": "el", "types": [ "HTMLElement" ], "description": " The element\n\n " }, { "name": "geometry", "types": [ "Geometry" ], "description": " The body's geometry\n\n " } ], "internal": true, "description": "Set dom element style properties for a circle.", "short_description": "Set dom element style properties for a circle.", "line": 136, "aliases": [], "children": [], "file": "src/renderers/dom.js", "name": "circleProperties", "name_prefix": "DomRenderer#", "path": "DomRenderer.prototype.circleProperties", "outFile": "dom.html#DomRenderer.prototype.circleProperties" }, { "id": "DomRenderer#detach", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "HTMLElement", "Object" ], "description": " DOM node or event data (`data.body`)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "data", "types": [ "HTMLElement", "Object" ], "description": " DOM node or event data (`data.body`)\n\n " } ], "description": "Event callback to detach a node from the DOM", "short_description": "Event callback to detach a node from the DOM", "line": 221, "aliases": [], "children": [], "file": "src/renderers/dom.js", "name": "detach", "name_prefix": "DomRenderer#", "path": "DomRenderer.prototype.detach", "outFile": "dom.html#DomRenderer.prototype.detach" }, { "id": "DomRenderer#pointProperties", "type": "instance method", "signatures": [ { "arguments": [ { "name": "el", "types": [ "HTMLElement" ], "description": " The element\n\n " }, { "name": "geometry", "types": [ "Geometry" ], "description": " The body's geometry\n\n " } ] } ], "arguments": [ { "name": "el", "types": [ "HTMLElement" ], "description": " The element\n\n " }, { "name": "geometry", "types": [ "Geometry" ], "description": " The body's geometry\n\n " } ], "internal": true, "description": "Set dom element style properties for a point.", "short_description": "Set dom element style properties for a point.", "line": 120, "aliases": [], "children": [], "file": "src/renderers/dom.js", "name": "pointProperties", "name_prefix": "DomRenderer#", "path": "DomRenderer.prototype.pointProperties", "outFile": "dom.html#DomRenderer.prototype.pointProperties" }, { "id": "DomRenderer#rectangleProperties", "type": "instance method", "signatures": [ { "arguments": [ { "name": "el", "types": [ "HTMLElement" ], "description": " The element\n\n " }, { "name": "geometry", "types": [ "Geometry" ], "description": " The body's geometry\n\n " } ] } ], "arguments": [ { "name": "el", "types": [ "HTMLElement" ], "description": " The element\n\n " }, { "name": "geometry", "types": [ "Geometry" ], "description": " The body's geometry\n\n " } ], "internal": true, "description": "Set dom element style properties for a rectangle.", "short_description": "Set dom element style properties for a rectangle.", "line": 154, "aliases": [], "children": [], "file": "src/renderers/dom.js", "name": "rectangleProperties", "name_prefix": "DomRenderer#", "path": "DomRenderer.prototype.rectangleProperties", "outFile": "dom.html#DomRenderer.prototype.rectangleProperties" } ], "file": "src/renderers/dom.js", "subclasses": [], "name": "DomRenderer", "path": "DomRenderer", "outFile": "dom.html" }, { "id": "PixiRenderer", "type": "class", "superclass": "Renderer", "description": "Physics.renderer('pixi')\n\nRenderer that uses the PIXI.js library. [Documentation can be found here](https://github.com/wellcaffeinated/PhysicsJS/wiki/PIXI-Renderer).\n\nAdditional config options:\n\n- metaEl: HTMLElement to write meta information like FPS and IPF into. (default: autogenerated)\n- offset: Offset the shapes by this amount. (default: `{ x: 0, y: 0 }`)\n- styles: Styles to use to draw the shapes. (see below)\n\nThe styles property should contain _default_ styles for each shape you want to draw.\n\nExample:\n\n```javascript\nstyles: {\n // Defines the default canvas colour\n 'color': '0x66FF99',\n\n 'circle' : {\n strokeStyle: '0xE8900C',\n lineWidth: 3,\n fillStyle: '0xD5DE4C',\n angleIndicator: '0xE8900C',\n strokeAlpha: 1,\n fillAlpha: 1\n },\n\n 'convex-polygon' : {\n strokeStyle: '0xE8900C',\n lineWidth: 3,\n fillStyle: '0xD5DE4C',\n angleIndicator: '0xE8900C'\n }\n}\n```\n\nStyles can also be defined on a per-body basis. Use the \"styles\" property for a body:\n\nExample:\n\n```javascript\nPhysics.body('circle', {\n // ...\n styles: {\n strokeStyle: '0x542437',\n lineWidth: 1,\n fillStyle: '0x542437',\n angleIndicator: '0xFFFFFF'\n }\n});\n```\n\nYou can also define an image to use for a body:\n\nExample:\n\n```javascript\nPhysics.body('circle', {\n // ...\n styles: {\n src: 'path/to/image.jpg',\n width: 40,\n height: 50,\n anchor: { x: 0.5, y: 0.5 }\n }\n});\n```", "short_description": "Physics.renderer('pixi')\n", "line": 76, "aliases": [], "children": [ { "id": "PixiRenderer#attach", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "PIXI.Graphics", "Object" ], "description": " Graphics object or event data (`data.body`)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "data", "types": [ "PIXI.Graphics", "Object" ], "description": " Graphics object or event data (`data.body`)\n\n " } ], "description": "Event callback to attach a child to the stage", "short_description": "Event callback to attach a child to the stage", "line": 239, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "attach", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.attach", "outFile": "pixi-renderer.html#PixiRenderer.prototype.attach" }, { "id": "PixiRenderer#centerAnchor", "type": "instance method", "signatures": [ { "arguments": [ { "name": "view", "types": [ "PIXI.DisplayObject" ], "description": " The view to center\n\n " } ] } ], "arguments": [ { "name": "view", "types": [ "PIXI.DisplayObject" ], "description": " The view to center\n\n " } ], "description": "Centers the anchor to {x: 0.5, y: 0.5} of a view", "short_description": "Centers the anchor to {x: 0.5, y: 0.5} of a view", "line": 622, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "centerAnchor", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.centerAnchor", "outFile": "pixi-renderer.html#PixiRenderer.prototype.centerAnchor" }, { "id": "PixiRenderer#createCircle", "type": "instance method", "signatures": [ { "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "r", "types": [ "Number" ], "description": " The circle radius\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a circle.\n\n " } ] } ], "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "r", "types": [ "Number" ], "description": " The circle radius\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a circle.\n\n " } ], "description": "Create a circle for use in PIXI stage", "short_description": "Create a circle for use in PIXI stage", "line": 362, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "createCircle", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.createCircle", "outFile": "pixi-renderer.html#PixiRenderer.prototype.createCircle" }, { "id": "PixiRenderer#createDisplay", "type": "instance method", "signatures": [ { "arguments": [ { "name": "type", "types": [ "String" ], "description": " The type of PIXI.DisplayObject to make\n\n " }, { "name": "options", "types": [ "Object" ], "description": " Options to apply to the view.\n\n " } ], "returns": [ { "type": "PIXI.DisplayObject", "description": " An object that is renderable.\n\n " } ] } ], "arguments": [ { "name": "type", "types": [ "String" ], "description": " The type of PIXI.DisplayObject to make\n\n " }, { "name": "options", "types": [ "Object" ], "description": " Options to apply to the view.\n\n " } ], "returns": [ { "type": "PIXI.DisplayObject", "description": " An object that is renderable.\n\n " } ], "description": "Create a PIXI sprite or movie clip.", "short_description": "Create a PIXI sprite or movie clip.", "line": 563, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "createDisplay", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.createDisplay", "outFile": "pixi-renderer.html#PixiRenderer.prototype.createDisplay" }, { "id": "PixiRenderer#createLine", "type": "instance method", "signatures": [ { "arguments": [ { "name": "from", "types": [ "Vectorish" ], "description": " Starting point\n\n " }, { "name": "to", "types": [ "Vectorish" ], "description": " Ending point\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a polygon.\n\n " } ] } ], "arguments": [ { "name": "from", "types": [ "Vectorish" ], "description": " Starting point\n\n " }, { "name": "to", "types": [ "Vectorish" ], "description": " Ending point\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a polygon.\n\n " } ], "description": "Create a line for use in PIXI stage", "short_description": "Create a line for use in PIXI stage", "line": 441, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "createLine", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.createLine", "outFile": "pixi-renderer.html#PixiRenderer.prototype.createLine" }, { "id": "PixiRenderer#createPolygon", "type": "instance method", "signatures": [ { "arguments": [ { "name": "verts", "types": [ "Array" ], "description": " Array of [[Vectorish]] vertices\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a polygon.\n\n " } ] } ], "arguments": [ { "name": "verts", "types": [ "Array" ], "description": " Array of [[Vectorish]] vertices\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a polygon.\n\n " } ], "description": "Create a polygon for use in PIXI stage", "short_description": "Create a polygon for use in PIXI stage", "line": 399, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "createPolygon", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.createPolygon", "outFile": "pixi-renderer.html#PixiRenderer.prototype.createPolygon" }, { "id": "PixiRenderer#createRect", "type": "instance method", "signatures": [ { "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "r", "types": [ "Number" ], "description": " The rectangle width\n\n " }, { "name": "styles", "types": [ "Number" ], "description": " The rectangle height\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a circle.\n\n " } ] } ], "arguments": [ { "name": "x", "types": [ "Number" ], "description": " The x coord\n\n " }, { "name": "y", "types": [ "Number" ], "description": " The y coord\n\n " }, { "name": "width", "types": [ "Number" ], "description": " The rectangle width\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The rectangle height\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object representing a circle.\n\n " } ], "description": "Create a rectangle for use in PIXI stage", "short_description": "Create a rectangle for use in PIXI stage", "line": 382, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "createRect", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.createRect", "outFile": "pixi-renderer.html#PixiRenderer.prototype.createRect" }, { "id": "PixiRenderer#detach", "type": "instance method", "signatures": [ { "arguments": [ { "name": "data", "types": [ "PIXI.Graphics", "Object" ], "description": " Graphics object or event data (`data.body`)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "data", "types": [ "PIXI.Graphics", "Object" ], "description": " Graphics object or event data (`data.body`)\n\n " } ], "description": "Event callback to detach a child from the stage", "short_description": "Event callback to detach a child from the stage", "line": 220, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "detach", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.detach", "outFile": "pixi-renderer.html#PixiRenderer.prototype.detach" }, { "id": "PixiRenderer#drawBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The body to draw\n\n " }, { "name": "view", "types": [ "DisplayObject" ], "description": " The pixi display object\n\n " } ] } ], "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The body to draw\n\n " }, { "name": "view", "types": [ "DisplayObject" ], "description": " The pixi display object\n\n " } ], "description": "Draw a PIXI.DisplayObject to the stage.", "short_description": "Draw a PIXI.DisplayObject to the stage.", "line": 287, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "drawBody", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.drawBody", "outFile": "pixi-renderer.html#PixiRenderer.prototype.drawBody" }, { "id": "PixiRenderer#loadSpriteSheets", "type": "instance method", "signatures": [ { "arguments": [ { "name": "assetsToLoad", "types": [ "Array" ], "description": " Array of spritesheets to load\n\n " }, { "name": "callback", "types": [ "Function" ], "description": " Function to call when loading is complete\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "assetsToLoad", "types": [ "Array" ], "description": " Array of spritesheets to load\n\n " }, { "name": "callback", "types": [ "Function" ], "description": " Function to call when loading is complete\n\n " } ], "description": "Loads textures defined in a spritesheet", "short_description": "Loads textures defined in a spritesheet", "line": 259, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "loadSpriteSheets", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.loadSpriteSheets", "outFile": "pixi-renderer.html#PixiRenderer.prototype.loadSpriteSheets" }, { "id": "PixiRenderer#setStyles", "type": "instance method", "signatures": [ { "arguments": [ { "name": "graphics", "types": [ "PIXI.Graphics" ], "description": " The graphics object to set styles on\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object\n\n " } ] } ], "arguments": [ { "name": "graphics", "types": [ "PIXI.Graphics" ], "description": " The graphics object to set styles on\n\n " }, { "name": "styles", "types": [ "Object" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "PIXI.Graphics", "description": " A graphic object\n\n " } ], "description": "Set styles on pixi graphics object", "short_description": "Set styles on pixi graphics object", "line": 322, "aliases": [], "children": [], "file": "src/renderers/pixi-renderer.js", "name": "setStyles", "name_prefix": "PixiRenderer#", "path": "PixiRenderer.prototype.setStyles", "outFile": "pixi-renderer.html#PixiRenderer.prototype.setStyles" } ], "file": "src/renderers/pixi-renderer.js", "subclasses": [], "name": "PixiRenderer", "path": "PixiRenderer", "outFile": "pixi-renderer.html" } ], "file": "src/core/renderer.js", "subclasses": [ "CanvasRenderer", "DebugRenderer", "DomRenderer", "PixiRenderer" ], "name": "Renderer", "path": "Renderer", "outFile": "renderer.html" }, "Renderer#init": { "id": "Renderer#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " The configuration options passed by the factory\n\n " } ], "internal": true, "description": "Initialization. Internal use.", "short_description": "Initialization. Internal use.", "line": 58, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "init", "name_prefix": "Renderer#", "path": "Renderer.prototype.init", "outFile": "renderer.html#Renderer.prototype.init" }, "Renderer#resize": { "id": "Renderer#resize", "type": "instance method", "signatures": [ { "arguments": [ { "name": "width", "optional": true, "types": [ "Number" ], "description": " The width in px\n\n " }, { "name": "height", "optional": true, "types": [ "Number" ], "description": " The height in px\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "width", "types": [ "Number" ], "description": " The width in px\n\n " }, { "name": "height", "types": [ "Number" ], "description": " The height in px\n\n " } ], "description": "Set the dimensions of the renderer.\n\nIf no dimensions are specified it will auto resize.", "short_description": "Set the dimensions of the renderer.\n", "line": 87, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "resize", "name_prefix": "Renderer#", "path": "Renderer.prototype.resize", "outFile": "renderer.html#Renderer.prototype.resize" }, "Renderer#setWorld": { "id": "Renderer#setWorld", "type": "instance method", "signatures": [ { "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "world", "types": [ "Object" ], "description": " The world (or null)\n\n " } ], "description": "Set which world to apply to.\n\nUsually this is called internally. Shouldn't be a need to call this yourself usually.", "short_description": "Set which world to apply to.\n", "line": 107, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "setWorld", "name_prefix": "Renderer#", "path": "Renderer.prototype.setWorld", "outFile": "renderer.html#Renderer.prototype.setWorld" }, "Renderer#render": { "id": "Renderer#render", "type": "instance method", "signatures": [ { "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " Array of bodies in the world (by reference!)\n\n " }, { "name": "meta", "types": [ "Object" ], "description": " meta information\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "bodies", "types": [ "Array" ], "description": " Array of bodies in the world (by reference!)\n\n " }, { "name": "meta", "types": [ "Object" ], "description": " meta information\n\n " } ], "description": "Render the world bodies and meta. Called by world.render()", "short_description": "Render the world bodies and meta. Called by world.render()", "line": 129, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "render", "name_prefix": "Renderer#", "path": "Renderer.prototype.render", "outFile": "renderer.html#Renderer.prototype.render" }, "Renderer#createView": { "id": "Renderer#createView", "type": "instance method", "signatures": [ { "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " geometry The geometry\n\n " }, { "name": "styles", "types": [ "Object", "String" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "Mixed", "description": " Whatever the renderer needs to render the body.\n\n " } ] } ], "arguments": [ { "name": "geometry", "types": [ "Geometry" ], "description": " geometry The geometry\n\n " }, { "name": "styles", "types": [ "Object", "String" ], "description": " The styles configuration\n\n " } ], "returns": [ { "type": "Mixed", "description": " Whatever the renderer needs to render the body.\n\n " } ], "description": "Create a view for the specified geometry.\n\nThe view is used to render the body. It is a cached version\nof the body that gets moved and rotated according to the simulation.\n\nThe styles are used to modify the appearance of the view.\nThey depend on the renderer.\n\nOverride this when creating renderers.", "short_description": "Create a view for the specified geometry.\n", "line": 182, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "createView", "name_prefix": "Renderer#", "path": "Renderer.prototype.createView", "outFile": "renderer.html#Renderer.prototype.createView" }, "Renderer#drawMeta": { "id": "Renderer#drawMeta", "type": "instance method", "signatures": [ { "arguments": [ { "name": "meta", "types": [ "Object" ], "description": " The meta data\n\n " } ] } ], "arguments": [ { "name": "meta", "types": [ "Object" ], "description": " The meta data\n\n " } ], "description": "Draw the meta data.\n\nThe meta data will look like this:\n\n```javascript\nmeta = {\n fps: 60, // the frames per second\n ipf: 4 // the number of iterations per frame\n};\n```\n\nOverride this when creating renderers.", "short_description": "Draw the meta data.\n", "line": 209, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "drawMeta", "name_prefix": "Renderer#", "path": "Renderer.prototype.drawMeta", "outFile": "renderer.html#Renderer.prototype.drawMeta" }, "Renderer#drawBody": { "id": "Renderer#drawBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "body", "types": [ "Object" ], "description": " The body to draw\n\n " }, { "name": "view", "types": [ "Object" ], "description": " The view for the body\n\n " } ] } ], "arguments": [ { "name": "body", "types": [ "Object" ], "description": " The body to draw\n\n " }, { "name": "view", "types": [ "Object" ], "description": " The view for the body\n\n " } ], "description": "Draw specified body using specified view.\n\nOverride this when creating renderers.", "short_description": "Draw specified body using specified view.\n", "line": 226, "aliases": [], "children": [], "file": "src/core/renderer.js", "name": "drawBody", "name_prefix": "Renderer#", "path": "Renderer.prototype.drawBody", "outFile": "renderer.html#Renderer.prototype.drawBody" }, "Physics.world": { "id": "Physics.world", "type": "class", "related_to": "Physics", "description": "The world class and factory function.\n\nUse [[Physics]] to create worlds.", "short_description": "The world class and factory function.\n", "line": 8, "aliases": [], "children": [ { "id": "Physics.world#add", "type": "instance method", "signatures": [ { "arguments": [ { "name": "things", "types": [ "Object", "Array" ], "description": " The thing, or array of things (body, behavior, integrator, or renderer) to add.\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "things", "types": [ "Object", "Array" ], "description": " The thing, or array of things (body, behavior, integrator, or renderer) to add.\n\n " } ], "chainable": true, "description": "Multipurpose add method. Add one or many bodies, behaviors, integrators, renderers...", "short_description": "Multipurpose add method. Add one or many bodies, behaviors, integrators, renderers...", "line": 204, "aliases": [], "children": [], "file": "src/core/world.js", "name": "add", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.add", "outFile": "world.html#Physics.world.prototype.add" }, { "id": "Physics.world#addBehavior", "type": "instance method", "signatures": [ { "arguments": [ { "name": "behavior", "types": [ "Behavior" ], "description": " The behavior to add\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "behavior", "types": [ "Behavior" ], "description": " The behavior to add\n\n " } ], "chainable": true, "description": "Add a behavior to the world", "short_description": "Add a behavior to the world", "line": 467, "aliases": [], "children": [], "file": "src/core/world.js", "name": "addBehavior", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.addBehavior", "outFile": "world.html#Physics.world.prototype.addBehavior" }, { "id": "Physics.world#addBody", "type": "instance method", "signatures": [ { "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The behavior to add\n\n " } ], "returns": [ { "type": "this" } ] } ], "arguments": [ { "name": "body", "types": [ "Body" ], "description": " The behavior to add\n\n " } ], "chainable": true, "description": "Add a body to the world", "short_description": "Add a body to the world", "line": 535, "aliases": [], "children": [], "file": "src/core/world.js", "name": "addBody", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.addBody", "outFile": "world.html#Physics.world.prototype.addBody" }, { "id": "Physics.world#destroy", "type": "instance method", "signatures": [ { "arguments": [] } ], "description": "Destroy the world.\n(Bwahahahahaha!)", "short_description": "Destroy the world.\n(Bwahahahahaha!)", "line": 803, "aliases": [], "children": [], "file": "src/core/world.js", "name": "destroy", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.destroy", "outFile": "world.html#Physics.world.prototype.destroy" }, { "id": "Physics.world#find", "type": "instance method", "signatures": [ { "arguments": [ { "name": "rules", "types": [ "Object" ], "description": " Query rules\n\n " } ], "returns": [ { "type": "Array" } ] }, { "arguments": [ { "name": "filter", "arguments": [ { "name": "body", "description": " Each body in the world\n\n ", "types": [ "Body" ] } ], "callback": true, "types": [ "Function" ], "description": " Filter function called to check bodies\n\n " } ], "returns": [ { "type": "Array" } ] } ], "arguments": [ { "name": "rules", "types": [ "Object" ], "description": " Query rules\n\n " }, { "name": "filter", "types": [ "Function" ], "description": " Filter function called to check bodies\n\n " }, { "name": "body", "types": [ "Body" ], "description": " Each body in the world\n\n " } ], "related_to": "Physics.query", "description": "Find all matching bodies based on query rules.", "short_description": "Find all matching bodies based on query rules.", "line": 624, "aliases": [], "children": [], "file": "src/core/world.js", "name": "find", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.find", "outFile": "world.html#Physics.world.prototype.find" }, { "id": "Physics.world#findOne", "type": "instance method", "signatures": [ { "arguments": [ { "name": "rules", "types": [ "Object" ], "description": " Query rules.\n\n " } ], "returns": [ { "type": "Body" }, { "type": false } ] }, { "arguments": [ { "name": "filter", "arguments": [ { "name": "body", "description": " Each body in the world\n\n ", "types": [ "Body" ] } ], "callback": true, "types": [ "Function" ], "description": " Filter function called to check bodies\n\n " } ], "returns": [ { "type": "Body" }, { "type": false } ] } ], "arguments": [ { "name": "rules", "types": [ "Object" ], "description": " Query rules.\n\n " }, { "name": "filter", "types": [ "Function" ], "description": " Filter function called to check bodies\n\n " }, { "name": "body", "types": [ "Body" ], "description": " Each body in the world\n\n " } ], "related_to": "Physics.query", "description": "Find first matching body based on query rules.", "short_description": "Find first matching body based on query rules.", "line": 606, "aliases": [], "children": [], "file": "src/core/world.js", "name": "findOne", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.findOne", "outFile": "world.html#Physics.world.prototype.findOne" }, { "id": "Physics.world#getBehaviors", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " Array of behaviors\n\n " } ], "description": "Get copied list of behaviors in the world", "short_description": "Get copied list of behaviors in the world", "line": 492, "aliases": [], "children": [], "file": "src/core/world.js", "name": "getBehaviors", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.getBehaviors", "outFile": "world.html#Physics.world.prototype.getBehaviors" }, { "id": "Physics.world#getBodies", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Array" } ] } ], "returns": [ { "type": "Array", "description": " Array of bodies\n\n " } ], "description": "Get copied list of bodies in the world", "short_description": "Get copied list of bodies in the world", "line": 560, "aliases": [], "children": [], "file": "src/core/world.js", "name": "getBodies", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.getBodies", "outFile": "world.html#Physics.world.prototype.getBodies" }, { "id": "Physics.world#has", "type": "instance method", "signatures": [ { "arguments": [ { "name": "thing", "types": [ "Object" ], "description": " The thing to test\n\n " } ], "returns": [ { "type": "Boolean", "description": " `true` if thing is in the world, `false` otherwise.\n\n " } ] } ], "arguments": [ { "name": "thing", "types": [ "Object" ], "description": " The thing to test\n\n " } ], "returns": [ { "type": "Boolean", "description": " `true` if thing is in the world, `false` otherwise.\n\n " } ], "chainable": true, "description": "Determine if a thing has been added to world.", "short_description": "Determine if a thing has been added to world.", "line": 305, "aliases": [], "children": [], "file": "src/core/world.js", "name": "has", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.has", "outFile": "world.html#Physics.world.prototype.has" }, { "id": "Physics.world#init", "type": "instance method", "signatures": [ { "arguments": [ { "name": "options", "optional": true, "types": [ "Object" ], "description": " configuration options (see constructor)\n\n " }, { "name": "fn", "arguments": [ { "name": "world" }, { "name": "Physics" } ], "callback": true, "optional": true, "types": [ "Function", "Array" ], "description": " Callback function or array of callbacks called with this === world\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " configuration options (see constructor)\n\n " }, { "name": "fn", "types": [ "Function", "Array" ], "description": " Callback function or array of callbacks called with this === world\n\n " } ], "internal": true, "related_to": "new Physics.world", "description": "Initialization", "short_description": "Initialization", "line": 144, "aliases": [], "children": [], "file": "src/core/world.js", "name": "init", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.init", "outFile": "world.html#Physics.world.prototype.init" }, { "id": "Physics.world#integrator", "type": "instance method", "signatures": [ { "arguments": [ { "name": "integrator", "optional": true, "types": [ "Integrator" ], "description": " The integrator to set on the world\n\n " } ], "returns": [ { "type": "Integrator", "description": " The currently set integrator if `integrator` not specified\n\n " }, { "type": "this", "description": " for chaining if `integrator` specified\n\n " } ] } ], "arguments": [ { "name": "integrator", "types": [ "Integrator" ], "description": " The integrator to set on the world\n\n " } ], "returns": [ { "type": "Integrator", "description": " The currently set integrator if `integrator` not specified\n\n " }, { "type": "this", "description": " for chaining if `integrator` specified\n\n " } ], "chainable": true, "description": "Get or Set the integrator", "short_description": "Get or Set the integrator", "line": 351, "aliases": [], "children": [], "file": "src/core/world.js", "name": "integrator", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.integrator", "outFile": "world.html#Physics.world.prototype.integrator" }, { "id": "Physics.world#isPaused", "type": "instance method", "signatures": [ { "arguments": [], "returns": [ { "type": "Boolean" } ] } ], "returns": [ { "type": "Boolean", "description": " Returns `true` if world is paused, `false` otherwise.\n\n " } ], "description": "Determine if world is paused.", "short_description": "Determine if world is paused.", "line": 792, "aliases": [], "children": [], "file": "src/core/world.js", "name": "isPaused", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.isPaused", "outFile": "world.html#Physics.world.prototype.isPaused" }, { "id": "Physics.world#iterate", "type": "instance method", "signatures": [ { "arguments": [ { "name": "dt", "types": [ "Number" ], "description": " The timestep\n\n " } ] } ], "arguments": [ { "name": "dt", "types": [ "Number" ], "description": " The timestep\n\n " } ], "internal": true, "description": "Do a single iteration.", "short_description": "Do a single iteration.", "line": 639, "aliases": [], "children": [], "file": "src/core/world.js", "name": "iterate", "name_prefix": "Physics.world#", "path": "Physics.world.prototype.iterate", "outFile": "world.html#Physics.world.prototype.iterate" }, { "id": "Physics.world#options", "type": "instance method", "signatures": [ { "arguments": [ { "name": "cfg", "types": [ "Object" ], "description": " configuration options (see constructor)\n\n " } ], "returns": [ { "type": "Object", "description": " Options container\n\n " } ] } ], "arguments": [ { "name": "options", "types": [ "Object" ], "description": " configuration options (see constructor)\n\n " } ], "returns": [ { "type": "Object", "description": " Options container\n\n " } ], "description": "Set config options. Also access options by `.options.