Cogs.Core
Public Types | Public Member Functions | Public Attributes | List of all members
Cogs::Core::TwinVisualsSystem Struct Reference
Inheritance diagram for Cogs::Core::TwinVisualsSystem:
Cogs::Core::ComponentSystemWithDataPool< TwinVisualsComponent, TwinVisualsData > Cogs::Core::ComponentSystemWithDataPools< ComponentType, DataTypes > Cogs::Core::ComponentSystem< ComponentType > Cogs::Core::ComponentSystemBase

Public Types

using base = ComponentSystemWithDataPool< TwinVisualsComponent, TwinVisualsData >
 
- Public Types inherited from Cogs::Core::ComponentSystem< ComponentType >
typedef ComponentType component_type
 

Public Member Functions

 TwinVisualsSystem (Memory::Allocator *allocator, SizeType capacity)
 
void preUpdate (Context *context) override
 Provided for custom pre update logic in derived systems.
 
void update (Context *context) override
 Provided for custom update logic in derived systems.
 
void postUpdate (Context *context) override
 
ComponentHandle createComponent () override
 
void destroyComponent (ComponentHandle handle) override
 
- Public Member Functions inherited from Cogs::Core::ComponentSystemWithDataPool< TwinVisualsComponent, TwinVisualsData >
 ComponentSystemWithDataPool (Memory::Allocator *allocator, SizeType size=1024)
 
TwinVisualsDatagetData (const TwinVisualsComponent *component)
 
const TwinVisualsDatagetData (const TwinVisualsComponent *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.
 

Public Attributes

TwinVisualsComponentglobalTwinVisualsComponent = nullptr
 
- 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.
 
Contextcontext = nullptr
 Pointer to the Context instance the system lives in.
 

Additional Inherited Members

- 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.
 

Detailed Description

Definition at line 60 of file TwinVisualsSystem.h.

Member Typedef Documentation

◆ base

Definition at line 62 of file TwinVisualsSystem.h.

Constructor & Destructor Documentation

◆ TwinVisualsSystem()

Cogs::Core::TwinVisualsSystem::TwinVisualsSystem ( Memory::Allocator allocator,
SizeType  capacity 
)
inline

Definition at line 64 of file TwinVisualsSystem.h.

Member Function Documentation

◆ createComponent()

ComponentHandle Cogs::Core::TwinVisualsSystem::createComponent ( )
overridevirtual

Overridden to update data pool contents in lockstep with the component pool. Any subclass overriding this method should call base class first.

Reimplemented from Cogs::Core::ComponentSystemWithDataPools< ComponentType, DataTypes >.

Definition at line 647 of file TwinVisualsSystem.cpp.

References Cogs::ComponentModel::ComponentHandle::resolveComponent().

◆ destroyComponent()

void Cogs::Core::TwinVisualsSystem::destroyComponent ( ComponentHandle  component)
overridevirtual

Overridden to update data pool contents in lockstep with the component pool. Any subclass overriding this method should also call base class.

Reimplemented from Cogs::Core::ComponentSystemWithDataPools< ComponentType, DataTypes >.

Definition at line 656 of file TwinVisualsSystem.cpp.

References Cogs::ComponentModel::ComponentHandle::resolveComponent().

◆ postUpdate()

void Cogs::Core::TwinVisualsSystem::postUpdate ( Context )
overridevirtual

Overridden to propagate carry flags. Any subclass overriding this method should also call base class.

Reimplemented from Cogs::Core::ComponentSystem< ComponentType >.

Definition at line 620 of file TwinVisualsSystem.cpp.

References Cogs::Core::Context::engine, Cogs::Core::TexturesFailed, and Cogs::Core::TexturesReady.

◆ preUpdate()

void Cogs::Core::TwinVisualsSystem::preUpdate ( Context )
overridevirtual

Provided for custom pre update logic in derived systems.

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 141 of file TwinVisualsSystem.cpp.

References Cogs::Core::ComponentSystemBase::context, and Cogs::Core::ComponentSystem< ComponentType >::pool.

◆ update()

void Cogs::Core::TwinVisualsSystem::update ( Context )
overridevirtual

Member Data Documentation

◆ globalTwinVisualsComponent

TwinVisualsComponent* Cogs::Core::TwinVisualsSystem::globalTwinVisualsComponent = nullptr

Definition at line 77 of file TwinVisualsSystem.h.


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