 |
ezEngine
Release 25.03
|
|
ezEngine
Release 25.03
|
A component manager that does no update at all on components and expects only a single instance to be created per world. More...
#include <SettingsComponentManager.h>
Public Member Functions | |
| ezSettingsComponentManager (ezWorld *pWorld) | |
| ComponentType * | GetSingletonComponent () |
| Returns the first component of this type that has been created. | |
| const ComponentType * | GetSingletonComponent () const |
| 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 | |
| ezWorld * | GetWorld () |
| Returns the corresponding world to this module. | |
| const ezWorld * | GetWorld () 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 ezRTTI * | GetDynamicRTTI () 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 () |
| Static Public Member Functions inherited from ezNoBase | |
| static const ezRTTI * | GetStaticRTTI () |
Friends | |
| class | ezComponentManagerFactory |
Additional Inherited Members | |
| Protected Types inherited from ezWorldModule | |
| using | UpdateFunction = ezDelegate< void(const UpdateContext &)> |
| Update function delegate. | |
| 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. | |
| ezAllocator * | GetAllocator () |
| Returns the allocator used by the world. | |
| ezInternal::WorldLargeBlockAllocator * | GetBlockAllocator () |
| 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 inherited from ezComponentManagerBase | |
| ezIdTable< ezComponentId, ezComponent * > | m_Components |
| Protected Attributes inherited from ezWorldModule | |
| ezWorld * | m_pWorld |
A component manager that does no update at all on components and expects only a single instance to be created per world.
Easy access to this single component is provided through the GetSingletonComponent() function. If a second component is created, the manager will log an error. The first created component will be used as the 'singleton', all other components are ignored. Use this for components derived from ezSettingsComponent, of which one should only have zero or one per world.
1.8.17