GlobalOptions.hh

Go to the documentation of this file.

/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
*                                                                            *
\*===========================================================================*/
 
 
//=============================================================================
//
//  Options used throughout the System
//
//=============================================================================
 
#pragma once
 
#include <OpenFlipper/common/GlobalDefines.hh>
#include <ACG/Scenegraph/DrawModes.hh>
#include <QDir>
#include <QStringList>
#include <QColor>
#include <QIcon>
#include "OpenFlipperQSettings.hh"
 
//===========================================================================
//===========================================================================
 
#define STRINGIFY(x) #x
#define TOSTRING(x) STRINGIFY(x)
 
DLLEXPORT
OpenFlipperQSettings& OpenFlipperSettings();
 
namespace OpenFlipper {
namespace Options {
 
DLLEXPORT
QDir applicationDir();
 
DLLEXPORT
QDir pluginDir();
 
DLLEXPORT
QDir textureDir();
 
DLLEXPORT
QDir licenseDir();
 
DLLEXPORT
QDir scriptDir();
 
DLLEXPORT
QDir shaderDir();
 
DLLEXPORT
QDir iconDir();
 
DLLEXPORT
QDir translationsDir();
 
DLLEXPORT
QDir fontsDir();
 
DLLEXPORT
QDir dataDir();
 
DLLEXPORT
QString applicationDirStr();
 
DLLEXPORT
QString pluginDirStr();
 
DLLEXPORT
QString shaderDirStr();
 
DLLEXPORT
QString textureDirStr();
 
DLLEXPORT
QString licenseDirStr();
 
DLLEXPORT
QString scriptDirStr();
 
DLLEXPORT
QString iconDirStr();
 
DLLEXPORT
QString dataDirStr();
 
DLLEXPORT
QIcon& OpenFlipperIcon();
 
DLLEXPORT
QString translationsDirStr();
 
DLLEXPORT
QString fontsDirStr();
 
DLLEXPORT
QString helpDirStr();
 
//===========================================================================
//===========================================================================
 
  DLLEXPORT
  QString getGlobalIniFullPath();
 
  DLLEXPORT
  QString getLocalIniFullPath();
 
  DLLEXPORT
  QStringList optionFiles();
 
  DLLEXPORT
  void configDir(QDir _dir);
 
  DLLEXPORT
  bool configDir(QString _dir);
 
  DLLEXPORT
  QString configDirStr();
 
  DLLEXPORT
  QDir configDir();
  
  DLLEXPORT
  bool deleteIniFile();
  
  DLLEXPORT
  void deleteIniFile(bool _delete);
 
//===========================================================================
//===========================================================================
 
  DLLEXPORT
  bool startup();
  
  DLLEXPORT
  void finishedStartup();
 
  DLLEXPORT
  QString currentScriptDirStr();
 
  DLLEXPORT
  QDir currentScriptDir();
 
  DLLEXPORT
  void currentScriptDir(QDir _dir);
 
  DLLEXPORT
  bool currentScriptDir(QString _dir);
 
 
 
  DLLEXPORT
  QString currentTextureDirStr();
 
  DLLEXPORT
  QDir currentTextureDir();
 
  DLLEXPORT
  void currentTextureDir(QDir _dir);
 
  DLLEXPORT
  bool currentTextureDir(QString _dir);
 
 
 
  DLLEXPORT
  QString lastDataType();
 
  DLLEXPORT
  void lastDataType(QString _type);
 
//===========================================================================
//===========================================================================
 
  DLLEXPORT
  bool is64bit();
 
  DLLEXPORT
  bool is32bit();
 
  DLLEXPORT
  bool isLinux();
 
  DLLEXPORT
  bool isWindows();
 
  DLLEXPORT
  bool isDarwin();
 
  DLLEXPORT
  QString dirSeparator();
 
//===========================================================================
//===========================================================================
 
  DLLEXPORT
  QString lang();
 
//===========================================================================
//===========================================================================
 
  DLLEXPORT
  void nogui( bool _nogui );
 
  DLLEXPORT
  bool nogui( );
 
  DLLEXPORT
  bool gui( );
 
  DLLEXPORT
  void coreProfile(bool _enableCoreProfile, bool _temporary = false);
 
  DLLEXPORT
  bool coreProfile( );
  
  DLLEXPORT
  QPair<int,int> glVersion();
  
  DLLEXPORT
  void glVersion(const QPair<int, int>& _version, bool _teporary = false);
  
  DLLEXPORT
  void samples(int _samples, bool _temporary = false);
  
  DLLEXPORT
  int samples();
 
  DLLEXPORT
  void stereo( bool _stereo );
 
  DLLEXPORT
  bool stereo( );
 
  enum StereoMode {
    OpenGL,
    AnaglyphRedCyan,
    AnaglyphCustom
  };
 
  DLLEXPORT
  void glStereo( bool _stereo, bool _temporary = false );
 
  DLLEXPORT
  bool glStereo( );
  
  DLLEXPORT
  bool glStereoRequested( );
 
  DLLEXPORT
  void stereoMode( StereoMode _mode );
 
  DLLEXPORT
  StereoMode stereoMode( );
 
  DLLEXPORT
  void anaglyphLeftEyeColorMatrix( std::vector<float> _mat );
 
  DLLEXPORT
  std::vector<float> anaglyphLeftEyeColorMatrix( );
 
  DLLEXPORT
  void anaglyphRightEyeColorMatrix( std::vector<float> _mat );
 
  DLLEXPORT
  std::vector<float> anaglyphRightEyeColorMatrix( );
 
  DLLEXPORT
  void synchronization( bool _synchronization );
 
  DLLEXPORT
  bool synchronization( );
 
  DLLEXPORT
  void defaultDrawMode( ACG::SceneGraph::DrawModes::DrawMode _mode, int _viewer );
 
  DLLEXPORT
  ACG::SceneGraph::DrawModes::DrawMode defaultDrawMode( int _viewer );
 
  DLLEXPORT
  void defaultPerspectiveProjectionMode( bool _mode, int _viewer );
 
  DLLEXPORT
  bool defaultPerspectiveProjectionMode( int _viewer );
 
  DLLEXPORT
  void defaultViewingDirection( int _mode, int _viewer );
 
  DLLEXPORT
  int defaultViewingDirection( int _viewer );
 
  DLLEXPORT
  void defaultLockRotation( bool _mode, int _viewer );
 
  DLLEXPORT
  bool defaultLockRotation( int _viewer );
 
  DLLEXPORT
  void defaultViewerLayout( int _layout );
 
  DLLEXPORT
  int defaultViewerLayout();
 
  DLLEXPORT
  void redrawDisabled( bool disable );
 
  DLLEXPORT
  bool redrawDisabled( );
 
  DLLEXPORT
  bool drawModesInContextMenu();
 
  DLLEXPORT
  void drawModesInContextMenu(bool _show);
 
//===========================================================================
//===========================================================================
 
  DLLEXPORT
  unsigned int examinerWidgets();
 
  enum LoggerState {
    InScene,
    Normal,
    Hidden
  };
 
  DLLEXPORT
  void loggerState( LoggerState _state);
 
  DLLEXPORT
  LoggerState loggerState( );
 
  DLLEXPORT
  QString currentViewMode( );
 
  DLLEXPORT
  void currentViewMode( QString _mode );
 
  DLLEXPORT
  QString windowTitle( );
 
  DLLEXPORT
  void windowTitle( QString _titel );
 
  DLLEXPORT
  void defaultColor( QColor _color );
 
  DLLEXPORT
  QColor defaultColor();
 
  DLLEXPORT
  void randomDefaultColor(bool _random);
 
  DLLEXPORT
  bool randomDefaultColor();
 
//===========================================================================
//===========================================================================
 
  DLLEXPORT
  bool scripting( );
 
  DLLEXPORT
  void scripting(bool _status );
 
//===========================================================================
//===========================================================================
 
  DLLEXPORT
  bool logToConsole( );
 
  DLLEXPORT
  void logToConsole(bool _logToConsole );
 
  DLLEXPORT
  bool debug();
 
  DLLEXPORT
  void debug(bool _debug );
 
//===========================================================================
//===========================================================================
 
  DLLEXPORT
  bool backupEnabled( );
 
  DLLEXPORT
  void enableBackup(bool _enableBackup );
 
 
  //===========================================================================
  //===========================================================================
 
  DLLEXPORT
  void blockSceneGraphUpdates( );
 
  DLLEXPORT
  void unblockSceneGraphUpdates();
 
  DLLEXPORT
  bool sceneGraphUpdatesBlocked( );
 
//===========================================================================
//===========================================================================
 
  DLLEXPORT
  bool savingSettings( );
 
  DLLEXPORT
  void savingSettings(bool _savingSettings );
 
  DLLEXPORT
  bool loadingRecentFile( );
 
  DLLEXPORT
  void loadingRecentFile(bool _loadingRecentFile );
 
//===========================================================================
//===========================================================================
 
DLLEXPORT
int* argc();
 
DLLEXPORT
char *** argv();
 
DLLEXPORT
void  argc( int* _argc );
 
DLLEXPORT
void argv( char*** _argv);
 
DLLEXPORT
bool remoteControl();
 
DLLEXPORT
void remoteControl( bool _remote );
 
DLLEXPORT
int remoteControlPort();
 
DLLEXPORT
void remoteControlPort(int _remotePort);
 
//===========================================================================
//===========================================================================
 
DLLEXPORT
void doSlotDebugging( bool _debugging );
 
DLLEXPORT
bool doSlotDebugging( );
 
//===========================================================================
//===========================================================================
 
DLLEXPORT
QString coreVersion();
 
DLLEXPORT
QString compilerInfo();
 
DLLEXPORT 
bool initializeSettings();
 
DLLEXPORT 
void closeSettings();
 
}
}