Blue Brain BioExplorer
core::PluginAPI Class Referenceabstract

#include <Plugin.h>

Inheritance diagram for core::PluginAPI:

Public Member Functions

virtual ~PluginAPI ()=default
 
virtual EnginegetEngine ()=0
 
virtual ScenegetScene ()=0
 
virtual ParametersManagergetParametersManager ()=0
 
virtual ActionInterfacegetActionInterface ()=0
 
virtual KeyboardHandlergetKeyboardHandler ()=0
 
virtual AbstractManipulatorgetCameraManipulator ()=0
 
virtual CameragetCamera ()=0
 
virtual RenderergetRenderer ()=0
 
virtual void triggerRender ()=0
 
virtual void setActionInterface (const ActionInterfacePtr &interface)=0
 

Detailed Description

The API that plugins can use to interact with Core.

Definition at line 31 of file Plugin.h.

Constructor & Destructor Documentation

◆ ~PluginAPI()

virtual core::PluginAPI::~PluginAPI ( )
virtualdefault

Member Function Documentation

◆ getActionInterface()

virtual ActionInterface* core::PluginAPI::getActionInterface ( )
pure virtual
Returns
access to the action interface of Core.

Implemented in core::Core::Impl.

◆ getCamera()

virtual Camera& core::PluginAPI::getCamera ( )
pure virtual
Returns
access to the camera of Core.

Implemented in core::Core::Impl.

◆ getCameraManipulator()

virtual AbstractManipulator& core::PluginAPI::getCameraManipulator ( )
pure virtual
Returns
access to the camera manipulator of Core.

Implemented in core::Core::Impl.

◆ getEngine()

virtual Engine& core::PluginAPI::getEngine ( )
pure virtual

Implemented in core::Core::Impl.

◆ getKeyboardHandler()

virtual KeyboardHandler& core::PluginAPI::getKeyboardHandler ( )
pure virtual
Returns
access to the keyboard handler of Core.

Implemented in core::Core::Impl.

◆ getParametersManager()

virtual ParametersManager& core::PluginAPI::getParametersManager ( )
pure virtual
Returns
access to the parameters of Core.

Implemented in core::Core::Impl.

◆ getRenderer()

virtual Renderer& core::PluginAPI::getRenderer ( )
pure virtual
Returns
access to the renderer of Core.

Implemented in core::Core::Impl.

◆ getScene()

virtual Scene& core::PluginAPI::getScene ( )
pure virtual
Returns
access to the scene of Core.

Implemented in core::Core::Impl.

◆ setActionInterface()

virtual void core::PluginAPI::setActionInterface ( const ActionInterfacePtr interface)
pure virtual

Set the action interface to be used by Core main loop.

Implemented in core::Core::Impl.

◆ triggerRender()

virtual void core::PluginAPI::triggerRender ( )
pure virtual

Triggers a new preRender() and potentially render() and postRender().

Implemented in core::Core::Impl.


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