Developer Documentation
|
#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 | 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::stereo (bool _stereo) |
Store stereo setting. More... | |
bool | OpenFlipper::Options::stereo () |
get current stereo setting More... | |
void | OpenFlipper::Options::glStereo (bool _glStereo) |
Store opengl stereo mode setting. More... | |
bool | OpenFlipper::Options::glStereo () |
get current opengl stereo setting 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 | 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 | |
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.
#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.
The following entries are available through the settings:
User Interface Settings
Mouse Controls
Definition at line 167 of file GlobalOptions.hh.
#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.
The following entries are available through the settings:
User Interface Settings
Mouse Controls
Definition at line 168 of file GlobalOptions.hh.
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.
The following entries are available through the settings:
User Interface Settings
Mouse Controls
Definition at line 938 of file GlobalOptions.cc.