From 32dbccd7ecb39104c960ffdb161a734c6eea49d2 Mon Sep 17 00:00:00 2001
From: Jaime Torrealba <solucionesinformaticasjtc@gmail.com>
Date: Thu, 26 Sep 2024 10:46:05 +0100
Subject: [PATCH] feat(app): 119 Props for colliders

---
 docs/components/collider.md                   | 27 +++++++++++++++
 docs/components/rigid-body.md                 | 34 +++++++++++--------
 .../src/pages/basics/RigidBodyProps.vue       | 23 ++++++++-----
 src/components/RigidBody.vue                  | 10 ++++++
 src/components/colliders/BaseCollider.vue     |  7 ++++
 src/types/collider.ts                         | 20 +++++++++++
 src/types/rigid-body.ts                       | 23 +++++++++++++
 src/utils/props.ts                            | 28 ++++++++++++++-
 8 files changed, 147 insertions(+), 25 deletions(-)

diff --git a/docs/components/collider.md b/docs/components/collider.md
index 3b3b0b0..280e449 100644
--- a/docs/components/collider.md
+++ b/docs/components/collider.md
@@ -1 +1,28 @@
 # Collider
+
+## Props
+
+| Prop            | Description                                                                                                   | Default   |
+| :-------------- | :------------------------------------------------------------------------------------------------------------ | --------- |
+| **shape**       | shape of the collider                                                                                         | `cuboid`  |
+| **args**        | The half-sizes of the collider shapes                                                                         | `[1,1,1]` |
+| **object**      | Required for certain shapes like `trimesh`, `hull`, `heightfield`.                                            |           |
+| **friction**    | The friction coefficient of this collider. (automatic-collider)                                               | `0.5`     |
+| **mass**        | Mass of the collider. (automatic-collider)                                                                    | `1`       |
+| **density**     | Restitution controls how elastic (aka. bouncy) a contact is. (automatic-collider)                             | `0`       |
+| **restitution** | The collider density. If non-zero the collider's mass and angular inertia will be added. (automatic-collider) | `1`       |
+
+:::info The `colliders` instance has many other methods, please check the
+[official docs](https://rapier.rs/docs/api/javascript/JavaScript3D/) for a
+complete list, if you need them, you can
+use[Template ref](https://vuejs.org/guide/essentials/template-refs.html#template-refs).
+:::
+
+## Expose object
+
+```
+ {
+  instance,
+  colliderDesc,
+}
+```
diff --git a/docs/components/rigid-body.md b/docs/components/rigid-body.md
index 3a2b65c..0a44157 100644
--- a/docs/components/rigid-body.md
+++ b/docs/components/rigid-body.md
@@ -133,21 +133,25 @@ SOON
 
 ## Props
 
-| Prop                    | Description                          | Default                        |
-| :---------------------- | :----------------------------------- | ------------------------------ |
-| **type**                | `rigidBody` type                     | `dynamic`                      |
-| **collider**            | `automatic collider                  | `cuboid`                       |
-| **gravityScale**        | gravity for the `rigidBody`          | `1`                            |
-| **additionalMass**      | add extra mass to the `rigidBody`    | `0`                            |
-| **linearDamping**       | set the linear damping               | `0`                            |
-| **angularDamping**      | set the angular damping              | `0`                            |
-| **dominanceGroup**      | set the dominance group              | `0`                            |
-| **linvel**              | linear velocity                      | `x: 0, y: 0, z: 0`             |
-| **angvel**              | angular velocity                     | `x: 0, y: 0, z: 0`             |
-| **enabledRotations**    | enable rotations in specific axis    | `{x: true, y: true, z: true }` |
-| **enabledTranslations** | enable translations in specific axis | `{x: true, y: true, z: true }` |
-| **lockTranslations**    | Lock all translations                | `false`                        |
-| **lockRotations**       | Lock all rotations                   | `false`                        |
+| Prop                    | Description                                                                                                   | Default                        |
+| :---------------------- | :------------------------------------------------------------------------------------------------------------ | ------------------------------ |
+| **type**                | `rigidBody` type                                                                                              | `dynamic`                      |
+| **collider**            | automatic collider                                                                                            | `cuboid`                       |
+| **gravityScale**        | gravity for the `rigidBody`                                                                                   | `1`                            |
+| **additionalMass**      | add extra mass to the `rigidBody`                                                                             | `0`                            |
+| **linearDamping**       | set the linear damping                                                                                        | `0`                            |
+| **angularDamping**      | set the angular damping                                                                                       | `0`                            |
+| **dominanceGroup**      | set the dominance group                                                                                       | `0`                            |
+| **linvel**              | linear velocity                                                                                               | `x: 0, y: 0, z: 0`             |
+| **angvel**              | angular velocity                                                                                              | `x: 0, y: 0, z: 0`             |
+| **enabledRotations**    | enable rotations in specific axis                                                                             | `{x: true, y: true, z: true }` |
+| **enabledTranslations** | enable translations in specific axis                                                                          | `{x: true, y: true, z: true }` |
+| **lockTranslations**    | Lock all translations                                                                                         | `false`                        |
+| **lockRotations**       | Lock all rotations                                                                                            | `false`                        |
+| **friction**            | The friction coefficient of this collider. (automatic-collider)                                               | `0.5`                          |
+| **mass**                | Mass of the collider. (automatic-collider)                                                                    | `1`                            |
+| **density**             | Restitution controls how elastic (aka. bouncy) a contact is. (automatic-collider)                             | `0`                            |
+| **restitution**         | The collider density. If non-zero the collider's mass and angular inertia will be added. (automatic-collider) | `1`                            |
 
 :::info The `rigidBody` instance has many other functions, please check the
 [official docs](https://rapier.rs/docs/api/javascript/JavaScript3D/) for a
diff --git a/playground/src/pages/basics/RigidBodyProps.vue b/playground/src/pages/basics/RigidBodyProps.vue
index a624f00..916634b 100644
--- a/playground/src/pages/basics/RigidBodyProps.vue
+++ b/playground/src/pages/basics/RigidBodyProps.vue
@@ -2,7 +2,7 @@
 import { OrbitControls } from '@tresjs/cientos'
 import { TresCanvas } from '@tresjs/core'
 import { TresLeches, useControls } from '@tresjs/leches'
-import { type ExposedRigidBody, Physics, RigidBody } from '@tresjs/rapier'
+import { BallCollider, type ExposedRigidBody, Physics, RigidBody } from '@tresjs/rapier'
 import { ACESFilmicToneMapping, SRGBColorSpace } from 'three'
 import { shallowRef } from 'vue'
 import '@tresjs/leches/styles'
@@ -28,15 +28,18 @@ const rotate = () => {
   rigidBoxRef.value.instance.applyTorqueImpulse({ x: 3, y: 5, z: 0 }, true)
 }
 
-const { gravityScale, linearDamping, angularDamping, lockT, linvelX } = useControls({
+const { gravityScale, linearDamping, angularDamping, lockT, linvelX, friction, mass, density, restitution } = useControls({
   gravityScale: { value: 2.5, min: -10, max: 10, step: 1 },
   linearDamping: { value: 0, min: -10, max: 10, step: 1 },
   angularDamping: { value: 0, min: -10, max: 10, step: 1 },
   linvelX: { value: 0, min: -10, max: 10, step: 1 },
-  lockT: true,
+  lockT: false,
+  // colliders
+  friction: { value: 0, min: 0, max: 10, step: 1 },
+  mass: { value: 1, min: 0, max: 10, step: 1 },
+  density: { value: 1, min: 0, max: 10, step: 1 },
+  restitution: { value: 1, min: 0, max: 10, step: 1 },
 })
-
-// TODO test locks and enabledTranslations, check docs
 </script>
 
 <template>
@@ -55,6 +58,11 @@ const { gravityScale, linearDamping, angularDamping, lockT, linvelX } = useContr
           :angularDamping="angularDamping.value"
           :enabledTranslations="{ x: true, y: true, z: true }"
           :lockTranslations="lockT.value"
+          :linvelX="linvelX.value"
+          :friction="friction.value"
+          :mass="mass.value"
+          :density="density.value"
+          :restitution="restitution.value"
         >
           <TresMesh :position="[4, 8, 0]" @click="jump">
             <TresTorusGeometry />
@@ -63,10 +71,7 @@ const { gravityScale, linearDamping, angularDamping, lockT, linvelX } = useContr
         </RigidBody>
 
         <RigidBody>
-          <TresMesh :position="[0, 8, 0]">
-            <TresTorusGeometry />
-            <TresMeshNormalMaterial />
-          </TresMesh>
+          <BallCollider :restitution="2" :args="[1, 1, 1]" :position="[2, 10, 2]" />
         </RigidBody>
 
         <!-- BOX -->
diff --git a/src/components/RigidBody.vue b/src/components/RigidBody.vue
index 4ec6ff7..3f70d0a 100644
--- a/src/components/RigidBody.vue
+++ b/src/components/RigidBody.vue
@@ -24,6 +24,12 @@ const props = withDefaults(defineProps<Partial<RigidBodyProps>>(), {
   enabledTranslations: () => ({ x: true, y: true, z: true }),
   lockTranslations: false,
   lockRotations: false,
+  // Automatic collider props
+  friction: 0.5,
+  mass: 1,
+  restitution: 0,
+  density: 1,
+
 })
 const { onBeforeRender } = useLoop()
 const { world } = useRapierContext()
@@ -132,6 +138,10 @@ onUnmounted(() => {
       :shape="_props.shape"
       :args="_props.args"
       :object="_props.object"
+      :friction="props.friction"
+      :mass="props.mass"
+      :restitution="props.restitution"
+      :density="props.density"
     />
     <slot v-once></slot>
   </TresGroup>
diff --git a/src/components/colliders/BaseCollider.vue b/src/components/colliders/BaseCollider.vue
index 12d2404..9b135c1 100644
--- a/src/components/colliders/BaseCollider.vue
+++ b/src/components/colliders/BaseCollider.vue
@@ -3,11 +3,16 @@ import { inject, nextTick, onUnmounted, type ShallowRef, shallowRef, watch } fro
 
 import { useRapierContext } from '../../composables'
 import { createCollider } from '../../core/collider'
+import { makePropsWatcherCL } from '../../utils/props'
 import type { ColliderProps, CreateColliderReturnType, ExposedCollider, RigidBodyContext } from '../../types'
 
 const props = withDefaults(defineProps<Partial<ColliderProps>>(), {
   shape: 'cuboid',
   args: () => [1, 1, 1],
+  friction: 0.5,
+  mass: 1,
+  restitution: 0,
+  density: 1,
 })
 
 const { world } = useRapierContext()
@@ -49,6 +54,8 @@ watch(bodyContext, async (state) => {
   state.colliders.push(infos)
 }, { immediate: true })
 
+makePropsWatcherCL(props, ['friction', 'restitution', 'density', 'mass'], colliderInfos)
+
 onUnmounted(() => {
   if (!bodyContext.value || !colliderInfos.value?.collider) { return }
 
diff --git a/src/types/collider.ts b/src/types/collider.ts
index b66627b..ddd3abe 100644
--- a/src/types/collider.ts
+++ b/src/types/collider.ts
@@ -47,6 +47,26 @@ export interface ColliderProps {
 
   /** @description {@link Collider} scale */
   scale?: [x: number, y: number, z: number] | [radiusScale: number]
+  /**
+   * @description The friction coefficient of this collider.
+   * @default 0.5
+   */
+  friction?: number
+  /**
+   * @description Mass of the collider.
+   * @default 1
+   */
+  mass?: number
+  /**
+   * @description Restitution controls how elastic (aka. bouncy) a contact is.
+   * @default 0
+   */
+  restitution?: number
+  /**
+   * @description The collider density. If non-zero the collider's mass and angular inertia will be added.
+   * @default 1.0
+   */
+  density?: number
 }
 
 export interface ExposedCollider {
diff --git a/src/types/rigid-body.ts b/src/types/rigid-body.ts
index 69087f3..f15bfcc 100644
--- a/src/types/rigid-body.ts
+++ b/src/types/rigid-body.ts
@@ -76,6 +76,29 @@ export interface RigidBodyProps {
    * @default false
    */
   lockRotations?: boolean
+
+  // AUTOMATIC COLLIDERS
+
+  /**
+   * @description The friction coefficient of this collider.
+   * @default 0.5
+   */
+  friction?: number
+  /**
+   * @description mass.
+   * @default 1
+   */
+  mass?: number
+  /**
+   * @description Restitution controls how elastic (aka. bouncy) a contact is.
+   * @default 0
+   */
+  restitution?: number
+  /**
+   * @description The collider density. If non-zero the collider's mass and angular inertia will be added.
+   * @default 1.0
+   */
+  density?: number
 }
 
 export interface ExposedRigidBody {
diff --git a/src/utils/props.ts b/src/utils/props.ts
index 5907be5..b9d2696 100644
--- a/src/utils/props.ts
+++ b/src/utils/props.ts
@@ -1,7 +1,7 @@
 import { watch } from 'vue'
 import type { RigidBody } from '@dimforge/rapier3d-compat'
 import type { ShallowRef } from 'vue'
-import type { CallableProps, Methods, RigidBodyContext, RigidBodyProps } from '../types'
+import type { CallableProps, ColliderProps, CreateColliderReturnType, Methods, RigidBodyContext, RigidBodyProps } from '../types'
 
 export const makePropWatcherRB = <
   K extends keyof RigidBodyProps,
@@ -28,3 +28,29 @@ export const makePropsWatcherRB = <
     + watcher.slice(1) as Capitalize<keyof RigidBodyProps>
   makePropWatcherRB(props, watcher as keyof RigidBodyProps, instance, `set${watcherName}`)
 })
+
+export const makePropWatcherCL = <
+  K extends keyof ColliderProps,
+>(
+  props: ColliderProps,
+  toWatch: K,
+  instance: ShallowRef<CreateColliderReturnType | undefined>,
+  onSet: `set${Capitalize<keyof ColliderProps>}`,
+) => watch([() => props[toWatch], instance], ([newValue, _]) => {
+  if (!instance.value) { return }
+  (instance.value.collider[onSet as keyof typeof instance.value.collider] as CallableProps<ColliderProps>[keyof CallableProps<ColliderProps>])?.(newValue, true)
+})
+
+export const makePropsWatcherCL = <
+  K extends keyof ColliderProps,
+>(
+  props: ColliderProps,
+  watchers: K[],
+  instance: ShallowRef<CreateColliderReturnType | undefined>,
+) => watchers.forEach((_) => {
+  const watcher = _ as string
+  // Uppercase only for the first letter in the watcher
+  const watcherName = watcher.charAt(0).toUpperCase()
+    + watcher.slice(1) as Capitalize<keyof ColliderProps>
+  makePropWatcherCL(props, watcher as keyof ColliderProps, instance, `set${watcherName}`)
+})