Space

The heart of all Nape simulations.

Instance Members #

@private

Dynamic object for user to store additional data.

This object cannot be set, only its dynamically created properties may be set. In AS3 the type of this property is &#42

This object will be lazily constructed so that until accessed for the first time, will be null internally.

@default {}

Space gravity.

Units are of pixels/second/second @default (0,0)

Broadphase type in use.

Flag controlling sorting of contact points.

If true, then collisions will be resolved in an order defined by their penetration depths. This can be shown to improve stability of the physics as well as making simulations more consistent regardless of which broadphase is used.

Having sorting enabled obviously incurs a cost, and you may consider disabling it if you are having issues with performance (Though things such as number of physics iterations will have much greater bearing on performance than this, especcialy since enabling this may permit you to use less iterations).

@default true

Angular drag applied to all bodies in Space.

This represents the fraction of a body's angular velocity which will be removed per second. This value has no unit attached.

@default 0.015

Linear drag applied to all bodies in Space.

This represents the fraction of a body's linear velocity which will be removed per second. This value has no unit attached.

@default 0.015

List of all Compounds directly placed in space.

This list is mutable, and adding an element to this list is one way of adding a Compound to this Space equivalent to: compound.space = space

This list is only those compounds directly placed in the space, any compound that is a child of another compound will not be in this list.

List of all Bodys directly placed in space.

This list is mutable, and adding an element to this list is one way of adding a Body to this Space equivalent to: body.space = space

This list is only those bodies directly placed in the space, any body that is a child of a Compound will not be in this list.

List of all active dynamic Bodies in space.

This list contains all dynamic bodies that are awake regardless of their containment in a Compound.

This list is immutable.

List of all Constraints directly placed in space.

This list is mutable, and adding an element to this list is one way of adding a Constraint to this Space equivalent to: constraint.space = space

This list is only those bodies directly placed in the space, any constraint that is a child of a Compound will not be in this list.

List of all active Constraints in space.

This list contains all constraints regardless of their containment in a Compound.

This list is immutable.

Static, immutable Body for constraint purposes.

This is a completely static, uncollidable, uninteractable Body with no Shapes, that cannot be modified in any way.

Its purpose is to provide a means for attaching Constraints from one Body to the Space itself, for instance pinning a body against a static point in space.

List of all active arbiters in Space.

This list is immutable.

List of all Listeners in space.

This list is mutable, and adding an element to this list is one way of adding a Listener to this Space equivalent to: listener.space = space

The time stamp of this Space object.

This is equal to the number of times that space.step(..) has been invoked.

The elapsed simulation time.

This is the total amount of 'time' that has elapsed in the Space simulation.

Apply given function to all bodies in space.

This method is a way to iterate over 'every' Body in the Space regardless of containment in a Compound.

Apply given function to all constraints in space.

This method is a way to iterate over 'every' Constraint in the Space regardless of containment in a Compound.

Apply given function to all compounds in space.

This method is a way to iterate over 'every' Compound in the Space regardless of containment in another Compound.

Clear the Space of all objects.

Things such as the elapsed simulation time, and time step will too be reset to 0.

Parameters such as gravity, and worldLinearDrag will be untouched by this operation.

Step simulation forward in time.

Determine the interaction type that would occur between a pair of Shapes.

This function takes into account everything possible, and ignoring the callback system will tell you precisely the type of interaction (if any at all) which will occur between these Shapes.

This function can only work if the Shapes belong to a Body.

This function can only make use of any constraints 'ignore' property to determine if 'null' should be returned if the constraints being used are inside of a Space.

Evaluate all Shapes under a given Point.

If the filter argument is non-null, then only shapes who's filter agrees to 'collide' will be considered.

Evaluate all Bodies under a given Point.

If the filter argument is non-null, then only bodies with a shape containing the given point whose filter agrees to 'collide' will be considered.

Evaluate all Shapes given an AABB.

If the filter argument is non-null, then only shapes who's filter agrees to 'collide' will be considered.

Evaluate all Bodies given an AABB.

If the filter argument is non-null, then only bodies with a shape classified as being part of the AABB, whose filter agrees to collide will be considered.

Evaluate all Shapes given a circle.

If the filter argument is non-null, then only shapes who's filter agrees to 'collide' will be considered.

Evaluate all Bodies given a circle.

If the filter argument is non-null, then only bodies with a shape classified as being part of the circle, whose filter agrees to collide will be considered.

Evaluate all Shapes given another shape.

If the filter argument is non-null, then only shapes who's filter agrees to 'collide' will be considered. The input shape's own filter is never used in this method. The input shape is considered a purely geometric object.

The input shape must be part of a Body so as to be well defined.

Evaluate all Bodies given a shape.

If the filter argument is non-null, then only bodies with a shape classified as being part of the input shape, whose filter agrees to collide will be considered. The input shape is considered a purely geometric

The input shape must be part of a Body so as to be well defined.

Evaluate all Shapes given a Body.

If the filter argument is non-null, then only shapes who's filter agrees to 'collide' will be considered. The input body's shape's own filters are never used in this method. The input body is considered a purely geometric object.

Evaluate all Bodies given a Body.

If the filter argument is non-null, then only bodies with a shape classified as being part of the input body, whose filter agrees to collide will be considered. The input body is considered a purely geometric

Perform a convex cast for soonest collision.

This method will return only the soonest collision result (if any), to find more than this, use the convexMultiCast method. The shape will not be swept further than the time delta provided. Shapes already intersecting the sweep shape at t = 0 are ignored.

If the filter argument is null, then all shapes will be collidable otherwise only those for whose filter agrees to 'collide'.

Perform a convex cast for all collisions in time order.

This method will return all collisions, or an empty list if there are none. The shape will not be swept further than the time delta provided. Shapes already intersecting the sweep shape at t = 0 are ignored.

If the filter argument is null, then all shapes will be collidable otherwise only those for whose filter agrees to 'collide'.

Perform a ray cast for closest result.

This method will return only the closest result (if any), to find more the first result, use the rayMultiCast method. The ray will not be cast beyond its maxDistance.

If the filter argument is null, then all shapes will be intersectable otherwise only those for whose filter agrees to 'collide'.

Perform a ray cast for all valid results.

This method will return all intersections (in distance order) of ray with shapes in the space up to the ray's maxDistance.

If the filter argument is null, then all shapes will be intersectable otherwise only those for whose filter agrees to 'collide'.

Construct a new Space object.

Private Members #

Metadata #