VGIS Documentation

Last Modified: 6/30/2006 12:46:00 PM

Source: developer.doc

Original Author: Zachary Wartell

Current Document Maintainer: Zachary Wartell

Contributors: <add names here>

Table of Contents

1 Purpose. 5

2 Typological Conventions. 5

2.1 Printing This Document 5

3 Getting Started. 5

3.1 VGIS Developers at College of Computing (CoC) at Georgia Tech. 6

3.2 VGIS Developers Elsewhere. 6

4 General Issues. 6

4.1 Getting Help. 6

4.2 Installing VGIS. 6

4.3 Compiling. 7

4.3.1 Microsoft Windows. 7

4.3.1.1 Compiling for Visual Studio .Net 2005. 8

4.3.1.2 Compiling for Visual Studio .Net 2003 (!! Discouraged !!) 8

4.3.1.3 Compiling for Visual Studio 6.0 (!! Deprecated !!) 9

4.3.1.4 EOEML versus College of Computing Compilation Scripts. 9

4.3.2 Unix and Linux. 10

4.3.2.1 EOEML versus College of Computing Compilation Scripts. 11

4.4 Running VGIS Applications. 11

5 Design Documents. 11

5.1 VGIS System Overview.. 12

5.2 Terrain Paging Algorithm.. 12

5.3 API (Doxygen generated) 12

5.4 Other Documentation. 12

5.5 Quadnodes and Coordinate Systems. 12

5.6 Feature Vector Support 15

5.7 File Formats. 15

5.7.1 Configuration Files. 15

5.7.2 Data Files. 15

5.7.2.1 Misc Formats. 15

5.7.2.2 Feature Format 16

5.7.2.3 Quickload Format 16

5.8 External Deprecated Documents. 16

6 Extending VGIS. 17

6.1 C/C++ Coding Standards. 17

6.1.1 Scope of Include Files, Functions, Data Types. 17

6.1.2 Source Code Style and Commenting. 18

6.1.3 CVS Commits. 20

6.2 Adding VGIS Libraries. 20

6.2.1 General Steps: 20

6.2.2 MSVC 6.0 Steps: 21

6.3 Adding External Libraries. 24

6.4 Data File Standards. 25

6.4.1 ASCII Files. 25

6.4.2 VGIS Extendend Backus-Naur Form.. 25

6.4.3 Binary Files. 26

6.5 Modularity. 26

6.5.1 Windows Linker Forces Modularity. 27

6.6 Microsoft Windows Issues. 27

6.6.1 Portability. 28

6.7 Conventions and Hints for CVS. 28

6.7.1 Locating and Installing CVS. 29

6.7.1.1 Georgia Tech Specific Instructions.