Config

A configuration structure. More...

#include "Config.h"

Public Attributes

	Name
std::string	VERSION <br>The I3T version.
std::string	AUTHOR <br>The author (Michal Folta)
std::string	MAIL <br>The author's mail.
std::string	SUPERVISOR <br>The supervisor (PF)
std::string	SUPERVISOR_MAIL <br>The supervisor's mail.
std::string	WEB_LINK <br>The web link to the thesis page.
std::string	OFFICIAL_SITE <br>The official site.
std::string	INFO_TEXT <br>The information text.
std::string	COPYRIGHT_TEXT <br>printed on the console
std::string	COPYRIGHT_TEXT_SHORT <br>printed on the console
glm::vec3	LINK_COLOR <br>The url link (mailTo: and http:) color used in aboutForm.h.
std::string	DEF_DESC <br>Information describing the definition - initial state of the scene description.
bool	SHOW_CONSOLE <br>True to show, false to hide the console.
bool	FULLSCREEN <br>True to fullscreen.
int	WIN_WIDTH <br>Width of the window - this is not a constant - set on onReshape in main.cpp.
int	WIN_HEIGHT <br>Height of the window - this is not a constant - set on onReshape in main.cpp.
int	REFRESHTIME <br>The refreshtime.
glm::vec3	BACKGROUND_COLOR <br>The background color.
float	CAM_NEAR <br>The camera near plane.
float	CAM_FAR <br>The camera far plane.
float	MOUSE_SENSITIVITY <br>The mouse sensitivity.
float	CAM_MOTION_SENSITIVITY <br>The camera motion sensitivity.
float	CAM_SCROLL_SENSITIVITY <br>The camera scroll sensitivity.
float	CAM_ROLL_SENSITIVITY <br>The camera roll sensitivity.
float	CAM_LERP_DISTTOSTEP_KOEF <br>The camera linearly interpolate disttostep koef.
std::string	CONTENT_FILE <br>The content file, such as \data\content.cnt, enumerating the \data*.cfg files (textures, materials (Phong parameters + textures), geometries (models), and objects (combines names, geometries and textures to groups of named objects))
std::string	LOAD_SCENE <br>The load scene.
std::string	TUTORIALS_FOLDER
std::string	TEXTURE_FOLDER

Detailed Description

cpp

struct Config;

struct Config;

A configuration structure.

it is read by loadFromFile(), default is in the file \cfg_default.dcfg

Public Attributes Documentation

variable VERSION

cpp

static std::string VERSION = "v006";

static std::string VERSION = "v006";

The I3T version.

variable AUTHOR

cpp

static std::string AUTHOR = "Michal Folta";

static std::string AUTHOR = "Michal Folta";

The author (Michal Folta)

variable MAIL

cpp

static std::string MAIL = "michal.fol@gmail.com";

static std::string MAIL = "michal.fol@gmail.com";

The author's mail.

variable SUPERVISOR

cpp

static std::string SUPERVISOR = "Petr Felkel";

static std::string SUPERVISOR = "Petr Felkel";

The supervisor (PF)

variable SUPERVISOR_MAIL

cpp

static std::string SUPERVISOR_MAIL = "felkel@fel.cvut.cz";

static std::string SUPERVISOR_MAIL = "felkel@fel.cvut.cz";

The supervisor's mail.

variable WEB_LINK

cpp

static std::string WEB_LINK = "http://dcgi.felk.cvut.cz/theses/2016/foltamic";

static std::string WEB_LINK = "http://dcgi.felk.cvut.cz/theses/2016/foltamic";

The web link to the thesis page.

variable OFFICIAL_SITE

cpp

static std::string OFFICIAL_SITE = "http://dcgi.fel.cvut.cz/";

static std::string OFFICIAL_SITE = "http://dcgi.fel.cvut.cz/";

The official site.

variable INFO_TEXT

cpp

static std::string INFO_TEXT = "Learn geometric transformations.\n\n"
                                "I3T is an educational application which "
                                "enables the study of 3D transformations and "
                                "their hierarchy in an illustrative way.\n\n"
                                "This tool is a result of master's thesis done "
                                "at the Department of Computer "
                                "Graphics and Interaction, FEL, CTU in Prague";

static std::string INFO_TEXT = "Learn geometric transformations.\n\n"
                                "I3T is an educational application which "
                                "enables the study of 3D transformations and "
                                "their hierarchy in an illustrative way.\n\n"
                                "This tool is a result of master's thesis done "
                                "at the Department of Computer "
                                "Graphics and Interaction, FEL, CTU in Prague";

The information text.

Todo: Add year and note of the continual development.

variable COPYRIGHT_TEXT

cpp

static std::string COPYRIGHT_TEXT = "I3T - The Interactive Tool for Teaching Transformations\n\n"

                                     "  Copyright (C) 2016-2023 I3T team, Department of Computer Graphics\n"
                                     "  and Interaction, FEE, Czech Technical University in Prague, CzechRepublic.\n\n"

                                     "I3T - The Interactive Tool for Teaching Transformations\n"
                                     "  is free software: you can redistribute it and/or modify\n"
                                     "  it under the terms of the GNU General Public License as published by\n"
                                     "  the Free Software Foundation, either version 3 of the License, or\n"
                                     "  (at your option) any later version.\n\n"

                                     "I3T - The Interactive Tool for Teaching Transformations\n"
                                     "  is distributed in the hope that it will be useful,\n"
                                     "  but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
                                     "  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
                                     "  See the GNU General Public License for more details.\n\n"

                                     "You should have received a copy of the GNU General Public License.\n"
                                     "  with this program in the attached file LICENSE.txt. \n"
                                     "  If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>.\n\n"

                                     "Project home: http://www.i3t-tool.org\n\n\n";

static std::string COPYRIGHT_TEXT = "I3T - The Interactive Tool for Teaching Transformations\n\n"

                                     "  Copyright (C) 2016-2023 I3T team, Department of Computer Graphics\n"
                                     "  and Interaction, FEE, Czech Technical University in Prague, CzechRepublic.\n\n"

                                     "I3T - The Interactive Tool for Teaching Transformations\n"
                                     "  is free software: you can redistribute it and/or modify\n"
                                     "  it under the terms of the GNU General Public License as published by\n"
                                     "  the Free Software Foundation, either version 3 of the License, or\n"
                                     "  (at your option) any later version.\n\n"

                                     "I3T - The Interactive Tool for Teaching Transformations\n"
                                     "  is distributed in the hope that it will be useful,\n"
                                     "  but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
                                     "  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
                                     "  See the GNU General Public License for more details.\n\n"

                                     "You should have received a copy of the GNU General Public License.\n"
                                     "  with this program in the attached file LICENSE.txt. \n"
                                     "  If not, see <https://www.gnu.org/licenses/gpl-3.0.txt>.\n\n"

                                     "Project home: http://www.i3t-tool.org\n\n\n";

printed on the console

variable COPYRIGHT_TEXT_SHORT

cpp

static std::string COPYRIGHT_TEXT_SHORT =
    "I3T - The Interactive Tool for Teaching Transformations\n\n"

    "  Copyright (C) 2016-2023 I3T team, Department of Computer Graphics\n"
    "  and Interaction, FEE, Czech Technical University in Prague, CzechRepublic.\n\n"

    "  This program comes with ABSOLUTELY NO WARRANTY. This is free software,\n"
    "  and you are welcome to redistribute it under certain conditions.\n"
    "  For details, read the attached file LICENSE.txt.\n";

static std::string COPYRIGHT_TEXT_SHORT =
    "I3T - The Interactive Tool for Teaching Transformations\n\n"

    "  Copyright (C) 2016-2023 I3T team, Department of Computer Graphics\n"
    "  and Interaction, FEE, Czech Technical University in Prague, CzechRepublic.\n\n"

    "  This program comes with ABSOLUTELY NO WARRANTY. This is free software,\n"
    "  and you are welcome to redistribute it under certain conditions.\n"
    "  For details, read the attached file LICENSE.txt.\n";

printed on the console

variable LINK_COLOR

cpp

static glm::vec3 LINK_COLOR = glm::vec3(0.55f, 0.8f, 1.0f);

static glm::vec3 LINK_COLOR = glm::vec3(0.55f, 0.8f, 1.0f);

The url link (mailTo: and http:) color used in aboutForm.h.

Todo: Move to the config structure

variable DEF_DESC

cpp

static std::string DEF_DESC =

    "Describe your scene here.\n"
    "\n"
    "Controls:\n"
    "-------------------------\n"
    "\n"
    "Camera:\n"
    "\n"
    "mouse right  - rotate\n"
    "mouse middle - pan\n"
    "mouse scroll - zoom\n"
    "\n"
    "work space:\n"
    "\n"
    "mouse left   - components movement\n"
    "mouse right  - menu\n"
    "mouse middle - pan\n"
    "mouse scroll - zoom\n";

static std::string DEF_DESC =

    "Describe your scene here.\n"
    "\n"
    "Controls:\n"
    "-------------------------\n"
    "\n"
    "Camera:\n"
    "\n"
    "mouse right  - rotate\n"
    "mouse middle - pan\n"
    "mouse scroll - zoom\n"
    "\n"
    "work space:\n"
    "\n"
    "mouse left   - components movement\n"
    "mouse right  - menu\n"
    "mouse middle - pan\n"
    "mouse scroll - zoom\n";

Information describing the definition - initial state of the scene description.

Todo:

Update to contain all key bindings from tabsConfig.cpp
Complete the help: Fill in all missing key combinations into the help window in config.h

Text of the help -.

variable SHOW_CONSOLE

cpp

static bool SHOW_CONSOLE = false;

static bool SHOW_CONSOLE = false;

True to show, false to hide the console.

variable FULLSCREEN

cpp

static bool FULLSCREEN = false;

static bool FULLSCREEN = false;

True to fullscreen.

variable WIN_WIDTH

cpp

static int WIN_WIDTH = 1400;

static int WIN_WIDTH = 1400;

Width of the window - this is not a constant - set on onReshape in main.cpp.

variable WIN_HEIGHT

cpp

static int WIN_HEIGHT = 900;

static int WIN_HEIGHT = 900;

Height of the window - this is not a constant - set on onReshape in main.cpp.

variable REFRESHTIME

cpp

static int REFRESHTIME = 17;

static int REFRESHTIME = 17;

The refreshtime.

variable BACKGROUND_COLOR

cpp

static glm::vec3 BACKGROUND_COLOR = glm::vec3(0.3f, 0.3f, 0.35f);

static glm::vec3 BACKGROUND_COLOR = glm::vec3(0.3f, 0.3f, 0.35f);

The background color.

variable CAM_NEAR

cpp

static float CAM_NEAR = 1.0f;

static float CAM_NEAR = 1.0f;

The camera near plane.

variable CAM_FAR

cpp

static float CAM_FAR = 1000.0f;

static float CAM_FAR = 1000.0f;

The camera far plane.

variable MOUSE_SENSITIVITY

cpp

static float MOUSE_SENSITIVITY = 0.2f;

static float MOUSE_SENSITIVITY = 0.2f;

The mouse sensitivity.

variable CAM_MOTION_SENSITIVITY

cpp

static float CAM_MOTION_SENSITIVITY = 0.1f;

static float CAM_MOTION_SENSITIVITY = 0.1f;

The camera motion sensitivity.

variable CAM_SCROLL_SENSITIVITY

cpp

static float CAM_SCROLL_SENSITIVITY = 0.02f;

static float CAM_SCROLL_SENSITIVITY = 0.02f;

The camera scroll sensitivity.

variable CAM_ROLL_SENSITIVITY

cpp

static float CAM_ROLL_SENSITIVITY = 0.001f;

static float CAM_ROLL_SENSITIVITY = 0.001f;

The camera roll sensitivity.

variable CAM_LERP_DISTTOSTEP_KOEF

cpp

static float CAM_LERP_DISTTOSTEP_KOEF = 0.05f;

static float CAM_LERP_DISTTOSTEP_KOEF = 0.05f;

The camera linearly interpolate disttostep koef.

variable CONTENT_FILE

cpp

static std::string CONTENT_FILE = "Data/content.cfg";

static std::string CONTENT_FILE = "Data/content.cfg";

The content file, such as \data\content.cnt, enumerating the \data*.cfg files (textures, materials (Phong parameters + textures), geometries (models), and objects (combines names, geometries and textures to groups of named objects))

variable LOAD_SCENE

cpp

static std::string LOAD_SCENE = "NONE";

static std::string LOAD_SCENE = "NONE";

The load scene.

variable TUTORIALS_FOLDER

cpp

static std::string TUTORIALS_FOLDER = "Data/Tutorials/";

static std::string TUTORIALS_FOLDER = "Data/Tutorials/";

variable TEXTURE_FOLDER

cpp

static std::string TEXTURE_FOLDER = "Data/Textures/";

static std::string TEXTURE_FOLDER = "Data/Textures/";

Updated on 2024-03-16 at 19:15:00 +0000

Classes

Namespaces

Config

Public Attributes

Detailed Description

Public Attributes Documentation

variable VERSION

variable AUTHOR

variable MAIL

variable SUPERVISOR

variable SUPERVISOR_MAIL

variable WEB_LINK

variable OFFICIAL_SITE

variable INFO_TEXT

variable COPYRIGHT_TEXT

variable COPYRIGHT_TEXT_SHORT

variable LINK_COLOR

variable DEF_DESC

variable SHOW_CONSOLE

variable FULLSCREEN

variable WIN_WIDTH

variable WIN_HEIGHT

variable REFRESHTIME

variable BACKGROUND_COLOR

variable CAM_NEAR

variable CAM_FAR

variable MOUSE_SENSITIVITY

variable CAM_MOTION_SENSITIVITY

variable CAM_SCROLL_SENSITIVITY

variable CAM_ROLL_SENSITIVITY

variable CAM_LERP_DISTTOSTEP_KOEF

variable CONTENT_FILE

variable LOAD_SCENE

variable TUTORIALS_FOLDER

variable TEXTURE_FOLDER

Config ​

Public Attributes ​

Detailed Description ​

Public Attributes Documentation ​

variable VERSION ​

variable AUTHOR ​

variable MAIL ​

variable SUPERVISOR ​

variable SUPERVISOR_MAIL ​

variable WEB_LINK ​

variable OFFICIAL_SITE ​

variable INFO_TEXT ​

variable COPYRIGHT_TEXT ​

variable COPYRIGHT_TEXT_SHORT ​

variable LINK_COLOR ​

variable DEF_DESC ​

variable SHOW_CONSOLE ​

variable FULLSCREEN ​

variable WIN_WIDTH ​

variable WIN_HEIGHT ​

variable REFRESHTIME ​

variable BACKGROUND_COLOR ​

variable CAM_NEAR ​

variable CAM_FAR ​

variable MOUSE_SENSITIVITY ​

variable CAM_MOTION_SENSITIVITY ​

variable CAM_SCROLL_SENSITIVITY ​

variable CAM_ROLL_SENSITIVITY ​

variable CAM_LERP_DISTTOSTEP_KOEF ​

variable CONTENT_FILE ​

variable LOAD_SCENE ​

variable TUTORIALS_FOLDER ​

variable TEXTURE_FOLDER ​

Config

Public Attributes

Detailed Description

Public Attributes Documentation

variable VERSION

variable AUTHOR

variable MAIL

variable SUPERVISOR

variable SUPERVISOR_MAIL

variable WEB_LINK

variable OFFICIAL_SITE

variable INFO_TEXT

variable COPYRIGHT_TEXT

variable COPYRIGHT_TEXT_SHORT

variable LINK_COLOR

variable DEF_DESC

variable SHOW_CONSOLE

variable FULLSCREEN

variable WIN_WIDTH

variable WIN_HEIGHT

variable REFRESHTIME

variable BACKGROUND_COLOR

variable CAM_NEAR

variable CAM_FAR

variable MOUSE_SENSITIVITY

variable CAM_MOTION_SENSITIVITY

variable CAM_SCROLL_SENSITIVITY

variable CAM_ROLL_SENSITIVITY

variable CAM_LERP_DISTTOSTEP_KOEF

variable CONTENT_FILE

variable LOAD_SCENE

variable TUTORIALS_FOLDER

variable TEXTURE_FOLDER