#include <Plugin-VSI/vsiPlugin.hh>

Inheritance diagram for VsiPlugin:

Public Slots
QString	askForInputs (QString _element, QString _inputs)
	Scripting function, that allows to ask the user for inputs during script execution.

void	messageBox (QString _message)
	Scripting function, that displays a message box.

bool	questionBox (QString _message)
	Scripting function, that displays a Yes/No message box.

bool	continueBox (QString _message)
	Shows a non blocking stop box for use inside loops.

QString	version ()

Signals
void	getMenubarMenu (QString _name, QMenu *&_menu, bool _create)

void	pluginExists (QString _pluginName, bool &_exists)

void	functionExists (QString _pluginName, QString _functionName, bool &_exists)

void	log (Logtype _type, QString _message)

void	log (QString _message)

void	executePythonScript (QString _script)

void	openPythonScriptInEditor (QString _script)

Signals inherited from BaseInterface
virtual void	updateView ()
	Update current view in Main Application.

virtual void	setSlotDescription (QString _slotName, QString _slotDescription, QStringList _parameters, QStringList _descriptions)
	Set a description for a public slot.

virtual void	setRenderer (unsigned int _viewer, QString _rendererName)
	Set a renderer for the given viewer.

Signals inherited from MenuInterface
virtual void	getMenubarMenu (QString _name, QMenu *&_menu, bool _create)
	Get a existing top level menu pointer or create a new one.

Signals inherited from RPCInterface
virtual void	pluginExists (QString _pluginName, bool &_exists)

Signals inherited from LoggingInterface
virtual void	log (Logtype _type, QString _message)=0

virtual void	log (QString _message)=0

Signals inherited from PythonInterface
virtual void	executePythonScript (QString _script)

Public Member Functions
	VsiPlugin ()
	Constructor.

	~VsiPlugin ()
	Destructor.

QString	name ()
	Name of the Plugin.

QString	description ()
	Description of the Plugin.

Private Slots
void	pluginsInitialized ()
	Register in menubar.

void	noguiSupported ()

Private Slots inherited from BaseInterface
virtual void	exit ()

virtual QString	version ()
	Return a version string for your plugin.

Private Member Functions
void	showScriptEditor ()
	Shows visual script editor.

void	showInScriptEditor (const QString &_script)
	Opens the text based script editor with the given script.

void	initContext ()
	initalisation

Private Member Functions inherited from BaseInterface
virtual void	noguiSupported ()

virtual	~BaseInterface ()
	Destructor.

virtual void	blockScenegraphUpdates (bool _block)
	Tell the core to prevent scenegraph updates.

virtual void	updatedObject (int _objectId)
	An object has been changed or added by this plugin.

virtual void	updatedObject (int _identifier, const UpdateType &_type)
	An object has been changed or added by this plugin.

virtual void	nodeVisibilityChanged (int _identifier)
	A scenegraph node has been shown or hidden.

virtual void	getCurrentRenderer (unsigned int _viewer, QString &_rendererName)
	Get the current renderer for the given viewer.

Private Member Functions inherited from MenuInterface
virtual	~MenuInterface ()
	Destructor.

virtual void	addMenubarAction (QAction *_action, QString _name)
	Adds an action to the menubar.

virtual void	addMenubarActions (std::vector< QAction * > &_actions, QString _name)
	Add multiple actions to the menu bar.

Private Member Functions inherited from RPCInterface
virtual	~RPCInterface ()
	Destructor.

virtual void	functionExists (QString _pluginName, QString _functionName, bool &_exists)

Private Member Functions inherited from LoggingInterface
virtual	~LoggingInterface ()
	Destructor.

Private Member Functions inherited from PythonInterface
virtual void	openPythonScriptInEditor (QString _script)

virtual	~PythonInterface ()
	Destructor.

Private Attributes
VSI::Context *	context_

VSI::BaseWidget *	baseWidget_

Detailed Description

Plugin that provides a visual scripting interface

Definition at line 71 of file vsiPlugin.hh.

Constructor & Destructor Documentation

◆ VsiPlugin()

VsiPlugin::VsiPlugin ( )

Constructor.

Definition at line 69 of file vsiPlugin.cc.

◆ ~VsiPlugin()

VsiPlugin::~VsiPlugin ( )

Destructor.

Definition at line 78 of file vsiPlugin.cc.

Member Function Documentation

◆ askForInputs

QString VsiPlugin::askForInputs	(	QString	_element,
		QString	_inputs
	)

slot

Scripting function, that allows to ask the user for inputs during script execution.

Gererates a dialog for the given element inputs.

Definition at line 169 of file vsiPlugin.cc.

◆ continueBox

bool VsiPlugin::continueBox ( QString _message )

slot

Shows a non blocking stop box for use inside loops.

Non blocking box which can be used inside scripting loops to stop on clicks.

Definition at line 267 of file vsiPlugin.cc.

◆ description()

QString VsiPlugin::description ( )

inlinevirtual

Description of the Plugin.

Implements BaseInterface.

Definition at line 111 of file vsiPlugin.hh.

◆ initContext()

void VsiPlugin::initContext ( )

private

initalisation

initalize context

Definition at line 125 of file vsiPlugin.cc.

◆ messageBox

void VsiPlugin::messageBox ( QString _message )

slot

Scripting function, that displays a message box.

Definition at line 244 of file vsiPlugin.cc.

◆ name()

QString VsiPlugin::name ( )

inlinevirtual

Name of the Plugin.

Implements BaseInterface.

Definition at line 108 of file vsiPlugin.hh.

◆ noguiSupported

void VsiPlugin::noguiSupported ( )

inlineprivateslot

Definition at line 132 of file vsiPlugin.hh.

◆ pluginsInitialized

void VsiPlugin::pluginsInitialized ( )

privateslot

Register in menubar.

Definition at line 89 of file vsiPlugin.cc.

◆ questionBox

bool VsiPlugin::questionBox ( QString _message )

slot

Scripting function, that displays a Yes/No message box.

Definition at line 254 of file vsiPlugin.cc.

◆ showInScriptEditor()

void VsiPlugin::showInScriptEditor ( const QString & _script )

private

Opens the text based script editor with the given script.

shows the given script in the textual script editor

Definition at line 226 of file vsiPlugin.cc.

◆ showScriptEditor()

void VsiPlugin::showScriptEditor ( )

private

Shows visual script editor.

Show visual script editor.

Definition at line 111 of file vsiPlugin.cc.

◆ version

QString VsiPlugin::version ( )

inlineslot

Definition at line 127 of file vsiPlugin.hh.

Member Data Documentation

◆ baseWidget_

VSI::BaseWidget* VsiPlugin::baseWidget_

private

Definition at line 148 of file vsiPlugin.hh.

◆ context_

VSI::Context* VsiPlugin::context_

private

Definition at line 147 of file vsiPlugin.hh.

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

Plugin-VSI/vsiPlugin.hh
Plugin-VSI/vsiPlugin.cc

Public Slots

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VsiPlugin()

◆ ~VsiPlugin()

Member Function Documentation

◆ askForInputs

◆ continueBox

◆ description()

◆ initContext()

◆ messageBox

◆ name()

◆ noguiSupported

◆ pluginsInitialized

◆ questionBox

◆ showInScriptEditor()

◆ showScriptEditor()

◆ version

Member Data Documentation

◆ baseWidget_

◆ context_