Options
All
  • Public
  • Public/Protected
  • All
Menu

An edge shape.

Hierarchy

Index

Constructors

constructor

  • Creates a new edge shape.

    Parameters

    Returns b2EdgeShape

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

  • Clone the shape.

    Returns b2Shape

Corner1IsConvex

  • Corner1IsConvex(): boolean
  • Determines if the first corner of this edge bends towards the solid side.

    Returns boolean

    True if convex, otherwise false.

Corner2IsConvex

  • Corner2IsConvex(): boolean
  • Determines if the second corner of this edge bends towards the solid side.

    Returns boolean

    True if convex, otherwise false.

GetCoreVertex1

  • Get a core vertex 1 in local coordinates. These vertices represent a smaller edge that is used for time of impact.

    Returns b2Vec2

    core vertex 1 in local coordinates.

GetCoreVertex2

  • Get a core vertex 2 in local coordinates. These vertices represent a smaller edge that is used for time of impact.

    Returns b2Vec2

    core vertex 2 in local coordinates.

GetCorner1Vector

  • Returns a unit vector halfway between direction and previous direction.

    Returns b2Vec2

    Halfway unit vector between direction and previous direction.

GetCorner2Vector

  • Returns a unit vector halfway between direction and previous direction.

    Returns b2Vec2

    Halfway unit vector between direction and previous direction.

GetDirectionVector

  • GetDirectionVector(): b2Vec2
  • Get a parallel unit vector, pointing from vertex 1 to vertex 2.

    Returns b2Vec2

    Vertex 1 to vertex 2 directional vector.

GetFirstVertex

  • Get the first vertex and apply the supplied transform.

    Parameters

    Returns b2Vec2

    First vertex with xf transform applied.

GetLength

  • GetLength(): number
  • Get the distance from vertex1 to vertex2.

    Returns number

    Distance from vertex1 to vertex2.

GetNextEdge

  • Get the next edge in the chain.

    Returns b2EdgeShape

    Next edge shape or null if there is no next edge shape.

GetNormalVector

  • Get a perpendicular unit vector, pointing from the solid side to the empty side.

    Returns b2Vec2

    Normal vector.

GetPrevEdge

  • Get the previous edge in the chain.

    Returns b2EdgeShape

    Previous edge shape or null if there is no previous edge shape.

GetType

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

    Returns number

GetVertex1

  • Get the local position of vertex1 in the parent body.

    Returns b2Vec2

    Local position of vertex1 in the parent body.

GetVertex2

  • Get the local position of vertex2 in the parent body.

    Returns b2Vec2

    Local position of vertex2 in the parent body.

RayCast

  • Cast a ray against this shape.

    Parameters

    Returns boolean

    True if the ray hits the shape, otherwise false.

Set

  • Set the shape values from another shape.

    Parameters

    • other: b2Shape

      The other shape to copy values from.

    Returns void

Support

  • Get the support point in the given world direction with the supplied transform.

    Parameters

    • xf: b2Transform

      Transform to apply.

    • dX: number

      X world direction.

    • dY: number

      Y world direction.

    Returns b2Vec2

    Support point.

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