utils/ogl/docs/intro.tex

   1 \chapter{Introduction}
   2 \pagenumbering{arabic}%
   3 \setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
   4 \setfooter{\thepage}{}{}{}{}{\thepage}
   5
   6 Object Graphics Library (\ogl) is a C++ library supporting the creation and
   7 manipulation of simple and complex graphic images on a canvas.
   8
   9 It can be found in the directory {\tt utils/ogl/src} in the
  10 wxWindows distribution. The file {\tt ogl.h} must be included to make use
  11 of the library.
  12
  13 Please see \helpref{OGL overview}{ogloverview} for a general description how the object library works. For details,
  14 please see the \helpref{class reference}{classref}.
  15
  16 \section{File structure}
  17
  18 These are the files that comprise the \ogl\ library.
  19
  20 \begin{description}\itemsep=0pt
  21 \item[basic.h] Header for basic objects such as wxShape and wxRectangleShape.
  22 \item[basic.cpp] Basic objects implementation (1).
  23 \item[basic2.cpp] Basic objects implementation (2).
  24 \item[bmpshape.h] wxBitmapShape class header.
  25 \item[bmpshape.cpp] wxBitmapShape implementation.
  26 \item[canvas.h] wxShapeCanvas class header.
  27 \item[canvas.cpp] wxShapeCanvas class implementation.
  28 \item[composit.h] Composite object class header.
  29 \item[composit.cpp] Composite object class implementation.
  30 \item[constrnt.h] Constraint classes header.
  31 \item[constrnt.cpp] Constraint classes implementation.
  32 \item[divided.h] Divided object class header.
  33 \item[divided.cpp] Divided object class implementation.
  34 \item[drawn.h] Drawn (metafile) object class header.
  35 \item[drawn.cpp] Drawn (metafile) object class implementation.
  36 \item[graphics.h] Main include file.
  37 \item[lines.h] wxLineShape class header.
  38 \item[lines.cpp] wxLineShape class implementation.
  39 \item[misc.h] Miscellaneous graphics functions header.
  40 \item[misc.cpp] Miscellaneous graphics functions implementation.
  41 \item[ogldiag.h] wxDiagram class header.
  42 \item[ogldiag.cpp] wxDiagram implementation.
  43 \item[mfutils.h] Metafile utilities header.
  44 \item[mfutils.cpp] Metafile utilities implementation.
  45 \end{description}
  46
  47