Data passed to the plugin constructor. More...

#include <PluginBase/PluginContext.hpp>

Collaboration diagram for Ra::Plugins::Context:

Signals
void	setContinuousUpdate (bool b)
	enable continuous rendering update

void	askForUpdate ()
	ask for single-shot rendering update

Public Member Functions
	Context (QObject *parent=nullptr)

Public Attributes
Engine::RadiumEngine *	m_engine { nullptr }

Gui::SelectionManager *	m_selectionManager { nullptr }

Gui::Timeline *	m_timeline { nullptr }

Gui::PickingManager *	m_pickingManager { nullptr }

Gui::Viewer *	m_viewer { nullptr }

std::string	m_exportDir { "." }

Detailed Description

Data passed to the plugin constructor.

Definition at line 22 of file PluginContext.hpp.

Constructor & Destructor Documentation

◆ Context()

Ra::Plugins::Context::Context ( QObject * parent = nullptr )

inlineexplicit

Definition at line 27 of file PluginContext.hpp.

Member Function Documentation

◆ askForUpdate

void Ra::Plugins::Context::askForUpdate ( )

signal

ask for single-shot rendering update

See also: BaseApplication::askForUpdate; setContinuousUpdate for usage example

◆ setContinuousUpdate

void Ra::Plugins::Context::setContinuousUpdate ( bool b )

signal

enable continuous rendering update

See also: BaseApplication::setContinuousUpdate

Usage: in your plugin, declare signals, and connect them to the PluginContext signals for forwarding:

class MyPlugin : public QObject, Ra::Plugins::RadiumPluginInterface
{
  void MyPlugin::registerPlugin( const Ra::Plugins::Context& context ) {
    connect( this, &MyPlugin::askForUpdate, &context, &Ra::Plugins::Context::askForUpdate );
    connect( this, &MyPlugin::setContinuousUpdate, &context,
&Ra::Plugins::Context::setContinuousUpdate );
  }
 
signals:
  void setContinuousUpdate( bool b );
  void askForUpdate();
};

Member Data Documentation

◆ m_engine

Engine::RadiumEngine* Ra::Plugins::Context::m_engine { nullptr }

Definition at line 29 of file PluginContext.hpp.

◆ m_exportDir

std::string Ra::Plugins::Context::m_exportDir { "." }

Definition at line 34 of file PluginContext.hpp.

◆ m_pickingManager

Gui::PickingManager* Ra::Plugins::Context::m_pickingManager { nullptr }

Definition at line 32 of file PluginContext.hpp.

◆ m_selectionManager

Gui::SelectionManager* Ra::Plugins::Context::m_selectionManager { nullptr }

Definition at line 30 of file PluginContext.hpp.

◆ m_timeline

Gui::Timeline* Ra::Plugins::Context::m_timeline { nullptr }

Definition at line 31 of file PluginContext.hpp.

◆ m_viewer

Gui::Viewer* Ra::Plugins::Context::m_viewer { nullptr }

Definition at line 33 of file PluginContext.hpp.

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

/home/runner/work/Radium-Engine/Radium-Engine/src/Radium-Engine/src/PluginBase/PluginContext.hpp

Signals

Public Member Functions

Public Attributes