Developer Documentation

Functions
GlobalOptions.hh File Reference
`#include <OpenFlipper/common/GlobalDefines.hh>`
`#include <ACG/Scenegraph/DrawModes.hh>`
`#include <QDir>`
`#include <QStringList>`
`#include <QColor>`
`#include <QIcon>`
`#include "OpenFlipperQSettings.hh"`

Go to the source code of this file.

## Functions
QDir | OpenFlipper::Options::applicationDir ()
| Returns the base Path of the application.
QDir | OpenFlipper::Options::pluginDir ()
| Returns the Path to the Standard Plugins.
QDir | OpenFlipper::Options::textureDir ()
| Returns the Path to the Textures.
QDir | OpenFlipper::Options::licenseDir ()
| Returns the Path to the License files.
QDir | OpenFlipper::Options::scriptDir ()
| Returns the Path to the Scripts.
QDir | OpenFlipper::Options::shaderDir ()
| Returns the Path to the shaders.
QDir | OpenFlipper::Options::iconDir ()
| Returns the Path to the Icons.
QDir | OpenFlipper::Options::translationsDir ()
| Returns the Path to the translation files.
QDir | OpenFlipper::Options::fontsDir ()
| Returns the Path to Fonts.
QDir | OpenFlipper::Options::dataDir ()
| Returns the Path to the main data directory.
QString | OpenFlipper::Options::applicationDirStr ()
| Returns the base Path of the application.
QString | OpenFlipper::Options::pluginDirStr ()
| Returns the Path to the Standard Plugins.
QString | OpenFlipper::Options::shaderDirStr ()
| Returns the Path to the Shader directory.
QString | OpenFlipper::Options::textureDirStr ()
| Returns the Path to the Textures.
QString | OpenFlipper::Options::licenseDirStr ()
| Returns the Path to the License files.
QString | OpenFlipper::Options::scriptDirStr ()
| Returns the Path to the Scripts.
QString | OpenFlipper::Options::iconDirStr ()
| Returns the Path to the Icons.
QString | OpenFlipper::Options::dataDirStr ()
| Returns the Path to the main data directory.
QIcon & | OpenFlipper::Options::OpenFlipperIcon ()
| Returns the OpenFlipper Icon.
QString | OpenFlipper::Options::translationsDirStr ()
| Returns the Path to the translation files.
QString | OpenFlipper::Options::fontsDirStr ()
| Returns the Path to Fonts.
QString | OpenFlipper::Options::helpDirStr ()
| Returns the Path to Help.
bool | OpenFlipper::Options::initializeSettings ()
| Internal function called by the core to connect to the program options.
void | OpenFlipper::Options::closeSettings ()
| Internal function called by the core to write the program options on exit.
Option files / paths
void | OpenFlipper::Options::optionFiles (QStringList _list)
| Set the list of option files.
QStringList | OpenFlipper::Options::optionFiles ()
| returns a list of all available option files
DLLEXPORT void | OpenFlipper::Options::configDir (QDir _dir)
| Sets the Path to the configuration directory.
DLLEXPORT bool | OpenFlipper::Options::configDir (QString _dir)
| Sets the Path to the configuration directory.
QString | OpenFlipper::Options::configDirStr ()
| Returns the base Path of the config Dir.
QDir | OpenFlipper::Options::configDir ()
| Returns the base Path of the config Dir.
bool | OpenFlipper::Options::deleteIniFile ()
| Returns true if ini-file should be deleted on exit.
void | OpenFlipper::Options::deleteIniFile (bool _delete)
| Set option to delete ini-files on exit.
current status
bool | OpenFlipper::Options::startup ()
| Returns if the system is currently in a startup phase.
void | OpenFlipper::Options::finishedStartup ()
| Set status to startup complete.
QString | OpenFlipper::Options::currentScriptDirStr ()
| return the current script-directory
QDir | OpenFlipper::Options::currentScriptDir ()
| return the current Script-directory
DLLEXPORT void | OpenFlipper::Options::currentScriptDir (QDir _dir)
| Sets the Path to the current Script-directory.
bool | OpenFlipper::Options::currentScriptDir (QString _dir)
| Sets the Path to the current Script-directory.
QString | OpenFlipper::Options::currentTextureDirStr ()
| return the current texture-directory
QDir | OpenFlipper::Options::currentTextureDir ()
| return the current texture-directory
DLLEXPORT void | OpenFlipper::Options::currentTextureDir (QDir _dir)
| Sets the Path to the current texture-directory.
bool | OpenFlipper::Options::currentTextureDir (QString _dir)
| Sets the Path to the current texture-directory.
QString | OpenFlipper::Options::lastDataType ()
| return last used dataType
void | OpenFlipper::Options::lastDataType (QString _type)
| set the last used dataType
Architecture detection and Architecture specific stuff
bool | OpenFlipper::Options::is64bit ()
| Returns the right separator String for this architecture ( Linux: "/" Windows: "\" )
bool | OpenFlipper::Options::is32bit ()
| Returns the right separator String for this architecture ( Linux: "/" Windows: "\" )
bool | OpenFlipper::Options::isLinux ()
| Returns the right separator String for this architecture ( Linux: "/" Windows: "\" )
bool | OpenFlipper::Options::isWindows ()
| Returns the right separator String for this architecture ( Linux: "/" Windows: "\" )
bool | OpenFlipper::Options::isDarwin ()
| Returns the right separator String for this architecture ( Linux: "/" Windows: "\" )
QString | OpenFlipper::Options::dirSeparator ()
| Returns the right separator String for this architecture ( Linux: "/" Windows: "\" )
Environment
QString | OpenFlipper::Options::lang ()
| Returns the LANG environment variable string.
Scripting Options
bool | OpenFlipper::Options::scripting ()
void | OpenFlipper::Options::scripting (bool _status)
Logging Options
bool | OpenFlipper::Options::logToConsole ()
| Log to console output?
void | OpenFlipper::Options::logToConsole (bool _logToConsole)
| Log to console output?
bool | OpenFlipper::Options::debug ()
| Give extra debug information.
void | OpenFlipper::Options::debug (bool _debug)
| Give extra debug information.
Backup operations
bool | OpenFlipper::Options::backupEnabled ()
| Do backups?
void | OpenFlipper::Options::enableBackup (bool _enableBackup)
| Do backups?
Update blocking
Used to speedup system when creating/removing a lot of objects. This disables the analysis of the scenegraph used for rendering.
void | OpenFlipper::Options::blockSceneGraphUpdates ()
| Block updates.
void | OpenFlipper::Options::unblockSceneGraphUpdates ()
| unblockUpdates
bool | OpenFlipper::Options::sceneGraphUpdatesBlocked ()
| Updates currently blocked?
Settings
bool | OpenFlipper::Options::savingSettings ()
| currently saving Settings ?
void | OpenFlipper::Options::savingSettings (bool _savingSettings)
| currently saving Settings ?
bool | OpenFlipper::Options::loadingRecentFile ()
| currently loading recent file ?
void | OpenFlipper::Options::loadingRecentFile (bool _loadingRecentFile)
| currently loading recent file ?
Core parameters
int * | OpenFlipper::Options::argc ()
| Get the argc parameter from the main application.
char *** | OpenFlipper::Options::argv ()
| Get the argv parameter from the main application.
void | OpenFlipper::Options::argc (int *_argc)
| Set the argc parameter from the main application ( Dont use it, only called from Core!!)
void | OpenFlipper::Options::argv (char ***_argv)
| Set the argv parameter from the main application ( Dont use it, only called from Core!!)
bool | OpenFlipper::Options::remoteControl ()
| is the core remoteControlled?
void | OpenFlipper::Options::remoteControl (bool _remote)
| is the core remoteControlled?
int | OpenFlipper::Options::remoteControlPort ()
| Get the remote control port.
void | OpenFlipper::Options::remoteControlPort (int _remotePort)
| Set the remote control port.
Debugging Options
void | OpenFlipper::Options::doSlotDebugging (bool _debugging)
bool | OpenFlipper::Options::doSlotDebugging ()
Version information
QString | OpenFlipper::Options::coreVersion ()
| Version of OpenFlipper Core.
QString | OpenFlipper::Options::compilerInfo ()
| Information about the used compiler.

## Persistent settings
#define | STRINGIFY(x) #x
| QSettings object containing all program settings of OpenFlipper. More...
#define | TOSTRING(x) STRINGIFY(x)
| QSettings object containing all program settings of OpenFlipper. More...
DLLEXPORT OpenFlipperQSettings & | OpenFlipperSettings ()
| QSettings object containing all program settings of OpenFlipper. More...

## Visualization Control
enum | OpenFlipper::Options::StereoMode { OpenGL, AnaglyphRedCyan, AnaglyphCustom }
| Stereo mode.
void | OpenFlipper::Options::nogui (bool _nogui)
| Store if a gui should be visible or not.
bool | OpenFlipper::Options::nogui ()
| get if a gui should be visible or not
bool | OpenFlipper::Options::gui ()
| get if a gui should be visible or not
void | OpenFlipper::Options::coreProfile (bool _enableCoreProfile, bool _temporary)
| Store opengl core profile setting.
bool | OpenFlipper::Options::coreProfile ()
| get opengl core profile setting
QPair< int, int > | OpenFlipper::Options::glVersion ()
| get opengl version setting
void | OpenFlipper::Options::glVersion (const QPair< int, int > &_version, bool _temporary)
| Store opengl version setting. More...
void | OpenFlipper::Options::samples (int _samples, bool _temporary)
| Store opengl MSAA sample count.
int | OpenFlipper::Options::samples ()
| Get opengl MSAA sample count.
void | OpenFlipper::Options::stereo (bool _stereo)
| Store stereo setting. More...
bool | OpenFlipper::Options::stereo ()
| get current stereo setting More...
void | OpenFlipper::Options::glStereo (bool _glStereo, bool _temporary)
| Store opengl stereo mode setting. More...
bool | OpenFlipper::Options::glStereo ()
| get current opengl stereo setting More...
bool | OpenFlipper::Options::glStereoRequested ()
| get the glStereo flag that was used to request the opengl context More...
void | OpenFlipper::Options::stereoMode (StereoMode _mode)
| Store stereo mode setting.
StereoMode | OpenFlipper::Options::stereoMode ()
| get current stereo mode setting
void | OpenFlipper::Options::anaglyphLeftEyeColorMatrix (std::vector< float > _mat)
| Store the 3x3 left eye color matrix values for custom anaglyph stereo mode.
std::vector< float > | OpenFlipper::Options::anaglyphLeftEyeColorMatrix ()
| get the 3x3 left eye color matrix values for custom anaglyph stereo mode
void | OpenFlipper::Options::anaglyphRightEyeColorMatrix (std::vector< float > _mat)
| Store the 3x3 right eye color matrix values for custom anaglyph stereo mode.
std::vector< float > | OpenFlipper::Options::anaglyphRightEyeColorMatrix ()
| get the 3x3 right eye color matrix values for custom anaglyph stereo mode
void | OpenFlipper::Options::synchronization (bool _synchronization)
| Store synchronization mode setting. More...
bool | OpenFlipper::Options::synchronization ()
| get current synchronization setting
void | OpenFlipper::Options::defaultDrawMode (ACG::SceneGraph::DrawModes::DrawMode _mode, int _viewer)
| Store defaultDrawMode setting.
ACG::SceneGraph::DrawModes::DrawMode | OpenFlipper::Options::defaultDrawMode (int _viewer)
| get defaultDrawMode setting
void | OpenFlipper::Options::defaultPerspectiveProjectionMode (bool _mode, int _viewer)
| Store defaultProjectionMode setting. More...
bool | OpenFlipper::Options::defaultPerspectiveProjectionMode (int _viewer)
| get defaultProjectionMode setting
void | OpenFlipper::Options::defaultViewingDirection (int _mode, int _viewer)
| Store defaultViewingDirection setting.
int | OpenFlipper::Options::defaultViewingDirection (int _viewer)
| get defaultViewingDirection setting
void | OpenFlipper::Options::defaultLockRotation (bool _mode, int _viewer)
| Store lockrotation setting.
bool | OpenFlipper::Options::defaultLockRotation (int _viewer)
| get lockrotation setting
void | OpenFlipper::Options::defaultViewerLayout (int _layout)
| Store defaultViewerLayout setting.
int | OpenFlipper::Options::defaultViewerLayout ()
| get defaultViewerLayout setting
void | OpenFlipper::Options::redrawDisabled (bool disable)
| Store disableRedraw setting.
bool | OpenFlipper::Options::redrawDisabled ()
| get disableRedraw setting
bool | OpenFlipper::Options::drawModesInContextMenu ()
| Get the flag if a drawMode Menu should always be visible in the context menu.
void | OpenFlipper::Options::drawModesInContextMenu (bool _show)
| Set the flag if a drawMode Menu should always be visible in the context menu.

## GUI Control
enum | OpenFlipper::Options::LoggerState { InScene, Normal, Hidden }
| State of the logging widget.
unsigned int | OpenFlipper::Options::examinerWidgets ()
| Number of examiner widgets.
void | OpenFlipper::Options::loggerState (LoggerState _state)
| Set to current. More...
LoggerState | OpenFlipper::Options::loggerState ()
| Current state of the logging window? More...
QString | OpenFlipper::Options::currentViewMode ()
| Which mode should is currently selected? More...
void | OpenFlipper::Options::currentViewMode (QString _mode)
| Which view mode is currently selected?
QString | OpenFlipper::Options::windowTitle ()
| Titel of the main window.
void | OpenFlipper::Options::windowTitle (QString _titel)
| Set title of the main window.
void | OpenFlipper::Options::defaultColor (QColor _color)
| Default color for objects.
QColor | OpenFlipper::Options::defaultColor ()
| Default color for objects.
void | OpenFlipper::Options::randomDefaultColor (bool _random)
| use randomized color as default for objects
bool | OpenFlipper::Options::randomDefaultColor ()
| use randomized color as default for objects

## Detailed Description

This Header provides access to globally defined variables such as Aplication Directories. You may use these Functions inside your plugins.

Definition in file GlobalOptions.hh.

## Macro Definition Documentation

## ◆ STRINGIFY

#define STRINGIFY | ( |  | x | ) | #x

QSettings object containing all program settings of OpenFlipper.

To get the settings use:
OpenFlipperSettings().value("<Key>").toDouble();
OpenFlipperSettings().value("<Key>").toBool();

To change settings do:
OpenFlipperSettings().setValue("<Key>","<Value>");
For detailed info about the values see the documentation of QSettings and the QVariant.

Note
  For each of your plugins, the key has to start with your plugin name!!!

The following entries are available through the settings:

User Interface Settings

- Core/Gui/glViewer/defaultBackgroundColor This controls the default background color of the glViewer (QColor)
- Core/Gui/glViewer/showControlWheels This setting controls if the control wheels should be visible in the glViewer (bool)
- Core/Gui/glViewer/glMouse This setting controls if the mouse is rendered in OpenGL or in the window manager(bool)
- Core/Gui/glViewer/stereoMousePick This setting controls if the mouse depth is picked in stereo mode(bool)
- Core/Gui/glViewer/restrictFrameRate This setting controls if the maximum frame rate should be restricted (bool)
- Core/Gui/glViewer/maxFrameRate If restrictFrameRate is set to yes, this setting controls the maximum frameRate used (unsigned int)
- Core/Gui/glViewer/useMultipleViewers Use only one viewer or automatically generate multiple viewers (bool)
- Core/Gui/glViewer/minimalSceneSize The minimal scene radius. If the scene is smaller, than the size will be set to this value (double)
- Core/Gui/ToolBoxes/hidden Hide the toolbox sidebar (bool)
- Core/Gui/ToolBoxes/ToolBoxOnTheRight Toolbox on the right or on the left (bool)
- Core/Gui/ToolBars/PickToolbarInScene Render picking toolbar into gl scene or as toolbox into main widget
- Core/Gui/TaskSwitcher/Hide Show or Hide the task switcher(bool)
- Core/Gui/LogWindow/LogWindowMode Log Window Mode .. 0 InScene, 1 Window, 2 Hidden (int)
- Core/Gui/LogWindow/OpenMeshErrors Log OpenMesh Errors? (bool)
- Core/Gui/splash This setting controls if the splash screen is shown at startup(bool)
- Core/Gui/fullscreen Show OpenFlipper in Fullscreen Mode(bool)
- Core/Projection/FOVY Field of view for projection matrix in perspective mode(double)
  User Interface Settings for each of the viewers
- Viewer<viewer>/perspectiveProjection Orthogonal = false,Perspective = true (bool)
- Viewer<viewer>/defaultViewingDirection 0:VIEW_FREE; 1:VIEW_TOP; 2:VIEW_BOTTOM; 3:VIEW_LEFT; 4:VIEW_RIGHT; 5:VIEW_FRONT; 6:VIEW_BACK (int)
- Viewer<viewer>/defaultLockRotation true: locked , false: unlocked (bool)
- Viewer<viewer>/Animation true: enabled, false: disabled (bool)
- Viewer<viewer>/BackfaceCulling true: enabled, false: disabled (bool)
- Viewer<viewer>/TwoSidedLighting true: enabled, false: disabled (bool)
- Viewer<viewer>/BackgroundColor Color of the viewer background (QColor)
- Viewer<viewer>/DefaultRenderer Name of the default Renderer (QString)
  File Handling
- Core/CurrentDir The current Directory of the Application
- Core/File/RecentFiles List of Recent Files
- Core/File/RecentTypes DataTypes of Recent Files
- Core/File/MaxRecent Maximum entries in recent File list
- Core/File/UseLoadDefaults Use the defaults saved in the file plugins
  Log Settings
- Core/Log/Logfile This is the location of the log file
- Core/Log/logFileEnabled This controls, if logging to file is enabled(bool)
  Language Settings
- Core/Language/Translation This is the translation to use ( default is en_US)
  Update Settings
- Core/Update/UserName Update UserName
- Core/Update/Pass Update Password
- Core/Update/URL Update URL

Mouse Controls

- Core/Mouse/Wheel/ZoomFactor Zoom factor used when turning the mouse wheel (double)
- Core/Mouse/Wheel/ZoomFactorShift Zoom factor used when turning the mouse wheel while shift is pressed (makes zoom slower while shift is pressed) (double)
- Core/Mouse/Wheel/Invert Invert mouse wheel zoom direction (bool)
  General Stereo Settings
- Core/Stereo/EyeDistance Distance between eyes. Defaults to 7 cm (double)
- Core/Stereo/FocalDistance Focal distance. Defaults to center of scene (double)
  Philips stereo display settings
- Core/Stereo/Philips/Content Philips stereo header content type (int)
- Core/Stereo/Philips/Factor Philips stereo header factor (int)
- Core/Stereo/Philips/Offset Philips stereo header offset cc (int)
- Core/Stereo/Philips/Select Philips stereo header select (int)
  Rendering debugger Settings
- Core/Debug/Picking/RenderPicking Enable picking rendering (bool)
- Core/Debug/Picking/RenderPickingMode The Mode used for picking rendering(QString)
- Core/Debug/Picking/RenderDepthImage Renders the depth buffer as a grayscale image (bool)
  Anaglyph stereo mode settings:

Definition at line 156 of file GlobalOptions.hh.

## ◆ TOSTRING

#define TOSTRING | ( |  | x | ) | STRINGIFY(x)

QSettings object containing all program settings of OpenFlipper.

To get the settings use:
OpenFlipperSettings().value("<Key>").toDouble();
OpenFlipperSettings().value("<Key>").toBool();

To change settings do:
OpenFlipperSettings().setValue("<Key>","<Value>");
For detailed info about the values see the documentation of QSettings and the QVariant.

Note
  For each of your plugins, the key has to start with your plugin name!!!

The following entries are available through the settings:

User Interface Settings

- Core/Gui/glViewer/defaultBackgroundColor This controls the default background color of the glViewer (QColor)
- Core/Gui/glViewer/showControlWheels This setting controls if the control wheels should be visible in the glViewer (bool)
- Core/Gui/glViewer/glMouse This setting controls if the mouse is rendered in OpenGL or in the window manager(bool)
- Core/Gui/glViewer/stereoMousePick This setting controls if the mouse depth is picked in stereo mode(bool)
- Core/Gui/glViewer/restrictFrameRate This setting controls if the maximum frame rate should be restricted (bool)
- Core/Gui/glViewer/maxFrameRate If restrictFrameRate is set to yes, this setting controls the maximum frameRate used (unsigned int)
- Core/Gui/glViewer/useMultipleViewers Use only one viewer or automatically generate multiple viewers (bool)
- Core/Gui/glViewer/minimalSceneSize The minimal scene radius. If the scene is smaller, than the size will be set to this value (double)
- Core/Gui/ToolBoxes/hidden Hide the toolbox sidebar (bool)
- Core/Gui/ToolBoxes/ToolBoxOnTheRight Toolbox on the right or on the left (bool)
- Core/Gui/ToolBars/PickToolbarInScene Render picking toolbar into gl scene or as toolbox into main widget
- Core/Gui/TaskSwitcher/Hide Show or Hide the task switcher(bool)
- Core/Gui/LogWindow/LogWindowMode Log Window Mode .. 0 InScene, 1 Window, 2 Hidden (int)
- Core/Gui/LogWindow/OpenMeshErrors Log OpenMesh Errors? (bool)
- Core/Gui/splash This setting controls if the splash screen is shown at startup(bool)
- Core/Gui/fullscreen Show OpenFlipper in Fullscreen Mode(bool)
- Core/Projection/FOVY Field of view for projection matrix in perspective mode(double)
  User Interface Settings for each of the viewers
- Viewer<viewer>/perspectiveProjection Orthogonal = false,Perspective = true (bool)
- Viewer<viewer>/defaultViewingDirection 0:VIEW_FREE; 1:VIEW_TOP; 2:VIEW_BOTTOM; 3:VIEW_LEFT; 4:VIEW_RIGHT; 5:VIEW_FRONT; 6:VIEW_BACK (int)
- Viewer<viewer>/defaultLockRotation true: locked , false: unlocked (bool)
- Viewer<viewer>/Animation true: enabled, false: disabled (bool)
- Viewer<viewer>/BackfaceCulling true: enabled, false: disabled (bool)
- Viewer<viewer>/TwoSidedLighting true: enabled, false: disabled (bool)
- Viewer<viewer>/BackgroundColor Color of the viewer background (QColor)
- Viewer<viewer>/DefaultRenderer Name of the default Renderer (QString)
  File Handling
- Core/CurrentDir The current Directory of the Application
- Core/File/RecentFiles List of Recent Files
- Core/File/RecentTypes DataTypes of Recent Files
- Core/File/MaxRecent Maximum entries in recent File list
- Core/File/UseLoadDefaults Use the defaults saved in the file plugins
  Log Settings
- Core/Log/Logfile This is the location of the log file
- Core/Log/logFileEnabled This controls, if logging to file is enabled(bool)
  Language Settings
- Core/Language/Translation This is the translation to use ( default is en_US)
  Update Settings
- Core/Update/UserName Update UserName
- Core/Update/Pass Update Password
- Core/Update/URL Update URL

Mouse Controls

- Core/Mouse/Wheel/ZoomFactor Zoom factor used when turning the mouse wheel (double)
- Core/Mouse/Wheel/ZoomFactorShift Zoom factor used when turning the mouse wheel while shift is pressed (makes zoom slower while shift is pressed) (double)
- Core/Mouse/Wheel/Invert Invert mouse wheel zoom direction (bool)
  General Stereo Settings
- Core/Stereo/EyeDistance Distance between eyes. Defaults to 7 cm (double)
- Core/Stereo/FocalDistance Focal distance. Defaults to center of scene (double)
  Philips stereo display settings
- Core/Stereo/Philips/Content Philips stereo header content type (int)
- Core/Stereo/Philips/Factor Philips stereo header factor (int)
- Core/Stereo/Philips/Offset Philips stereo header offset cc (int)
- Core/Stereo/Philips/Select Philips stereo header select (int)
  Rendering debugger Settings
- Core/Debug/Picking/RenderPicking Enable picking rendering (bool)
- Core/Debug/Picking/RenderPickingMode The Mode used for picking rendering(QString)
- Core/Debug/Picking/RenderDepthImage Renders the depth buffer as a grayscale image (bool)
  Anaglyph stereo mode settings:

Definition at line 157 of file GlobalOptions.hh.

## Function Documentation

## ◆ currentViewMode()

DLLEXPORT QString OpenFlipper::Options::currentViewMode | ( |  | ) |

Which mode should is currently selected?

Which view mode is currently selected?

Definition at line 692 of file GlobalOptions.cc.

## ◆ defaultPerspectiveProjectionMode()

DLLEXPORT void OpenFlipper::Options::defaultPerspectiveProjectionMode | ( | bool | _mode,
|  | int | _viewer
| ) |  |

Store defaultProjectionMode setting.

Perspective projection = true; Orthogonal Projection = false;

Definition at line 554 of file GlobalOptions.cc.

## ◆ doSlotDebugging() [1/2]

DLLEXPORT void OpenFlipper::Options::doSlotDebugging | ( | bool | _debugging | ) |

If you enable slot debugging, for some slots will be displayed who called them. Currently supported slots are:

- updateView()
- updated_objects( objectId )

Definition at line 834 of file GlobalOptions.cc.

## ◆ doSlotDebugging() [2/2]

DLLEXPORT bool OpenFlipper::Options::doSlotDebugging | ( |  | ) |

If you enable slot debugging, for some slots will be displayed who called them. Currently supported slots are:

- updateView()
- updated_objects( objectId )

Definition at line 838 of file GlobalOptions.cc.

## ◆ glStereo() [1/2]

DLLEXPORT void OpenFlipper::Options::glStereo | ( | bool | _glStereo,
|  | bool | _temporary
| ) |  |

Store opengl stereo mode setting.

Store opengl stereo support setting.

Definition at line 449 of file GlobalOptions.cc.

## ◆ glStereo() [2/2]

DLLEXPORT bool OpenFlipper::Options::glStereo | ( |  | ) |

get current opengl stereo setting

will be set in core is opengl stereo is supported

Definition at line 465 of file GlobalOptions.cc.

## ◆ glStereoRequested()

DLLEXPORT bool OpenFlipper::Options::glStereoRequested | ( |  | ) |

get the glStereo flag that was used to request the opengl context

will be set in core is opengl stereo is supported

Definition at line 473 of file GlobalOptions.cc.

## ◆ glVersion()

DLLEXPORT void OpenFlipper::Options::glVersion | ( | const QPair< int, int > & | _version,
|  | bool | _temporary
| ) |  |

Store opengl version setting.

set opengl version setting

Definition at line 415 of file GlobalOptions.cc.

## ◆ loggerState() [1/2]

DLLEXPORT void OpenFlipper::Options::loggerState | ( | LoggerState | _state | ) |

Set to current.

Set the logging widget state.

Definition at line 675 of file GlobalOptions.cc.

## ◆ loggerState() [2/2]

DLLEXPORT LoggerState OpenFlipper::Options::loggerState | ( |  | ) |

Current state of the logging window?

What is the current state of the logging widget?

Definition at line 680 of file GlobalOptions.cc.

## ◆ OpenFlipperSettings()

DLLEXPORT OpenFlipperQSettings& OpenFlipperSettings | ( |  | ) |

QSettings object containing all program settings of OpenFlipper.

To get the settings use:
OpenFlipperSettings().value("<Key>").toDouble();
OpenFlipperSettings().value("<Key>").toBool();

To change settings do:
OpenFlipperSettings().setValue("<Key>","<Value>");
For detailed info about the values see the documentation of QSettings and the QVariant.

Note
  For each of your plugins, the key has to start with your plugin name!!!

The following entries are available through the settings:

User Interface Settings

- Core/Gui/glViewer/defaultBackgroundColor This controls the default background color of the glViewer (QColor)
- Core/Gui/glViewer/showControlWheels This setting controls if the control wheels should be visible in the glViewer (bool)
- Core/Gui/glViewer/glMouse This setting controls if the mouse is rendered in OpenGL or in the window manager(bool)
- Core/Gui/glViewer/stereoMousePick This setting controls if the mouse depth is picked in stereo mode(bool)
- Core/Gui/glViewer/restrictFrameRate This setting controls if the maximum frame rate should be restricted (bool)
- Core/Gui/glViewer/maxFrameRate If restrictFrameRate is set to yes, this setting controls the maximum frameRate used (unsigned int)
- Core/Gui/glViewer/useMultipleViewers Use only one viewer or automatically generate multiple viewers (bool)
- Core/Gui/glViewer/minimalSceneSize The minimal scene radius. If the scene is smaller, than the size will be set to this value (double)
- Core/Gui/ToolBoxes/hidden Hide the toolbox sidebar (bool)
- Core/Gui/ToolBoxes/ToolBoxOnTheRight Toolbox on the right or on the left (bool)
- Core/Gui/ToolBars/PickToolbarInScene Render picking toolbar into gl scene or as toolbox into main widget
- Core/Gui/TaskSwitcher/Hide Show or Hide the task switcher(bool)
- Core/Gui/LogWindow/LogWindowMode Log Window Mode .. 0 InScene, 1 Window, 2 Hidden (int)
- Core/Gui/LogWindow/OpenMeshErrors Log OpenMesh Errors? (bool)
- Core/Gui/splash This setting controls if the splash screen is shown at startup(bool)
- Core/Gui/fullscreen Show OpenFlipper in Fullscreen Mode(bool)
- Core/Projection/FOVY Field of view for projection matrix in perspective mode(double)
  User Interface Settings for each of the viewers
- Viewer<viewer>/perspectiveProjection Orthogonal = false,Perspective = true (bool)
- Viewer<viewer>/defaultViewingDirection 0:VIEW_FREE; 1:VIEW_TOP; 2:VIEW_BOTTOM; 3:VIEW_LEFT; 4:VIEW_RIGHT; 5:VIEW_FRONT; 6:VIEW_BACK (int)
- Viewer<viewer>/defaultLockRotation true: locked , false: unlocked (bool)
- Viewer<viewer>/Animation true: enabled, false: disabled (bool)
- Viewer<viewer>/BackfaceCulling true: enabled, false: disabled (bool)
- Viewer<viewer>/TwoSidedLighting true: enabled, false: disabled (bool)
- Viewer<viewer>/BackgroundColor Color of the viewer background (QColor)
- Viewer<viewer>/DefaultRenderer Name of the default Renderer (QString)
  File Handling
- Core/CurrentDir The current Directory of the Application
- Core/File/RecentFiles List of Recent Files
- Core/File/RecentTypes DataTypes of Recent Files
- Core/File/MaxRecent Maximum entries in recent File list
- Core/File/UseLoadDefaults Use the defaults saved in the file plugins
  Log Settings
- Core/Log/Logfile This is the location of the log file
- Core/Log/logFileEnabled This controls, if logging to file is enabled(bool)
  Language Settings
- Core/Language/Translation This is the translation to use ( default is en_US)
  Update Settings
- Core/Update/UserName Update UserName
- Core/Update/Pass Update Password
- Core/Update/URL Update URL

Mouse Controls

- Core/Mouse/Wheel/ZoomFactor Zoom factor used when turning the mouse wheel (double)
- Core/Mouse/Wheel/ZoomFactorShift Zoom factor used when turning the mouse wheel while shift is pressed (makes zoom slower while shift is pressed) (double)
- Core/Mouse/Wheel/Invert Invert mouse wheel zoom direction (bool)
  General Stereo Settings
- Core/Stereo/EyeDistance Distance between eyes. Defaults to 7 cm (double)
- Core/Stereo/FocalDistance Focal distance. Defaults to center of scene (double)
  Philips stereo display settings
- Core/Stereo/Philips/Content Philips stereo header content type (int)
- Core/Stereo/Philips/Factor Philips stereo header factor (int)
- Core/Stereo/Philips/Offset Philips stereo header offset cc (int)
- Core/Stereo/Philips/Select Philips stereo header select (int)
  Rendering debugger Settings
- Core/Debug/Picking/RenderPicking Enable picking rendering (bool)
- Core/Debug/Picking/RenderPickingMode The Mode used for picking rendering(QString)
- Core/Debug/Picking/RenderDepthImage Renders the depth buffer as a grayscale image (bool)
  Anaglyph stereo mode settings:

Definition at line 1038 of file GlobalOptions.cc.

## ◆ scripting() [1/2]

DLLEXPORT bool OpenFlipper::Options::scripting | ( |  | ) |

Scripting status. If this flag is set to true, you should not call functions for multiple objects. Or do remote procedure calls to functions which add scripting commands. As this might call functions twice when executed via scripts. See the scripting plugin for additional information

Definition at line 736 of file GlobalOptions.cc.

## ◆ scripting() [2/2]

DLLEXPORT void OpenFlipper::Options::scripting | ( | bool | _status | ) |

Toggle scripting status (normally done by the Scripting plugin only)

Definition at line 740 of file GlobalOptions.cc.

## ◆ stereo() [1/2]

DLLEXPORT void OpenFlipper::Options::stereo | ( | bool | _stereo | ) |

Store stereo setting.

Store stereo support setting.

Definition at line 373 of file GlobalOptions.cc.

## ◆ stereo() [2/2]

DLLEXPORT bool OpenFlipper::Options::stereo | ( |  | ) |

get current stereo setting

get current stereo support setting

Definition at line 378 of file GlobalOptions.cc.

## ◆ synchronization()

DLLEXPORT void OpenFlipper::Options::synchronization | ( | bool | _synchronization | ) |

Store synchronization mode setting.

Store synchronization setting.

Definition at line 537 of file GlobalOptions.cc.