decl.hpp

Go to the documentation of this file.

 
#pragma once
 
namespace flecs {
 
struct id;
struct entity;
 
struct id {
    id()
        : world_(nullptr)
        , id_(0) { }
 
    explicit id(flecs::id_t value)
        : world_(nullptr)
        , id_(value) { }
 
    explicit id(flecs::world_t *world, flecs::id_t value = 0)
        : world_(world)
        , id_(value) { }
 
    explicit id(flecs::world_t *world, flecs::id_t first, flecs::id_t second)
        : world_(world)
        , id_(ecs_pair(first, second)) { }
 
    explicit id(flecs::world_t *world, const char *expr)
        : world_(world)
        , id_(ecs_id_from_str(world, expr)) { }
 
    explicit id(flecs::id_t first, flecs::id_t second)
        : world_(nullptr)
        , id_(ecs_pair(first, second)) { }
 
    explicit id(const flecs::id& first, const flecs::id& second)
        : world_(first.world_)
        , id_(ecs_pair(first.id_, second.id_)) { }
 
    bool is_pair() const {
        return (id_ & ECS_ID_FLAGS_MASK) == flecs::PAIR;
    }
 
    bool is_wildcard() const {
        return ecs_id_is_wildcard(id_);
    }
 
    bool is_entity() const {
        return !(id_ & ECS_ID_FLAGS_MASK);
    }
 
    flecs::entity entity() const;
 
    flecs::entity add_flags(flecs::id_t flags) const;
 
    flecs::entity remove_flags(flecs::id_t flags) const;
 
    flecs::entity remove_flags() const;
 
    flecs::entity remove_generation() const;
 
    flecs::entity type_id() const;
 
    bool has_flags(flecs::id_t flags) const {
        return ((id_ & flags) == flags);
    }
 
    bool has_flags() const {
        return (id_ & ECS_ID_FLAGS_MASK) != 0;
    }
 
    flecs::entity flags() const;
 
    bool has_relation(flecs::id_t first) const {
        if (!is_pair()) {
            return false;
        }
        return ECS_PAIR_FIRST(id_) == first;
    }
 
    flecs::entity first() const;
 
    flecs::entity second() const;
 
    /* Convert id to string */
    flecs::string str() const {
        return flecs::string(ecs_id_str(world_, id_));
    }
 
    flecs::string flags_str() const {
        return flecs::string_view( ecs_id_flag_str(id_ & ECS_ID_FLAGS_MASK));
    }
 
    flecs::id_t raw_id() const {
        return id_;
    }
 
    operator flecs::id_t() const {
        return id_;
    }
 
    flecs::world world() const;
 
protected:
    /* World is optional, but guarantees that entity identifiers extracted from
     * the id are valid */
    flecs::world_t *world_;
    flecs::id_t id_;
};
 
}