Menu

antzglobals.csv

Shane Saxon

[Home] - [User_Manual] - [File_Types] - hosted at openANTz.com

antzglobals.csv


Globals such as user layout, transparency mode and logins are loaded from the default antzglobals.csv file on startup.

To reset globals to hard-coded default values, simply delete the file and a new one will be generated during startup.

Saving a dataset also saves an instance of the globals with the scene state (nodes, tags, etc.)

antz0001globals.csv
antz0001node.csv
antz0001tag.csv

Loading a dataset will load the globals instance for that set (when the file is present.)

New data elements can ONLY be added to the globals file from the code. To do so you can add a line to the data init structure 'mapGlobals' located in 'npmap.c' file and re-compile.

However, you can modify the globals 'value' column in the CSV file to change the property. It is also possible to delete rows which will result in the app using its current value or upon startup using the hard-coded default for the missing element (row.)


Columns:

np_globals_id - Is an enumerated item_id for the table, can be used by other elements in the table specify the parent structure to support *dynamic data trees.

map_path - Specifies the root data structure (or table) for the element.
item_id - The specific item (row id) that the element belongs to.
element - The element member being accessed.
type - Type tag (in OSC) format, (ie: 'ffff' means the value contains 4 floats.)
permisions - Specifies if the parameter is read/write. '0' defaults to 'rw+'
name - Item name displayed in the GUI and API.
desc - Description of the item.
value - Value of the item


antzglobals.csv file (2014-05-02 release)

np_globals_id,map_path,item_id,element,type,permisions,name,desc,value
1,"np_gl",1,"alpha_mode","i",0,"","","2"
2,"np_gl",1,"background_rgba","ffff",0,"","","0.200000,0.000000,0.500000,1.000000"
3,"np_gl",1,"fullscreen","i",0,"","","0"
4,"np_gl",1,"window_size_xy","ii",0,"","","800,600"
5,"np_gl",1,"position_xy","ii",0,"","","756,238"
6,"np_gl",1,"hud_level","i",0,"","","2"
7,"np_gl",1,"subsample","i",0,"","","1"
8,"np_mouse",1,"tool","i",0,"","","13"
9,"np_mouse",1,"cam_mode","i",0,"","","0"
10,"np_mouse",1,"pick_mode","i",0,"","","3"
11,"np_db",1,"host_ip","s",0,"","","localhost"
12,"np_db",1,"user","s",0,"","","root"
13,"np_db",1,"password","s",0,"","","admin"
14,"np_db",1,"db_type","s",0,"","","mysql"
15,"np_osc",1,"tx_ip","s",0,"","","127.0.0.1"
16,"np_osc",1,"rx_ip","s",0,"","","127.0.0.1"
17,"np_osc",1,"tx_port","i",0,"","","8000"
18,"np_osc",1,"rx_port","i",0,"","","9000"
19,"np_browser",1,"url","s",0,"","","http://openantz.com/usr/docs/id.html"
20,"np_globals",1,"item_count","i",1,"","","20"

*Note that dynamic data trees are not yet supported. However in the future it is planned that you can specify any item from any table as the parent structure. For example, if the map_path = "np_globals" and the item_id = 2 then this items parent is whatever row has np_globals_id = 2 (in this case the parent is np_gl/1/background_rgba/ ).


Related

Wiki: File_Types
Wiki: Home
Wiki: User_Manual