[AI] A specialized pointer list for managing LegoROI instances. More...
#include <legoroilist.h>
Public Member Functions | |
| LegoROIList (MxBool p_ownership=FALSE) | |
| [AI] Construct a new LegoROIList with optional ownership of contained pointers. More... | |
| MxS8 | Compare (LegoROI *p_a, LegoROI *p_b) override |
| [AI] Comparison function for LegoROI pointers. More... | |
 Public Member Functions inherited from MxPtrList< LegoROI > | |
| MxPtrList (MxBool p_ownership) | |
| [AI] More... | |
| void | SetOwnership (MxBool p_ownership) |
| [AI] More... | |
| Public Member Functions inherited from MxList< T > | |
| MxList () | |
| [AI] Constructor. Initializes the list pointers to null (empty list). [AI] More... | |
| ~MxList () override | |
| [AI] Destructor. Deletes all entries in the list and manages resource ownership. [AI] More... | |
| void | Append (T p_obj) |
| [AI] More... | |
| void | Prepend (T p_obj) |
| [AI] More... | |
| void | DeleteAll () |
| [AI] More... | |
| void | Empty () |
| [AI] More... | |
| MxU32 | GetNumElements () |
| [AI] More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from MxPtrList< LegoROI > | |
| static void | Destroy (LegoROI *p_obj) |
| [AI] More... | |
| Protected Member Functions inherited from MxList< T > | |
| void | DeleteEntry (MxListEntry< T > *) |
| [AI] More... | |
| MxListEntry< T > * | InsertEntry (T, MxListEntry< T > *, MxListEntry< T > *) |
| [AI] More... | |
| Protected Member Functions inherited from MxCollection< T > | |
| MxCollection () | |
| [AI] Constructs an empty collection, initializing count and default element destructor. More... | |
| virtual MxS8 | Compare (T a, T b) |
| [AI] Compares two elements of the collection (default implementation returns zero; override in subclasses for meaningful comparison). More... | |
| ~MxCollection () override | |
| [AI] Virtual destructor for proper polymorphic destruction. More... | |
| void | SetDestroy (void(*p_customDestructor)(T)) |
| [AI] Assigns a custom destructor function to be used for elements of this collection. More... | |
| Protected Member Functions inherited from MxCore | |
| MxCore () | |
| [AI] Constructs a new MxCore object and assigns it a unique id. More... | |
| virtual | ~MxCore () |
| [AI] Virtual destructor. Required for correct polymorphic cleanup in derived classes. More... | |
| virtual MxLong | Notify (MxParam &p_param) |
| [AI] Virtual callback notification mechanism. More... | |
| virtual MxResult | Tickle () |
| [AI] Called by tickle managers to allow the object to update itself. More... | |
| virtual const char * | ClassName () const |
| [AI] Returns the runtime class name of this object. More... | |
| virtual MxBool | IsA (const char *p_name) const |
| [AI] Checks whether this object's class type or parents match the given name. More... | |
| MxU32 | GetId () |
| [AI] Gets the unique (per-process) id assigned to this object instance. More... | |
| Static Protected Member Functions inherited from MxCollection< T > | |
| static void | Destroy (T obj) |
| [AI] Static no-op destroy function; suitable for types that do not need destruction. More... | |
| Protected Attributes inherited from MxList< T > | |
| MxListEntry< T > * | m_first |
| [AI] Pointer to the first entry in the list. [AI] More... | |
| MxListEntry< T > * | m_last |
| [AI] Pointer to the last entry in the list. [AI] More... | |
| Protected Attributes inherited from MxCollection< T > | |
| MxU32 | m_count |
| [AI] Number of elements currently stored in the collection. More... | |
| void(* | m_customDestructor )(T) |
| [AI] Function pointer to the custom element destructor used for cleanup of elements. More... | |
Detailed Description
[AI] A specialized pointer list for managing LegoROI instances.
[AI] LegoROIList is a strongly-typed container derived from MxPtrList<LegoROI>, representing a collection of real-time object instances (ROI) as used in the LEGO Island game engine. It provides type safety and specialized comparison logic for LegoROI pointers, typically used to maintain and organize sets of rendered 3D objects or their references within the game engine. Ownership semantics can be toggled via the constructor parameter.
Definition at line 25 of file legoroilist.h.
Constructor & Destructor Documentation
◆ LegoROIList()
[AI] Construct a new LegoROIList with optional ownership of contained pointers.
- Parameters
-
p_ownership If TRUE, the list is responsible for deleting its contained LegoROI objects. [AI]
[AI] By default, the list does not assume ownership of its elements. Ownership affects clean-up behavior on destruction.
Definition at line 32 of file legoroilist.h.
Member Function Documentation
◆ Compare()
[AI] Comparison function for LegoROI pointers.
- Returns
- 0 if pointers are equal, -1 if p_a < p_b, 1 if p_a > p_b (pointer comparison). [AI]
[AI] This function performs a direct pointer value comparison between two LegoROI instances, necessary for ordered or uniqueness operations in the underlying list implementation.
- Remarks
- [AI] Overrides the virtual comparison required by MxPtrList. [AI]
Definition at line 42 of file legoroilist.h.
The documentation for this class was generated from the following file:
