The LodSystem is responsible for calculating common basic level of detail data for all entities with LodComponents attached to them. More...

#include <LodSystem.h>

Inheritance diagram for Cogs::Core::LodSystem:

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

void	update (Context *context)
	Updates the LodSystem.

Public Member Functions inherited from Cogs::Core::ComponentSystemWithDataPools< LodComponent, LodData >
	ComponentSystemWithDataPools (Memory::Allocator *allocator, SizeType size=1024, MemBlockType componentMemType=MemBlockType::Component, MemBlockType dataMemType=MemBlockType::ComponentData)

ComponentHandle	createComponent () override

void	destroyComponent (ComponentHandle component) override

T &	getData (const LodComponent *component)
	Get the data stored for the given component from the data pool storing objects of the specified template type.

const T &	getData (const LodComponent *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
float	previousFrameStickyness = 0.1f
	A number in [0,1] that indicates resilience to change, used to minimize popping.

GeometricErrorKind	geometricErrorKind = GeometricErrorKind::AreaBased
	Specifies what kind of error measure that is preferred.

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.

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.

Detailed Description

The LodSystem is responsible for calculating common basic level of detail data for all entities with LodComponents attached to them.

Based on the settings in the LodComponent, different level of detail calculations are performed, and the results stored in the corresponding LodData structures. These data may then be used by other component systems wanting to adjust the calculations being made based on the LOD results.

For the simple LOD methods, the LodSystem will directly control the visibility of entities based on the calculation results.

Definition at line 37 of file LodSystem.h.

Constructor & Destructor Documentation

◆ LodSystem()

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

inline

Definition at line 40 of file LodSystem.h.

Member Function Documentation

◆ update()

void Cogs::Core::LodSystem::update ( Context * context )

virtual

Updates the LodSystem.

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 111 of file LodSystem.cpp.

References Cogs::Core::ComponentSystemBase::context, geometricErrorKind, Cogs::Core::GeometricTolerance, Cogs::ComponentModel::Component::getComponent(), Cogs::Core::None, Cogs::Core::LodComponent::policy, Cogs::Core::ComponentSystem< ComponentType >::pool, previousFrameStickyness, Cogs::Core::LodComponent::separateHierarchies, Cogs::Core::Context::variables, and Cogs::Core::SceneComponent::visible.

Member Data Documentation

◆ geometricErrorKind

GeometricErrorKind Cogs::Core::LodSystem::geometricErrorKind = GeometricErrorKind::AreaBased

Specifies what kind of error measure that is preferred.

Definition at line 49 of file LodSystem.h.

Referenced by update().

◆ previousFrameStickyness

float Cogs::Core::LodSystem::previousFrameStickyness = 0.1f

A number in [0,1] that indicates resilience to change, used to minimize popping.

Definition at line 46 of file LodSystem.h.

Referenced by update().

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

Source/Systems/Core/LodSystem.h
Source/Systems/Core/LodSystem.cpp

Public Member Functions

Public Attributes

Additional Inherited Members