r547: no message
[ctsim.git] / doc / ctsim-appendix.tex
index c25c257638428656f2d10772a88b7efe61d5bf94..a826258e35e415887b2a6c4046eee6a9de106a84 100644 (file)
-\chapter{Appendix}\label{appendix}\index{Appendix}%
-\setheader{{\it CHAPTER \thechapter}}{}{}{}{}{{\it CHAPTER \thechapter}}%
-\setfooter{\thepage}{}{}{}{}{\thepage}%
+\appendix
 
-\section{Simple Graphics Package}\index{Simple Graphics Package}%
+\chapter{Simple Graphics Package}\label{appendix}\index{Simple Graphics Package}
+\setheader{{\it Appendix \thechapter}}{}{}{\ctsimheadtitle}{}{{\it Appendix \thechapter}}%
+\ctsimfooter%
 
-\subsection{Overview}%
-Simple Graphics Package was creates in 1983 by Kevin Rosenberg and is modelled after the graphics library in Foley and van Dam\cite{FOLEY82}.
+Simple Graphics Package was created in 1980 by Kevin Rosenberg and
+is modelled after the hypothetical graphics library described by Foley and van
+Dam\cite{FOLEY82}. It is designed to be platform-independent.
 
-\begin{verbatim}
-                       +------------------------+
-                       | World Coordinate level |
-                       +-----------+------------+
-                                   |
-                     +-------------+-------------+
-                     | Clipping against Window() |
-                     +-------------+-------------+
-                                   |
-                      +------------+-------------+
-                      | Convert to Normalized    |
-                      | device coordinates (NDC) |
-                      +------------+-------------+
-                                   |
-                     +-------------+-------------+
-                     | Clipping against Viewport |
-                     +-------------+-------------+
-                                   |
-                      +------------+-------------+
-                      | Convert to Physical      |
-                      | device coordinates (PDC) |
-                      +--------------------------+
-\end{verbatim}
+\section{Transformation Sequence}
+\latexonly{
+\parbox{11cm}{
+\centerline{Master coordinate (MC) level}
+\centerline{$\downarrow$}
+\centerline{Apply \emph{Current transformation matrix}}
+\centerline{$\downarrow$}
+\centerline{World coordinate (WC) level}
+\centerline{$\downarrow$}
+\centerline{Clipping against Window}
+\centerline{$\downarrow$}
+\centerline{Convert to Normalized device coordinates (NDC)}
+\centerline{$\downarrow$}
+\centerline{Clipping against Viewport}
+\centerline{$\downarrow$}
+\centerline{Convert to Physical device coordinates (PDC)}
+}}
+\latexignore{
+\centerline{Master coordinate (MC) level}
+\centerline{Apply \emph{Current transformation matrix}}
+\centerline{World coordinate (WC) level}
+\centerline{Clipping against Window}
+\centerline{Convert to Normalized device coordinates (NDC)}
+\centerline{Clipping against Viewport}
+\centerline{Convert to Physical device coordinates (PDC)}
+}
 
-\subsection{Functions}%
+\section{Functions}%
 
-\subsubsection{World Coordinate Level}%
-     initgrf2 ()                         Initialize 2 dimensional graphics\\
-     termgrf2 ()                         Terminate 2 dimensional graphics\\
-     Window  (xmin, ymin, xmax, ymax)   Set window for world coordinates\\
-     Viewport (xmin, ymin, xmax, ymax)   Viewport for window in NDC\\
-     MoveAbs (x, y)                     Move graphics cursor\\
-     MoveRel (dx, dy)\\
-     PointAbs (x, y)                      Plot point at current position\\
-     PointRel (dx, dy)\\
-     LineAbs2 (x, y)             Draw line from current point to point\\
-     LineRel2 (dx, dy)\\
-     MarkerAbs2 (x, y)                     Draw marker at current position\\
-     MarkerRel2 (dx, dy)\\
-     PolylineAbs (x[], y[], n)             Draw a set of lines\\
-     PolylineRel (dx[]. dy[]. n)\\
-     wc\_to\_ndc (xwc, ywc, xndc, yndc)    Convert from world coord to NDC\\
-     ndc\_to\_wc (xndc, yndc, xwc, ywc)    Convert from NDC to world coord\\
-     DrawText (str)                      Draw text string at current positon\\
+\subsection{Master coordinate functions}
+\begin{twocollist}
+\twocolitem{\texttt{setWindow(xmin,ymin,xmax,ymax)}}{Set window for world
+coordinates}
+\twocolitem{\texttt{moveAbs(x,y)}}{Move graphics cursor to absolute position}
+\twocolitem{\texttt{moveRel(dx,dy)}}{Move graphics cursor relative to current position}
+\twocolitem{\texttt{pointAbs(x,y)}}{Draw point at current position}
+\twocolitem{\texttt{pointRel(dx,dy)}}{Draw point relative to current position}
+\twocolitem{\texttt{lineAbs(x,y)}}{Draw line from current position to
+absolute position}
+\twocolitem{\texttt{lineRel(dx,dy)}}{Draw line from current position to position
+relative to current position}
+\twocolitem{\texttt{markerAbs(x,y)}}{Draw marker at current position}
+\twocolitem{\texttt{markerRel(dx,dy)}}{Draw marker relative to current position}
+\twocolitem{\texttt{polylineAbs(x[],y[],n)}}{Draw a series of lines to absolute position}
+\twocolitem{\texttt{polylineRel(dx[],dy[],n)}}{Draw series of lines relative to current position}
+\twocolitem{\texttt{drawString(str)}}{Draw text string at current positon}
+\twocolitem{\texttt{drawCircle(r)}}{Draw circle at current positon}
+\twocolitem{\texttt{drawArc(r,start,stop)}}{Draw arc with center at current positon}
+\twocolitem{\texttt{drawRect(xmin,ymin,xmax,ymax)}}{Draw rectangle}
+\end{twocollist}
 
-     INTERNAL:\\
-          calc\_map ()                        Calculate wc to ndc factors\\
-          clip(rectangle[4], x1, y1, x2, y2) Clip a line againt rectangle\\
+\subsection{Normalized coordinate functions}%
+\begin{twocollist}
+\twocolitem{\texttt{Viewport(xmin,ymin,xmax,ymax)}}{Viewport for window
+in NDC}
+\twocolitem{\texttt{stylus(x,y,beam)}}{Draw a line from current
+position if beam = 1, otherwise move stylus to new position}
+\twocolitem{\texttt{markerNDC(xndc,yndc)}}{Draw marker at NDC position}
+\end{twocollist}
 
+\subsection{Master coordinate to World coordinate transformations}%
+These transformation functions operate on the \emph{Current transformation
+matrix} (CTM).
 
-\subsubsection{Normalized Coordinate level}%
-     stylus (x, y, beam)                 Draw a line from current position\\
-     setColor (color)            Set current drawing color\\
-     setLinestyle (style)                Set current line style\\
-     setLinewidth (width)                Set current line width\\
-     setTextColor (foreground, background) If back=-1, then transparent \\
+\begin{twocollist}
+\twocolitem{\texttt{clearCTM()}}{Sets the CTM to an identity matrix}
+\twocolitem{\texttt{preTranslate(x,y)}}{Apply translation to CTM}
+\twocolitem{\texttt{postTranslate(x,y)}}{Apply translation to CTM}
+\twocolitem{\texttt{preScale(x,y)}}{Apply scale to CTM}
+\twocolitem{\texttt{postScale(x,y)}}{Apply scale to CTM}
+\twocolitem{\texttt{preRotate(angle)}}{Apply rotation to CTM}
+\twocolitem{\texttt{postRotate(angle)}}{Apply rotation to CTM}
+\twocolitem{\texttt{preShear(x,y)}}{Apply shear to CTM}
+\twocolitem{\texttt{postShear(x,y)}}{Apply shear to CTM}
+\end{twocollist}
 
-     setMarker (type, color)      Set marker attibutes\\
-     markerNDC (xndc, yndc)                Draw marker at NDC position\\
+\subsection{Coordinate transformation functions}%
+\begin{twocollist}
+\twocolitem{\texttt{transformMCtoNDC(\&x,\&y)}}{Convert from master
+coordinates to NDC}
+\twocolitem{\texttt{transformNDCtoMC(\&x,\&y)}}{Convert from NDC to master
+coordinates}
+\end{twocollist}
 
-\subsection{Coordinate Mapping}%
+\subsection{State functions}
+\begin{twocollist}
+\twocolitem{\texttt{eraseWindow()}}{Clears the screen}
+\twocolitem{\texttt{setColor(color)}}{Set current pen color}
+\twocolitem{\texttt{setLinestyle(style)}}{Set current pen style}
+\twocolitem{\texttt{setLinewidth(width)}}{Set current pen width}
+\twocolitem{\texttt{setTextColor(foreground, background)}}{Set text colors}
+\twocolitem{\texttt{setMarker(type,color)}}{Set marker attibutes}
+\twocolitem{\texttt{setRasterOp(rasterOp)}}{Set raster operator}
+\end{twocollist}
 
-\subsubsection{Mapping from world coordinates to physical device coordinates}%
+\section{Coordinate Mapping}
 
-Window (World Coordinates):   xwmin, xwmax, ywmin, ywmax \\
-Viewport (Normalized Device Coordinates): xvmin, xvmax, yvmin, yvmax\\
-Physical (Physicial Device Coordinates): xpmax, ypmax\\
+\subsection{Dimensions}
+Window (World Coordinates):  $X_{wmin}, X_{wmax}, Y_{wmin}, Y_{wmax}$ \\
+Viewport (Normalized Device Coordinates): $X_{vmin}, X_{vmax}, Y_{vmin}, Y_{vmax}$\\
+Physical (Physicial Device Coordinates): $X_{pmax}, Y_{pmax}$\\
+
+\subsection{Formulas}
+To convert from Master coordinates to World coordinates: \\
+\centerline{Apply \emph{current transformation matrix}}
 
 To convert from WC to NDC:\\
 \begin{equation}
-     X_{ndc} = X_vmin + (X_wc - X_wmin) / (X_wmax - X_wmin)
+X_{ndc} = X_{vmin} + (X_{vmax} - X_{vmin})  (X_{wc} - X_{wmin}) / (X_{wmax} - X_{wmin})
 \end{equation}
 \begin{equation}
-     Y_{ndc} = Y_vmin + (Y_wc - Y_wmin) / (Y_wmax - Y_wmin)
+Y_{ndc} = Y_{vmin} + (Y_{vmax} - Y_{vmin}) (Y_{wc} - Y_{wmin}) / (Y_{wmax} - Y_{wmin})
 \end{equation}
+
 To convert from NDC to PDC:
 \begin{equation}
      X_{pdc} = X_{ndc} X_{pmax}
@@ -89,17 +129,3 @@ To convert from NDC to PDC:
 \begin{equation}
      Y_{pdc} = X_{ndc} Y_{pmax}
 \end{equation}
-
-So, for each device set up the following composite transformation:\\
-\begin{equation}
-     x_{pdc} = x_{pmax} (x_{vmin} + (x_{wc} - x_{wmin}) / (x_{wmax} - x_{wmin}))
-\end{equation}
-\begin{equation}
-     y_{pdc} = y_{pmax} (y_{vmin} + (y_{wc} - y_{wmin}) / (y_{wmax} - y_{wmin}))
-\end{equation}
-\begin{equation}
-     X_{pdc} = X_{pmax} X_{vmin} + ((X_{wc} \- X_{wmin})  X_{pmax})/(X_{wmax} \- X_{wmin}))
-\end{equation}
-\begin{equation}
-     X_{pdc} = X_{add} + (X_wc - X_{sub})  X_{fract}
-\end{equation}