Directional light does not disappear after removing the DirectionalLight component
#15560
Comments
tim-blackbird
added
C-Bug
tim-blackbird
changed the title
DirectionalLight componentDirectionalLight component
|
This seems like a general issue we need to solve with the retained render world that the PR/docs doesn't answer, who is responsible for removing components from the render world? Should that be done by the extract step, a separate system/plugin, or is it the users responsibility? A workaround is to remove In any case we really need to fix and/or document it before 0.15. |
|
[4:24 PM]kristoff3r: The OIT example is broken with the retained render world in the same way as #15560. How do we plan to support removing components like this? From Discord. |
# Objective Fixes #15560 Fixes (most of) #15570 Currently a lot of examples (and presumably some user code) depend on toggling certain render features by adding/removing a single component to an entity, e.g. `SpotLight` to toggle a light. Because of the retained render world this no longer works: Extract will add any new components, but when it is removed the entity persists unchanged in the render world. ## Solution Add `SyncComponentPlugin<C: Component>` that registers `SyncToRenderWorld` as a required component for `C`, and adds a component hook that will clear all components from the render world entity when `C` is removed. We add this plugin to `ExtractComponentPlugin` which fixes most instances of the problem. For custom extraction logic we can manually add `SyncComponentPlugin` for that component. We also rename `WorldSyncPlugin` to `SyncWorldPlugin` so we start a naming convention like all the `Extract` plugins. In this PR I also fixed a bunch of breakage related to the retained render world, stemming from old code that assumed that `Entity` would be the same in both worlds. I found that using the `RenderEntity` wrapper instead of `Entity` in data structures when referring to render world entities makes intent much clearer, so I propose we make this an official pattern. ## Testing Run examples like ``` cargo run --features pbr_multi_layer_material_textures --example clearcoat cargo run --example volumetric_fog ``` and see that they work, and that toggles work correctly. But really we should test every single example, as we might not even have caught all the breakage yet. --- ## Migration Guide The retained render world notes should be updated to explain this edge case and `SyncComponentPlugin` --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com> Co-authored-by: Trashtalk217 <trashtalk217@gmail.com>
Removing the
DirectionalLightcomponent does not remove the directional light from the render worldCaused by #15320
Noticed in the
clearcoatexampleThe text was updated successfully, but these errors were encountered: