updated doc

This commit is contained in:
Michele Caini
2019-08-30 14:50:48 +02:00
parent 35a7008444
commit 869f96816c
2 changed files with 20 additions and 2 deletions

5
TODO
View File

@@ -18,8 +18,6 @@
* built-in support for dual (or N-) buffering
* allow for custom stomp functions
* deprecate/replace snapshot
* remove dependency
* remove prototype
TODO
* custom (decoupled) pools ==> double buffering, shared components, multi-model
@@ -27,6 +25,9 @@ TODO
- inline variables are fine here, only the head represents a problem
- we should always resolve by looking into the list of types when working across boundaries, no direct resolve
* nested groups: AB/ABC/ABCD/... (hints: sort, check functions)
* snapshot rework/deprecation
* create(hint: entity) -> force-create
* assign<T...>(first, last)
* use unordered_map for named pools and context variables:
* use direct access (pool-like) also for context variables
* improves multi-stomp

View File

@@ -615,6 +615,14 @@ public:
*
* @sa create
*
* The components must be copyable for obvious reasons. The source entity
* must be a valid one.<br/>
* If no components are provided, the registry will try to copy all the
* existing types. The non-copyable ones will be ignored.
*
* @note
* Specifying the list of components is ways faster than an opaque copy.
*
* @tparam Component Types of components to copy.
* @tparam Exclude Types of components not to be copied.
* @param src A valid entity identifier to be copied.
@@ -633,6 +641,15 @@ public:
*
* @sa create
*
* The components must be copyable for obvious reasons. The entities must be
* all valid.<br/>
* If no components are provided, the registry will try to copy all the
* existing types. The non-copyable ones will be ignored.
*
* @note
* Specifying the list of components is ways faster than an opaque copy and
* uses the batch creation under the hood.
*
* @tparam Component Types of components to copy.
* @tparam Exclude Types of components not to be copied.
* @param first An iterator to the first element of the range to generate.