Class HavokInternalAPI

constructor

• new HavokInternalAPI(havok, gravity): HavokInternalAPI

• Parameters

  • havok: HavokPhysicsWithBindings
  • gravity: Observable<[number, number, number], never>

  Returns HavokInternalAPI

_frame

• _frame(step): void

• Parameters

  • step: number

  Returns void

_internalComputeMassProperties

• _internalComputeMassProperties(bodyId): [[number, number, number], number, [number, number, number], [number, number, number, number]]

• Parameters

  • bodyId: HP_BodyId

  Returns [[number, number, number], number, [number, number, number], [number, number, number, number]]

addBodyToWorld

• addBodyToWorld(bodyId): void

• Parameters

  • bodyId: HP_BodyId

  Returns void

addShapeToBody

• addShapeToBody(containerShapeID, shape, transforms): void

• Parameters

  • containerShapeID: HP_ShapeId
  • shape: HP_ShapeId
  • transforms: any

  Returns void

applyImpulse

• applyImpulse(bodyId, impulse, location): void

• Parameters

  • bodyId: HP_BodyId
  • impulse: [number, number, number]
  • location: [number, number, number]

  Returns void

createBody

• createBody(): HP_BodyId

• Returns HP_BodyId

createContainer

• createContainer(): HP_ShapeId

• Returns HP_ShapeId

createShape

• createShape(shapeType, position, quaternion, scale, vertices, indicies): HP_ShapeId

• Parameters

  • shapeType: PhysicsShapeType
  • position: Vector3
  • quaternion: Quaternion
  • scale: Vector3
  • vertices: undefined | Vector3[]
  • indicies: undefined | number[]

  Returns HP_ShapeId

dispose

• dispose(): void

• Returns void

disposeConstraint

• disposeConstraint(constraint): void

• Disposes a physics constraint.

  Parameters

  • constraint: PhysicsConstraint

    The physics constraint to dispose.

    This method is useful for releasing the resources associated with a physics constraint, such as the Havok constraint, when it is no longer needed. This is important for avoiding memory leaks.

  Returns void

freeBuffer

• freeBuffer(arr): void

• Parameters

  • arr: PluginMemoryRef

  Returns void

getAngularDamping

• getAngularDamping(bodyId): number

• Parameters

  • bodyId: HP_BodyId

  Returns number

getAngularVelocityToRef

• getAngularVelocityToRef(bodyId, angVel): void

• Parameters

  • bodyId: HP_BodyId
  • angVel: Vector3

  Returns void

getAxisFriction

• getAxisFriction(constraint, axis): number

• Gets the friction value of the specified axis of the given constraint.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to get the axis friction from.
  • axis: PhysicsConstraintAxis

    The axis to get the friction from.

  Returns number

  The friction value of the specified axis.

getAxisMaxLimit

• getAxisMaxLimit(constraint, axis): number

• Gets the maximum limit of the given axis of the given constraint.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to get the maximum limit from.
  • axis: PhysicsConstraintAxis

    The axis to get the maximum limit from.

  Returns number

  The maximum limit of the given axis of the given constraint.

getAxisMinLimit

• getAxisMinLimit(constraint, axis): number

• Gets the minimum limit of the specified axis of the given constraint.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to get the minimum limit from.
  • axis: PhysicsConstraintAxis

    The axis to get the minimum limit from.

  Returns number

  The minimum limit of the specified axis of the given constraint.

getAxisMode

• getAxisMode(constraint, axis): PhysicsConstraintAxisLimitMode

• Gets the axis limit mode of the given constraint.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to get the axis limit mode from.
  • axis: PhysicsConstraintAxis

    The axis to get the limit mode from.

  Returns PhysicsConstraintAxisLimitMode

  The axis limit mode of the given constraint.

getAxisMotorMaxForce

• getAxisMotorMaxForce(constraint, axis): number

• Gets the maximum force of the motor of the given constraint axis.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to get the motor maximum force from.
  • axis: PhysicsConstraintAxis

    The axis of the constraint to get the motor maximum force from.

  Returns number

  The maximum force of the motor of the given constraint axis.

getAxisMotorTarget

• getAxisMotorTarget(constraint, axis): number

• Gets the target of the motor of the given axis of the given constraint.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to get the motor target from.
  • axis: PhysicsConstraintAxis

    The axis of the constraint to get the motor target from.

  Returns number

  The target of the motor of the given axis of the given constraint.

getAxisMotorType

• getAxisMotorType(constraint, axis): PhysicsConstraintMotorType

• Gets the motor type of the specified axis of the given constraint.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to get the motor type from.
  • axis: PhysicsConstraintAxis

    The axis of the constraint to get the motor type from.

  Returns PhysicsConstraintMotorType

  The motor type of the specified axis of the given constraint.

getBodyGeometry

• getBodyGeometry(bodyId): {
      indices: never[];
      positions: never[];
  } | {
      indices: Uint32Array;
      positions: Float32Array;
  }

• Parameters

  • bodyId: HP_BodyId

  Returns {
      indices: never[];
      positions: never[];
  } | {
      indices: Uint32Array;
      positions: Float32Array;
  }

getConstraintEnabled

• getConstraintEnabled(constraintID): boolean

• Parameters

  • constraintID: HP_ConstraintId

  Returns boolean

getDensity

• getDensity(containerShapeID): number

• Parameters

  • containerShapeID: HP_ShapeId

  Returns number

getGravityFactor

• getGravityFactor(bodyId): number

• Parameters

  • bodyId: HP_BodyId

  Returns number

getLinearDamping

• getLinearDamping(bodyId): number

• Parameters

  • bodyId: HP_BodyId

  Returns number

getLinearVelocityToRef

• getLinearVelocityToRef(bodyId, linVel): void

• Parameters

  • bodyId: HP_BodyId
  • linVel: Vector3

  Returns void

getMassProperties

• getMassProperties(bodyId): PhysicsMassProperties

• Parameters

  • bodyId: HP_BodyId

  Returns PhysicsMassProperties

getMaterial

• getMaterial(shapeID): {
      dynamicFriction: number;
      frictionCombine: undefined | PhysicsMaterialCombineMode;
      restitution: number;
      restitutionCombine: undefined | PhysicsMaterialCombineMode;
      staticFriction: number;
  }

• Parameters

  • shapeID: HP_ShapeId

  Returns {
      dynamicFriction: number;
      frictionCombine: undefined | PhysicsMaterialCombineMode;
      restitution: number;
      restitutionCombine: undefined | PhysicsMaterialCombineMode;
      staticFriction: number;
  }

  • dynamicFriction: number

  • frictionCombine: undefined | PhysicsMaterialCombineMode

  • restitution: number

  • restitutionCombine: undefined | PhysicsMaterialCombineMode

  • staticFriction: number

getMotionType

• getMotionType(bodyId): any

• Parameters

  • bodyId: HP_BodyId

  Returns any

getNumBodies

• getNumBodies(): number

• Returns number

getSpeedLimit

• getSpeedLimit(worldId?): number

• Parameters

  • worldId: HP_WorldId = ...

  Returns number

getTriangles

• getTriangles(indices): PluginMemoryRef

• Parameters

  • indices: number[]

  Returns PluginMemoryRef

getUpdatedPhysicsTransforms

• getUpdatedPhysicsTransforms(bodyId): [Vector3, Quaternion]

• Parameters

  • bodyId: HP_BodyId

  Returns [Vector3, Quaternion]

getVerticesMemoryRef

• getVerticesMemoryRef(vertices): PluginMemoryRef

• Parameters

  • vertices: Vector3[]

  Returns PluginMemoryRef

initConstraint

• initConstraint(constraint): void

• Initializes a physics constraint with the given parameters.

  Parameters

  • constraint: PhysicsConstraint

    The physics constraint to be initialized.

  Returns void

releaseShape

• releaseShape(shapeId): void

• Parameters

  • shapeId: HP_ShapeId

  Returns void

removeBodyFromWorld

• removeBodyFromWorld(bodyId): void

• Parameters

  • bodyId: HP_BodyId

  Returns void

removeShapeFromBody

• removeShapeFromBody(containerShapeID, shapeIndex): void

• Parameters

  • containerShapeID: HP_ShapeId
  • shapeIndex: number

  Returns void

setAngularDamping

• setAngularDamping(bodyId, damping): void

• Parameters

  • bodyId: HP_BodyId
  • damping: number

  Returns void

setAngularVelocity

• setAngularVelocity(bodyId, angVel): void

• Parameters

  • bodyId: HP_BodyId
  • angVel: [number, number, number]

  Returns void

setAxisFriction

• setAxisFriction(constraint, axis, friction): void

• Sets the friction of the given axis of the given constraint.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to set the friction of.
  • axis: PhysicsConstraintAxis

    The axis of the constraint to set the friction of.
  • friction: number

    The friction to set.

  Returns void

setAxisMaxLimit

• setAxisMaxLimit(constraint, axis, limit): void

• Sets the maximum limit of the given axis of the given constraint.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to set the maximum limit of the given axis.
  • axis: PhysicsConstraintAxis

    The axis to set the maximum limit of.
  • limit: number

    The maximum limit to set.

  Returns void

setAxisMinLimit

• setAxisMinLimit(constraint, axis, limit): void

• Sets the minimum limit of the given axis of the given constraint.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to set the minimum limit of.
  • axis: PhysicsConstraintAxis

    The axis to set the minimum limit of.
  • limit: number

    The minimum limit to set.

  Returns void

setAxisMode

• setAxisMode(constraint, axis, limitMode): void

• Sets the limit mode of the specified axis of the given constraint.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to set the axis mode of.
  • axis: PhysicsConstraintAxis

    The axis to set the limit mode of.
  • limitMode: PhysicsConstraintAxisLimitMode

    The limit mode to set.

  Returns void

setAxisMotorMaxForce

• setAxisMotorMaxForce(constraint, axis, maxForce): void

• Sets the maximum force that can be applied by the motor of the given constraint axis.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to set the motor max force for.
  • axis: PhysicsConstraintAxis

    The axis of the constraint to set the motor max force for.
  • maxForce: number

    The maximum force that can be applied by the motor.

  Returns void

setAxisMotorTarget

• setAxisMotorTarget(constraint, axis, target): void

• Sets the target of an axis motor of a constraint.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to set the axis motor target of.
  • axis: PhysicsConstraintAxis

    The axis of the constraint to set the motor target of.
  • target: number

    The target of the axis motor.

  Returns void

setAxisMotorType

• setAxisMotorType(constraint, axis, motorType): void

• Sets the motor type of the given axis of the given constraint.

  Parameters

  • constraint: PhysicsConstraint

    The constraint to set the motor type of.
  • axis: PhysicsConstraintAxis

    The axis of the constraint to set the motor type of.
  • motorType: PhysicsConstraintMotorType

    The motor type to set.

  Returns void

  void

setBodyShape

• setBodyShape(bodyId, containerShapeID): void

• Parameters

  • bodyId: HP_BodyId
  • containerShapeID: HP_ShapeId

  Returns void

setBodyTargetQTransform

• setBodyTargetQTransform(bodyId, transform): void

• Parameters

  • bodyId: HP_BodyId
  • transform: [[number, number, number], [number, number, number, number]]

  Returns void

setCollisionCallbackEnabled

• setCollisionCallbackEnabled(bodyId, enabled): void

• Enable collision to be reported for a body when a callback is settup on the world

  Parameters

  • bodyId: HP_BodyId
  • enabled: boolean

  Returns void

setCollisionsEnabled

• setCollisionsEnabled(constraintID, enabled): void

• Parameters

  • constraintID: HP_ConstraintId
  • enabled: boolean

  Returns void

setConstraintEnabled

• setConstraintEnabled(constraintID, enabled): void

• Parameters

  • constraintID: HP_ConstraintId
  • enabled: boolean

  Returns void

setDensity

• setDensity(containerShapeID, density): void

• Parameters

  • containerShapeID: HP_ShapeId
  • density: number

  Returns void

setGravityFactor

• setGravityFactor(bodyId, factor): void

• Parameters

  • bodyId: HP_BodyId
  • factor: number

  Returns void

setLinearDamping

• setLinearDamping(bodyId, damping): void

• Parameters

  • bodyId: HP_BodyId
  • damping: number

  Returns void

setLinearVelocity

• setLinearVelocity(bodyId, linVel): void

• Parameters

  • bodyId: HP_BodyId
  • linVel: [number, number, number]

  Returns void

setMassProperties

• setMassProperties(bodyId, centerOfMass?, mass?, inertia?, inertiaOrientation?): void

• Parameters

  • bodyId: HP_BodyId
  • OptionalcenterOfMass: [number, number, number]
  • Optionalmass: number
  • Optionalinertia: [number, number, number]
  • OptionalinertiaOrientation: [number, number, number, number]

  Returns void

setMaterial

• setMaterial(shapeId, material): void

• Parameters

  • shapeId: HP_ShapeId
  • material: {
        dynamicFriction?: number;
        frictionCombine?: PhysicsMaterialCombineMode;
        restitution?: number;
        restitutionCombine?: PhysicsMaterialCombineMode;
        staticFriction?: number;
    }

    • OptionaldynamicFriction?: number

    • OptionalfrictionCombine?: PhysicsMaterialCombineMode

    • Optionalrestitution?: number

    • OptionalrestitutionCombine?: PhysicsMaterialCombineMode

    • OptionalstaticFriction?: number

  Returns void

setMotionType

• setMotionType(bodyId, motionType): void

• Parameters

  • bodyId: HP_BodyId
  • motionType: MotionType

  Returns void

setQTransform

• setQTransform(bodyId, transform): void

• Parameters

  • bodyId: HP_BodyId
  • transform: [[number, number, number], [number, number, number, number]]

  Returns void

setSpeedLimit

• setSpeedLimit(worldId?, maxLinearVelocity, maxAngularVelocity): void

• Parameters

  • worldId: HP_WorldId = ...
  • maxLinearVelocity: number
  • maxAngularVelocity: number

  Returns void

_tabInFocus

world