Code.org p5.play
p5.CollisionShape
Collision Shape Base Class
We have a set of collision shapes available that all conform to a simple interface so that they can be checked against one another using the Separating Axis Theorem.
This base class implements all the required methods for a collision shape and can be used as a collision point with no changes. Other shapes should inherit from this and override most methods.
Table of Contents
- Methods
- Properties
- Static Methods
Constructor
p5.CollisionShape
-
center -
rotation
Parameters:
-
[center]p5.Vector optional(zero if omitted)
-
[rotation]Number optional(zero if omitted)
Methods
_getCandidateAxes
()
Array.Compute candidate separating axes relative to another object. Override this method in subclasses to implement collision behavior.
Returns:
_getMinRadius
-
axis
Get the shape's minimum radius on any axis for tunneling checks.
Parameters:
-
axisp5.Vector
Returns:
_getRadiusOnAxis
-
axis
Get this shape's radius (half-width of its projection) along the given axis. Override this method in subclasses to implement collision behavior.
Parameters:
-
axisp5.Vector
Returns:
_onTransformChanged
()
Recalculate cached properties, relevant vectors, etc. when at least one of the shape's transforms changes. The base CollisionShape (and PointCollider) only need to recompute the shape's center, but other shapes may need to override this method and do additional recomputation.
Compute the smallest movement needed to move this collision shape out of another collision shape. If the shapes are not overlapping, returns a zero vector to indicate that no displacement is necessary.
Parameters:
-
otherp5.CollisionShape
Returns:
getBoundingBox
()
Top: number, bottom: number, left: number, right: number, width: number, height: number
Get world-space axis-aligned bounds information for this collision shape. Used primarily for the quadtree.
Returns:
}
overlap
-
other
Check whether this shape overlaps another.
Parameters:
-
otherp5.CollisionShape
Returns:
setParentTransform
-
parent
Update this collider's parent transform, which will in turn adjust its position, rotation and scale in world-space and recompute cached values if necessary. If a Sprite is passed as the 'parent' then a new transform will be computed from the sprite's position/rotation/scale and used.
Parameters:
-
parentp5.Transform2D | Sprite
updateFromSprite
-
sprite
Update this collider based on the properties of a parent Sprite.
Descendant classes should override this method to adopt the dimensions
of the sprite if getsDimensionsFromSprite is true.
Parameters:
-
spriteSprite
Properties
_localTransform
p5.Transform2D
protected
Transform of this shape relative to its parent. If there is no parent, this is pretty much the world-space transform. This should stay consistent with _offset, _rotation and _scale properties.
_offset
p5.Vector
private
The center of the collision shape in local-space; also, the offset of the collision shape's center from its parent sprite's center.
_parentTransform
p5.Transform2D
protected
Transform of whatever parent object (probably a sprite) this shape is associated with. If this is a free-floating shape, the parent transform will remain an identity matrix.
_rotation
Number
private
Rotation in radians in local space (relative to parent). Note that this will only be meaningful for shapes that can rotate, i.e. Oriented Bounding Boxes
_scale
p5.Vector
private
Scale X and Y in local space. Note that this will only be meaningful for shapes that have dimensions (e.g. not for point colliders)
center
p5.Vector
The center of the collision shape in world-space. Note: You can set this property with a value in world-space, but it will actually modify the collision shape's local transform.
getsDimensionsFromSprite
Boolean
If true, when calling updateFromSprite this collider will adopt the
base dimensions of the sprite in addition to adopting its transform.
If false, only the transform (position/rotation/scale) will be adopted.
offset
p5.Vector
The center of the collision shape in local-space - if this collider is owned by a sprite, the offset of the collider center from the sprite center.
rotation
Number
The local-space rotation of the collider, in radians.
WORLD_AXES
Array.Static Methods
p5.CollisionShape._getCanididateAxesForShapes
-
shape1 -
shape2
Parameters:
-
shape1p5.CollisionShape -
shape2p5.CollisionShape