#include <coVRPluginList.h>

Public Types
enum	PluginDomain { Default , Vis , Window , Input , NumPluginDomains }

Public Member Functions
void	loadDefault ()
	load configured plugins More...

coVRPlugin *	getPlugin (const char *name) const
	returns the plugin called name More...

coVRPlugin *	addPlugin (const char *name, PluginDomain domain=Default)
	load a plugin, call init, add to list of managed plugins More...

void	unload (coVRPlugin *m)
	mark plugin for unloading More...

void	notify (int level, const char *text) const
	call notify method of all plugins More...

void	addNode (osg::Node , const RenderObject o=NULL, coVRPlugin *addingPlugin=NULL) const
	call addNode method of all plugins More...

void	addObject (const RenderObject container, osg::Group root, const RenderObject geometry, const RenderObject normals, const RenderObject colors, const RenderObject texture) const
	call addObject method of all plugins More...

void	newInteractor (const RenderObject container, coInteractor it) const
	call newInteractor method of all plugins More...

bool	requestInteraction (coInteractor inter, osg::Node triggerNode, bool isMouse)
	call enableInteraction method of all plugins until one is accepting the request More...

void	coviseError (const char *error) const
	call coviseError method of all plugins More...

void	guiToRenderMsg (const char *msg) const
	call guiToRenderMsg method of all plugins More...

void	removeObject (const char *objName, bool replaceFlag) const
	call removeObject method of all plugins More...

void	removeNode (osg::Node node, bool isGroup=false, osg::Node realNode=NULL) const
	call removeNode method of all plugins More...

bool	update () const
	call update method of all plugins More...

void	preFrame ()
	call preFrame method of all plugins More...

void	postFrame () const
	call postFrame method of all plugins More...

void	preDraw (osg::RenderInfo &renderInfo) const
	call preDraw method of all plugins More...

void	preSwapBuffers (int windowNumber) const
	call preSwapBuffers method of all plugins More...

void	clusterSyncDraw () const
	call clusterSyncDraw() method of all plugins More...

void	postSwapBuffers (int windowNumber) const
	call postSwapBuffers method of all plugins More...

void	param (const char *paramName, bool inMapLoading) const
	call param method of all plugins More...

bool	key (int type, int keySym, int mod) const
	call key method of all plugins More...

bool	userEvent (int mod) const
	call userEvent method of all plugins More...

void	requestTimestep (int timestep)
	call requestTimestep method of all plugins More...

void	setTimestep (int timestep)
	call setTimestep method of all plugins More...

void	message (int toWhom, int t, int l, const void *b) const
	send a message to all plugins More...

void	UDPmessage (covise::UdpMessage *msg) const
	send a UDPmessage to all plugins More...

void	forwardMessage (const covise::DataHandle &dh) const

void	requestQuit (bool killSession) const
	request to terminate COVER or COVISE session More...

bool	sendVisMessage (const covise::Message *msg) const
	send a message to COVISE/visualisation system - delivered via only one plugin More...

bool	becomeCollaborativeMaster () const
	request to become master of a collaborative session - return true if delivered More...

covise::Message *	waitForVisMessage (int messageType) const
	for visualisation system plugins: wait for message, return NULL if no such plugin More...

bool	executeAll () const
	for visualisation system plugins: execute data flow network - return true if delivered More...

void	expandBoundingSphere (osg::BoundingSphere &bs) const
	allow plugins to expand scene bounding sphere More...

void	commitTimestep (int t, coVRPlugin *caller)
	called by plugin's commitTimestep method when timestep is prepared More...

void	unloadAllPlugins (PluginDomain domain=Default)

Static Public Member Functions
static coVRPluginList *	instance ()
	singleton More...

Friends
class	coVRPluginSupport

class	OpenCOVER

Member Enumeration Documentation

◆ PluginDomain

enum opencover::coVRPluginList::PluginDomain

Enumerator
Default
Vis
Window
Input
NumPluginDomains

Member Function Documentation

◆ addNode()

void opencover::coVRPluginList::addNode	(	osg::Node *	,
		const RenderObject *	o = `NULL`,
		coVRPlugin *	addingPlugin = `NULL`
	)		const

call addNode method of all plugins

◆ addObject()

void opencover::coVRPluginList::addObject	(	const RenderObject *	container,
		osg::Group *	root,
		const RenderObject *	geometry,
		const RenderObject *	normals,
		const RenderObject *	colors,
		const RenderObject *	texture
	)		const

call addObject method of all plugins

◆ addPlugin()

coVRPlugin * opencover::coVRPluginList::addPlugin	(	const char *	name,
		PluginDomain	domain = `Default`
	)

load a plugin, call init, add to list of managed plugins

◆ becomeCollaborativeMaster()

bool opencover::coVRPluginList::becomeCollaborativeMaster ( ) const

request to become master of a collaborative session - return true if delivered

◆ clusterSyncDraw()

void opencover::coVRPluginList::clusterSyncDraw ( ) const

call clusterSyncDraw() method of all plugins

◆ commitTimestep()

void opencover::coVRPluginList::commitTimestep	(	int	t,
		coVRPlugin *	caller
	)

called by plugin's commitTimestep method when timestep is prepared

◆ coviseError()

void opencover::coVRPluginList::coviseError ( const char * error ) const

call coviseError method of all plugins

◆ executeAll()

bool opencover::coVRPluginList::executeAll ( ) const

for visualisation system plugins: execute data flow network - return true if delivered

◆ expandBoundingSphere()

void opencover::coVRPluginList::expandBoundingSphere ( osg::BoundingSphere & bs ) const

allow plugins to expand scene bounding sphere

◆ forwardMessage()

void opencover::coVRPluginList::forwardMessage ( const covise::DataHandle & dh ) const

add new plugins, if not already loaded unpack and distribute a Message

◆ getPlugin()

coVRPlugin * opencover::coVRPluginList::getPlugin ( const char * name ) const

returns the plugin called name

◆ guiToRenderMsg()

void opencover::coVRPluginList::guiToRenderMsg ( const char * msg ) const

call guiToRenderMsg method of all plugins

◆ instance()

static coVRPluginList * opencover::coVRPluginList::instance ( )

static

singleton

◆ key()

bool opencover::coVRPluginList::key	(	int	type,
		int	keySym,
		int	mod
	)		const

call key method of all plugins

◆ loadDefault()

void opencover::coVRPluginList::loadDefault ( )

load configured plugins

◆ message()

void opencover::coVRPluginList::message	(	int	toWhom,
		int	t,
		int	l,
		const void *	b
	)		const

send a message to all plugins

◆ newInteractor()

void opencover::coVRPluginList::newInteractor	(	const RenderObject *	container,
		coInteractor *	it
	)		const

call newInteractor method of all plugins

◆ notify()

void opencover::coVRPluginList::notify	(	int	level,
		const char *	text
	)		const

call notify method of all plugins

◆ param()

void opencover::coVRPluginList::param	(	const char *	paramName,
		bool	inMapLoading
	)		const

call param method of all plugins

◆ postFrame()

void opencover::coVRPluginList::postFrame ( ) const

call postFrame method of all plugins

◆ postSwapBuffers()

void opencover::coVRPluginList::postSwapBuffers ( int windowNumber ) const

call postSwapBuffers method of all plugins

◆ preDraw()

void opencover::coVRPluginList::preDraw ( osg::RenderInfo & renderInfo ) const

call preDraw method of all plugins

◆ preFrame()

void opencover::coVRPluginList::preFrame ( )

call preFrame method of all plugins

◆ preSwapBuffers()

void opencover::coVRPluginList::preSwapBuffers ( int windowNumber ) const

call preSwapBuffers method of all plugins

◆ removeNode()

void opencover::coVRPluginList::removeNode	(	osg::Node *	node,
		bool	isGroup = `false`,
		osg::Node *	realNode = `NULL`
	)		const

call removeNode method of all plugins

◆ removeObject()

void opencover::coVRPluginList::removeObject	(	const char *	objName,
		bool	replaceFlag
	)		const

call removeObject method of all plugins

◆ requestInteraction()

bool opencover::coVRPluginList::requestInteraction	(	coInteractor *	inter,
		osg::Node *	triggerNode,
		bool	isMouse
	)

call enableInteraction method of all plugins until one is accepting the request

◆ requestQuit()

void opencover::coVRPluginList::requestQuit ( bool killSession ) const

request to terminate COVER or COVISE session

◆ requestTimestep()

void opencover::coVRPluginList::requestTimestep ( int timestep )

call requestTimestep method of all plugins

◆ sendVisMessage()

bool opencover::coVRPluginList::sendVisMessage ( const covise::Message * msg ) const

send a message to COVISE/visualisation system - delivered via only one plugin

◆ setTimestep()

void opencover::coVRPluginList::setTimestep ( int timestep )

call setTimestep method of all plugins

◆ UDPmessage()

void opencover::coVRPluginList::UDPmessage ( covise::UdpMessage * msg ) const

send a UDPmessage to all plugins

◆ unload()

void opencover::coVRPluginList::unload ( coVRPlugin * m )

mark plugin for unloading

◆ unloadAllPlugins()

void opencover::coVRPluginList::unloadAllPlugins ( PluginDomain domain = Default )

◆ update()

bool opencover::coVRPluginList::update ( ) const

call update method of all plugins

◆ userEvent()

bool opencover::coVRPluginList::userEvent ( int mod ) const

call userEvent method of all plugins

◆ waitForVisMessage()

covise::Message * opencover::coVRPluginList::waitForVisMessage ( int messageType ) const

for visualisation system plugins: wait for message, return NULL if no such plugin

Friends And Related Function Documentation

◆ coVRPluginSupport

friend class coVRPluginSupport

friend

◆ OpenCOVER

friend class OpenCOVER