Inheritance diagram for FileSKLPlugin:

Public Slots
int	loadObject (QString _filename)

bool	saveObject (int _id, QString _filename)

Signals
void	openedFile (int _id)

void	addEmptyObject (DataType _type, int &_id)

void	load (QString _filename, DataType _type, int &_id)

void	save (int _id, QString _filename)

void	log (Logtype _type, QString _message)

void	log (QString _message)

void	updatedObject (int _identifier, const UpdateType &_type)

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

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

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

Signals inherited from FileInterface
virtual void	openedFile (int _id)
	This signal has to be emitted if an object has been loaded from a file. More...

Signals inherited from LoadSaveInterface
virtual void	save (int _id, QString _filename)
	Save object to a file. More...

virtual void	load (QString _filename, DataType _type, int &_id)
	Load object from file with a specific DataType. More...

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

virtual void	log (QString _message)=0

Signals inherited from ScriptInterface
virtual void	scriptInfo (QString _functionWithParameters)
	Emit this signal if a scriptable function is executed. More...

virtual void	getScriptingEngine (QScriptEngine *&_engine)

virtual void	executeScript (QString _script)

virtual void	getAvailableFunctions (QStringList &_functions)

Public Member Functions
QString	name ()
	Return a name for the plugin. More...

QString	description ()
	Return a description of what the plugin is doing. More...

DataType	supportedType ()
	Return your supported object type( e.g. DATA_TRIANGLE_MESH ) More...

QString	getSaveFilters ()

QString	getLoadFilters ()

QWidget *	saveOptionsWidget (QString)

QWidget *	loadOptionsWidget (QString)

Private Slots
void	fileOpened (int)

Private Slots inherited from BaseInterface
virtual void	exit ()

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

Private Slots inherited from FileInterface
virtual int	loadObject (QString _filename)=0
	Load an object from the given file. More...

virtual int	loadObject (QString _filename, DataType _type)
	Load an object from the given file. More...

Private Member Functions
void	loadIniFile (INIFile &_ini, int _id)
	Load per object settings. More...

void	saveIniFile (INIFile &_ini, int _id)
	Save per object settings. More...

void	noguiSupported ()

void	initializePlugin ()
	Initialize Plugin. More...

template<typename Skeleton >
bool	LoadSkeleton (Skeleton *_pSkeleton, QString _filename)

template<typename Skeleton >
bool	SaveSkeleton (Skeleton *_pSkeleton, QString _filename)

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

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

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

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

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

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

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

virtual bool	saveObject (int _id, QString _filename)=0
	Save an object from the given file. More...

virtual bool	saveObjects (IdList _ids, QString _filename)
	Save multiple objects to one file. More...

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

virtual void	addEmptyObject (DataType _type, int &_id)

virtual void	copyObject (int _oldId, int &_newId)

virtual void	emptyObjectAdded (int _id)
	DEPRECATED HERE (Moved to Type Interface)! Emit this signal if an empty object has been created. More...

virtual void	deleteObject (int _id)
	Delete an object This signal can be called from any thread. . More...

virtual void	deleteAllObjects ()
	Delete all Objects. More...

virtual void	getAllFileFilters (QStringList &_filters)
	Get all file filters that are registered. More...

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

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

virtual void	executeFileScript (QString _filename)

virtual void	getDescription (QString _function, QString &_description, QStringList &_parameters, QStringList &_descriptions)

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

Detailed Description

Definition at line 57 of file FileSkeleton.hh.

Member Function Documentation

◆ description()

QString FileSKLPlugin::description ( )

inlinevirtual

Return a description of what the plugin is doing.

This function has to return a basic description of the plugin

Implements BaseInterface.

Definition at line 92 of file FileSkeleton.hh.

◆ getLoadFilters()

QString FileSKLPlugin::getLoadFilters ( )

virtual

Return the Qt Filters for File dialogs when loading files (e.g. "Off files ( *.off )" )

Implements FileInterface.

Definition at line 53 of file FileSkeleton.cc.

◆ getSaveFilters()

QString FileSKLPlugin::getSaveFilters ( )

virtual

Get the Qt Filters for Filedialogs when saving files (e.g. "Off files ( *.off )" )

Implements FileInterface.

Definition at line 57 of file FileSkeleton.cc.

◆ initializePlugin()

void FileSKLPlugin::initializePlugin ( )

privatevirtual

Initialize Plugin.

This slot is called if the plugin is loaded and has to be initialized. All initialization stuff in this slot has to stay inside the plugin, no external signals are allowed here (and will be ignored). Don't create any objects via PluginFunctions here. Use the pluginsInitialized() slot for external initialization. After execution of this slot your plugin should be fully functional. Only gui elements may be uninitialized and should be created in pluginsInitialized().

Reimplemented from BaseInterface.

Definition at line 50 of file FileSkeleton.cc.

◆ loadIniFile()

void FileSKLPlugin::loadIniFile	(	INIFile &	_ini,
		int	_id
	)

privatevirtual

Load per object settings.

Every time the core opens a settings file containing objects the core will call this slot for each object it finds. The object itself is loaded before the slot is called. Therefore the object is available from within your plugin.

Parameters

_ini	ini file
_id	Id of the object to load data for

Reimplemented from INIInterface.

Definition at line 333 of file FileSkeleton.cc.

◆ loadOptionsWidget()

QWidget* FileSKLPlugin::loadOptionsWidget ( QString _currentFilter )

inlinevirtual

You can provide a special widget showing options for loading your file types depending on the current filter

_currentFilter: one filter from loadFilters

Return 0 when you don't need one

Implements FileInterface.

Definition at line 100 of file FileSkeleton.hh.

◆ name()

QString FileSKLPlugin::name ( )

inlinevirtual

Return a name for the plugin.

This Function has to return the name of the plugin.

Implements BaseInterface.

Definition at line 91 of file FileSkeleton.hh.

◆ noguiSupported()

void FileSKLPlugin::noguiSupported ( )

inlineprivatevirtual

Using this function you can inform the core that your plugin can run without creating a widget. If your plugin does not implement this function, it will not be loaded in scripting mode without gui. You don't have to do anything in this function.

Reimplemented from BaseInterface.

Definition at line 83 of file FileSkeleton.hh.

◆ saveIniFile()

void FileSKLPlugin::saveIniFile	(	INIFile &	_ini,
		int	_id
	)

privatevirtual

Save per object settings.

Every time a settings file is created this slot is called once per object. Here you can write additional information handled by your plugin which is attached to the object.

Parameters

_ini	ini file
_id	Identifier of the object to save

Reimplemented from INIInterface.

Definition at line 349 of file FileSkeleton.cc.

◆ saveOptionsWidget()

QWidget* FileSKLPlugin::saveOptionsWidget ( QString _currentFilter )

inlinevirtual

You can provide a special widget showing options for saving your file types depending on the current filter

_currentFilter: one filter from saveFilters

Return 0 when you don't need one

Implements FileInterface.

Definition at line 99 of file FileSkeleton.hh.

◆ supportedType()

DataType FileSKLPlugin::supportedType ( )

virtual

Return your supported object type( e.g. DATA_TRIANGLE_MESH )

If you support multiple DataTypes you can combine them bitwise here. The function is used from the load and save code to check if your plugin can handle an object of a given dataType.

Implements FileInterface.

Definition at line 61 of file FileSkeleton.cc.

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

PluginCollection-FilePlugins/Plugin-FileSKL/FileSkeleton.hh
PluginCollection-FilePlugins/Plugin-FileSKL/FileSkeleton.cc

Public Slots

Signals

Public Member Functions

Private Slots

Private Member Functions

Detailed Description

Member Function Documentation

◆ description()

◆ getLoadFilters()

◆ getSaveFilters()

◆ initializePlugin()

◆ loadIniFile()

◆ loadOptionsWidget()

◆ name()

◆ noguiSupported()

◆ saveIniFile()

◆ saveOptionsWidget()

◆ supportedType()