glData : Development

Developer's Guide

Adapted from the ai.planet "Developer Set Up" Tutorial by Dave Kerr. Version 1.03 - June 28 2004.

To develop glData, you should use the Concurrent Version System (CVS). You will need CVS to get the latest versions of both glData and glScene.

Initial Setup

Here are easy steps to set up your Delphi 7 environment to develop glData.

  1. Create a sourceforge account
  2. Install a CVS client
  3. Install the Delphi 7.0 Unofficial ActionBands Update
  4. Install the kbmMemTable library
  5. Install the Graphics32 Library
  6. Download and install GLScene
  7. Install glData
  8. Compile glData Components
  9. Compile glData

Developing

  1. Join the team
  2. Communication
  3. Contributing Code
  4. Bug Reports/Feature Requests
  5. Optimization

Create a sourceforge account

Visit sourceforge and create an account: http://www.sourceforge.net.

∆ Top of Page

Install a CVS client

There are a number of CVS tools you can use:

∆ Top of Page

Install the Delphi 7.0 Unofficial ActionBands Update

glData uses the TActionPopupMenu component. This is available in the Delphi 7.0 ActionBands Update - available on Steve Trefethen's Website.

Delphi Update 7.1 is also recommended

∆ Top of Page

Install the kbmMemTable library

Download the latest (4.08b) version of kbmMemTable. Follow the installation directions from the supplied README.txt file.

∆ Top of Page

Install the Graphics32 Library

Download and install the latest version (1.5.1) of Alex Denisov's Graphics 32 Library.

∆ Top of Page

Download and install GLScene

This section discusses how to obtain the latest version of GLScene - OpenGL solution for Delphi.

You should first read this GLScene CVS Tutorial. The following list of steps assume you are using TortoiseCVS.

  1. Open Windows explorer
  2. Make a directory on your computer called GLScene.
  3. Right-click on the GLScene directory, and select "CVS Checkout".
  4. If you are not a developer, then use Secure Shell for protocol, and 'anonymous' for Username.
  5. If you are a developer, then use Password for protocol, and your SourceForge account for Username.
  6. For Server, type "cvs.sourceforge.net".
  7. For Repository, type "/cvsroot/glscene".
  8. For Module, type "Source".
  9. Then click OK.
  10. Repeat the above steps, with Module "Delphi7" instead of "Source". If you are using Delphi6 or other version then type that version instead. This tutorial assumes version 7.
  11. Open the GLScene\Delphi7 directory, and Open "GLScene7.dpk". Recommended: Click Options and set the Output directory to: "C:\Program Files\Borland\Delphi7\Lib". This allows Delphi to find the GLScene DCUs anywhere.
  12. GLScene.inc will need to be edited to automagically use GR32 images. Inside the .inc is the line:// Activate support for Alex Denissov's Graphics32 library (http://www.g32.org). Simply remove the . from the next line: {.$DEFINE GLS_Graphics32_SUPPORT}. The Graphics32 library is NOT included in any GLScene download, it is available from its own website. If GR32 is used you will need to change its Always compile to OFF (the last line of the list of Compiler Directives), otherwise Glscene will have an error message.
  13. Compile, then Install.

∆ Top of Page

Install glData

  1. Open Windows explorer
  2. Make a Directory on your computer called "glData".
  3. Right-click on the glData directory, and select "CVS Checkout"
  4. If you are not a developer, then use Secure Shell for protocol, and 'anonymous' for Username.
  5. If you are a developer, then use Password for protocol, and your SourceForge account for Username.
  6. For Server, type "cvs.sourceforge.net"
  7. For Repository, type "/cvsroot/glData"
  8. Install Modules
    • built - sample files, installation build scripts
    • comps - import/export components, required for compiling glData
    • dcus - does not contain any DCUS (delphi compiled units). Present to store dcus on a developers machine. Please don't commit dcus to the repository.
    • project - delphi project(s). At present only Delphi 7 version.
    • source - source code. Split into two submodules: code (.pas files only) and interface (containing forms).
  9. Then click OK. There is a couple of MB of files to download so please be patient.

∆ Top of Page

Compile glData Components

In the comps directory there is a package file for Delphi 7 called "GEdgeIO_D7.dpk". Open this in Delphi and select Install. Repeat for "GEdgeIDDB_D7.dpk".

∆ Top of Page

Compile glData

  1. In the project\delphi7 directory open up the glData.dpr project.
  2. Select "Build All".
  3. If it compiles succesfully, then you are ready to develop!
  4. If it does not compile, you may have not installed one of the third party libraries or GLScene correctly, or the GLScene DCUs cannot be found.
  5. Try "Running" glData to view your data.

∆ Top of Page

Join the Team

  1. Visit SourceForge.net and create a user account.
  2. Ask Aaron to add you to the developer list.
  3. You will now have access to the developer forum.
  4. Please join the developer mailing list.

∆ Top of Page

Communication

You should post a message to the forum and say what you would like to do. If you are having problems then someone will help you out.

∆ Top of Page

Contributing Code

Code can be added or modified directly from CVS.

  1. Open Windows Explorer.
  2. Find the directory with your modified file.
  3. Click that directory with the right mouse button.
  4. Select CVS Commit if you changed a file or CVS Add if you made a new file.
  5. Please do not submit DCUs.

Alternatively code contributions may be posted on the sourceforge forums.

∆ Top of Page

Bug Reports/Feature Requests

Post a message in the forums about the bug. If it is a serious bug, or no one is fixing it, use the SourceForge bug reporting tool.

∆ Top of Page

Optimization

Use GpProfile to optimise code.

∆ Top of Page