A shape that is a capsule.

Hierarchy

Constructors

  • Creates a new capsule with the given radius and half-height.

    Parameters

    • halfHeight: number

      The balls half-height along the y axis.

    • radius: number

      The balls radius.

    Returns Capsule

Properties

halfHeight: number

The capsule's half height, along the y axis.

radius: number

The radius of the capsule's basis.

type: Capsule = ShapeType.Capsule

Methods

  • Parameters

    • ray: Ray
    • shapePos: Vector
    • shapeRot: number
    • maxToi: number
    • solid: boolean

    Returns number

  • Computes the time of impact between two moving shapes.

    Returns

    If the two moving shapes collider at some point along their trajectories, this returns the time at which the two shape collider as well as the contact information during the impact. Returns nullif the two shapes never collide along their paths.

    Parameters

    • shapePos1: Vector

      The initial position of this sahpe.

    • shapeRot1: number

      The rotation of this shape.

    • shapeVel1: Vector

      The velocity of this shape.

    • shape2: Shape

      The second moving shape.

    • shapePos2: Vector

      The initial position of the second shape.

    • shapeRot2: number

      The rotation of the second shape.

    • shapeVel2: Vector

      The velocity of the second shape.

    • targetDistance: number

      − If the shape moves closer to this distance from a collider, a hit will be returned.

    • maxToi: number

      The maximum time when the impact can happen.

    • stopAtPenetration: boolean

      If set to false, the linear shape-cast won’t immediately stop if the shape is penetrating another shape at its starting point and its trajectory is such that it’s on a path to exist that penetration state.

    Returns ShapeCastHit

  • Computes one pair of contact points between two shapes.

    Returns

    null if the shapes are separated by a distance greater than prediction, otherwise contact details. The result is given in world-space.

    Parameters

    • shapePos1: Vector

      The initial position of this sahpe.

    • shapeRot1: number

      The rotation of this shape.

    • shape2: Shape

      The second shape.

    • shapePos2: Vector

      The initial position of the second shape.

    • shapeRot2: number

      The rotation of the second shape.

    • prediction: number

      The prediction value, if the shapes are separated by a distance greater than this value, test will fail.

    Returns ShapeContact

  • Parameters

    Returns boolean

  • Parameters

    • ray: Ray
    • shapePos: Vector
    • shapeRot: number
    • maxToi: number

    Returns boolean

  • Tests if this shape intersects another shape.

    Returns

    true if the two shapes intersect, false if they don’t.

    Parameters

    • shapePos1: Vector

      The position of this shape.

    • shapeRot1: number

      The rotation of this shape.

    • shape2: Shape

      The second shape to test.

    • shapePos2: Vector

      The position of the second shape.

    • shapeRot2: number

      The rotation of the second shape.

    Returns boolean

  • Returns RawShape

  • instant mode without cache

    Parameters

    • rawSet: RawColliderSet
    • handle: number

    Returns Shape

Generated using TypeDoc