Cogs.Core
Public Member Functions | Private Attributes | List of all members
Cogs::Core::EchoSounder::PingIsoSystem Struct Reference
Inheritance diagram for Cogs::Core::EchoSounder::PingIsoSystem:
Cogs::Core::ComponentSystemWithDataPool< PingIsoComponent, SinglePingIsoSurfacesData > Cogs::Core::ComponentSystemWithDataPools< ComponentType, DataTypes > Cogs::Core::ComponentSystem< ComponentType > Cogs::Core::ComponentSystemBase

Public Member Functions

 PingIsoSystem (Memory::Allocator *allocator, SizeType capacity)
 
void initialize (Context *context) override
 Initialize the system.
 
void update (Context *context) override
 Provided for custom update logic in derived systems.
 
void cleanup (Context *context) override
 Provided for custom cleanup logic in derived systems.
 
void setDataSystem (DataSetSystem *dataSystem)
 
- Public Member Functions inherited from Cogs::Core::ComponentSystemWithDataPool< PingIsoComponent, SinglePingIsoSurfacesData >
 ComponentSystemWithDataPool (Memory::Allocator *allocator, SizeType size=1024)
 
SinglePingIsoSurfacesData & getData (const PingIsoComponent *component)
 
const SinglePingIsoSurfacesData & getData (const PingIsoComponent *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

DataSetSystemdataSetSystem = nullptr
 
MaterialHandle surfaceMaterial
 
VariableKey rangeKey
 
VariableKey opacityKey
 

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

Detailed Description

Definition at line 57 of file PingIsoSystem.h.

Constructor & Destructor Documentation

◆ PingIsoSystem()

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

Definition at line 61 of file PingIsoSystem.h.

Member Function Documentation

◆ cleanup()

void PingIsoSystem::cleanup ( Context )
overridevirtual

Provided for custom cleanup logic in derived systems.

Cleanup is performed during shutdown of the system, and all entities and related data should have been deleted.

All system services are available during the execution of cleanup().

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 187 of file PingIsoSystem.cpp.

References Cogs::Core::ComponentSystemBase::cleanup(), and Cogs::Core::ComponentSystemBase::context.

◆ initialize()

void PingIsoSystem::initialize ( Context context)
overridevirtual

Initialize the system.

Initialization is performed after all systems are created and a renderer initialized, but before the first time anything is rendered.

Parameters
contextPointer to the context the system lives in.

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 30 of file PingIsoSystem.cpp.

References Cogs::Core::ComponentSystemBase::context, and Cogs::Core::ComponentSystemBase::initialize().

◆ setDataSystem()

void Cogs::Core::EchoSounder::PingIsoSystem::setDataSystem ( DataSetSystem dataSystem)
inline

Definition at line 69 of file PingIsoSystem.h.

◆ update()

void PingIsoSystem::update ( Context )
overridevirtual

Member Data Documentation

◆ dataSetSystem

DataSetSystem* Cogs::Core::EchoSounder::PingIsoSystem::dataSetSystem = nullptr
private

Definition at line 72 of file PingIsoSystem.h.

◆ opacityKey

VariableKey Cogs::Core::EchoSounder::PingIsoSystem::opacityKey
private

Definition at line 75 of file PingIsoSystem.h.

◆ rangeKey

VariableKey Cogs::Core::EchoSounder::PingIsoSystem::rangeKey
private

Definition at line 74 of file PingIsoSystem.h.

◆ surfaceMaterial

MaterialHandle Cogs::Core::EchoSounder::PingIsoSystem::surfaceMaterial
private

Definition at line 73 of file PingIsoSystem.h.


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