Engine²
Open-source game engine written in C++.
Loading...
Searching...
No Matches
CameraMovement::Plugin Class Reference

Plugin for camera movement control. More...

#include <PluginCameraMovement.hpp>

Inheritance diagram for CameraMovement::Plugin:
Engine::APlugin Engine::IPlugin

Public Member Functions

 Plugin (Engine::Core &core)
 ~Plugin () override=default
void Bind () override
 Pure virtual method that must be implemented by derived plugin classes. This method is called when the plugin is added to the engine, and is where the plugin should register its systems, resources, and any other functionality it provides to the engine.
Public Member Functions inherited from Engine::APlugin
 APlugin (Core &core)
 Constructor for APlugin. It takes a reference to the Core, which is used to register systems and resources in the Bind method.
template<CScheduler TScheduler, typename... Systems>
decltype(auto) RegisterSystems (Systems... systems)
 Register systems to a scheduler.
template<typename TResource>
TResource & RegisterResource (TResource &&resource)
 Register a resource in the core.
template<CPlugin... TPlugins>
void RequirePlugins ()
 Add a plugin to the core.
template<CScheduler TScheduler, typename... Args>
TScheduler & RegisterScheduler (Args &&...args)
 Register a scheduler in the core.
CoreGetCore ()
 Get a reference to the core. This can be used to register systems and resources in the Bind method.
Public Member Functions inherited from Engine::IPlugin
virtual ~IPlugin ()=default
 Virtual destructor for IPlugin.

Detailed Description

Plugin for camera movement control.

This plugin provides camera movement functionality with customizable behaviors. It requires Object, Input, and Window plugins to be loaded.

After binding the plugin, the user must set the active camera entity using:

auto& cameraManager = core.GetResource<CameraMovement::Resource::CameraManager>();
cameraManager.SetActiveCamera(cameraEntity);
CameraManager is a resource that manages the active camera entity.
Definition CameraManager.hpp:24
void SetActiveCamera(Engine::Entity entity)
Set the active camera entity.
Definition CameraManager.hpp:36

Constructor & Destructor Documentation

◆ Plugin()

CameraMovement::Plugin::Plugin ( Engine::Core & core)
explicit

◆ ~Plugin()

CameraMovement::Plugin::~Plugin ( )
overridedefault

Member Function Documentation

◆ Bind()

void CameraMovement::Plugin::Bind ( )
overridevirtual

Pure virtual method that must be implemented by derived plugin classes. This method is called when the plugin is added to the engine, and is where the plugin should register its systems, resources, and any other functionality it provides to the engine.

See also
Engine::Core
Engine::APlugin

Implements Engine::APlugin.


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