Developer Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Signals | Public Member Functions | Private Slots | List of all members
LoggingInterface Class Referenceabstract

Interface for all Plugins which do logging to the logging window of the framework. More...

#include <OpenFlipper/BasePlugin/LoggingInterface.hh>

Inheritance diagram for LoggingInterface:
BackupPlugin BSplineCurveSelectionPlugin BSplineSurfaceSelectionPlugin ComponentsPlugin DataControlPlugin DecimaterPlugin DepthPeeling DepthPeelingPlugin FileBundlePlugin FileBVHPlugin FileHeightFieldPNGPlugin FileLightPlugin FileOBJPlugin FileOFFPlugin FileOMPlugin FileOpenVolumeMeshPlugin FilePlaPlugin FilePLYPlugin FilePolyLinePlugin FilePTSPlugin FileScriptPlugin FileSKLPlugin FileSPHPlugin FileSTLPlugin FileViewPlugin FileVTKPlugin HoleFillerPlugin InfoMeshObjectPlugin InfoSkeletonObjectPlugin InfoVolumeMeshObjectPlugin INIPlugin IsotropicRemesherPlugin MemInfoPlugin MeshComparePlugin MeshObjectSelectionPlugin MeshRepairPlugin MouseAndKeyPlugin MovePlugin ObjectSelectionPlugin PluginAlignMeshes PolyLinePlugin PolyLineSelectionPlugin PrimitivesGeneratorPlugin PropertyVisPlugin RemesherPlugin Renderer Renderer ScriptingPlugin SelectionBasePlugin SkeletalAnimationPlugin SkeletonEditingPlugin SlicePlugin SmootherPlugin SmootherPlugin SmootherPlugin SplatCloudObjectSelectionPlugin SplatCloudRenderingControlPlugin SSAOPlugin SubdividerPlugin TestPlugin TextureControlPlugin TopologyPlugin TypeBSplineCurvePlugin TypeBSplineSurfacePlugin TypeCameraPlugin TypeCoordsysPlugin TypeHexahedralMeshPlugin TypeLightPlugin TypePlanePlugin TypePolyhedralMeshPlugin TypePolyLinePlugin TypePolyMeshPlugin TypeSkeletonPlugin TypeSpherePlugin TypeSplatCloudPlugin TypeTriangleMeshPlugin ViewControlPlugin VolumeMeshSelectionPlugin

Signals

virtual void log (Logtype _type, QString _message)=0
 
virtual void log (QString _message)=0
 

Public Member Functions

virtual ~LoggingInterface ()
 Destructor.
 

Private Slots

virtual void logOutput (Logtype _type, QString _message)
 

Detailed Description

Interface for all Plugins which do logging to the logging window of the framework.

Detailed description
By emitting the given signals you can log information to the main logger window of the core. To simplify debugging, the core will prepend the plugin name to every log message. You dont have to do this yourself!
The log message will either be black or will be colored depending on the Logtype you specified.

A more detailed description of the LoggingInterface can be found here or read our tutorials Implementing a mesh smoother plugin and Implementing mouse and keyboard interaction for an example of how to use logging output.

Definition at line 123 of file LoggingInterface.hh.

Member Function Documentation

virtual void LoggingInterface::log ( Logtype  _type,
QString  _message 
)
pure virtualsignal

Send a log message to the mainwindow of the widget
This signal can be called from any thread.

Parameters
_typeMessage type (LOGINFO,LOGOUT,LOGWARN,LOGERR)
_messageMessage to be displayed
virtual void LoggingInterface::log ( QString  _message)
pure virtualsignal

Send a log message to the mainwindow of the widget
defaults to LOGOUT message type
This signal can be called from any thread.

Parameters
_messageMessage to be displayed
virtual void LoggingInterface::logOutput ( Logtype  _type,
QString  _message 
)
inlineprivatevirtualslot

Through this slot you can receive all logging information emitted by OpenFlipper or one of its plugins

Parameters
_typeMessage type
_messageMessage

Definition at line 150 of file LoggingInterface.hh.

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