The fog system manages fog instances, in addition to special handling a single fog component as the global fog instance. More...
#include <FogSystem.h>
Inheritance diagram for Cogs::Core::FogSystem:
Public Member Functions | |
| FogSystem (Memory::Allocator *allocator, SizeType capacity) | |
| void | update (Context *context) |
| Updated the fog system. | |
| void | setGlobalFog (ComponentModel::ComponentHandle fogComponent) |
| Set the global fog component, used to control fog for the entire scene. | |
| FogComponent * | getGlobalFog () const |
| Get the global fog component. | |
 Public Member Functions inherited from Cogs::Core::ComponentSystemWithDataPool< FogComponent, FogData > | |
| ComponentSystemWithDataPool (Memory::Allocator *allocator, SizeType size=1024) | |
| FogData & | getData (const FogComponent *component) |
| const FogData & | getData (const FogComponent *component) const |
| Public Member Functions inherited from Cogs::Core::ComponentSystemWithDataPools< ComponentType, DataTypes > | |
| ComponentSystemWithDataPools (Memory::Allocator *allocator, SizeType size=1024, MemBlockType componentMemType=MemBlockType::Component, MemBlockType dataMemType=MemBlockType::ComponentData) | |
| ComponentHandle | createComponent () override |
| void | destroyComponent (ComponentHandle component) override |
| template<typename T > | |
| T & | getData (const ComponentType *component) |
| Get the data stored for the given component from the data pool storing objects of the specified template type. | |
| template<typename T > | |
| const T & | getData (const ComponentType *component) const |
| Get the const data stored for the given component from the data pool storing objects of the specified template type. | |
| Public Member Functions inherited from Cogs::Core::ComponentSystem< ComponentType > | |
| ComponentSystem (Memory::Allocator *allocator, SizeType size=16384, MemBlockType componentMemType=MemBlockType::Component) | |
| void | instrumentedPreUpdate () override |
| Provided for tagged engine instrumentation. | |
| void | instrumentedUpdate () override |
| Provided for tagged engine instrumentation. | |
| void | instrumentedPostUpdate () override |
| Provided for tagged engine instrumentation. | |
| ComponentHandle | createComponent () override |
| Create a new component instance. | |
| void | destroyComponent (ComponentHandle component) override |
| Destroy the component held by the given handle. | |
| SizeType | getComponentIndex (const Component *component) const |
| Get the index of the given component in the component pool. | |
| size_t | size () |
| Returns the number of active components. | |
| void | clearCarryFlags () |
| Clear carry flags of all active components. | |
| void | resetFlags () |
| Reset the flags of all active components. | |
| void | prepareUpdate (Context *) override |
| void | postUpdate (Context *) override |
| ComponentHandle | getHandle (const ComponentType *component) |
| Get a handle to the given Component instance. | |
| virtual void | addEntitiesWithComponent (std::vector< EntityId > &entities, Reflection::TypeId componentTypeId) override |
| Return all entities with a given. | |
| Public Member Functions inherited from Cogs::Core::ComponentSystemBase | |
| virtual | ~ComponentSystemBase () |
| Provided for destruction via pointer to base. | |
| ComponentSystemBase (Reflection::TypeId componentType) | |
| Constructs a ComponentSystemBase to manage components of the given componentType. | |
| virtual void | initialize (Context *context) |
| Initialize the system. | |
| void | preUpdate () |
| Run the pre-update method of the system. | |
| void | update () |
| Updates the system state to that of the current frame. | |
| void | postUpdate () |
| Perform post update logic in the system. | |
| virtual void | preUpdate (Context *) |
| Provided for custom pre update logic in derived systems. | |
| virtual void | prepareUpdate (Context *) |
| Provided for custom update preparation logic in derived systems. | |
| virtual void | update (Context *) |
| Provided for custom update logic in derived systems. | |
| virtual void | postUpdate (Context *) |
| Provided for custom post update logic in derived systems. | |
| virtual void | instrumentedPreUpdate () |
| Provided for tagged engine instrumentation. | |
| virtual void | instrumentedUpdate () |
| Provided for tagged engine instrumentation. | |
| virtual void | instrumentedPostUpdate () |
| Provided for tagged engine instrumentation. | |
| virtual void | addEntitiesWithComponent (std::vector< EntityId > &, Reflection::TypeId) |
| Return all entities with a given. | |
| virtual void | cleanup (Context *) |
| Provided for custom cleanup logic in derived systems. | |
| virtual ComponentHandle | createComponent () |
| Create a new component instance. | |
| virtual void | destroyComponent (ComponentHandle) |
| Destroy the component held by the given handle. | |
| Reflection::TypeId | getComponentType () const |
| Get the reflected type of the components managed by this system. | |
Private Attributes | |
| ComponentModel::ComponentHandle | globalFog = ComponentModel::ComponentHandle::Empty() |
| Global fog handle. | |
Additional Inherited Members | |
| Public Types inherited from Cogs::Core::ComponentSystem< ComponentType > | |
| typedef ComponentType | component_type |
| Static Public Member Functions inherited from Cogs::Core::ComponentSystem< ComponentType > | |
| static Reflection::TypeId | getTypeId () |
| Get the type id of the component type used by the system. | |
| Public Attributes inherited from Cogs::Core::ComponentSystem< ComponentType > | |
| ComponentPool< ComponentType > | pool |
| Pool of components managed by the system. | |
| Public Attributes inherited from Cogs::Core::ComponentSystemBase | |
| Reflection::TypeId | componentType |
| The type of components managed by this instance. | |
| Context * | context = nullptr |
| Pointer to the Context instance the system lives in. | |
Detailed Description
The fog system manages fog instances, in addition to special handling a single fog component as the global fog instance.
Definition at line 23 of file FogSystem.h.
Constructor & Destructor Documentation
◆ FogSystem()
|
inline |
Definition at line 26 of file FogSystem.h.
Member Function Documentation
◆ getGlobalFog()
|
inline |
Get the global fog component.
Definition at line 35 of file FogSystem.h.
References globalFog, and Cogs::ComponentModel::ComponentHandle::resolveComponent().
◆ setGlobalFog()
|
inline |
Set the global fog component, used to control fog for the entire scene.
Definition at line 32 of file FogSystem.h.
References globalFog.
◆ update()
|
virtual |
Updated the fog system.
Reimplemented from Cogs::Core::ComponentSystemBase.
Definition at line 3 of file FogSystem.cpp.
Member Data Documentation
◆ globalFog
|
private |
Global fog handle.
Definition at line 39 of file FogSystem.h.
Referenced by getGlobalFog(), and setGlobalFog().
The documentation for this class was generated from the following files:
- Source/Systems/Core/FogSystem.h
- Source/Systems/Core/FogSystem.cpp
