crashcat docs
    Preparing search index...

    Type Alias ShapeDef<S>

    type ShapeDef<S extends ShapeBase> = {
        castRay: CastRayVsShapeFn<S>;
        category: ShapeCategory;
        collidePoint: CollidePointVsShapeFn<S>;
        computeMassProperties: ComputeMassPropertiesImpl<S>;
        getInnerRadius: GetInnerRadiusImpl<S>;
        getLeafShape: GetLeafShapeImpl<S>;
        getSubShapeTransformedShape: GetSubShapeTransformedShapeImpl<S>;
        getSupportFunction: GetSupportFunctionImpl<S>;
        getSupportingFace: GetSupportingFaceImpl<S>;
        getSurfaceNormal: GetSurfaceNormalImpl<S>;
        type: ShapeType;
        createSupportPool(): any;
        register(): void;
    }

    Type Parameters

    Index

    Properties

    castRay category collidePoint computeMassProperties getInnerRadius getLeafShape getSubShapeTransformedShape getSupportFunction getSupportingFace getSurfaceNormal type

    Methods

    createSupportPool register

    Properties

    castRay: CastRayVsShapeFn<S>

    cast a ray against the shape

    category: ShapeCategory

    Shape category used for collision dispatch registration

    collidePoint: CollidePointVsShapeFn<S>

    test if a point collides with the shape

    computeMassProperties: ComputeMassPropertiesImpl<S>

    get mass properties for the shape

    getInnerRadius: GetInnerRadiusImpl<S>

    get inner radius - radius of the biggest sphere that fits entirely in the shape

    getLeafShape: GetLeafShapeImpl<S>

    navigate to leaf shape following sub shape id hierarchy

    getSubShapeTransformedShape: GetSubShapeTransformedShapeImpl<S>

    navigate to transformed shape following sub shape id hierarchy, accumulating transforms

    getSupportFunction: GetSupportFunctionImpl<S>

    Get a support function for this shape. return undefined for non-convex shapes.

    the pool created by createSupportPool() for this shape type

    the shape instance

    support function mode (INCLUDE/EXCLUDE_CONVEX_RADIUS)

    scale to apply to the shape

    getSupportingFace: GetSupportingFaceImpl<S>

    get supporting face

    getSurfaceNormal: GetSurfaceNormalImpl<S>

    get surface normal

    type: ShapeType

    Methods

    • Create a support pool for this shape type. return undefined for non-convex shapes. Called once per ShapeSupportPool when pools are created or shapes are registered.

      Returns any

    • Register collision and cast handlers for this shape type

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods