Isle
Loading...
Searching...
No Matches
LegoPathControllerList Class Reference

Class representing a list of pointers to LegoPathController objects, with optional ownership semantics. More...

#include <legopathcontrollerlist.h>

Inheritance diagram for LegoPathControllerList:
Collaboration diagram for LegoPathControllerList:

Public Member Functions

 LegoPathControllerList (MxBool p_ownership=FALSE)
 Constructor for LegoPathControllerList. More...
 
MxS8 Compare (LegoPathController *p_a, LegoPathController *p_b) override
 Compares two LegoPathController pointers for equality or ordering. More...
 
- Public Member Functions inherited from MxPtrList< LegoPathController >
 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< LegoPathController >
static void Destroy (LegoPathController *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

Class representing a list of pointers to LegoPathController objects, with optional ownership semantics.

[AI]

[AI] Inherits from MxPtrList<LegoPathController>. This class is used to manage a collection of LegoPathController pointers, optionally owning (deleting) the objects when the list is destroyed, depending on the ownership flag. Provides pointer comparison to support sorting or unique enforcement. Used to track all active LegoPathControllers, which are responsible for moving actors along paths. [AI]

Definition at line 27 of file legopathcontrollerlist.h.

Constructor & Destructor Documentation

◆ LegoPathControllerList()

LegoPathControllerList::LegoPathControllerList ( MxBool  p_ownership = FALSE)
inline

Constructor for LegoPathControllerList.

[AI]

Parameters
p_ownershipIf TRUE, the list will delete objects when destroyed or removed; otherwise, objects are not deleted. Defaults to FALSE. [AI]

[AI] Passes ownership parameter to the base MxPtrList constructor. [AI]

Definition at line 34 of file legopathcontrollerlist.h.

Member Function Documentation

◆ Compare()

MxS8 LegoPathControllerList::Compare ( LegoPathController p_a,
LegoPathController p_b 
)
inlineoverride

Compares two LegoPathController pointers for equality or ordering.

[AI]

Parameters
p_aPointer to first LegoPathController. [AI]
p_bPointer to second LegoPathController. [AI]
Returns
0 if equal, -1 if p_a < p_b, 1 if p_a > p_b (using pointer value comparison). [AI]

[AI] Used by list implementation for ordering or duplicate checks. Comparisons are based on pointer address, not on object content. [AI]

Definition at line 43 of file legopathcontrollerlist.h.


The documentation for this class was generated from the following file: