Doc version: 2.1

Author: Gwenole Capp

email: gwenole.capp@gmail.com

Multidimensional Data Entity - GL display

Version 0.3.2

public: std::string data

private: std::string name

private: std::vector<*MDE> vMDE

The public member data holds all data assigned to the private member name, can store strings of any size and can include the space character.

The private member name holds a string of any size but no space character should be included, it acts as a name for the MDE internally.

The private member vMDE is a standard vector of pointers to instances of MDE, that is what gives the multidimension capability of a MDE instance.

Main documentation and detailed API can be found here

Menu flow in text mode

Main menu:

Option 1 opens the Data Menu, select if you want to load a file.

The path and name of the file that is currently loaded into the MDE instance is displayed under option 1.

Option 2 opens the Font Menu, select if you want to change the Font, the Font size or the Font Color.

The current Font, Font size and Font colors & Alpha are displayed.

Option 3 opens the Coordinates Menu, select if you want to change the coordinates of the master of the MDE instance, or to set the rules for the offset betweens the element of a MDE instance.

The Current coordinates and current rules are displayed.

Option 4 opens the Frame Menu, select if you want to display a frame box behind the text for each 'name' and 'data' of an MDE instance, to set the colors and alpha for that frame box or set horizontal and vertical padding values for displaying the text within that frame box.

ON/OFF indicator for the display of the frame box is shown, also the Colors & Alpha for the frame box and the padding are displayed.

Option 5 opens the Color Menu, select if you want to change colors and alpha for the background, the font or the frame box (if the frame box display is on).

The current colors and Alpha are displayed here for the Backgound, the Font and the Frame Box, if the Frame Box switch is ON (in the Frame Menu).

Option t displays the MDE instance in the terminal.

Option g displays the MDE instance in an openGL context (using freeglut).

Data Menu

Option 1 opens the Load File, select if you want to load a file.

The path and name of the file currently loaded is displayed .

Option 2 is to load a hard coded dataset used for testing.

Option 3 is for entering manually and recursively names and data into the MDE instance.

Starting from the master Entity, you enter name and data then create sub-entities by entering name and data for each indexes, starting with the level just after the master Entity and going top to bottom, until user type 'end' in the name of each branches created.(to clarify)

You can save a data set as an xml file after options 2 or 3.

Option b is to go back to the parent menu.

Option q is to quit the program.

Font Menu

Option 1 opens menu Font to a font from a list.

The current font is displayed.

Option 2 is to enter Font Size as an non-signed integer.

The current Font size is displayed.

Option 3 is to enter the (R,G,B,A) float values for the Colors and Alpha for the Font.

The current (R,G,B,A) for the Font are displayed.

Option b is to go back to the parent menu.

Option q is to quit the program.

Coordinates Menu

Option 1 is to enter the (x,y,z) float values as coordinate for the master entity of the MDE instance.

The current coordinates of the master entity is displayed.

Option 2 is to open the Offset Rules menu, select if you want to change the offset rules determining the distance between each type of elements of a MDE instance.

All current rules's (x,y,z) values are displayed.

Option b is to go back to the parent menu.

Option q is to quit the program.

Frame Menu

Option 1 is to switch ON/OFF the fame box display. The frame box is an individual 3D colored box on which the text is displayed.

The current state of the switch is displayed (ON or OFF).

Option 2 is to enter the (R,G,B,A) float values for the Colors and Alpha for the Frame Box.

The current (R,G,B,A) for the Frame Box are displayed.

Option 3 is to enter the horizontal and veticale float values for the Padding between the edge of the Frame box and the text.

The current horizontal and vertical padding values are displayed.

Option b is to go back to the parent menu.

Option q is to quit the program.

Color Menu

Option 1 is to enter the (R,G,B,A) float values for the Background of the openGL viewport.

The current (R,G,B,A) for the Background are displayed.

Option 2 is to enter the (R,G,B,A) float values for the Colors and Alpha for the Font.

The current (R,G,B,A) for the Font are displayed.

Option 3 is to enter the (R,G,B,A) float values for the Colors and Alpha for the Frame Box. It is available only if the Frame BOx display switch is set to ON.

The current horizontal and vertical padding values are displayed (If the Frame box switch to ON).

Option b is to go back to the parent menu.

Option q is to quit the program.

Load File

The path and name of the current loaded file is displayed.

Option 1 is to enter the name and path of the file to load. The file has to be in the ../datafiles folder and include the extension (most likely xml).

Options 2, 3 and 4 are to load some example/testing files.

Option b is to go back to the parent menu.

Option q is to quit the program.

Font

The current Font name is displayed.

Options 1, 2, 3 and 4 are to select the Font.

Offset Rules

Option 1 is to enter the (x,y,z) float values as coordinate offset between the elements name and data of each entities of the MDE instance.

The current offset rule (x,y,z) for name<->data is displayed.

Option 2 is to enter the (x,y,z) float values as coordinate offset between the indexes of within vMDE sub-entities of the MDE instance.

The current offset rule (x,y,z) for index is displayed.

Option 3 is to enter the (x,y,z) float values as coordinate offset between the levels of each sub-entities of the MDE instance.

The current offset rule (x,y,z) for level is displayed.

Option b is to go back to the parent menu.

Option q is to quit the program.

Mouse control in Graphic Mode menu:

Use Mouse Left click to look around right, left, up or down with the camera .

Use Mouse Wheel to zoom in or out.

Keyboard control in Graphic Mode menu:

Use keys WASD or arrow keys to move camera:

       W or up to move forward

       S or down to move backward

       A or left to move left

       D or right to move right

Use key ESC to exit the program.