mylingo3d/src/interface/IPhysicsObjectManager.ts

Lingo3D is a React/Vue 3d game development framework that ships with a complete visual editor

import { Point3d } from "@lincode/math"
import PhysicsObjectManager from "../display/core/PhysicsObjectManager"
import cubeShape from "../display/core/PhysicsObjectManager/cannon/shapes/cubeShape"
import ISimpleObjectManager, {
    simpleObjectManagerDefaults,
    simpleObjectManagerSchema
} from "./ISimpleObjectManager"
import Defaults from "./utils/Defaults"
import { ExtractProps } from "./utils/extractProps"
import { hideSchema } from "./utils/nonEditorSchemaSet"
import Nullable from "./utils/Nullable"
import NullableDefault from "./utils/NullableDefault"

export type PhysicsGroupIndex = 0 | 1 | 2 | 3 | 4 | 5
export type PhysicsOptions = boolean | "2d" | "map" | "map-debug" | "character"
export type PhysicsShape = (this: PhysicsObjectManager) => Promise<void>

export default interface IPhysicsObjectManager extends ISimpleObjectManager {
    maxAngularVelocityX: number
    maxAngularVelocityY: number
    maxAngularVelocityZ: number

    maxVelocityX: number
    maxVelocityY: number
    maxVelocityZ: number

    velocity: Point3d
    gravity: boolean

    noTumble: Nullable<boolean>
    slippery: Nullable<boolean>
    mass: Nullable<number>
    physicsGroup: Nullable<PhysicsGroupIndex>
    ignorePhysicsGroups: Nullable<Array<PhysicsGroupIndex>>

    physics: PhysicsOptions
    physicsShape: PhysicsShape
}

export const physicsObjectManagerSchema: Required<
    ExtractProps<IPhysicsObjectManager>
> = {
    ...simpleObjectManagerSchema,

    maxAngularVelocityX: Number,
    maxAngularVelocityY: Number,
    maxAngularVelocityZ: Number,

    maxVelocityX: Number,
    maxVelocityY: Number,
    maxVelocityZ: Number,

    velocity: Object,
    gravity: Boolean,

    noTumble: Boolean,
    slippery: Boolean,
    mass: Number,
    physicsGroup: Number,
    ignorePhysicsGroups: Array,

    physics: [String, Boolean],
    physicsShape: Function
}
hideSchema([
    "maxAngularVelocityX",
    "maxAngularVelocityY",
    "maxAngularVelocityZ",
    "maxVelocityX",
    "maxVelocityY",
    "maxVelocityZ",
    "velocity",
    "noTumble",
    "slippery",
    "mass",
    "physicsGroup",
    "ignorePhysicsGroups",
    "physicsShape"
])

export const physicsObjectManagerDefaults: Defaults<IPhysicsObjectManager> = {
    ...simpleObjectManagerDefaults,

    maxAngularVelocityX: Infinity,
    maxAngularVelocityY: Infinity,
    maxAngularVelocityZ: Infinity,

    maxVelocityX: Infinity,
    maxVelocityY: Infinity,
    maxVelocityZ: Infinity,

    velocity: { x: 0, y: 0, z: 0 },
    gravity: true,

    noTumble: new NullableDefault(false),
    slippery: new NullableDefault(false),
    mass: new NullableDefault(1),
    physicsGroup: undefined,
    ignorePhysicsGroups: undefined,

    physics: false,
    physicsShape: cubeShape
}