#include <AH/Containers/Updatable.hpp>
Detailed Description
class UpdatableCRTP< Derived >
A super class for object that have to be updated regularly.
All instances of this class are kept in a linked list, so it's easy to iterate over all of them to update them.
This version uses static polymorphism using the Curiously Recurring Template Pattern. This requires less virtual function calls.
(Only the destructor is virtual.)
Definition at line 28 of file Updatable.hpp.
Inheritance diagram for UpdatableCRTP< Derived >: Collaboration diagram for UpdatableCRTP< Derived >:Enabling and disabling updatables | |
| void | enable () |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More... | |
| void | disable () |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More... | |
| bool | isEnabled () const |
| Check if this updatable is enabled. More... | |
| void | moveDown () |
| Move down this element in the list. More... | |
| static void | enable (UpdatableCRTP *element) |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More... | |
| static void | enable (UpdatableCRTP &element) |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More... | |
| template<class U , size_t N> | |
| static void | enable (U(&array)[N]) |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More... | |
| static void | disable (UpdatableCRTP *element) |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More... | |
| static void | disable (UpdatableCRTP &element) |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More... | |
| template<class U , size_t N> | |
| static void | disable (U(&array)[N]) |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More... | |
Public Member Functions | |
| virtual | ~UpdatableCRTP () __attribute__((no_sanitize("undefined"))) |
| Destructor: remove the updatable from the linked list of instances. More... | |
Protected Member Functions | |
| UpdatableCRTP () __attribute__((no_sanitize("undefined"))) | |
| Constructor: create an Updatable and add it to the linked list of instances. More... | |
| UpdatableCRTP (const UpdatableCRTP &) __attribute__((no_sanitize("undefined"))) | |
| UpdatableCRTP & | operator= (const UpdatableCRTP &) |
| UpdatableCRTP (UpdatableCRTP &&) __attribute__((no_sanitize("undefined"))) | |
| UpdatableCRTP & | operator= (UpdatableCRTP &&) |
Protected Attributes | |
| Derived * | next |
| Derived * | previous |
Static Protected Attributes | |
| static DoublyLinkedList< Derived > | updatables |
Constructor & Destructor Documentation
◆ UpdatableCRTP() [1/3]
|
inlineprotected |
Constructor: create an Updatable and add it to the linked list of instances.
Definition at line 50 of file Updatable.hpp.
◆ UpdatableCRTP() [2/3]
|
inlineprotected |
Definition at line 54 of file Updatable.hpp.
◆ UpdatableCRTP() [3/3]
|
inlineprotected |
Definition at line 61 of file Updatable.hpp.
◆ ~UpdatableCRTP()
|
inlinevirtual |
Destructor: remove the updatable from the linked list of instances.
Definition at line 68 of file Updatable.hpp.
Member Function Documentation
◆ operator=() [1/2]
|
inlineprotected |
Definition at line 59 of file Updatable.hpp.
◆ operator=() [2/2]
|
inlineprotected |
Definition at line 64 of file Updatable.hpp.
◆ enable() [1/4]
|
inline |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 96 of file Updatable.hpp.
◆ disable() [1/4]
|
inline |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 106 of file Updatable.hpp.
◆ isEnabled()
|
inline |
Check if this updatable is enabled.
- Note
- Assumes that the updatable is not added to a different linked list by the user.
Definition at line 120 of file Updatable.hpp.
◆ enable() [2/4]
|
inlinestatic |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 125 of file Updatable.hpp.
◆ enable() [3/4]
|
inlinestatic |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 127 of file Updatable.hpp.
◆ enable() [4/4]
|
inlinestatic |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 130 of file Updatable.hpp.
◆ disable() [2/4]
|
inlinestatic |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 136 of file Updatable.hpp.
◆ disable() [3/4]
|
inlinestatic |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 138 of file Updatable.hpp.
◆ disable() [4/4]
|
inlinestatic |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 141 of file Updatable.hpp.
◆ moveDown()
|
inline |
Move down this element in the list.
Definition at line 147 of file Updatable.hpp.
Member Data Documentation
◆ updatables
|
staticprotected |
Definition at line 152 of file Updatable.hpp.
◆ next
|
protectedinherited |
Definition at line 320 of file LinkedList.hpp.
◆ previous
|
protectedinherited |
Definition at line 321 of file LinkedList.hpp.
The documentation for this class was generated from the following file:
