feat: `Joints` implementation #150

Neosoulink · 2024-11-20T00:16:21Z

Summary

This PR introduces the Joints feature.

Joints are one of the advanced features natively available in Rapier.
This PR provides an easy, basic but robust way to deal with it.

Logs

Support for Joint types:
- "fixed" | "spring" | "rope" | "generic" | "spherical" | "prismatic" | "revolute"
New components based on the supported joint types (FixedJoint, SphericalJoint, ...)

How to use

Here's a basic implementation example:

<RigidBody
  v-for="(ref, i) in bodyRefs"
  :key="i"
  :ref="ref"
  :type="i === 0 ? 'kinematic' : 'dynamic'"
  :position="[i * 1.5, 0, 0]"
   collider="ball"
 >
  <TresMesh>
    <TresSphereGeometry />
    <TresMeshNormalMaterial />
  </TresMesh>
</RigidBody>

<SphericalJoint
  v-for="(ref, i) in bodyRefs"
  :key="i"
  :bodies="[ref.value?.[0]?.instance, bodyRefs[i - 1]?.value?.[0]?.instance]"
  :params="[
    [-1.1, 0, 0],
    [1.1, 0, 0],
  ]"
/>

Preview

Screen.Recording.2024-11-20.at.2.10.27.AM.mov

Will close #108

Neosoulink · 2024-12-09T14:08:53Z

Hi @alvarosabu, I just added a base documentation for Joint.
I'd appreciate having your review of it (the Joint implementation in general).

cc: @JaimeTorrealba

- Init joint component - Add `JointProps` interface - Add Joint Demo

Neosoulink · 2025-01-07T17:56:03Z

Any update on this one?

This PR is waiting for review

JaimeTorrealba

I like the implementation, But also I would add a composable WDYT? With the same logic

an useJoint() or similar so the people is not force to use it with Tres.js components only

JaimeTorrealba · 2025-01-11T19:06:13Z

.vscode/settings.json

-  }
+  },
+
+  "cSpell.words": [


I think the settings should be removed here, this is personal to our environments.

JaimeTorrealba · 2025-01-11T19:06:48Z

docs/components/joint.md

+
+Joints is an extension feature provided in [Rapier#Joint](https://rapier.rs/docs/user_guides/javascript/joints/). It lets us connect two or more bodies, restricting their movements according to each other.
+
+In **Tres** we can achieve such motion restriction by using one of the available components designed to handle joints:


Small one but maybe we need consistency here it all pages should be "Tres.js"

JaimeTorrealba · 2025-01-11T19:08:42Z

docs/components/joint.md

+
+<template>
+  <RigidBody
+    v-for="(ref, i) in bodyRefs"


I got a problem, the mental load of this example is high. I would instead, in this page, come with a very basic example, just two rigid Bodies joined (just that). The idea here is that they learn how to use it.

JaimeTorrealba · 2025-01-11T19:09:38Z

playground/src/pages/basics/JointsDemo.vue

+  Array.from({ length: 10 }).map(() => shallowRef<ExposedRigidBody>(null)),
+)
+
+setInterval(() => {


Why setInterval?

And if you decided to use setInterval, please remember to clear the interval in the onUnmouted

Oh yeah, you're right,

setInterval was used to update the rotation of the first and have that whip effect

JaimeTorrealba · 2025-01-11T19:13:00Z

src/components/joints/BaseJoint.vue

+  }
+
+  if (hasParamsError) {
+    throw new Error(`Invalid "${type}" joint parameters`)


Maybe too difficult, but could be said what parameters have problems?

Neosoulink · 2025-01-11T21:17:12Z

I like the implementation, But also I would add a composable WDYT? With the same logic

an useJoint() or similar so the people is not force to use it with Tres.js components only

I think it possible even to have both features

JaimeTorrealba · 2025-01-11T21:32:07Z

I like the implementation, But also I would add a composable WDYT? With the same logic
an useJoint() or similar so the people is not force to use it with Tres.js components only

I think it possible even to have both features

Completely, maybe another PR to be more organized.

Neosoulink requested a review from JaimeTorrealba November 20, 2024 00:16

Neosoulink self-assigned this Nov 20, 2024

Neosoulink requested a review from alvarosabu as a code owner November 20, 2024 00:16

Neosoulink marked this pull request as draft November 20, 2024 00:19

Neosoulink marked this pull request as ready for review December 9, 2024 14:05

Neosoulink added enhancement New feature or request feature p3-significant High-priority enhancement (priority) labels Dec 10, 2024

Neosoulink added 7 commits December 12, 2024 19:11

feat(core): base joint integration

2137ae8

- Init joint component - Add `JointProps` interface - Add Joint Demo

feat(core): add rope & spherical joint types

37096db

feat(core): add common object types

cebe338

feat(playground): implement spherical joint demo

d5e58d6

feat(core): implement all the supported Joints

93965e1

style(core): use spaces

c531dfa

docs: add Joint base documentation

8c4afea

Neosoulink force-pushed the feat/joints branch from 683f466 to 8c4afea Compare December 12, 2024 17:11

chore(setting): minor correct

5b89fee

JaimeTorrealba requested changes Jan 11, 2025

View reviewed changes

JaimeTorrealba reviewed Jan 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: `Joints` implementation #150

feat: `Joints` implementation #150

Neosoulink commented Nov 20, 2024 •

edited

Loading

Neosoulink commented Dec 9, 2024

Neosoulink commented Jan 7, 2025

JaimeTorrealba left a comment

JaimeTorrealba Jan 11, 2025

Neosoulink Jan 11, 2025

JaimeTorrealba Jan 11, 2025

Neosoulink Jan 11, 2025

JaimeTorrealba Jan 11, 2025

JaimeTorrealba Jan 11, 2025

Neosoulink Jan 11, 2025

JaimeTorrealba Jan 11, 2025

Neosoulink commented Jan 11, 2025

JaimeTorrealba commented Jan 11, 2025


		Joints is an extension feature provided in [Rapier#Joint](https://rapier.rs/docs/user_guides/javascript/joints/). It lets us connect two or more bodies, restricting their movements according to each other.

		In Tres we can achieve such motion restriction by using one of the available components designed to handle joints:

feat: Joints implementation #150

Are you sure you want to change the base?

feat: Joints implementation #150

Conversation

Neosoulink commented Nov 20, 2024 • edited Loading

Summary

Logs

How to use

Neosoulink commented Dec 9, 2024

Neosoulink commented Jan 7, 2025

JaimeTorrealba left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Neosoulink commented Jan 11, 2025

JaimeTorrealba commented Jan 11, 2025

feat: `Joints` implementation #150

feat: `Joints` implementation #150

Neosoulink commented Nov 20, 2024 •

edited

Loading