ccPluginInterface Class Reference

Standard ECV plugin interface. More...

#include <ecvPluginInterface.h>

Inheritance diagram for ccPluginInterface:

Classes
struct	Contact
struct	Reference

Public Types
typedef QList< Contact >	ContactList
using	ReferenceList = QList< Reference >

Public Member Functions
virtual	~ccPluginInterface ()=default
	Virtual destructor. More...
virtual CC_PLUGIN_TYPE	getType () const =0
	Returns plugin type (standard or OpenGL filter) More...
virtual bool	isCore () const =0
	Is this plugin a core plugin? More...
virtual QString	getName () const =0
	Returns (short) name (for menu entry, etc.) More...
virtual QString	getDescription () const =0
	Returns long name/description (for tooltip, etc.) More...
virtual QIcon	getIcon () const
	Returns icon. More...
virtual ReferenceList	getReferences () const
virtual ContactList	getAuthors () const
virtual ContactList	getMaintainers () const
virtual bool	start ()
	Starts the plugin. More...
virtual void	stop ()
	Stops the plugin. More...
virtual ccExternalFactory *	getCustomObjectsFactory () const
	Returns the plugin's custom object factory (if any) More...
virtual void	registerCommands (ccCommandLineInterface *cmd)
	Optional: registers commands (for the command line mode) More...

Protected Member Functions
virtual void	setIID (const QString &iid)=0
virtual const QString &	IID () const =0
	Get the IID of the plugin. More...

Detailed Description

Standard ECV plugin interface.

Version 3.2

Definition at line 33 of file ecvPluginInterface.h.

Member Typedef Documentation

ContactList

typedef QList<Contact> ccPluginInterface::ContactList

Definition at line 41 of file ecvPluginInterface.h.

ReferenceList

using ccPluginInterface::ReferenceList = QList<Reference>

Definition at line 50 of file ecvPluginInterface.h.

Constructor & Destructor Documentation

~ccPluginInterface()

virtual ccPluginInterface::~ccPluginInterface ( )

virtualdefault

Virtual destructor.

Member Function Documentation

getAuthors()

virtual ContactList ccPluginInterface::getAuthors ( ) const

inlinevirtual

Returns a list of the authors' names and email addresses This is optional. See qDummyPlugin for a real example. Added in v3.1 of the plugin interface.

Reimplemented in ccDefaultPluginInterface.

Definition at line 83 of file ecvPluginInterface.h.

getCustomObjectsFactory()

virtual ccExternalFactory* ccPluginInterface::getCustomObjectsFactory ( ) const

inlinevirtual

Returns the plugin's custom object factory (if any)

Plugins may provide a factory to build custom objects. This allows qCC_db to properly code and decode the custom objects stream in BIN files. Custom objects must inherit the ccCustomHObject or ccCustomLeafObject interfaces.

Definition at line 111 of file ecvPluginInterface.h.

Referenced by ccPluginManager::loadPlugins().

getDescription()

virtual QString ccPluginInterface::getDescription ( ) const

pure virtual

Returns long name/description (for tooltip, etc.)

Implemented in ccDefaultPluginInterface.

getIcon()

virtual QIcon ccPluginInterface::getIcon ( ) const

inlinevirtual

Returns icon.

Should be reimplemented if necessary

Reimplemented in ccDefaultPluginInterface.

Definition at line 71 of file ecvPluginInterface.h.

getMaintainers()

virtual ContactList ccPluginInterface::getMaintainers ( ) const

inlinevirtual

Returns a list of the maintainers' names and email addresses This is optional. See qDummyPlugin for a real example. Added in v3.1 of the plugin interface.

Reimplemented in ccDefaultPluginInterface.

Definition at line 89 of file ecvPluginInterface.h.

getName()

virtual QString ccPluginInterface::getName ( ) const

pure virtual

Returns (short) name (for menu entry, etc.)

Implemented in ccDefaultPluginInterface.

Referenced by ccPluginManager::loadPlugins().

getReferences()

virtual ReferenceList ccPluginInterface::getReferences ( ) const

inlinevirtual

Returns a list of references (articles and websites) for the plugin This is optional. See qDummyPlugin for a real example. Added in v3.1 of the plugin interface.

Reimplemented in ccDefaultPluginInterface.

Definition at line 77 of file ecvPluginInterface.h.

getType()

virtual CC_PLUGIN_TYPE ccPluginInterface::getType ( ) const

pure virtual

Returns plugin type (standard or OpenGL filter)

Implemented in ccStdPluginInterface, ccPclPluginInterface, and ccIOPluginInterface.

IID()

virtual const QString& ccPluginInterface::IID ( ) const

protectedpure virtual

Get the IID of the plugin.

Referenced by ccPluginManager::isEnabled(), and ccPluginManager::setPluginEnabled().

isCore()

virtual bool ccPluginInterface::isCore ( ) const

pure virtual

Is this plugin a core plugin?

Implemented in ccDefaultPluginInterface.

registerCommands()

virtual void ccPluginInterface::registerCommands ( ccCommandLineInterface *  cmd )

inlinevirtual

Optional: registers commands (for the command line mode)

Does nothing by default.

Warning

: don't use keywords that are already used by the main application or other plugins! (use a unique prefix for all commands if possible)

Reimplemented in PythonPlugin, qPCV, qCSF, and q3DMASCPlugin.

Definition at line 121 of file ecvPluginInterface.h.

setIID()

virtual void ccPluginInterface::setIID ( const QString &  iid )

protectedpure virtual

Set the IID of the plugin (which comes from Q_PLUGIN_METADATA). It is used to uniquely identify the plugin.

start()

virtual bool ccPluginInterface::start ( void  )

inlinevirtual

Starts the plugin.

Should be reimplemented if necessary. Used when 'starting' a plugin from the command line (to start a background service, a thread, etc.)

Definition at line 96 of file ecvPluginInterface.h.

Referenced by ccCompass::estimateStructureNormals().

stop()

virtual void ccPluginInterface::stop ( )

inlinevirtual

Stops the plugin.

Should be reimplemented if necessary. Used to stop a plugin previously started (see ccPluginInterface::start).

Reimplemented in PythonPlugin, and qPCL.

Definition at line 103 of file ecvPluginInterface.h.

---

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

• /root/ACloudViewer/libs/CVPluginStub/include/ecvPluginInterface.h