react-native-filament/src/hooks/useEntityInScene.ts

A real-time physically based 3D rendering engine for React Native

import { useEffect } from 'react'
import { Entity, Scene } from '../types'

/**
 * A hook that "on mount" adds the entity to the scene, and "on unmount" removes it.
 */
export function useEntityInScene(scene: Scene, entity?: Entity) {
  useEffect(() => {
    if (entity == null) return
    scene.addEntity(entity)

    return () => {
      scene.removeEntity(entity)
    }
  }, [entity, scene])
}