Cogs::Core::EchoSounder::SwathIsoSystem Struct Reference

Inheritance diagram for Cogs::Core::EchoSounder::SwathIsoSystem:

Public Member Functions
	SwathIsoSystem (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< SwathIsoComponent, SwathIsoSurfacesData >
	ComponentSystemWithDataPool (Memory::Allocator *allocator, SizeType size=1024)
SwathIsoSurfacesData &	getData (const SwathIsoComponent *component)
const SwathIsoSurfacesData &	getData (const SwathIsoComponent *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
DataSetSystem *	dataSetSystem = nullptr
MaterialHandle	surfaceMaterial
VariableKey	rangeKey

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

Definition at line 44 of file SwathIsoSystem.h.

Constructor & Destructor Documentation

SwathIsoSystem()

Cogs::Core::EchoSounder::SwathIsoSystem::SwathIsoSystem ( Memory::Allocator *  allocator, SizeType  capacity  )

inline

Definition at line 48 of file SwathIsoSystem.h.

Member Function Documentation

cleanup()

void SwathIsoSystem::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 37 of file SwathIsoSystem.cpp.

initialize()

void SwathIsoSystem::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

context

Pointer to the context the system lives in.

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 26 of file SwathIsoSystem.cpp.

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

setDataSystem()

void Cogs::Core::EchoSounder::SwathIsoSystem::setDataSystem ( DataSetSystem *  dataSystem )

inline

Definition at line 56 of file SwathIsoSystem.h.

update()

void SwathIsoSystem::update ( Context *  )

overridevirtual

Provided for custom update logic in derived systems.

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 42 of file SwathIsoSystem.cpp.

References Cogs::Core::ComponentSystemBase::context, Cogs::Core::EntityStore::createChildEntity(), Cogs::Core::Context::engine, Cogs::ComponentModel::Component::getComponent(), Cogs::ComponentModel::Component::getContainer(), Cogs::Core::SubMeshRenderComponent::materials, Cogs::Core::ComponentSystem< ComponentType >::pool, Cogs::ComponentModel::Component::setChanged(), Cogs::Core::Context::store, and Cogs::Core::Context::variables.

Member Data Documentation

dataSetSystem

DataSetSystem* Cogs::Core::EchoSounder::SwathIsoSystem::dataSetSystem = nullptr

private

Definition at line 59 of file SwathIsoSystem.h.

rangeKey

VariableKey Cogs::Core::EchoSounder::SwathIsoSystem::rangeKey

private

Definition at line 62 of file SwathIsoSystem.h.

surfaceMaterial

MaterialHandle Cogs::Core::EchoSounder::SwathIsoSystem::surfaceMaterial

private

Definition at line 61 of file SwathIsoSystem.h.

---

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

• Extensions/EchoSounder/Source/Systems/SwathIsoSystem.h
• Extensions/EchoSounder/Source/Systems/SwathIsoSystem.cpp