Start migrating playground controls to @tresjs/leches

[alvarosabu]

Description

Since we are going to deprecate useTweakpane soon, let's start migrating all the playground examples that use tweakpane with @tresjs/leches instead

Suggested solution

Migrate:

• ./playground/src/pages/staging/EnvironmentDemo.vue
• ./playground/src/pages/materials/CustomShaderMaterialDemo.vue
• ./playground/src/pages/staging/ContactShadowsDemo.vue
• ./playground/src/pages/staging/StarsDemo.vue
• ./playground/src/pages/staging/PrecipitationDemo.vue
• ./playground/src/pages/controls/OrbitControlsDemo.vue
• ./playground/src/pages/controls/TransformControlsDemo.vue
• ./playground/src/pages/controls/CameraControlsDemo.vue
• ./playground/src/pages/abstractions/LeviosoDemo.vue
• ./playground/src/pages/abstractions/FBODemo.vue

Alternative

No response

Additional context

No response

Validations

• I agree to follow this project's Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.

[andretchen0]

Are there docs for leches? Or a repo?

All I've managed to find so far is the source on npm.

[alvarosabu]

Hi @andretchen0 I just made it public https://github.com/Tresjs/leches

The documentation can be found here https://tresleches.netlify.app/

[alvarosabu]

Hey @JaimeTorrealba @andretchen0 I just created a branch for this, I'm planning to migrate some of them to TresLeches but I really need your support here.

We need to deprecate tweakpane for v4. #296

[andretchen0]

Hey @JaimeTorrealba @andretchen0 I just created a branch for this, I'm planning to migrate some of them to TresLeches but I really need your support here.

@alvarosabu

Happy to help out!

The branch isn't linked in the sidebar here or on #296.

Can you add the link to the branch here and then @ me?

I'm guessing the preference is to use Leches where possible and not v-tweakpane, which was linked on #296. Is that right?

[alvarosabu]

I'm guessing the preference is to use Leches where possible and not v-tweakpane, which was linked on #296. Is that right?

Correct

I just pushed the branch bugfix/183-start-migrating-playground-controls-to-tresjsleches

@andretchen0 @JaimeTorrealba let me know which ones would you take so we don't repeat ourselves

[andretchen0]

branch

Got it. Thanks!

let me know which ones would you take

I'll start at the bottom of the "Migrate" list in the top-line issue and work up.

So we don't duplicate our efforts, I'll do my best to remember to push as the files are completed and tick the proper box in the "Migrate" list.

Housekeeping:

• I added the paths to the "Migrate" list on the top-line issue to (hopefully) reduce ambiguity.
• I ticked ./playground/src/pages/staging/EnvironmentDemo.vue in the "Migrate" list. It uses Leches.
• I'm not sure which file(s) TheGizmos refers to and I can't find any other occurences of useTweakPane except for the paths in the "Migrate" list. @alvarosabu , Could you add the path(s) to TheGizmos to the list or remove TheGizmos if the entry is no longer needed?

[andretchen0]

@alvarosabu

I've just pushed the last of the playground demos to #308 .

Questions

• What should we do about "TheGizmos" in the top-level issue description? I'm not sure what that refers to. Could you let me know which files need to be changed or whether to ignore "TheGizmos"?
• There are still some non-playground occurences of tweakpane in Cientos. See list below. I've left them in place for now because this issue is "Start migrating playground controls". Do you want those to be addressed under this issue?
• Are we ready to review refactor: remove TweakPane, use Leches #308 ?

Remaining occurences of tweakpane

package.json
pnpm-lock.yaml
vite.config.ts
docs/package.json
docs/.vitepress/config.ts
docs/.vitepress/theme/components/CustomShaderMaterialDemo.vue
docs/guide/misc/use-tweakpane.md
src/core/misc/index.ts
src/core/misc/useTweakPane/index.ts

[alvarosabu]

Hi buddy @andretchen0 , sorry that it took me so long to get back to you.

Amazing job migrating all the demos to tresleches and for providing insightful feedback about the GUI controls.

What should we do about "TheGizmos" in the top-level issue description? I'm not sure what that refers to. Could you let me know which files need to be changed or whether to ignore "TheGizmos"?

Ignore it, it was the old name of the TransformControlsDemo

There are still some non-playground occurences of tweakpane in Cientos. See list below. I've left them in place for now because this issue is "Start migrating playground controls". Do you want those to be addressed under this issue?

Lets include in this PR the ones in the docs, then we merge this because the complete removal of tweakpane is gonna be done in #296

Are we ready to review #308 ?

Lets include the changes in the docs and we are ready

Thanks a lot 🙏🏻