Rename WorldQueryData & WorldQueryFilter to QueryData & QueryFilter

[taizu-jin]

Rename WorldQueryData & WorldQueryFilter to QueryData & QueryFilter

Fixes #10776

Solution

Traits WorldQueryData & WorldQueryFilter were renamed to QueryData and QueryFilter, respectively. Related Trait types were also renamed.

---

Changelog

• Trait WorldQueryData has been renamed to QueryData. Derive macro's QueryData attribute world_query_data has been renamed to query_data.
• Trait WorldQueryFilter has been renamed to QueryFilter. Derive macro's QueryFilter attribute world_query_filter has been renamed to query_filter.
• Trait's ExtractComponent type Query has been renamed to Data.
• Trait's GetBatchData types Query & QueryFilter has been renamed to Data & Filter, respectively.
• Trait's ExtractInstance type Query has been renamed to Data.
• Trait's ViewNode type ViewQuery has been renamed to ViewData.
• Trait's RenderCommand types ViewWorldQuery & ItemWorldQuery has been renamed to ViewData & ItemData, respectively.

Migration Guide

Note: if merged before 0.13 is released, this should instead modify the migration guide of #10776 with the updated names.

• Rename WorldQueryData & WorldQueryFilter trait usages to QueryData & QueryFilter and their respective derive macro attributes world_query_data & world_query_filter to query_data & query_filter.
• Rename the following trait type usages:
  • Trait's ExtractComponent type Query to Data.
  • Trait's GetBatchData type Query to Data.
  • Trait's ExtractInstance type Query to Data.
  • Trait's ViewNode type ViewQuery to ViewData'
  • Trait's RenderCommand types ViewWorldQuery & ItemWorldQuery to ViewData & ItemData, respectively.

// Before
#[derive(WorldQueryData)]
#[world_query_data(derive(Debug))]
struct EmptyQuery {
    empty: (),
}

// After
#[derive(QueryData)]
#[query_data(derive(Debug))]
struct EmptyQuery {
    empty: (),
}

// Before
#[derive(WorldQueryFilter)]
struct CustomQueryFilter<T: Component, P: Component> {
    _c: With<ComponentC>,
    _d: With<ComponentD>,
    _or: Or<(Added<ComponentC>, Changed<ComponentD>, Without<ComponentZ>)>,
    _generic_tuple: (With<T>, With<P>),
}

// After
#[derive(QueryFilter)]
struct CustomQueryFilter<T: Component, P: Component> {
    _c: With<ComponentC>,
    _d: With<ComponentD>,
    _or: Or<(Added<ComponentC>, Changed<ComponentD>, Without<ComponentZ>)>,
    _generic_tuple: (With<T>, With<P>),
}

// Before
impl ExtractComponent for ContrastAdaptiveSharpeningSettings {
    type Query = &'static Self;
    type Filter = With<Camera>;
    type Out = (DenoiseCAS, CASUniform);

    fn extract_component(item: QueryItem<Self::Query>) -> Option<Self::Out> {
        //...
    }
}

// After
impl ExtractComponent for ContrastAdaptiveSharpeningSettings {
    type Data = &'static Self;
    type Filter = With<Camera>;
    type Out = (DenoiseCAS, CASUniform);

    fn extract_component(item: QueryItem<Self::Data>) -> Option<Self::Out> {
        //...
    }
}

// Before
impl GetBatchData for MeshPipeline {
    type Param = SRes<RenderMeshInstances>;
    type Query = Entity;
    type QueryFilter = With<Mesh3d>;
    type CompareData = (MaterialBindGroupId, AssetId<Mesh>);
    type BufferData = MeshUniform;

    fn get_batch_data(
        mesh_instances: &SystemParamItem<Self::Param>,
        entity: &QueryItem<Self::Query>,
    ) -> (Self::BufferData, Option<Self::CompareData>) {
        // ....
    }
}

// After
impl GetBatchData for MeshPipeline {
    type Param = SRes<RenderMeshInstances>;
    type Data = Entity;
    type Filter = With<Mesh3d>;
    type CompareData = (MaterialBindGroupId, AssetId<Mesh>);
    type BufferData = MeshUniform;

    fn get_batch_data(
        mesh_instances: &SystemParamItem<Self::Param>,
        entity: &QueryItem<Self::Data>,
    ) -> (Self::BufferData, Option<Self::CompareData>) {
        // ....
    }
}

// Before
impl<A> ExtractInstance for AssetId<A>
where
    A: Asset,
{
    type Query = Read<Handle<A>>;
    type Filter = ();

    fn extract(item: QueryItem<'_, Self::Query>) -> Option<Self> {
        Some(item.id())
    }
}

// After
impl<A> ExtractInstance for AssetId<A>
where
    A: Asset,
{
    type Data = Read<Handle<A>>;
    type Filter = ();

    fn extract(item: QueryItem<'_, Self::Data>) -> Option<Self> {
        Some(item.id())
    }
}

// Before
impl ViewNode for PostProcessNode {
    type ViewQuery = (
        &'static ViewTarget,
        &'static PostProcessSettings,
    );

    fn run(
        &self,
        _graph: &mut RenderGraphContext,
        render_context: &mut RenderContext,
        (view_target, _post_process_settings): QueryItem<Self::ViewQuery>,
        world: &World,
    ) -> Result<(), NodeRunError> {
        // ...
    }
}

// After
impl ViewNode for PostProcessNode {
    type ViewData = (
        &'static ViewTarget,
        &'static PostProcessSettings,
    );

    fn run(
        &self,
        _graph: &mut RenderGraphContext,
        render_context: &mut RenderContext,
        (view_target, _post_process_settings): QueryItem<Self::ViewData>,
        world: &World,
    ) -> Result<(), NodeRunError> {
        // ...
    }
}

// Before
impl<P: CachedRenderPipelinePhaseItem> RenderCommand<P> for SetItemPipeline {
    type Param = SRes<PipelineCache>;
    type ViewWorldQuery = ();
    type ItemWorldQuery = ();
    #[inline]
    fn render<'w>(
        item: &P,
        _view: (),
        _entity: (),
        pipeline_cache: SystemParamItem<'w, '_, Self::Param>,
        pass: &mut TrackedRenderPass<'w>,
    ) -> RenderCommandResult {
        // ...
    }
}

// After
impl<P: CachedRenderPipelinePhaseItem> RenderCommand<P> for SetItemPipeline {
    type Param = SRes<PipelineCache>;
    type ViewData = ();
    type ItemData = ();
    #[inline]
    fn render<'w>(
        item: &P,
        _view: (),
        _entity: (),
        pipeline_cache: SystemParamItem<'w, '_, Self::Param>,
        pass: &mut TrackedRenderPass<'w>,
    ) -> RenderCommandResult {
        // ...
    }
}

[github-actions]

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

[alice-i-cecile]

@ItsDoot @james-j-obrien review please :D

[alice-i-cecile]

@taizu-jin great PR description <3 Thanks for tackling this.

[taizu-jin]

So the "fix" 25b9d7d for missing_deref test was actually an opposite. Is there a reason why my test run had a different output there and I could fix that instead or I should've just ignored it because I didn't touch that part of the code?

[james-j-obrien]

I'm a fan. The World prefix always looked odd to me (it's not used anywhere else) and seemed like a way to avoid conflicting with the Query type. Now that it's not a problem I see no reason not to do this.

[james-j-obrien]

Perhaps remove WORLD here as well?

[taizu-jin]

I was contemplating this as well. How about derive_world_query_filter, derive_world_query_filter_impl fns and their helper structs? Does it make sense to also rename the source file as well?

[james-j-obrien]

Imo it doesn't make sense to leave traces of the old naming that might mislead future contributors, but in the end these internal names/filenames aren't going to affect users so it's not a huge deal.

[taizu-jin]

Gotcha, I'm leaning on cleaning it up completely. Do you mind if I re-request for a review after the changes?

[ItsDoot]

Looks good as-is, as long as James' concerns are satisfied. All the suggestions I list here are just suggestions and not required for my approval.

[Nilirad]

I think WorldQueryDataFilter and WorldQueryDataAttributes should be changed. They are private, but still worth changing for consistency.

Also, module names and their respective files should be adapted too (e.g. world_query_data.rs → query_data.rs)

[Nilirad]

Review was tedious but straightforward. I think we can proceed.