Inheritance diagram for FileOpenVolumeMeshPlugin:

Public Slots
int	loadObject (QString _filename)

bool	saveObject (int _id, QString _filename)

QString	version ()

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	emptyObjectAdded (int _id)

void	updateView ()

void	updatedObject (int _id, const UpdateType &_type)

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 FileInterface
virtual void	openedFile (int _id)
	This signal has to be emitted if an object has been loaded from a file.

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

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

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.

virtual void	getScriptingEngine (QScriptEngine *&_engine)

virtual void	executeFileScript (QString _filename)

virtual void	getAvailableFunctions (QStringList &_functions)

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

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

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

QString	getSaveFilters ()

QString	getLoadFilters ()

QWidget *	saveOptionsWidget (QString _currentFilter)

QWidget *	loadOptionsWidget (QString _currentFilter)

Private Slots
void	fileOpened (int)

void	loadIniFileLast (INIFile &_ini, int _id)

void	saveIniFile (INIFile &_ini, int _id)

void	initializePlugin ()

void	noguiSupported ()

Private Slots inherited from BaseInterface
virtual void	exit ()

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

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

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

Private Member Functions
template<typename MeshT >
void	loadMesh (const char *_filename, MeshT &_mesh, bool _comp, bool _topCheck)

template<typename MeshT >
void	saveMesh (const char *_filename, MeshT &_mesh, bool _comp)

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 FileInterface
virtual	~FileInterface ()
	Destructor.

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

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

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.

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

virtual void	deleteAllObjects ()
	Delete all Objects.

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

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

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

virtual void	showScriptInEditor (QString _filename)

virtual void	executeScript (QString _script)

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

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

Private Attributes
QWidget *	loadOptions_

QWidget *	saveOptions_

QComboBox *	typeCheck_

QCheckBox *	loadCompMode_

QCheckBox *	loadTopCheck_

QCheckBox *	saveCompMode_

OpenVolumeMesh::IO::FileManager	fileManager_

Detailed Description

Definition at line 66 of file FileOpenVolumeMesh.hh.

Constructor & Destructor Documentation

◆ FileOpenVolumeMeshPlugin()

FileOpenVolumeMeshPlugin::FileOpenVolumeMeshPlugin ( )

Definition at line 56 of file FileOpenVolumeMesh.cc.

Member Function Documentation

◆ description()

QString FileOpenVolumeMeshPlugin::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 117 of file FileOpenVolumeMesh.hh.

◆ fileOpened

void FileOpenVolumeMeshPlugin::fileOpened ( int )

inlineprivateslot

Definition at line 100 of file FileOpenVolumeMesh.hh.

◆ getLoadFilters()

QString FileOpenVolumeMeshPlugin::getLoadFilters ( )

virtual

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

Implements FileInterface.

Definition at line 108 of file FileOpenVolumeMesh.cc.

◆ getSaveFilters()

QString FileOpenVolumeMeshPlugin::getSaveFilters ( )

virtual

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

Implements FileInterface.

Definition at line 116 of file FileOpenVolumeMesh.cc.

◆ initializePlugin

void FileOpenVolumeMeshPlugin::initializePlugin ( )

privateslot

Definition at line 68 of file FileOpenVolumeMesh.cc.

◆ loadIniFileLast

void FileOpenVolumeMeshPlugin::loadIniFileLast	(	INIFile &	_ini,
		int	_id
	)

privateslot

Definition at line 324 of file FileOpenVolumeMesh.cc.

◆ loadMesh()

template<typename MeshT >

void FileOpenVolumeMeshPlugin::loadMesh	(	const char *	_filename,
		MeshT &	_mesh,
		bool	_comp,
		bool	_topCheck
	)

private

Definition at line 50 of file FileOpenVolumeMeshT_impl.hh.

◆ loadObject

int FileOpenVolumeMeshPlugin::loadObject ( QString _filename )

slot

Definition at line 136 of file FileOpenVolumeMesh.cc.

◆ loadOptionsWidget()

QWidget * FileOpenVolumeMeshPlugin::loadOptionsWidget ( QString _currentFilter )

virtual

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 369 of file FileOpenVolumeMesh.cc.

◆ name()

QString FileOpenVolumeMeshPlugin::name ( )

inlinevirtual

Return a name for the plugin.

This Function has to return the name of the plugin.

Implements BaseInterface.

Definition at line 113 of file FileOpenVolumeMesh.hh.

◆ noguiSupported

void FileOpenVolumeMeshPlugin::noguiSupported ( )

inlineprivateslot

Definition at line 107 of file FileOpenVolumeMesh.hh.

◆ saveIniFile

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

privateslot

Definition at line 345 of file FileOpenVolumeMesh.cc.

◆ saveMesh()

template<typename MeshT >

void FileOpenVolumeMeshPlugin::saveMesh	(	const char *	_filename,
		MeshT &	_mesh,
		bool	_comp
	)

private

Definition at line 270 of file FileOpenVolumeMeshT_impl.hh.

◆ saveObject

bool FileOpenVolumeMeshPlugin::saveObject	(	int	_id,
		QString	_filename
	)

slot

Definition at line 271 of file FileOpenVolumeMesh.cc.

◆ saveOptionsWidget()

QWidget * FileOpenVolumeMeshPlugin::saveOptionsWidget ( QString _currentFilter )

virtual

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 362 of file FileOpenVolumeMesh.cc.

◆ supportedType()

DataType FileOpenVolumeMeshPlugin::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 124 of file FileOpenVolumeMesh.cc.

◆ version

QString FileOpenVolumeMeshPlugin::version ( )

inlineslot

Definition at line 135 of file FileOpenVolumeMesh.hh.

Member Data Documentation

◆ fileManager_

OpenVolumeMesh::IO::FileManager FileOpenVolumeMeshPlugin::fileManager_

private

Definition at line 158 of file FileOpenVolumeMesh.hh.

◆ loadCompMode_

QCheckBox* FileOpenVolumeMeshPlugin::loadCompMode_

private

Definition at line 154 of file FileOpenVolumeMesh.hh.

◆ loadOptions_

QWidget* FileOpenVolumeMeshPlugin::loadOptions_

private

Definition at line 149 of file FileOpenVolumeMesh.hh.

◆ loadTopCheck_

QCheckBox* FileOpenVolumeMeshPlugin::loadTopCheck_

private

Definition at line 155 of file FileOpenVolumeMesh.hh.

◆ saveCompMode_

QCheckBox* FileOpenVolumeMeshPlugin::saveCompMode_

private

Definition at line 156 of file FileOpenVolumeMesh.hh.

◆ saveOptions_

QWidget* FileOpenVolumeMeshPlugin::saveOptions_

private

Definition at line 150 of file FileOpenVolumeMesh.hh.

◆ typeCheck_

QComboBox* FileOpenVolumeMeshPlugin::typeCheck_

private

Definition at line 152 of file FileOpenVolumeMesh.hh.

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

PluginCollection-FilePlugins/Plugin-FileOVM/FileOpenVolumeMesh.hh
PluginCollection-FilePlugins/Plugin-FileOVM/FileOpenVolumeMesh.cc
PluginCollection-FilePlugins/Plugin-FileOVM/FileOpenVolumeMeshT_impl.hh

Public Slots

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FileOpenVolumeMeshPlugin()

Member Function Documentation

◆ description()

◆ fileOpened

◆ getLoadFilters()

◆ getSaveFilters()

◆ initializePlugin

◆ loadIniFileLast

◆ loadMesh()

◆ loadObject

◆ loadOptionsWidget()

◆ name()

◆ noguiSupported

◆ saveIniFile

◆ saveMesh()

◆ saveObject

◆ saveOptionsWidget()

◆ supportedType()

◆ version

Member Data Documentation

◆ fileManager_

◆ loadCompMode_

◆ loadOptions_

◆ loadTopCheck_

◆ saveCompMode_

◆ saveOptions_

◆ typeCheck_