ezEngine  Release 25.03
ezComponentManager< T, StorageType > Class Template Reference
Inheritance diagram for ezComponentManager< T, StorageType >:

Public Types

using ComponentType = T
 
using SUPER = ezComponentManagerBase
 

Public Member Functions

 ezComponentManager (ezWorld *pWorld)
 Although the constructor is public always use ezWorld::CreateComponentManager to create an instance.
 
bool TryGetComponent (const ezComponentHandle &hComponent, ComponentType *&out_pComponent)
 Returns if a component with the given handle exists and if so writes out the corresponding pointer to out_pComponent.
 
bool TryGetComponent (const ezComponentHandle &hComponent, const ComponentType *&out_pComponent) const
 Returns if a component with the given handle exists and if so writes out the corresponding pointer to out_pComponent.
 
ezBlockStorage< ComponentType, ezInternal::DEFAULT_BLOCK_SIZE, StorageType >::Iterator GetComponents (ezUInt32 uiStartIndex=0)
 Returns an iterator over all components.
 
ezBlockStorage< ComponentType, ezInternal::DEFAULT_BLOCK_SIZE, StorageType >::ConstIterator GetComponents (ezUInt32 uiStartIndex=0) const
 Returns an iterator over all components.
 
virtual void CollectAllComponents (ezDynamicArray< ezComponentHandle > &out_allComponents, bool bOnlyActive) override
 Adds all components that this manager handles to the given array (array is not cleared). Prefer to use more efficient methods on derived classes, only use this if you need to go through a ezComponentManagerBase pointer.
 
virtual void CollectAllComponents (ezDynamicArray< ezComponent * > &out_allComponents, bool bOnlyActive) override
 Adds all components that this manager handles to the given array (array is not cleared). Prefer to use more efficient methods on derived classes, only use this if you need to go through a ezComponentManagerBase pointer.
 
- Public Member Functions inherited from ezComponentManagerBase
bool IsValidComponent (const ezComponentHandle &hComponent) const
 Checks whether the given handle references a valid component.
 
bool TryGetComponent (const ezComponentHandle &hComponent, ezComponent *&out_pComponent)
 Returns if a component with the given handle exists and if so writes out the corresponding pointer to out_pComponent.
 
bool TryGetComponent (const ezComponentHandle &hComponent, const ezComponent *&out_pComponent) const
 Returns if a component with the given handle exists and if so writes out the corresponding pointer to out_pComponent.
 
ezUInt32 GetComponentCount () const
 Returns the number of components managed by this manager.
 
ezComponentHandle CreateComponent (ezGameObject *pOwnerObject)
 Create a new component instance and returns a handle to it.
 
template<typename ComponentType >
ezTypedComponentHandle< ComponentType > CreateComponent (ezGameObject *pOwnerObject, ComponentType *&out_pComponent)
 Create a new component instance and returns a handle to it.
 
void DeleteComponent (const ezComponentHandle &hComponent)
 Deletes the given component. Note that the component will be invalidated first and the actual deletion is postponed.
 
void DeleteComponent (ezComponent *pComponent)
 Deletes the given component. Note that the component will be invalidated first and the actual deletion is postponed.
 
template<typename ComponentType >
EZ_ALWAYS_INLINE ezTypedComponentHandle< ComponentType > CreateComponent (ezGameObject *pOwnerObject, ComponentType *&out_pComponent)
 
- Public Member Functions inherited from ezWorldModule
ezWorldGetWorld ()
 Returns the corresponding world to this module.
 
const ezWorldGetWorld () const
 Returns the corresponding world to this module.
 
ezUInt32 GetWorldIndex () const
 Same as GetWorld()->GetIndex(). Needed to break circular include dependencies.
 
- Public Member Functions inherited from ezReflectedClass
virtual const ezRTTIGetDynamicRTTI () const
 
bool IsInstanceOf (const ezRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T >
EZ_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Static Public Member Functions

static ezWorldModuleTypeId TypeId ()
 Returns the type id corresponding to the component type managed by this manager.
 
- Static Public Member Functions inherited from ezNoBase
static const ezRTTIGetStaticRTTI ()
 

Protected Member Functions

virtual ezComponentCreateComponentStorage () override
 
virtual void DeleteComponentStorage (ezComponent *pComponent, ezComponent *&out_pMovedComponent) override
 
void RegisterUpdateFunction (UpdateFunctionDesc &desc)
 
- Protected Member Functions inherited from ezComponentManagerBase
 ezComponentManagerBase (ezWorld *pWorld)
 
- Protected Member Functions inherited from ezWorldModule
 ezWorldModule (ezWorld *pWorld)
 
void RegisterUpdateFunction (const UpdateFunctionDesc &desc)
 Registers the given update function at the world.
 
void DeregisterUpdateFunction (const UpdateFunctionDesc &desc)
 De-registers the given update function from the world. Note that only the m_Function and the m_Phase of the description have to be valid for de-registration.
 
ezAllocatorGetAllocator ()
 Returns the allocator used by the world.
 
ezInternal::WorldLargeBlockAllocatorGetBlockAllocator ()
 Returns the block allocator used by the world.
 
bool GetWorldSimulationEnabled () const
 Returns whether the world simulation is enabled.
 
virtual void Initialize ()
 This method is called after the constructor. A derived type can override this method to do initialization work. Typically this is the method where updates function are registered.
 
virtual void Deinitialize ()
 This method is called before the destructor. A derived type can override this method to do deinitialization work.
 
virtual void OnSimulationStarted ()
 This method is called at the start of the next world update when the world is simulated. This method will be called after the initialization method.
 
virtual void WorldClear ()
 Called by ezWorld::Clear(). Can be used to clear cached data when a world is completely cleared of objects (but not deleted).
 

Protected Attributes

friend ComponentType
 
ezBlockStorage< ComponentType, ezInternal::DEFAULT_BLOCK_SIZE, StorageType > m_ComponentStorage
 
- Protected Attributes inherited from ezComponentManagerBase
ezIdTable< ezComponentId, ezComponent * > m_Components
 
- Protected Attributes inherited from ezWorldModule
ezWorldm_pWorld
 

Friends

class ezComponentManagerFactory
 

Additional Inherited Members

- Protected Types inherited from ezWorldModule
using UpdateFunction = ezDelegate< void(const UpdateContext &)>
 Update function delegate.
 

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