Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 503 conditional rendering of primitives #514

Merged
merged 10 commits into from
Feb 21, 2024
Merged

feat: 503 conditional rendering of primitives #514

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
cf979fa
feat(nodeOps): switch instance logic for reactive `object` prop
alvarosabu Jan 18, 2024
5a24eea
chore: playground primitives with models
alvarosabu Jan 18, 2024
5ed02b6
chore: fix linter
alvarosabu Jan 18, 2024
8d52f32
chore: fix tests and linters, primitive object is now reactive
alvarosabu Jan 19, 2024
2df1e65
chore: refactor instance swaping logic to overwrite set and copy prop…
alvarosabu Jan 19, 2024
3490c4a
Merge branch 'v4' into feature/503-conditional-rendering-of-primitives
alvarosabu Feb 2, 2024
37ab904
chore: tests
alvarosabu Feb 2, 2024
b0ba190
chore: remove console.log
alvarosabu Feb 5, 2024
de730ef
chore: remove unused import watch
alvarosabu Feb 5, 2024
8408351
feat: add primitive conditional to patch object prop
alvarosabu Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions playground/components.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ declare module 'vue' {
DanielTest: typeof import('./src/components/DanielTest.vue')['default']
DebugUI: typeof import('./src/components/DebugUI.vue')['default']
DeleteMe: typeof import('./src/components/DeleteMe.vue')['default']
DynamicModel: typeof import('./src/components/DynamicModel.vue')['default']
FBXModels: typeof import('./src/components/FBXModels.vue')['default']
Gltf: typeof import('./src/components/gltf/index.vue')['default']
LocalOrbitControls: typeof import('./src/components/LocalOrbitControls.vue')['default']
Expand Down
20 changes: 20 additions & 0 deletions playground/src/components/DynamicModel.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<script setup lang="ts">
import { useControls } from '@tresjs/leches'
import { useGLTF } from '@tresjs/cientos'

const { scene } = await useGLTF('https://raw.githubusercontent.com/Tresjs/assets/main/models/gltf/blender-cube.glb',
{ draco: true })

const { nodes } = await useGLTF(
'https://raw.githubusercontent.com/Tresjs/assets/main/models/gltf/aku-aku/AkuAku.gltf',
{ draco: true },
)
const model = nodes.AkuAku
const { isCube } = useControls({
isCube: true,
})
</script>

<template>
<primitive :object="isCube ? scene : model" />
</template>
32 changes: 12 additions & 20 deletions playground/src/components/TheExperience.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ import { ref, watchEffect } from 'vue'
import { BasicShadowMap, SRGBColorSpace, NoToneMapping } from 'three'
import { TresCanvas } from '@tresjs/core'
import { OrbitControls } from '@tresjs/cientos'
import { TresLeches, useControls } from '@tresjs/leches'
import '@tresjs/leches/styles'
import TheSphere from './TheSphere.vue'

const gl = {
Expand All @@ -19,25 +17,18 @@ const gl = {
const wireframe = ref(true)

const canvas = ref()
const meshRef = ref()

const { isVisible } = useControls({
isVisible: true,
})

watchEffect(() => {
if (meshRef.value) {
console.log(meshRef.value)
if (canvas.value) {
console.log(canvas.value.context)
}
})
</script>

<template>
<TresLeches />
<TresCanvas
v-bind="gl"
ref="canvas"
window-size
class="awiwi"
:style="{ background: '#008080' }"
>
Expand All @@ -46,10 +37,14 @@ watchEffect(() => {
:look-at="[0, 4, 0]"
/>
<OrbitControls />
<TresFog
:color="gl.clearColor"
:near="5"
:far="15"
/>
<TresMesh
:position="[-2, 6, 0]"
:rotation="[0, Math.PI, 0]"
name="cone"
cast-shadow
>
<TresConeGeometry :args="[1, 1.5, 3]" />
Expand All @@ -66,22 +61,19 @@ watchEffect(() => {
/>
</TresMesh>
<TresMesh
ref="meshRef"
:rotation="[-Math.PI / 2, 0, Math.PI / 2]"
name="floor"
:rotation="[-Math.PI / 2, 0, 0]"
receive-shadow
>
<TresPlaneGeometry :args="[20, 20, 20]" />
<TresMeshToonMaterial
color="#D3FC8A"
/>
<TresPlaneGeometry :args="[10, 10, 10, 10]" />
<TresMeshToonMaterial color="#D3FC8A" />
</TresMesh>
<TheSphere v-if="isVisible" />
<TheSphere />
<TresAxesHelper :args="[1]" />
<TresDirectionalLight
:position="[0, 2, 4]"
:intensity="2"
cast-shadow
/>
<TresOrthographicCamera />
</TresCanvas>
</template>
90 changes: 90 additions & 0 deletions playground/src/pages/primitives.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
<script setup lang="ts">
import { ref, watchEffect } from 'vue'
import { BasicShadowMap, SRGBColorSpace, NoToneMapping, Mesh, TorusGeometry, MeshToonMaterial, TorusKnotGeometry, PlaneGeometry, Group, SphereGeometry } from 'three'

Check failure on line 3 in playground/src/pages/primitives.vue

View workflow job for this annotation

GitHub Actions / Lint (16) 

This line has a length of 165. Maximum allowed is 120
import { TresCanvas } from '@tresjs/core'
import { OrbitControls } from '@tresjs/cientos'
import { TresLeches, useControls } from '@tresjs/leches'
import '@tresjs/leches/styles'

const gl = {
clearColor: '#82DBC5',
shadows: true,
alpha: false,
shadowMapType: BasicShadowMap,
outputColorSpace: SRGBColorSpace,
toneMapping: NoToneMapping,
}

const wireframe = ref(true)

const canvas = ref()
const meshRef = ref()

const { knot } = useControls({
knot: true,
})

watchEffect(() => {
if (meshRef.value) {
console.log(meshRef.value)
}
})

const torusMesh = new Mesh(
new TorusGeometry(1, 0.5, 16, 100),
new MeshToonMaterial({
color: '#82DBC5',
}),
)

const torusKnot = new Mesh(
new TorusKnotGeometry(1, 0.5, 100, 16),
new MeshToonMaterial({
color: '#ff00ff',
}),
)

const sphere = new Mesh(
new SphereGeometry(1, 32, 32),
new MeshToonMaterial({
color: '#82DBC5',
}),
)

Copy link
Contributor

@andretchen0 andretchen0 Jan 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In nodeOps.ts, I mentioned that cloning means that setup references are lost. Below is some demonstration code that can be pasted here.

useRenderLoop().onLoop(() => {
  torus.rotateX(0.01)
  torusKnot.rotateY(0.01)
})

Both torus and torusKnot continue to exist after the clone, but they no longer point to the on-screen objects, so the on-screen objects don't update.

If the objects aren't clone()d in nodeOps, the on-screen shapes will rotate – but other errors pop up.

I don't know if there's a workaround here. Just pointing it out.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andretchen0 This argument makes me think we should abandon the idea of trying to make :object prop reactive, swiping instances without losing the ref is getting too complicated.

Users could still use primitives with conditional rendering, I wanted primitive to work similar to component but honestly at this point I don't know how to achieve it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alvarosabu

I don't understand the internals of Tres well enough to have an opinion on the feasibility here.

I'll start reading the source after I finish <AnimatedSprite /> for Cientos.

I wanted primitive to work similar to component but honestly at this point I don't know how to achieve it.

I agree that this is a worthwhile goal. It'd be great if it "just works".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andretchen0 let me know if you are up to a pair-programming call to discuss the internals when you get free let me know, we definitely can use your knowledge and your quality feedback inside of the custom renderer code. 💚

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alvarosabu

Sure thing. That could be fun!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @andretchen0 I created a thread on the core team discord channel discussing this but to give a summary:

I found a way of making it work (animations), the only constraint is that the object passed through :object needs to be of the same type (mesh -> mesh) (group -> group). If we do (mesh -> group), it doesn't work anymore.

Screen_Recording_2024-02-02_at_12.43.44.mov

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I'll go read the Discord.

const firstGroup = new Group()
firstGroup.add(torusMesh)
firstGroup.add(torusKnot)

const secondGroup = new Group()
secondGroup.add(sphere)
</script>

<template>
<TresLeches />
<TresCanvas
v-bind="gl"
ref="canvas"
window-size
class="awiwi"
:style="{ background: '#008080' }"
>
<TresPerspectiveCamera
:position="[7, 7, 7]"
:look-at="[0, 4, 0]"
/>
<OrbitControls />
<primitive
:position="[4, 2, 0]"
:object="knot ? firstGroup : secondGroup"
/>
<Suspense>
<DynamicModel />
</Suspense>
<TresAxesHelper :args="[1]" />
<TresDirectionalLight
:position="[0, 2, 4]"
:intensity="2"
cast-shadow
/>
</TresCanvas>
</template>
5 changes: 5 additions & 0 deletions playground/src/router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,11 @@ const routes = [
name: 'Perf',
component: () => import('./pages/perf/index.vue'),
},
{
path: '/primitives',
name: 'Primitives',
component: () => import('./pages/primitives.vue'),
},
{
path: '/empty',
name: 'empty',
Expand Down
Loading
Loading