Developer Documentation
Loading...
Searching...
No Matches
FilePTSPlugin Class Reference
Inheritance diagram for FilePTSPlugin:
AboutInfoInterface RPCInterface ScriptInterface LoggingInterface LoadSaveInterface FileInterface BaseInterface

Public Slots

QString version ()
 
int loadObject (QString _filename)
 
bool saveObject (int _objectId, QString _filename)
 

Signals

void openedFile (int _objectId)
 
void addEmptyObject (DataType _type, int &_objectId)
 
void deleteObject (int _objectId)
 
void updatedObject (int _objectId, const UpdateType &_type)
 
void log (QString _message)
 
void log (Logtype _type, QString _message)
 
void addAboutInfo (QString _text, QString _tabName)
 
- 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)
 
- Signals inherited from RPCInterface
virtual void pluginExists (QString _pluginName, bool &_exists)
 
- Signals inherited from AboutInfoInterface
virtual void addAboutInfo (QString _text, QString _tabName)
 Adds a widget to OpenFlippers about dialog.
 

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)
 
QWidget * loadOptionsWidget (QString)
 

Private Slots

void initializePlugin ()
 
void noguiSupported ()
 
void slotUpdateSaveColorRange ()
 
void slotLoadMakeDefaultButtonClicked ()
 
void slotSaveMakeDefaultButtonClicked ()
 
- 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

bool readBinaryFile (const char *_filename, SplatCloud &_splatCloud)
 
bool readTextFile (const char *_filename, AdaptorBase &_adaptor)
 
bool writeBinaryFile (const char *_filename, const SplatCloudNode *_splatCloudNode)
 
bool writeTextFile (const char *_filename, const SplatCloudNode *_splatCloudNode)
 
bool readCompressedBinaryChunk (FILE *_file, size_t _compressedSize, char *_dst)
 
std::vector< ReadObject > getReadObjectOrder ()
 
- 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 RPCInterface
virtual ~RPCInterface ()
 Destructor.
 
virtual void functionExists (QString _pluginName, QString _functionName, bool &_exists)
 
- Private Member Functions inherited from AboutInfoInterface
virtual ~AboutInfoInterface ()
 Destructor.
 

Private Attributes

ptsLoadWigetloadOptions_
 
QWidget * saveOptions_
 
QCheckBox * saveBinaryFile_
 
QCheckBox * saveNormals_
 
QCheckBox * savePointsizes_
 
QCheckBox * saveColors_
 
QComboBox * saveColorRange_
 
QCheckBox * saveIndices_
 
QPushButton * saveMakeDefaultButton_
 

Detailed Description

Definition at line 120 of file FilePTS.hh.

Constructor & Destructor Documentation

◆ FilePTSPlugin()

FilePTSPlugin::FilePTSPlugin ( )

Definition at line 211 of file FilePTS.cc.

◆ ~FilePTSPlugin()

FilePTSPlugin::~FilePTSPlugin ( )
inline

Definition at line 160 of file FilePTS.hh.

Member Function Documentation

◆ description()

QString FilePTSPlugin::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 164 of file FilePTS.hh.

◆ getLoadFilters()

QString FilePTSPlugin::getLoadFilters ( )
inlinevirtual

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

Implements FileInterface.

Definition at line 171 of file FilePTS.hh.

◆ getReadObjectOrder()

std::vector< ReadObject > FilePTSPlugin::getReadObjectOrder ( )
private

Definition at line 567 of file FilePTS.cc.

◆ getSaveFilters()

QString FilePTSPlugin::getSaveFilters ( )
inlinevirtual

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

Implements FileInterface.

Definition at line 170 of file FilePTS.hh.

◆ initializePlugin

void FilePTSPlugin::initializePlugin ( )
privateslot

Definition at line 225 of file FilePTS.cc.

◆ loadObject

int FilePTSPlugin::loadObject ( QString  _filename)
slot

Definition at line 1129 of file FilePTS.cc.

◆ loadOptionsWidget()

QWidget * FilePTSPlugin::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 1353 of file FilePTS.cc.

◆ name()

QString FilePTSPlugin::name ( )
inlinevirtual

Return a name for the plugin.

This Function has to return the name of the plugin.

Implements BaseInterface.

Definition at line 163 of file FilePTS.hh.

◆ noguiSupported

void FilePTSPlugin::noguiSupported ( )
inlineprivateslot

Definition at line 154 of file FilePTS.hh.

◆ readBinaryFile()

bool FilePTSPlugin::readBinaryFile ( const char *  _filename,
SplatCloud _splatCloud 
)
private

Definition at line 300 of file FilePTS.cc.

◆ readCompressedBinaryChunk()

bool FilePTSPlugin::readCompressedBinaryChunk ( FILE *  _file,
size_t  _compressedSize,
char *  _dst 
)
private

Definition at line 1119 of file FilePTS.cc.

◆ readTextFile()

bool FilePTSPlugin::readTextFile ( const char *  _filename,
AdaptorBase _adaptor 
)
private

Definition at line 619 of file FilePTS.cc.

◆ saveObject

bool FilePTSPlugin::saveObject ( int  _objectId,
QString  _filename 
)
slot

Definition at line 1313 of file FilePTS.cc.

◆ saveOptionsWidget()

QWidget * FilePTSPlugin::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 1410 of file FilePTS.cc.

◆ slotLoadMakeDefaultButtonClicked

void FilePTSPlugin::slotLoadMakeDefaultButtonClicked ( )
privateslot

Definition at line 1485 of file FilePTS.cc.

◆ slotSaveMakeDefaultButtonClicked

void FilePTSPlugin::slotSaveMakeDefaultButtonClicked ( )
privateslot

Definition at line 1533 of file FilePTS.cc.

◆ slotUpdateSaveColorRange

void FilePTSPlugin::slotUpdateSaveColorRange ( )
privateslot

Definition at line 1476 of file FilePTS.cc.

◆ supportedType()

DataType FilePTSPlugin::supportedType ( )
inlinevirtual

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 167 of file FilePTS.hh.

◆ version

QString FilePTSPlugin::version ( )
inlineslot

Definition at line 178 of file FilePTS.hh.

◆ writeBinaryFile()

bool FilePTSPlugin::writeBinaryFile ( const char *  _filename,
const SplatCloudNode _splatCloudNode 
)
private

Definition at line 847 of file FilePTS.cc.

◆ writeTextFile()

bool FilePTSPlugin::writeTextFile ( const char *  _filename,
const SplatCloudNode _splatCloudNode 
)
private

Definition at line 992 of file FilePTS.cc.

Member Data Documentation

◆ loadOptions_

ptsLoadWiget* FilePTSPlugin::loadOptions_
private

Definition at line 202 of file FilePTS.hh.

◆ saveBinaryFile_

QCheckBox* FilePTSPlugin::saveBinaryFile_
private

Definition at line 206 of file FilePTS.hh.

◆ saveColorRange_

QComboBox* FilePTSPlugin::saveColorRange_
private

Definition at line 210 of file FilePTS.hh.

◆ saveColors_

QCheckBox* FilePTSPlugin::saveColors_
private

Definition at line 209 of file FilePTS.hh.

◆ saveIndices_

QCheckBox* FilePTSPlugin::saveIndices_
private

Definition at line 211 of file FilePTS.hh.

◆ saveMakeDefaultButton_

QPushButton* FilePTSPlugin::saveMakeDefaultButton_
private

Definition at line 214 of file FilePTS.hh.

◆ saveNormals_

QCheckBox* FilePTSPlugin::saveNormals_
private

Definition at line 207 of file FilePTS.hh.

◆ saveOptions_

QWidget* FilePTSPlugin::saveOptions_
private

Definition at line 203 of file FilePTS.hh.

◆ savePointsizes_

QCheckBox* FilePTSPlugin::savePointsizes_
private

Definition at line 208 of file FilePTS.hh.


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