The cinematic camera system calculates interpolation data for cinematic components found in the scene. More...

#include <CinematicCameraSystem.h>

Inheritance diagram for Cogs::Core::CinematicCameraSystem:

Public Member Functions
	CinematicCameraSystem (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	addInterestPoint (const CinematicCameraComponent &targetComp)
	Add default point (camPos, camRot, 2.0f, 2.0f, linear)

void	addInterestPoint (const CinematicCameraComponent &targetComp, glm::vec3 &pos, glm::quat &rot, float time, float waitTime, CameraEasingMode mode)
	Add user defined point.

void	playCameraSequence (const CinematicCameraComponent &targetComp)
	Notify system to start playing the whole sequence.

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

CinematicCameraData &	getData (const CinematicCameraComponent *component)

const CinematicCameraData &	getData (const CinematicCameraComponent *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 Member Functions
bool	triggerTargetPoint (const CinematicCameraComponent &targetComp, const short &id=0)
	Trigger Interpolator segment "id" belonging to interpolator [{start,0},...,{n-1,n}].

Private Attributes
std::array< EasingFn::Ptr,(size_t) CameraEasingMode::SIZE >	easingFn = {}
	Map of EnumValue to FnPtr.

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

The cinematic camera system calculates interpolation data for cinematic components found in the scene.

Definition at line 43 of file CinematicCameraSystem.h.

Constructor & Destructor Documentation

◆ CinematicCameraSystem()

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

inline

Definition at line 46 of file CinematicCameraSystem.h.

◆ ~CinematicCameraSystem()

Cogs::Core::CinematicCameraSystem::~CinematicCameraSystem ( )

Definition at line 12 of file CinematicCameraSystem.cpp.

Member Function Documentation

◆ addInterestPoint() [1/2]

void Cogs::Core::CinematicCameraSystem::addInterestPoint ( const CinematicCameraComponent & targetComp )

Add default point (camPos, camRot, 2.0f, 2.0f, linear)

Definition at line 101 of file CinematicCameraSystem.cpp.

◆ addInterestPoint() [2/2]

void Cogs::Core::CinematicCameraSystem::addInterestPoint	(	const CinematicCameraComponent &	targetComp,
		glm::vec3 &	pos,
		glm::quat &	rot,
		float	time,
		float	waitTime,
		CameraEasingMode	mode
	)

Add user defined point.

Definition at line 122 of file CinematicCameraSystem.cpp.

◆ cleanup()

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

◆ initialize()

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

References Cogs::Core::ComponentSystemBase::initialize().

◆ playCameraSequence()

void Cogs::Core::CinematicCameraSystem::playCameraSequence ( const CinematicCameraComponent & targetComp )

Notify system to start playing the whole sequence.

Definition at line 139 of file CinematicCameraSystem.cpp.

◆ triggerTargetPoint()

bool Cogs::Core::CinematicCameraSystem::triggerTargetPoint	(	const CinematicCameraComponent &	targetComp,
		const short &	id = `0`
	)

private

Trigger Interpolator segment "id" belonging to interpolator [{start,0},...,{n-1,n}].

Definition at line 170 of file CinematicCameraSystem.cpp.

◆ update()

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

overridevirtual

Provided for custom update logic in derived systems.

Reimplemented from Cogs::Core::ComponentSystemBase.

Definition at line 33 of file CinematicCameraSystem.cpp.

Member Data Documentation

◆ easingFn

std::array<EasingFn::Ptr, (size_t)CameraEasingMode::SIZE > Cogs::Core::CinematicCameraSystem::easingFn = {}

private

Map of EnumValue to FnPtr.

Definition at line 67 of file CinematicCameraSystem.h.

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

Extensions/CinematicCamera/Source/CinematicCameraSystem.h
Extensions/CinematicCamera/Source/CinematicCameraSystem.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CinematicCameraSystem()

◆ ~CinematicCameraSystem()

Member Function Documentation

◆ addInterestPoint() [1/2]

◆ addInterestPoint() [2/2]

◆ cleanup()

◆ initialize()

◆ playCameraSequence()

◆ triggerTargetPoint()

◆ update()

Member Data Documentation

◆ easingFn