ba819bcfca
This commit clarifies and corrects documentation in several public header files. The changes include fixing typos, improving wording, and adding missing details to make the API easier to understand and use. No functional changes are included in this commit.
95 lines
2.8 KiB
C++
95 lines
2.8 KiB
C++
/*
|
|
* Copyright (C) 2017 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef TNT_UTILS_ENTITY_H
|
|
#define TNT_UTILS_ENTITY_H
|
|
|
|
#include <utils/compiler.h>
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
|
|
namespace utils {
|
|
|
|
/**
|
|
* An Entity is a handle to an object in the Entity Component System (ECS).
|
|
*
|
|
* Entities are created by the EntityManager and can be associated with various components
|
|
* (e.g., Renderable, Transform, Light) to define their behavior and properties.
|
|
*/
|
|
class UTILS_PUBLIC Entity {
|
|
public:
|
|
// this can be used to create an array of to-be-filled entities (see create())
|
|
Entity() noexcept { } // NOLINT(modernize-use-equals-default), Ubuntu compiler bug
|
|
|
|
// Entities can be copied
|
|
Entity(const Entity& e) noexcept = default;
|
|
Entity(Entity&& e) noexcept = default;
|
|
Entity& operator=(const Entity& e) noexcept = default;
|
|
Entity& operator=(Entity&& e) noexcept = default;
|
|
|
|
// Entities can be compared
|
|
bool operator==(Entity e) const { return e.mIdentity == mIdentity; }
|
|
bool operator!=(Entity e) const { return e.mIdentity != mIdentity; }
|
|
|
|
// Entities can be sorted
|
|
bool operator<(Entity e) const { return e.mIdentity < mIdentity; }
|
|
|
|
bool isNull() const noexcept {
|
|
return mIdentity == 0;
|
|
}
|
|
|
|
// an id that can be used for debugging/printing
|
|
uint32_t getId() const noexcept {
|
|
return mIdentity;
|
|
}
|
|
|
|
explicit operator bool() const noexcept { return !isNull(); }
|
|
|
|
void clear() noexcept { mIdentity = 0; }
|
|
|
|
// Exports an entity to an int32_t which can be used "as is" in the Java programing language.
|
|
static int32_t smuggle(Entity entity) noexcept {
|
|
return int32_t(entity.getId());
|
|
}
|
|
|
|
// Imports an entity from an int32_t generated by smuggle() above.
|
|
static Entity import(int32_t identity) noexcept {
|
|
return Entity{ Type(identity) };
|
|
}
|
|
|
|
struct Hasher {
|
|
typedef Entity argument_type;
|
|
typedef size_t result_type;
|
|
result_type operator()(argument_type const& e) const {
|
|
return e.getId();
|
|
}
|
|
};
|
|
|
|
private:
|
|
friend class EntityManager;
|
|
friend class EntityManagerImpl;
|
|
using Type = uint32_t;
|
|
|
|
explicit Entity(Type identity) noexcept : mIdentity(identity) { }
|
|
|
|
Type mIdentity = 0;
|
|
};
|
|
|
|
} // namespace utils
|
|
|
|
#endif // TNT_UTILS_ENTITY_H
|