Inheritance diagram for Cogs::Core::ZipSystem:

Public Member Functions
	ZipSystem (Memory::Allocator *allocator, SizeType capacity)

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.

Public Member Functions inherited from Cogs::Core::ComponentSystemWithDataPool< ZipComponent, ZipData >
	ComponentSystemWithDataPool (Memory::Allocator *allocator, SizeType size=1024)

ZipData &	getData (const ZipComponent *component)

const ZipData &	getData (const ZipComponent *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 Types
using	base = ComponentSystemWithDataPool< ZipComponent, ZipData >

Private Member Functions
bool	setupComponent (Context *context, ZipComponent &component)

bool	needsUpdate (Context *context, ZipComponent &component)

void	updateStaticLog (Context *context, ZipComponent &component)

bool	updateStaticHighLight (Context *context, ZipComponent &component)

void	updateDynamic (Context *context, ZipComponent &component)

void	setupMaterial (Context *context)

void	resetComponent (ZipComponent &component)

Private Attributes
MaterialHandle	zipMaterial = MaterialHandle::NoHandle

bool	useGpu = false

VariableKey	axisKey = {}

VariableKey	parameterKey = {}

VariableKey	diffuseColorKey = {}

VariableKey	colorMapKey = {}

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 34 of file ZipSystem.h.

Member Typedef Documentation

◆ base

using Cogs::Core::ZipSystem::base = ComponentSystemWithDataPool<ZipComponent, ZipData>

private

Definition at line 36 of file ZipSystem.h.

Constructor & Destructor Documentation

◆ ZipSystem()

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

inline

Definition at line 38 of file ZipSystem.h.

Member Function Documentation

◆ cleanup()

void Cogs::Core::ZipSystem::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 288 of file ZipSystem.cpp.

◆ needsUpdate()

bool Cogs::Core::ZipSystem::needsUpdate	(	Context *	context,
		ZipComponent &	component
	)

private

Definition at line 294 of file ZipSystem.cpp.

◆ resetComponent()

void Cogs::Core::ZipSystem::resetComponent ( ZipComponent & component )

private

Definition at line 606 of file ZipSystem.cpp.

◆ setupComponent()

bool Cogs::Core::ZipSystem::setupComponent	(	Context *	context,
		ZipComponent &	component
	)

private

Definition at line 383 of file ZipSystem.cpp.

◆ setupMaterial()

void Cogs::Core::ZipSystem::setupMaterial ( Context * context )

private

Definition at line 591 of file ZipSystem.cpp.

◆ update()

void Cogs::Core::ZipSystem::update ( Context * )

overridevirtual

Provided for custom update logic in derived systems.

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 250 of file ZipSystem.cpp.

References Cogs::Core::ComponentSystemBase::context, Cogs::Core::HandleIsValid(), Cogs::Core::ComponentSystem< ComponentType >::pool, and Cogs::Core::Context::variables.

◆ updateDynamic()

void Cogs::Core::ZipSystem::updateDynamic	(	Context *	context,
		ZipComponent &	component
	)

private

Definition at line 625 of file ZipSystem.cpp.

◆ updateStaticHighLight()

bool Cogs::Core::ZipSystem::updateStaticHighLight	(	Context *	context,
		ZipComponent &	component
	)

private

Definition at line 452 of file ZipSystem.cpp.

◆ updateStaticLog()

void Cogs::Core::ZipSystem::updateStaticLog	(	Context *	context,
		ZipComponent &	component
	)

private

Definition at line 314 of file ZipSystem.cpp.

Member Data Documentation

◆ axisKey

VariableKey Cogs::Core::ZipSystem::axisKey = {}

private

Definition at line 58 of file ZipSystem.h.

◆ colorMapKey

VariableKey Cogs::Core::ZipSystem::colorMapKey = {}

private

Definition at line 61 of file ZipSystem.h.

◆ diffuseColorKey

VariableKey Cogs::Core::ZipSystem::diffuseColorKey = {}

private

Definition at line 60 of file ZipSystem.h.

◆ parameterKey

VariableKey Cogs::Core::ZipSystem::parameterKey = {}

private

Definition at line 59 of file ZipSystem.h.

◆ useGpu

bool Cogs::Core::ZipSystem::useGpu = false

private

Definition at line 56 of file ZipSystem.h.

◆ zipMaterial

MaterialHandle Cogs::Core::ZipSystem::zipMaterial = MaterialHandle::NoHandle

private

Definition at line 55 of file ZipSystem.h.

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

Extensions/WellLog/Source/Systems/ZipSystem.h
Extensions/WellLog/Source/Systems/ZipSystem.cpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ base

Constructor & Destructor Documentation

◆ ZipSystem()

Member Function Documentation

◆ cleanup()

◆ needsUpdate()

◆ resetComponent()

◆ setupComponent()

◆ setupMaterial()

◆ update()

◆ updateDynamic()

◆ updateStaticHighLight()

◆ updateStaticLog()

Member Data Documentation

◆ axisKey

◆ colorMapKey

◆ diffuseColorKey

◆ parameterKey

◆ useGpu

◆ zipMaterial