Commit 2e9f5295 authored by Jan Möbius's avatar Jan Möbius
Browse files

Some more documentation fixes

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@13780 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 8774a8e6
...@@ -70,7 +70,9 @@ class BaseInterface { ...@@ -70,7 +70,9 @@ class BaseInterface {
//=========================================================================== //===========================================================================
/** @name Initialization /** @name Initialization
* @{ */ * @{
* \anchor BaseInterfaceInitialization
* */
//=========================================================================== //===========================================================================
private slots: private slots:
...@@ -87,7 +89,7 @@ class BaseInterface { ...@@ -87,7 +89,7 @@ class BaseInterface {
/** \brief Initialize Plugin step 2 /** \brief Initialize Plugin step 2
* *
* This slot is called if all plugins are loaded and the core is ready. Afterwards you can already send * This slot is called if all plugins are loaded and the core is ready. Afterwards you can already send
* signals to other plugins and the core (e.g. adding global textures). Do not create objects via addEmpty * signals to other plugins and the core (e.g. adding global textures). \note Do not create objects via addEmpty
* or load objects in this slot, as the rendering system is not ready yet. * or load objects in this slot, as the rendering system is not ready yet.
*/ */
virtual void pluginsInitialized() {}; virtual void pluginsInitialized() {};
...@@ -323,7 +325,7 @@ To use the BaseInterface: ...@@ -323,7 +325,7 @@ To use the BaseInterface:
</ul> </ul>
\section baseInterfacePluginInitialization Plugin Initialization \section baseInterfacePluginInitialization Plugin Initialization
BaseInterface provides two functions to initialize a plugin. The first function is BaseInterface::initializePlugin(). BaseInterface provides two functions to initialize a plugin \ref BaseInterfaceInitialization. The first function is BaseInterface::initializePlugin().
This function is called immediately after the plugin has been connected with OpenFlipper. When a plugin is This function is called immediately after the plugin has been connected with OpenFlipper. When a plugin is
loaded, all signals and slots from the used interfaces are connected to the core. After this, the loaded, all signals and slots from the used interfaces are connected to the core. After this, the
BaseInterface::initializePlugin() slot is called. In this slot you can initialize your plugin. BaseInterface::initializePlugin() slot is called. In this slot you can initialize your plugin.
...@@ -332,7 +334,7 @@ in this slot. \n ...@@ -332,7 +334,7 @@ in this slot. \n
After all plugins are loaded, the slot BaseInterface::pluginsInitialized() is called for each plugin. All After all plugins are loaded, the slot BaseInterface::pluginsInitialized() is called for each plugin. All
other plugins are now available and you can setup your user interface components in this slot. other plugins are now available and you can setup your user interface components in this slot.
The following graphic shows the initialization of a plugin. The following graphic shows the initialization of a plugin.
\image html startupProcess.jpg \image html OpenFlipperStartup.png
\section baseInterfaceObjectUpdateNotification Object Update Notification \section baseInterfaceObjectUpdateNotification Object Update Notification
The objects in OpenFlippers scene are stored and managed in OpenFlippers core. If a plugin changes one of the The objects in OpenFlippers scene are stored and managed in OpenFlippers core. If a plugin changes one of the
......
...@@ -208,7 +208,7 @@ public slots: ...@@ -208,7 +208,7 @@ public slots:
\section fileInterface_Functionality Functionality \section fileInterface_Functionality Functionality
This interface class has to be fully implemented. When you want to support save and load This interface class has to be fully implemented. When you want to support save and load
for an object type you have to implement all functions in this class in a file plugin. for an object type you have to implement all functions in this class in a file plugin.
The plugin has to be named Plugin-File<FileExtension>. The plugins are loaded directly after the The plugin has to be named Plugin-File\<FileExtension\>. The plugins are loaded directly after the
Type Plugins. Type Plugins.
OpenFlipper manages loading and saving of files from the core. OpenFlipper manages loading and saving of files from the core.
......
...@@ -32,9 +32,9 @@ ...@@ -32,9 +32,9 @@
* the QT library. Afterwards the object and scenegraph management are initialized. The next step creates the core * the QT library. Afterwards the object and scenegraph management are initialized. The next step creates the core
* user interface and the logging system. Now the plugins are loaded in the following way: * user interface and the logging system. Now the plugins are loaded in the following way:
* -# All the plugins are loaded into memory. * -# All the plugins are loaded into memory.
* -# For each plugin, the interfaces get connected and afterwards the BaseInterface::initializePlugin function is called. * -# For each plugin, the interfaces get connected and afterwards the BaseInterface::initializePlugin() function is called.
* (Here you can setup your internal variables). After execution of this slot your plugin should be fully functional. Only gui * (Here you can setup your internal variables). After execution of this slot your plugin should be fully functional. Only gui
* elements may be uninitialized and should be created in pluginsInitialized(). * elements may be uninitialized and should be created in BaseInterface::pluginsInitialized().
* -# For each plugin the BaseInterface::pluginsInitialized() function is called. Here you can setup your gui elements and start * -# For each plugin the BaseInterface::pluginsInitialized() function is called. Here you can setup your gui elements and start
* sending signals to the core. * sending signals to the core.
* -# For each plugin the INIInterface::loadIniFileOptions() slot is called (if the interface is implemented). This slot can be used to load * -# For each plugin the INIInterface::loadIniFileOptions() slot is called (if the interface is implemented). This slot can be used to load
......
...@@ -81,7 +81,7 @@ ...@@ -81,7 +81,7 @@
* OpenFlipperSettings().setValue("<Key>","<Value>");\n * OpenFlipperSettings().setValue("<Key>","<Value>");\n
* For detailed info about the values see the documentation of QSettings and the QVariant.\n * For detailed info about the values see the documentation of QSettings and the QVariant.\n
* *
* <b>For each of your plugins, the key has to start with your plugin name!!!</b> * \note For each of your plugins, the key has to start with your plugin name!!!
* *
* The following entries are available through the settings: * The following entries are available through the settings:
* *
...@@ -132,21 +132,21 @@ ...@@ -132,21 +132,21 @@
* * Core/Update/Pass Update Password * * Core/Update/Pass Update Password
* * Core/Update/URL Update URL * * Core/Update/URL Update URL
* *
* <b>Mouse Controls<b>\n * <b>Mouse Controls</b>\n
* * Core/Mouse/Wheel/ZoomFactor Zoom factor used when turning the mouse wheel (double)\n * * Core/Mouse/Wheel/ZoomFactor Zoom factor used when turning the mouse wheel (double)\n
* * Core/Mouse/Wheel/ZoomFactorShift Zoom factor used when turning the mouse wheel while shift is pressed (makes zoom slower while shift is pressed) (double)\n * * Core/Mouse/Wheel/ZoomFactorShift Zoom factor used when turning the mouse wheel while shift is pressed (makes zoom slower while shift is pressed) (double)\n
* *
* <b>General Stereo Settings<b>\n * <b>General Stereo Settings</b>\n
* * Core/Stereo/EyeDistance Distance between eyes. Defaults to 7 cm (double)\n * * Core/Stereo/EyeDistance Distance between eyes. Defaults to 7 cm (double)\n
* * Core/Stereo/FocalDistance Focal distance. Defaults to center of scene (double)\n * * Core/Stereo/FocalDistance Focal distance. Defaults to center of scene (double)\n
* \n * \n
* <b>Philips stereo display settings<b>\n * <b>Philips stereo display settings</b>\n
* * Core/Stereo/Philips/Content Philips stereo header content type (int)\n * * Core/Stereo/Philips/Content Philips stereo header content type (int)\n
* * Core/Stereo/Philips/Factor Philips stereo header factor (int)\n * * Core/Stereo/Philips/Factor Philips stereo header factor (int)\n
* * Core/Stereo/Philips/Offset Philips stereo header offset cc (int)\n * * Core/Stereo/Philips/Offset Philips stereo header offset cc (int)\n
* * Core/Stereo/Philips/Select Philips stereo header select (int)\n * * Core/Stereo/Philips/Select Philips stereo header select (int)\n
* \n * \n
* <b>Rendering debugger Settings<b>\n * <b>Rendering debugger Settings</b>\n
* * Core/Debug/Picking/RenderPicking Enable picking rendering (bool)\n * * Core/Debug/Picking/RenderPicking Enable picking rendering (bool)\n
* * Core/Debug/Picking/RenderPickingMode The Mode used for picking rendering(QString) \n * * Core/Debug/Picking/RenderPickingMode The Mode used for picking rendering(QString) \n
* * Core/Debug/Picking/RenderDepthImage Renders the depth buffer as a grayscale image (bool) \n * * Core/Debug/Picking/RenderDepthImage Renders the depth buffer as a grayscale image (bool) \n
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment