mixin.inl

Go to the documentation of this file.

/**
 * @file addons/cpp/mixins/query/mixin.inl
 * @brief Query world mixin.
 */
 
/**
 * @memberof flecs::world
 * @ingroup cpp_core_queries
 *
 * @{
 */
 
/** Create a query.
 * Returns a flecs::sparse_query when all components have the dont_fragment
 * trait and don't declare the on_instantiate::inherit policy.
 *
 * @see ecs_query_init()
 */
template <typename... Comps, typename... Args>
conditional_t<sizeof...(Args) == 0 && _::is_sparse_query<Comps...>::value,
    flecs::sparse_query<Comps...>, flecs::query<Comps...>>
query(Args &&... args) const;
 
/** Create a query from an entity.
 *
 * @see ecs_query_init()
 */
flecs::query<> query(flecs::entity query_entity) const;
 
/** Create a query builder.
 *
 * @see ecs_query_init()
 */
template <typename... Comps, typename... Args>
flecs::query_builder<Comps...> query_builder(Args &&... args) const;
 
/** Iterate over all entities with components in the argument list of the function.
 * The function parameter must match the following signature:
 *
 * @code
 * void(*)(flecs::entity)
 * @endcode
 *
 * or:
 *
 * @code
 * void(*)(T&, U&, ...)
 * @endcode
 *
 * or:
 *
 * @code
 * void(*)(flecs::entity, T&, U&, ...)
 * @endcode
 * 
 */
template <typename Func>
void each(Func&& func) const;
 
/** Iterate over all entities with the provided component.
 * The function parameter must match the following signature:
 *
 * @code
 * void(*)(T&)
 * @endcode
 *
 * or:
 *
 * @code
 * void(*)(flecs::entity, T&)
 * @endcode
 * 
 */
template <typename T, typename Func>
void each(Func&& func) const;
 
/** Iterate over all entities with the provided (component) ID. */
template <typename Func>
void each(flecs::id_t term_id, Func&& func) const;
 
/** @} */