Options
All
  • Public
  • Public/Protected
  • All
Menu

A circle shape.

Hierarchy

Index

Constructors

constructor

  • Creates a new circle shape.

    Parameters

    • Optional radius: number

      Circle radius.

    Returns b2CircleShape

Properties

Static e_circleShape

e_circleShape: number

Static e_edgeShape

e_edgeShape: number

Static e_hitCollide

e_hitCollide: number

Return value for TestSegment indicating a hit.

Static e_missCollide

e_missCollide: number

Return value for TestSegment indicating a miss.

Static e_polygonShape

e_polygonShape: number

Static e_shapeTypeCount

e_shapeTypeCount: number

Static e_unknownShape

e_unknownShape: number

Static startsInsideCollide

startsInsideCollide: number

Return value for TestSegment indicating that the segment starting point, p1, is already inside the shape.

Methods

ComputeAABB

  • Given a transform, compute the associated axis aligned bounding box for this shape.

    Parameters

    • aabb: b2AABB

      Calculated AABB, this argument is out.

    • xf: b2Transform

      Transform to calculate the AABB.

    Returns void

ComputeMass

  • ComputeMass(massData: b2MassData, density: number): void
  • Compute the mass properties of this shape using its dimensions and density. The inertia tensor is computed about the local origin, not the centroid.

    Parameters

    • massData: b2MassData

      Calculate the mass, this argument is out.

    • density: number

    Returns void

ComputeSubmergedArea

  • Compute the volume and centroid of this shape intersected with a half plane

    Parameters

    • normal: b2Vec2

      The surface normal.

    • offset: number

      The surface offset along the normal.

    • xf: b2Transform

      The shape transform.

    • c: b2Vec2

      The centroid, this argument is out.

    Returns number

Copy

  • Copies the circle shape.

    Returns b2CircleShape

    Copy of this circle shape.

GetLocalPosition

  • Get the local position of this circle in its parent body.

    Returns b2Vec2

    This circle's local position.

GetRadius

  • GetRadius(): number
  • Get the radius of the circle.

    Returns number

    This circle's radius.

GetType

  • GetType(): number
  • Get the type of this shape. You can use this to down cast to the concrete shape.

    Returns number

RayCast

  • Cast a ray against this shape.

    Parameters

    Returns boolean

    True if the ray hits the shape, otherwise false.

Set

  • Set the circle shape values from another shape.

    Parameters

    • other: b2CircleShape

      The other circle shape to copy values from.

    Returns void

SetLocalPosition

  • SetLocalPosition(position: b2Vec2): void
  • Set the local position of this circle in its parent body.

    Parameters

    • position: b2Vec2

      The new local position of this circle.

    Returns void

SetRadius

  • SetRadius(radius: number): void
  • Set the radius of the circle.

    Parameters

    • radius: number

      The new radius of the circle.

    Returns void

TestPoint

  • Test a point for containment in this shape. This only works for convex shapes.

    Parameters

    • xf: b2Transform

      Shape world transform.

    • p: b2Vec2

      Point to test against, in world coordinates.

    Returns boolean

    True if the point is in this shape, otherwise false.

Static TestOverlap

  • Test if two shapes overlap with the applied transforms.

    Parameters

    • shape1: b2Shape

      shape to test for overlap with shape2.

    • transform1: b2Transform

      shape1 transform to apply.

    • shape2: b2Shape

      shape to test for overlap with shape1.

    • transform2: b2Transform

      shape2 transform to apply.

    Returns boolean

    True if shape1 and shape2 overlap, otherwise false.

Generated using TypeDoc