home *** CD-ROM | disk | FTP | other *** search
/ Carousel / CAROUSEL.cdr / mactosh / code / p_fracap.sit / UFracAppPalette.inc1.p < prev    next >
Text File  |  1988-08-17  |  71KB  |  1,571 lines

  1. {------------------------------------------------------------
  2. #
  3. #    Apple Macintosh Developer Technical Support
  4. #
  5. #    MacApp Color QuickDraw Palette Fractal Sample Application
  6. #
  7. #    FracAppPalette
  8. #
  9. #    UFracAppPalette.inc1.p    -    Pascal Source
  10. #
  11. #    Copyright ⌐ 1988 Apple Computer, Inc.
  12. #    All rights reserved.
  13. #
  14. #    Versions:    1.0                        8/88
  15. #
  16. #    Components:    MFracAppPalette.p        August 1, 1988
  17. #                UFracAppPalette.p        August 1, 1988
  18. #                UFracAppPalette.inc1.p    August 1, 1988
  19. #                FracAppPalette.r        August 1, 1988
  20. #                FracAppPalette.make        August 1, 1988
  21. #
  22. #    The FracAppPalette program is a version of the FracApp program that is
  23. #    set up to be as compatible as possible.  To this end it uses the Palette
  24. #    Manager to set up the color environment.  It does not support color table
  25. #    animation.  It demonstrates how to use the Palette Manager for standard
  26. #    color use.  It shows how to create and use an offscreen gDevice w/ Port
  27. #    for special color useage, as well as how to CopyBits that data up to the
  28. #    screen to handle update events.  PICT files are read and written, using the
  29. #    quickdraw bottlenecks to minimize the use of memory.
  30. #            Written in MacApp Object Pascal code.
  31. #            Compatibility rating = 0, no known risks.
  32. #
  33. #    The program is a complete Macintosh application written in Object 
  34. #    Pascal using MacApp.  It supports multiple windows, calculations in the
  35. #    background under MultiFinder, use of the Palette Manager, reading and
  36. #    writing of PICT files using the bottlenecks, and shows how to calculate
  37. #    the Mandelbrot set.
  38. #
  39. #    There is a resource file that is necessary as well, to define the Menus, Window,
  40. #    Dialog, Color table, and Palette resources used in the program.
  41. #
  42. ------------------------------------------------------------}
  43. { FracAppPalette:
  44.     Copyright 1988 by Bob.  All rights reserved, since Bob has all rights.
  45.     February 1, 1988. 
  46.     Written by Bo3b Johnson of Developer Technical Support. }
  47.     
  48. { Version 1.0 }
  49.  
  50. { The following is a list of features or bug fixes that could be added to the program:
  51.   *** Check the segmentation.
  52.   *** Make it run crashless using temp documents to store partial fractals.
  53.   *** Updates could be cleaner so no partial fractals are displayed.
  54.   *** Override window.updateevent so we can avoid the EraseRect on updates.
  55.   *** Draw selection rect in offscreen, copy up to screen for flicker free selection.
  56.   *** Crash on 3 monitor system during window drag.
  57.   *** Could set the bytes directly in offscreen PixMap, skip using MoveTo:Line. 
  58.   *** Copy up from small picture up to big screen gets garbage, src rect too big?
  59.   *** Allow a way to Zoom in using coordinates.
  60.   *** Allow the user to set the colors used in display.
  61.   *** Bigger penSize for fast, lo-res fractals.  Allow user to set size of pen.
  62.   *** Some things for the reader to do to modify the program. 
  63.   }
  64.  
  65. { Where does it fit:
  66.     This is a series of sample programs for those doing development
  67.     using Color QuickDraw.  Since the whole color problem depends
  68.     upon the exact effect desired, there are a number of answers
  69.     to how to use colors, from the simple to the radically complex.
  70.     These programs try to cover the gamut, so you should use 
  71.     which ever seems appropriate.  In most cases, use the simplest
  72.     one that will give the desired results.  The compatibility
  73.     rating is from 0..9 where low is better.  The more known risks 
  74.     there are the higher the rating.
  75.     
  76.     
  77.     The programs (in order of compatibility):
  78.     
  79.         SillyBalls:
  80.             This is the simplest use of Color QuickDraw, and does
  81.             not use the Palette Manager.  It draws randomly colored
  82.             balls in a color window.  This is intended to give you
  83.             the absolute minimum required to get color on the screen.
  84.             Written in straight Pascal code.
  85.             Compatibility rating = 0, no known risks.
  86.         
  87.         FracAppPalette:    (***)
  88.             This is a version of FracApp that uses only the Palette
  89.             Manager.  It does not support color table animation
  90.             since that part of the Palette Manager is not sufficient.
  91.             The program demonstrates a full color palette that is
  92.             used to display the Mandelbrot set.  It uses an offscreen
  93.             gDevice w/ Port to handle the data, using CopyBits to
  94.             draw to the window.  The Palette is automatically 
  95.             associated with each window.  The PICT files are read
  96.             and written using the bottlenecks, to save on memory
  97.             useage.
  98.             Written in MacApp Object Pascal code.
  99.             Compatibility rating = 0, no known risks.
  100.         
  101.         TubeTest:
  102.             This is a small demo program that demonstrates using the
  103.             Palette Manager for color table animation.  It uses a 
  104.             color palette with animating entries, and draws using the
  105.             Palette Manager.  There are two circles of animating colors
  106.             which gives a flowing tube effect.  This is a valid case
  107.             for using the animating colors aspect of the Palette Manager,
  108.             since the image is being drawn directly.
  109.             Written in straight Pascal code.
  110.             Compatibility rating = 0, no known risks.
  111.         
  112.         FracApp:
  113.             This is the ╘commercial quality╒ version of FracApp.  This
  114.             version supports color table animation, using an offscreen
  115.             gDevice w/ Port, and handles multiple documents.  The
  116.             CopyBits updates to the screen are as fast as possible.  The
  117.             program does not use the Palette Manager, except to
  118.             provide for the system palette, or color modes with less than
  119.             255 colors.  For color table animation using an offscreen
  120.             gDevice w/ Port, it uses the Color Manager and handles the
  121.             colors itself.  Strict compatibility was relaxed to allow for
  122.             a higher performance program.  This is the most ╘real╒ of the
  123.             sample programs.
  124.             Written in MacApp Object Pascal code.
  125.             Compatibility rating = 2.  (nothing will break, but it may not
  126.                 always look correct.)
  127.         
  128.         FracApp300:
  129.             This doesn't support colors, but demonstrates how to create and
  130.             use a 300 dpi bitmap w/ Port.  The bitmap is printed at full
  131.             resolution on LaserWriters, and clipped on other printers (but
  132.             they still print).  It demonstrates how to use a high resolution
  133.             image as a PICT file, and how to print them out.
  134.             Written in MacApp Object Pascal code.
  135.             Compatibility rating = 1.  (The use of PrGeneral is slightly 
  136.                 out of the ordinary, although supported.)
  137. }
  138.  
  139. { Reasons for this version of reality (the strategy):
  140.     The main idea behind this program is to allow you to create and fool around 
  141.     with the Mandelbrot set, using this number cruncher wizzo computer we got
  142.     here.  While we are making these documents, we also throw in a couple of
  143.     special effects to make it more fun, like the special color mapping.  
  144.     This program is specifically intended to be a sample program, and as such
  145.     takes no compatibility risks.  This means it is not the highest performance, it
  146.     is the safest.  No intentional shortcuts were taken
  147.     in the program, but some things were left out due to time constraints.  Like
  148.     all real programs, some people will like it and some people will hate it.  I
  149.     hope you like it, but if you don╒t, send me some mail telling me why.
  150.     
  151.     This version of the program does not support color table animation, even 
  152.     though this was one of the major effects the program was to use for the
  153.     most interesting effect.  The Palette Manager is not sufficient to perform
  154.     the color table animation for multiple documents, so for this version it
  155.     was removed.  This is the most compatible way of doing things, although
  156.     the most lame as well.
  157.     
  158.     The overall structure of the program is to have the MacApp Document object
  159.     handle all the data.  This includes an offscreen gDevice and port that are
  160.     the actual fractal data.  The View object uses the Document╒s data to draw
  161.     into the window visible to the user.  The Document does all the work of
  162.     calculating new fractals during Idle times.  It also handles saving the
  163.     data to disk and reading it back.  The data files are PICT so as to be as
  164.     compatible as we can.   The program handles zooming in to
  165.     see closer views of the environment, using selection rectangles as you
  166.     would expect.  This whole block of comments at the beginning are intended
  167.     to describe some more macroscopic problems and structure.  In the code 
  168.     itself you will find the tactical comments dealing with how a specific
  169.     operation is done.  
  170.     
  171.     The fractal calculation is done by the CalcCity routine of the Document.  The
  172.     Application object gets the DoIdle call, and he calls each document to 
  173.     have a pixel calculated in each document.  The calculation is done a pixel
  174.     at a time so that it can be done in the background with no visible effect
  175.     on the foreground app.  As each horizontal line of data is finished it is 
  176.     updated to the screen.  The algorithm is very simple.
  177.     
  178.     Allocating and using an offscreen gDevice and port are found in the Document
  179.     object, as the BuildOffWorld method.  The port offscreen is used as a drawing
  180.     environment once a pixel is calculated, as seen in DoIdle for the Document.
  181.  
  182.  
  183.     If your program does not need to use color table animation, then you should
  184.     use the Palette Manager.  It does a good job at handling the color environment
  185.     when the clients merely need to use colors.  In this version of the program,
  186.     we avoid color table animation, since it would require some compatability
  187.     risks in order to use it effectively.  The palette used here is our group of
  188.     colors, associated with each window, making the fractals look 'right'
  189.     whenever we get an update event.  The color mapping from the offscreen
  190.     gDevice w/ Port to the screen is done automatically by CopyBits, so we
  191.     don't have to do anything special to make it work.  Using the Palette 
  192.     Manager makes for the simplest code.  This version gives acceptable
  193.     performance when using system 6.0 or QuickerDraw.  In addition the colors
  194.     displayed should always look correct, since the Palette Manager will try
  195.     to keep the colors displayed as accurate as possible.  Even when in the
  196.     background, or on other monitors, the colors displayed should look 
  197.     close to the normal set.  For simpler code, the Color Search Proc that made 
  198.     the zebra display was removed.  The palette has the system palette as the
  199.     first 16 colors, which will be used in the lesser color modes.  This is to
  200.     avoid forcing a large group of one color onto the monitor, which will look 
  201.     as bad as having the system palette.  Rather than have the PM make 
  202.     everybody look bad in lesser modes, we will hopefully make other programs
  203.     look OK by ensuring those colors are there.
  204.     
  205.     When we set up the offscreen gDevice, we set it up using a 3 bit iTable to save
  206.     on memory that isn't used.  The offscreen device is not filled using color 
  207.     commands, but is filled using an indexed mode instead.  This means no color
  208.     mapping is necessary for that as a destination, so there is no point in taking
  209.     up another 4K per document that is not used.
  210.     
  211.     When a document is saved the color table from the offscreen gDevice is used.
  212.     This is the clut resource that is used uniformly throughout the program.  If
  213.     you hate my choice of colors, you can change the clut to something else and
  214.     all should work the same (except old documents will map into something else).
  215.     
  216.     The program currently uses ScreenBits.Bounds as the determining size of the
  217.     view and thus the fractal that is calculated.  This is OK, but a better approach
  218.     would be to allow the user to specify the limits of the Fractal they want.  This
  219.     involves adding another dialog and save defaults type of feature but is a better
  220.     way to solve the problem since it is not obvious what the best size would be.
  221.     ScreenBits.bounds is easy to use, but whenever there is no obvious best answer
  222.     it is always better to let the user decide instead, that way they can╒t bitch.
  223.     
  224.     Another goal of course was to get this thing done.  A goal that tends to slide
  225.     away as more things are added to the program, so in true Macintosh style,
  226.     the 1.0 version of the program is somewhat limited, and may not be fully
  227.     debugged.  Some things specifically left out: printing the documents to 
  228.     a LaserWriter with grey scales instead, using temporary documents to 
  229.     make the program crashless (so you can start up where you left off, saving
  230.     the computation it took to get there), an option to make the ╘pen╒ size bigger
  231.     so you can do a low-res fractal to begin with.  These things are all admirable 
  232.     features to add, but you have to finish version 1.0 sometime, so this was it.  
  233.     These other things will be added if possible.
  234.     
  235.     Carefully watch the 881 flag with this MPW business.  There are a number of
  236.     ridiculous problems associated with its use.  In particular the $LOAD files
  237.     are dangerous to use with 881 and the combination of the two will often 
  238.     end up compiling successfully into a program that is garbage and will
  239.     crash upon running it.  This, remind yourself, is a feature of the most 
  240.     powerful development system around.  In order to build currently, the main
  241.     program MFracApp.p should be compiled with new $LOAD files and the 881
  242.     flag turned off.  All of the MacApp sources should be compiled with a new
  243.     $LOAD file and 881 turned off.  The last step should be to compile the UFracApp.p
  244.     with the 881 flag turned on, and with new $LOAD files as well.  Beware or
  245.     be prepared to spend a lot of time on something silly.  To solve this 
  246.     problem the Make file used with FracApp has a specific compile rule for 
  247.     the UFracApp file.  UFracApp also uses its own $LOAD file, that is different
  248.     from the MacApp and MFracApp ones.  The 881 flag is not specifically
  249.     required, but it makes code that uses the 881 directly instead of going
  250.     through SANE for a speed up of about 10 times.  Since we are speed freaks
  251.     here as well, the 881 option had to be used.  Given the problems, I would
  252.     probably skip the 881 option and do the time critical pieces in assembler.
  253.     
  254.     If you want to know how long a fractal took to calculate there is a time
  255.     stamp saved in the file header.  It is no longer drawn in the window since
  256.     it is not accurate when the program has run in the background or if there
  257.     are multiple documents open.  This could be added again if desired.
  258.     
  259.     Notably I am aware of the fact that this program does not really calculate
  260.     Fractals.  Actually it calculates and displays the Mandelbrot set which is
  261.     not self-similar so it cannot really be called a fractal.  It is distressing to
  262.     add to the confusion as to what fractals are, but it is too late.  For more
  263.     information on Fractals and the Mandelbrot set (no umlaut on the o), you
  264.     could see Mandelbrot╒s book ╘The Fractal Geometry of Nature╒, but it is 
  265.     pretty mathematical and not all that helpful.  A better source is the
  266.     Peitgen-Richter book ╘The Beauty of Fractals╒, which has a do it yourself
  267.     section in the back.
  268.     
  269.     The program is structured primarily around the document.  The document is
  270.     the object to create and maintain the offscreen gDevice & port.  The document
  271.     converts the offscreen data into a PICT file when saved or restored.  The
  272.     document also does the calculation of the fractal, keeping the offscreen data
  273.     up to data as it goes along.  The view only handles taking the document data
  274.     and displaying it.
  275.     
  276.     For the zoom operation, there was no really great way to handle the new
  277.     document case based on another document.  This is a little strange to be 
  278.     doing, and the structure of MacApp was such that we couldn╒t get to the 
  279.     data desired at the right time.  The logical place to put it in at 
  280.     DoMakeDocument was too early to have the gDevice allocated and ready
  281.     to start more stuff.  The problem was resolved by using global variables
  282.     to transmit the information to the other piece of the program that
  283.     might need it.  Essentially DoInitialState decides if this is a brand new
  284.     base level document or a zoom in based on the state of the global variables.
  285.     
  286.     The MacApp memory management approach is used as well.  The big pieces
  287.     used by the Documents come out of permanent memory, helping to avoid
  288.     a crash from no memory.  When we allocate something that will be thrown
  289.     away immediately, like a spare color table or something, it of course
  290.     comes out of normal memory.  We did not do a full blown memory analysis
  291.     of the program since it is such a memory hog anyway.  The mem! resource
  292.     is set up in a form that is roughly close (a bit high) without trying to be
  293.     extra accurate.  When a document takes 400K of RAM to open it hardly 
  294.     seems relevant to make sure the mem! is accurate to 2K.  Because of this
  295.     somewhat cavalier approach you may not be able to open a document in
  296.     a few cases where you really should be able to.  The mem! in use of 40K
  297.     is close with a +2K/-10K error on how big it should really be.
  298.     
  299.     The time stamp as the elapsedTime field in the FracHeader is not fully
  300.     accurate, so it is no longer displayed.  Currently it is set as an elapsed
  301.     time from when it was started to when it ended, which has a number
  302.     of problems.  This will be made more accurate in the future, probably
  303.     using a calculation that gives us a once through the loop calculation
  304.     in units of TimeDBRA, so we can be more machine independent.
  305.     
  306.     The QuickDraw BottleNecks are used to both read and write the actual
  307.     fractal data from/to the disk.  This is done since the data in the document
  308.     may be very large (100K) and if we just spool the data from the file
  309.     we don't actually have to use that extra hunk of memory.  We have to read
  310.     the data anyway, so we go ahead and just read it in as we play it back.
  311.     As it is played back it goes into the offscreen gDevice's pixMap, so we
  312.     have the data to display.  No memory hit for the document is a big win.
  313.     When writing the data, the same thing is true so we don't have to have
  314.     a huge handle to hold the picture data itself.  We also avoid the problem
  315.     of not having enough memory to create the picture in the first place,
  316.     making a document unsaveable.  That is particualarly annoying, and
  317.     is easy to avoid using the spooling approach.   The drawback here is that
  318.     the spooling process slows down opening and closing documents rather
  319.     severely, since it breaks up a long read/write operation into hundreds of
  320.     small ones.
  321.     
  322.     With thanks to Skippy Blair for the discussions of color QuickDraw and the 
  323.     Palette Manager.  Thanks to Darin Adler for further discussion of the Palette
  324.     Manager and for good suggestions on making it more MacApp friendly.
  325.     }
  326.     
  327.  
  328.     { Global variables.  }
  329. VAR
  330.     gStaggerCount:     INTEGER;                { for staggering windows. }
  331.     gOurColors:            CTabHandle;            { color table we use as a source for documents. }
  332.     gRealMin,
  333.     gRealMax,
  334.     gImagMin,
  335.     gImagMax:            Extended;                { used for zooming in operation. }
  336.         
  337.         { The next globals are used for the QuickDraw bottlenecks when reading or
  338.             writing a picture to disk.  These are needed, since the bottlenecks cannot
  339.             be owned procedures. }
  340.     gPictSize:            LongInt;                { number of bytes used for saving a PICT. }
  341.     gPictError:            OSErr;                    { do some error handling in bottleneck. }
  342.     gPictRefNum:        Integer;                { Need the refnum of the open file too. }
  343.     gPictHandle:            PicHandle;            { for reading/writing a picture. }
  344.  
  345.  
  346. { Set some compiler options that we desire for the main body of code only.  You
  347.     might wish to leave on the range checking, but I was not satisfied with having
  348.     to push and pop in the code, and was not pleased with the slowdown in performance. 
  349.     These can be dangerous to turn off, especially the $H.  For those who use MPW
  350.     more than I, you probably want to make these settable from the command line,
  351.     or use the MacApp debug or no-debug compile time variables.  }
  352. {$PUSH}        { Save the compiler state before we change it. }
  353. {$ D+}            { Debugging labels on for the code here. }
  354. {$R-}            { No range checking to make things faster. }
  355. {$OV-}            { No overflow checking either. }
  356. {$H-}            { No handle checking to avoid compiler complaints on WITHs.  Be careful. }
  357. {$N+}    
  358.  
  359. {-------------------------------  Application  -------------------------------}
  360.  
  361. PROCEDURE TFracAppApplication.IFracAppApplication(itsMainFileType: OSType);
  362.  
  363. BEGIN
  364.     gStaggerCount := 0;
  365.     IApplication(itsMainFileType);
  366.     fIdlePriority := 1;                        { say we need Idle time calls to TApp.DoIdle }
  367.     gRealMin := 0;                            { must be set to empty to start with. }
  368.     gRealMax := 0;                            { so we do normal document open. }
  369.     
  370.         { Now allocate a color table that we will use whenever we create a new document
  371.             or need to compare colors.  This is so we have the same color table for each
  372.             document, as well having the ctSeed the same for them all. }
  373.     gOurColors := GetCTable(kClut);                    { install our new desired one from clut }
  374.     FailNil (gOurColors);
  375.     
  376. END;        { TFracAppApplication.IFracAppApplication }
  377.  
  378.  
  379.     { OK, this is where a new document gets created.  This does the init for the
  380.         document object itself.  After it is done, the view and window can
  381.         be created, relying upon the data in the document. }
  382. FUNCTION  TFracAppApplication.DoMakeDocument(itsCmdNumber: CmdNumber):
  383.         TDocument; OVERRIDE;
  384.         
  385. VAR        aFracAppDocument:    TFracAppDocument;
  386.  
  387. BEGIN
  388.     { Allocate and initialize the document}
  389.     New(aFracAppDocument);
  390.     FailNil(aFracAppDocument);
  391.  
  392.     { Now initialize the document fields, and set up the global state of the fractal
  393.         to a default set of the starting fractal. }
  394.     aFracAppDocument.IFracAppDocument;
  395.  
  396.     { We successfully created a document so we can return the document object for
  397.         use by the application. }
  398.     DoMakeDocument := aFracAppDocument;
  399.     
  400. END;    { TFracAppApplication.DoMakeDocument }
  401.  
  402.  
  403.     { Performs Idle time processing for the application.  This will do the
  404.         fractal calculation during the idle times.  It will allow each open
  405.         document a chance to calculate.  The CalcCity is a method owned by
  406.         each document that will get a call from the ForAllDocumentsDo. 
  407.         The documents don't use the DoIdle routine since we want each
  408.         open document to get time, not just the one in the target chain. }
  409. PROCEDURE  TFracAppApplication.DoIdle (phase: IdlePhase); OVERRIDE;
  410.  
  411.         { Give each document some CPU time. }
  412.     PROCEDURE DoFractalCalc(aDocument: TFracAppDocument);
  413.     
  414.     BEGIN
  415.         aDocument.CalcCity;                        { give the document its time to calc. }
  416.     END;
  417.  
  418. BEGIN
  419.         { Send the message to each open document to calculate the next pixel. }
  420.     IF phase = IdleContinue  THEN  ForAllDocumentsDo (DoFractalCalc);
  421. END;        { TFracAppApplication.DoIdle }
  422.  
  423.  
  424.  
  425. {-------------------------------  Document  -------------------------------}
  426.  
  427.     { An auxiliary method to set up the step constants for the fractal calculation.
  428.         It is external since we need to set up the constants when we create a new
  429.         fractal as a zoom in.   Sets up the width/height of fractal, the delta in each
  430.         axis as a real number, and ensures that the starting min/max values for
  431.         the figure are set to supply a 1:1 aspect ratio.  The step constants are 
  432.         zeroed to start the fractal anew.  Allocates no memory. }
  433. PROCEDURE  TFracAppDocument.SetUpConstants;
  434.  
  435. BEGIN
  436.     WITH fFracHeader  DO  BEGIN
  437.         { Set up the iterations by calculating up the step constants, and the 
  438.             edges of the view area in pixels. }
  439.     
  440.         plotWidth := (calcRect.Right - calcRect.Left);
  441.         plotHeight := (calcRect.Bottom - calcRect.Top);        
  442.         deltaP := (realMax-realMin)/(plotWidth-1);
  443.         deltaQ := (imagMax-imagMin)/(plotHeight-1);
  444.     
  445.         { Force aspect ratio 1:1, making delta smallest of two.  This effectively grows
  446.             one side or the other out, like rMax/iMax becoming bigger number. }
  447.         IF deltaP > deltaQ  THEN  BEGIN
  448.             deltaQ := deltaP;
  449.             imagMax := deltaQ * (plotHeight-1) + imagMin;     { new maximum for q }
  450.         END   { grow the q side }
  451.         ELSE  BEGIN
  452.             deltaP := deltaQ;
  453.             realMax := deltaP * (plotWidth-1) + realMin;         { new maximum for p }
  454.         END;  { grow the p side }
  455.     
  456.         { Now start the counters at zero, as the edge of the area to calc. }
  457.         curCol := 0;  curRow := 0;
  458.         
  459.         { And the elapsed time is zero of course, since we are just starting. }
  460.         elapsedTime := 0;
  461.     END;        { WITH fractalDocument }
  462. END;        { SetUpConstants }
  463.  
  464.  
  465.     { Utility method to build the offscreen gDevice and offscreen Port that is used for
  466.         the document data.  This happy fellow will allocate huge old hunks of Ram for
  467.         the document and set up the initial state of the gDevice with the right color
  468.         table and so on.  This is done as a utility routine since we don't know in advance
  469.         how big the gDevice will be, and we want to make it as big as it was when the
  470.         document was saved, reading it from the header.  If we are making a new 
  471.         document, the DoInitialState will call with the screen rectangle. }
  472.         
  473. PROCEDURE  TFracAppDocument.BuildOffWorld (sizeOfDoc: Rect);
  474.  
  475. VAR        oldPerm:             Boolean;
  476.             dummy:                Boolean;
  477.             docW, docH:        LongInt;
  478.             fi:                     FailInfo;
  479.             currDevice:        GDHandle;
  480.             currPort:            GrafPtr;
  481.             Erry:                    OSErr;
  482.                 
  483.         { This is the error handler for when we get errors while making a new document,
  484.             typically like running out of memory.  Since the Free method for the document
  485.             will get called we don't have to chuck the things that normally get killed. 
  486.             Just set allocation back to normal (for the error message itself), the drawing 
  487.             environment back to normal and return.  }
  488.     PROCEDURE DeathDocument (error: OSErr; message: LONGINT);
  489.     
  490.     BEGIN
  491.         oldPerm := PermAllocation (oldPerm);    { Set memory back to previous. }
  492.         
  493.         SetGDevice (currDevice);                        { Set device back to main, just in case. }
  494.         SetPort (currPort);
  495.     END;
  496.  
  497. BEGIN
  498.     currDevice := GetGDevice;                        { save current for error handling. }
  499.     GetPort(currPort);
  500.     
  501.     { The memory used creating the view must be out of permanent memory, it is too 
  502.         big.  Any failure to get it from permanent memory will invoke the error handler. }
  503.     oldPerm := PermAllocation (TRUE);
  504.  
  505.     CatchFailures(fi, DeathDocument);            { any failures, must be cleaned up. }
  506.  
  507.     { Let's set up the size of the rectangle we are using for the document. }
  508.     docW := sizeOfDoc.right - sizeOfDoc.left;
  509.     docH := sizeOfDoc.bottom - sizeOfDoc.top;
  510.  
  511.  
  512.     { Now try to set up the offscreen bitMap (color).  If we fail we have to split,
  513.         and we might since we may not have 300K or more (basically a full screen
  514.         worth, which is unlikely to be less than 300K) for the pixMap.  Each document
  515.         on screen will have a full pixMap for it.  Allocate a full screen size buffer in
  516.         8 bit depth.  Also make it into a color port so we can draw into it normally and 
  517.         use it as a source for CopyBits.  Requires 8 bits deep for the number of colors,  
  518.         and sets up a buffer with that in mind, that is full docRect size with
  519.         one byte per pixel as 8 bit mode.  This is width x height.  8 bits/byte. }    
  520.     fBigBuff := NewPtr (docW * docH);
  521.     FailMemError;                                                { couldn't get it we die. }
  522.  
  523.  
  524.     { OK, now we get wacko.  We need to create our own gDevice, since we want to have
  525.         an offscreen device.  This needs to be done so that we have full control over the
  526.         color table used, in order to save full 8 bit documents, even if we aren't in 8 bit
  527.         mode when we save.  So...  We will start by creating a NewGDevice, that will 
  528.         allocate a temporary ITable, and PixMap with partial colorTable;  change the 
  529.         fields of the device's pixMap to our bitMap, with right size, depth, and rowbytes; 
  530.         init the fields of that device, including changing the color table to our color 
  531.         table created from our clut;  set that gDevice as the current one; then do the 
  532.         OpenCPort which will use the current gDevice to make its PixMap and color table;
  533.         When we go to draw or save the data in the offscreen buffer,
  534.         we need to set the current device so we use our color table, making all the
  535.         colors come out right.  }
  536.             
  537.     { Now we need to do the piece to make an offscreen gDevice that is not connected
  538.         to the screen.  Allocate a new one, with stub pixMap. }
  539.     fDrawingDevice := NewGDevice (0, -1);            { -1 means unphysical device.  }
  540.     FailNIL (fDrawingDevice);                                { If we failed, error out. }
  541.     
  542.     { Now init all the fields we can in the gDevice Record, since it comes uninitialized. }
  543.     HLock ( Handle(fDrawingDevice) );
  544.     WITH  fDrawingDevice^^  DO  BEGIN
  545.         gdId := 0;                                                        { no ID for search & complement procs }
  546.         gdType := clutType;                                        { color table type fer sure. }
  547.         
  548.         { Get the color table for the offscreen gDevice.  This is a copy of the global
  549.             color table we created early on. }
  550.         DisposCTable (gdPMap^^.pmTable);                { kill the stub that is there. }
  551.         gdPMap^^.pmTable := gOurColors;                    { make a copy of our global color table. }
  552.         Erry := HandToHand (Handle(gdPMap^^.pmTable)); { and stick it into this gDevice too. }
  553.         FailOSErr (Erry);                                            { if not possible, blow out. }
  554.         
  555.         { build a new iTable for this device, based on the new color table.  3 bit res to
  556.             save on memory since we don't need the iTable for our stuff. }
  557.         MakeITable (gdPMap^^.pmTable, gdITable, 3);
  558.         FailOSErr (QDError);                                        { no memory, we can leave here. }
  559.         
  560.         gdResPref := 3;                                                { preferred resolution in table. }
  561.         gdSearchProc := NIL;                                        { no search proc. }
  562.         gdCompProc := NIL;                                        { no complement proc. }
  563.         { Set the gdFlags to be: color, ramInit, noDriver, screenActive }
  564.         gdFlags := 2**0 + 2**10 + 2**14 + 2**15;    { set each bit we need. }
  565.         
  566.         { Now set up the fields in the offscreen PixMap correctly. }
  567.         gdPMap^^.baseAddr := fBigBuff;                        { The base address is our buffer. }
  568.         gdPMap^^.bounds := sizeOfDoc;                        { bounding rectangle to our device. }
  569.         { one byte per pixel horizontally is rowBytes.  + $8000 to make it color port. }
  570.         gdPMap^^.rowBytes := docW + $8000;
  571.         gdPMap^^.pixelSize := 8;
  572.         gdPMap^^.cmpCount := 1;
  573.         gdPMap^^.cmpSize := 8;
  574.         
  575.         gdRect := sizeOfDoc;                                        { the bounding rectangle for gDevice, too. }
  576.     END;        { With fDrawingDevice }
  577.         
  578.         { Now unlock the gDevice handle since it is in the System Heap.  The system
  579.             can use it unlocked as well as locked so we try to help avoid fragmentation. }
  580.     HUnLock ( Handle(fDrawingDevice) );
  581.  
  582.     { Yow, that was rough.  Now we have a fully initialized gDevice offscreen with its
  583.         own colortable.  All color mapping should be done using that color table, and the
  584.         drawing we do to it should make the saved pictures save that color table too. 
  585.         Set to our new device so we OpenCPort with all new parameters. }
  586.     SetGDevice (fDrawingDevice);
  587.     
  588.     { After all of that, we have a gDevice which is complete.  It has the color table we want
  589.         associated with it, from the clut, it has the right portBits.baseAddr and the right
  590.         size.  It is complete, except that we can't draw into it using normal calls.  We thus
  591.         need to make a port that we can use.  We have set the gDevice to be the one we just
  592.         created, and when we OpenCPort we will get a copy of the fields we just set up in
  593.         our new gDevice.  The port is simply an interface into our gDevice for drawing.
  594.         Allocate a port record on the heap as a pointer.  (permanent memory useage).  We
  595.         allow the port to come out of temporary memory since it will blow up (most
  596.         unfriendly) if it cannot do it.  After it lives, though we want to check if we
  597.         have no more reserve, and if so we must bag this document. }
  598.     fDrawingPort := CGrafPtr( NewPtr (SizeOf (CGrafPort)) );    { address of C Port record. }
  599.     FailNil (fDrawingPort);                                    { didn╒t get it, means we die. }
  600.     
  601.     { Now the world is created, put memory allocation back to temporary, so that the
  602.         QD pieces can come out of temp memory as well.  No more permanent blocks are
  603.         allocated by us, except for the port, which cannot fail or we die.  }
  604.     dummy := PermAllocation (FALSE);
  605.  
  606.     OpenCPort (fDrawingPort);                                { make a new port offscreen. }
  607.     FailNoReserve;                                                    { Make reserve, die if we can╒t }
  608.         
  609.         { QuickDraw is most obnoxious about making a port that is bigger than the screen,
  610.             so we need to modify the visRgn to make it as big as our full page document.  It is
  611.             OK to change this ports visRgn since we own it offscreen.  This is in case we
  612.             are opening a document made on a different computer with a bigger screen. }
  613.     RectRgn(fDrawingPort^.visRgn, sizeOfDoc);
  614.  
  615.         { Go whap on the other pieces of the port record to set it up to be offscreen. }    
  616.     fDrawingPort^.portRect := sizeOfDoc;
  617.  
  618.     { OK, we have a nice new color port that is offscreen.  It has a fancy color table that
  619.         came from the clut that will be used for the owning window.  It is 8 bits deep,
  620.         has 256 colors in its color table and has a rect the size passed in.  It has no
  621.         pieces that are related to the main gDevice, so we shouldn't alter that by drawing
  622.         in this port.  }
  623.         
  624.         { Clear the error handler chain, we don't make any more dangerous requests. }
  625.     Success (fi);
  626.  
  627.  
  628.         { Set the memory allocation to what we started with. }
  629.     oldPerm := PermAllocation (oldPerm);
  630.  
  631.         { Now we have the offscreen PixMap, we need to initialize it to white. }
  632.     SetPort (GrafPtr(fDrawingPort));
  633.     EraseRect (sizeOfDoc);                { clear the bits. }
  634.  
  635.         { We are done drawing and stuff for now, so set the gDevice back to where it was. }
  636.     SetGDevice (currDevice);
  637.     SetPort (currPort);
  638. END;    { BuildOffWorld }
  639.  
  640.  
  641.     { Init for the FracAppDocument itself.  This sets up the Document object. }
  642. PROCEDURE      TFracAppDocument.IFracAppDocument;
  643.  
  644. VAR        dummyTime:        LongInt;        { for picky compiler }
  645.     
  646. BEGIN
  647.     { Set up failure mechanism in case IDocument fails}
  648.     IDocument(kFileType, kSignature, kUsesDataFork,
  649.             NOT kUsesRsrcFork, NOT kDataOpen, NOT kRsrcOpen);
  650.     
  651.     { Set the time in our starting time variable in case we are still calculating.
  652.         Temp var is to make the picky compiler not get worried about the var
  653.         parameter.  This routine can't move memory anyway, but it won't allow
  654.         this use. }
  655.     GetDateTime (dummyTime);
  656.     fStartTime := dummyTime;
  657.     
  658.     fBigBuff := NIL;
  659.     fDrawingPort := NIL;                                    { set up in case we fail in here. }
  660.     fDrawingDevice := NIL;
  661. END;    { TFracAppDocument.IFracAppDocument }
  662.  
  663.  
  664.     { Does the work for a New operation, where we start with a new fractal
  665.         that doesn't have any stored data.  This is to set up the view with no
  666.         data and set up the fractal coordinates to the default.  It will use the size
  667.         of the  main screen to make a new document, and create the offscreen 
  668.         world to match.  If the global variable of gRealMin and gRealMax are both
  669.         nonzero, then we want to use the global state being passed us by the 
  670.         New Fractal handler.  This is for the zoom in. }
  671. PROCEDURE TFracAppDocument.DoInitialState;  OVERRIDE;
  672.     
  673. BEGIN
  674.     WITH  fFracHeader  DO BEGIN
  675.         { Start by filling in the fields that never change. }
  676.         fType := kSignature;            { creator of these documents. }
  677.         hdrId := INTEGER ('FA');        { ID of the file, different from other PICT files. }
  678.         version := 1;                        { version 1 files. 0 was old MandibleJug docs. }
  679.         
  680.         done := FALSE;                    { not done, starting brand new document. }
  681.     
  682.         { We start from scratch.  This is the standard set of coordinates to start
  683.             the default Mandelbrot set. 
  684.             Set up the coordinates to do, saving state in header vars. }
  685.         realMin := -2.5;  realMax := 1.5;
  686.         imagMin := -1.5;  imagMax := 1.5;
  687.         
  688.             { If we are supposed to do a zoom in, use those numbers instead. }
  689.         IF (gRealMin <> 0) AND (gRealMax <> 0)  THEN BEGIN
  690.             realMin := gRealMin;        realMax := gRealMax;
  691.             imagMin := gImagMin;    imagMax := gImagMax;
  692.         END;
  693.         
  694.         { Set the fractal rectangle to be the full screen size. }
  695.         calcRect := ScreenBits.bounds;
  696.  
  697.     END;        { With FracHeader }
  698.     
  699.         { Clear the state of the globals so any new documents will not be zoom in types. }
  700.     gRealMin := 0;        gRealMax := 0;
  701.     
  702.         { Build the initial state of the document offscreen gDevice & port }
  703.     BuildOffWorld (fFracHeader.calcRect);
  704.     
  705.         { Set up the rest of the constants that are used in the fractal, including
  706.             the deltas in each axis and the step constants for stepping through
  707.             each point in the fractal plane. }
  708.     SetUpConstants;
  709. END;        { TFracAppDocument.DoInitialState }
  710.  
  711.  
  712. PROCEDURE TFracAppDocument.DoMakeViews(forPrinting: BOOLEAN); OVERRIDE;
  713.  
  714. VAR        aFracAppView:    TFracAppView;
  715.  
  716. BEGIN
  717.     { Create a new view (failing if we can't), get a rectangle with
  718.         the appropriate extent, and initialize the view. }
  719.     New(aFracAppView);
  720.     FailNil(aFracAppView);
  721.  
  722.     { Initialize the view for use as a drawing environment. }
  723.     aFracAppView.IFracAppView (SELF, fFracHeader.calcRect);
  724.  
  725.     {save a reference to the view in a TFracAppDocument field, for use
  726.         by DoMakeWindows}
  727.     fFracAppView := aFracAppView;
  728. END;    { TFracAppDocument.DoMakeViews }
  729.  
  730.  
  731. PROCEDURE TFracAppDocument.DoMakeWindows; OVERRIDE;
  732.  
  733. VAR        aWindow:    TWindow;
  734.     
  735. BEGIN
  736.     { Gets window definition from resource file; the window is to have both horizontal 
  737.         and vertical scrollbars, and is to have my 'fFracAppView' installed in it;
  738.         NewSimpleWindow will exit via the failure mechanism if allocation fails. 
  739.         There is a palette associated with this window by Resource Id, so it will
  740.         automatically get used when the window is created. }
  741.     aWindow := NewSimpleWindow(kFracAppWindowID, NOT kDialogWindow,
  742.                     kWantHScrollBar, kWantVScrollBar, fFracAppView);
  743.  
  744.     SimpleStagger(aWindow, kStaggerAmount, kStaggerAmount, gStaggerCount);
  745. END;    { TFracAppDocument.DoMakeWindows }
  746.  
  747.  
  748.     { This routine will size the current image as it goes to the disk.  It won't actually
  749.         save any data or anything, but will merely watch the bytes go by keeping track
  750.         of how many go by.  The size is used by DoNeedDiskSpace. }
  751. PROCEDURE  PictSizer (dPointer: Ptr; nextHunk: Integer);
  752.  
  753. BEGIN
  754.     gPictSize := gPictSize + nextHunk;
  755. END;
  756.  
  757.  
  758.     { Routine to find out how much disk space will be required to save the data.  
  759.         This does not call the Inherited DoNeedDiskSpace since we don't support
  760.         printing info here.  The routine will replace the PutPicProc of the port
  761.         with our PictSizer routine.  When the picture is created here, no bytes 
  762.         will actually be allocated or saved, we will just watch it go by and 
  763.         save off the size in the global variable.  That value is returned
  764.         as the expected document size. }
  765. PROCEDURE TFracAppDocument.DoNeedDiskSpace(VAR dataForkBytes, 
  766.             rsrcForkBytes: LONGINT);   OVERRIDE;
  767.             
  768. VAR        picPort:            GrafPtr;
  769.             currDevice:        GDHandle;
  770.             currPort:            GrafPtr;
  771.             newGrafs:            CQDProcs;
  772.             oldProcs:            QDProcsPtr;        { bug in include files, CGrafPort has QDProcs *** }
  773.             
  774. BEGIN
  775.     { Create a picture Item itself, by opening the picture and doing the CopyBits
  776.         operation to the same port.  That picture will then be packed using the
  777.         normal packing operation of the Mac.  That block is then the data to be
  778.         written to the file. }
  779.         
  780.     currDevice := GetGDevice;                                { save off current one. }
  781.     GetPort (currPort);
  782.     
  783.     SetGDevice (fDrawingDevice);                            { set to ours for drawing in it. }
  784.     picPort := GrafPtr (fDrawingPort);                    { the pointer to our port. }
  785.     SetPort (picPort);                                            { set there to do pict saving. }
  786.  
  787.         { Save the pointer to the current CGrafProcs }
  788.     oldProcs := thePort^.grafProcs;
  789.     
  790.         { Set our GrafProc record up to have the standard pieces. }
  791.     SetStdCProcs(newGrafs);
  792.     
  793.         { Change the port to use those GrafProcs instead. }
  794.     thePort^.grafProcs := @newGrafs;
  795.     
  796.         { We are in our offscreen port.  Change the GrafProc pointer for picture saving. }
  797.     newGrafs.putPicProc := @PictSizer;
  798.         
  799.         { Init the size of the pict we are going to save.  Start with picture header. }
  800.     gPictSize := SIZEOF (Picture);
  801.     
  802.         { The current gDevice is our offscreen device.  Now go ahead and open the picture 
  803.             and build it in RAM.  We would have done this by slices before, but the newer
  804.             systems have a patch for playing back pictures that minimize the RAM hit, so
  805.             we don't have to worry about the full screen CopyBits here. }
  806.     WITH  picPort^  DO BEGIN
  807.         gPictHandle := OpenPicture (portRect);
  808.         
  809.                 { copy all of the image to itself, in an open picture it saves the bits. }
  810.             CopyBits (portBits, portBits, portRect, portRect, srcCopy, NIL);            
  811.             
  812.         ClosePicture;                        { the picture is created, and packed. }
  813.     END;        { with picPort^ }
  814.  
  815.  
  816.         { Done saving the size of the picture itself.  Now set the GrafProcs back to normal. }
  817.     thePort^.grafProcs := oldProcs;
  818.     
  819.         { Dispose the pict handle, we didn't actually make anything there. }
  820.     KillPicture (gPictHandle);
  821.     gPictHandle := NIL;
  822.     
  823.     { Set the drawing device back where it belongs, in case of error, we get right device. }
  824.     SetGDevice (currDevice);                                    { set back to system for normal. }
  825.     SetPort (currPort);
  826.  
  827.     { The picture has been sized.  Now add that in to the total size the file will use on
  828.         disk, include the header for the file, plus the number of bytes in actual PICT. }
  829.     dataForkBytes := dataForkBytes + gPictSize + kPICTHeaderSize;
  830. END;        { DoNeedDiskSpace }
  831.  
  832.  
  833.     { This routine will save the current image as it is created.  As the data requests
  834.         go by that data will be written to the file.  The data is being created by the
  835.         OpenPicture/CopyBits in DoWrite, this is the bottleneck for that operation.
  836.         Any errors found while doing this will make us skip any further requests
  837.         to write data to the disk.  No memory is allocated.   Communication with 
  838.         DoWrite is done through globals, since bottlenecks must be at the main
  839.         level.  The bottleneck must also keep track of how many bytes are written,
  840.         so that the header on the picture can be fixed up to be correct.  This must
  841.         be done to avoid creating bogus pictures.  The picSize field of the handle
  842.         must be updated continuously so that when the picture is done, the ClosePicture
  843.         can create a valid picture.  The check for the NIL handle is to handle the
  844.         problem of when the OpenPicture is called.  The proc gets called before 
  845.         the handle is valid.  Be very careful of these bottleneck things, it is 
  846.         easy to run into problems that are very hard to figure out.  QuickDraw
  847.         has no facilities to give you info when things go wrong so it makes it
  848.         a bit tougher. }
  849. PROCEDURE  PictWriter (dPointer: Ptr; nextHunk: Integer);
  850.  
  851. VAR    longHunk:    LongInt;
  852.  
  853. BEGIN
  854.     IF gPictError = noErr THEN  BEGIN
  855.         longHunk := nextHunk;
  856.         gPictError := FSWrite(gPictRefNum, longHunk, dPointer);
  857.         gPictSize := gPictSize + longHunk;
  858.         IF gPictHandle <> NIL THEN  gPictHandle^^.picSize := LoWord (gPictSize);
  859.     END;
  860. END;
  861.  
  862.  
  863.     { Write the data calculated into the document to the file.  This will make it a real
  864.         PICT file.  It writes the header first, then the PICT data.  This is so that it 
  865.         will still be a normal PICT file and can be used by other programs.  
  866.         The file will be saved using QuickDraw Bottlenecks for the PutPicProc.  
  867.         As the data requests go by, they will be written to the file, using the
  868.         PictWriter routine. }
  869. PROCEDURE TFracAppDocument.DoWrite(aRefNum: INTEGER; makingCopy: BOOLEAN);
  870.             OVERRIDE;
  871.  
  872. VAR        recSize:            LongInt;
  873.             fi:                     FailInfo;
  874.             picPort:            GrafPtr;
  875.             currDevice:        GDHandle;
  876.             currPort:            GrafPtr;
  877.             newGrafs:            CQDProcs;
  878.             oldProcs:            QDProcsPtr;        { bug in include files, CGrafPort has QDProcs *** }
  879.  
  880.     PROCEDURE DeathWrite (error: OSErr; message: LONGINT);
  881.     BEGIN
  882.         IF gPictHandle <> NIL THEN      KillPicture (gPictHandle);
  883.         gPictHandle := NIL;
  884.  
  885.         thePort^.grafProcs := oldProcs;
  886.         SetGDevice (currDevice);                { set back to system for normal. }
  887.         SetPort (currPort);
  888.     END;
  889.     
  890. BEGIN
  891.         { We have legit data in our document, set the mark in the file to be at the front. }
  892.     FailOSErr ( SetFPos (aRefNum, fsFromStart, 0) );
  893.  
  894.         { Write the FracHeader to the file, it includes the pertinent details about
  895.             the fractal including the global state for it. }
  896.     recSize := SIZEOF (FracRecord);                           { our header on fractal files. }
  897.     FailOSErr ( FSWrite (aRefNum, recSize, @fFracHeader) );
  898.  
  899.         { Now we need to write the picture data itself out to the file, after we set the
  900.             mark to be after the entire header.  Make sure the file is that big before we do it. 
  901.             Included in this set is the header of the picture itself, the 10 bytes that
  902.             include the rectangle.  Those bytes will be updated after the picture is
  903.             written. }
  904.     FailOSErr ( SetEOF (aRefNum, kPICTHeaderSize+SIZEOF (Picture) ) );
  905.     FailOSErr ( SetFPos (aRefNum, fsFromStart, kPICTHeaderSize+SIZEOF (Picture) ) );
  906.     
  907.         { The file is all set up to go.  We now want to replace the QuickDraw bottleneck
  908.             and create the actual Picture data. }
  909.     currDevice := GetGDevice;                                { save off current one. }
  910.     GetPort (currPort);
  911.     
  912.         { If the write of the picture header fails, we want to dispose the handle allocated. }
  913.     CatchFailures(fi, DeathWrite);
  914.  
  915.         { Move over to the offscreen port/device. }
  916.     SetGDevice (fDrawingDevice);                            { set to ours for drawing in it. }
  917.     picPort := GrafPtr (fDrawingPort);                    { the pointer to our port. }
  918.     SetPort (picPort);                                            { set there to do pict saving. }
  919.  
  920.         { Save the pointer to the current CGrafProcs }
  921.     oldProcs := thePort^.grafProcs;
  922.     
  923.         { Set our GrafProc record up to have the standard pieces. }
  924.     SetStdCProcs(newGrafs);
  925.     
  926.         { Change the port to use those GrafProcs instead. }
  927.     thePort^.grafProcs := @newGrafs;
  928.     
  929.         { We are in our offscreen port.  Change the GrafProc pointer for picture saving. }
  930.     newGrafs.putPicProc := @PictWriter;
  931.         
  932.         { Tell PictWriter what file to write to, and start the pic size including the
  933.             picture header.  Start all the pieces off the right way. }
  934.     gPictRefNum := aRefNum;
  935.     gPictSize := SIZEOF(Picture);
  936.     gPictError := noErr;
  937.     gPictHandle := NIL;
  938.  
  939.         { Actually open the picture and do the CopyBits in order to process the picture.
  940.             The data will be written by PictWriter as it is called by QuickDraw. }
  941.     WITH  picPort^  DO BEGIN
  942.         gPictHandle := OpenPicture (portRect);
  943.             ClipRect(portRect);            { Make it a happier picture. }
  944.         
  945.                 { copy all of the image to itself, in an open picture it saves the bits. }
  946.             CopyBits (portBits, portBits, portRect, portRect, srcCopy, NIL);            
  947.             
  948.         ClosePicture;                        { the picture is created, and packed. }
  949.     END;        { with picPort^ }
  950.     
  951.         { Now check for errors during the write operation.  The gPictError field will be
  952.             nonzero if we failed during the operation. }
  953.     FailOSErr (gPictError);
  954.         
  955.         { Move back to front of file and write the valid picture info to file. }
  956.     FailOSErr ( SetFPos (aRefNum, fsFromStart, kPICTHeaderSize) );
  957.     recSize := SIZEOF(Picture);
  958.     FailOSErr (FSWrite(aRefNum, recSize, Ptr(gPictHandle^)));
  959.  
  960.         { Done saving the data of the picture itself.  Now set the GrafProcs back to normal. }
  961.     thePort^.grafProcs := oldProcs;
  962.     
  963.         { Dispose the pict handle, we didn't actually make anything there. }
  964.     KillPicture (gPictHandle);
  965.     gPictHandle := NIL;
  966.  
  967.         { Set the drawing device back where it belongs, in case of error, we get right device. }
  968.     SetGDevice (currDevice);                                    { set back to system for normal. }
  969.     SetPort (currPort);
  970.  
  971.         { If we lived through it, clear error handler. }
  972.     Success (fi);
  973. END;            { TFracAppDocument.DoWrite }
  974.  
  975.  
  976.     { The bottleneck routine to read the picture from the disk.  This will read the
  977.         data required, and pass it along to the unpacker.  This makes it possible to
  978.         avoid using any RAM for the actual reading part, as it is being played back
  979.         into the offscreen device.  Error handling is somewhat tricky, since we 
  980.         need to force the picture to finish, and there isn't a really good way to 
  981.         do this.  The desired attempt here is to pass back a picture is finished 
  982.         opcode ($00FF) so we can get back to our code to handle the error.  This is 
  983.         better than no error recovery, but is not guaranteed to work. }
  984. PROCEDURE  PictReader (dPointer: Ptr; nextHunk: Integer);
  985.  
  986. VAR    longHunk:    LongInt;
  987.         I:                Integer;
  988.  
  989. BEGIN
  990.     IF gPictError = noErr THEN  BEGIN
  991.         longHunk := nextHunk;
  992.         gPictError := FSRead(gPictRefNum, longHunk, dPointer);
  993.     END
  994.     ELSE            { handle the error situation by passing back $00FF as the data.? }
  995.         FOR I := 1 to nextHunk  DO BEGIN
  996.             IF ODD (I) THEN  dPointer^ := $00
  997.             ELSE  dPointer^ := $FF;
  998.             dPointer := PTR (ORD4(dPointer) + 1);
  999.         END;
  1000. END;
  1001.  
  1002.  
  1003.     { Routine to read the data from the data fork of the file into our document so it
  1004.         can be displayed.  The quickdraw bottleneck will be replaced with the
  1005.         PictReader routine, making it read the data from the disk as the picture
  1006.         requests more data.  This obviates the need for an extra handle that is
  1007.         used to play back the picture.  This is done since that extra handle can
  1008.         be on the order of 100K, memory we may not have available. }
  1009. PROCEDURE TFracAppDocument.DoRead(aRefNum: INTEGER; rsrcExists,
  1010.                                                   forPrinting: BOOLEAN);  OVERRIDE;
  1011.  
  1012. VAR        recSize:            LongInt;
  1013.             fi:                     FailInfo;
  1014.             currDevice:        GDHandle;
  1015.             currPort:            GrafPtr;
  1016.             newGrafs:            CQDProcs;
  1017.             oldProcs:            QDProcsPtr;        { bug in include files, CGrafPort has QDProcs *** }
  1018.  
  1019.     PROCEDURE DeathRead (error: OSErr; message: LONGINT);
  1020.     BEGIN
  1021.         IF gPictHandle <> NIL THEN  KillPicture (gPictHandle);
  1022.         gPictHandle := NIL;
  1023.     END;
  1024.     
  1025. BEGIN
  1026.         { The file is open already, we just have to read the data out of it.  The first thing
  1027.             to read is the header we use to describe a fractal.  If we get an error
  1028.             here we need to split since we should always have at least a header.  The fractal
  1029.             header is the global state for the document.  We just read it into the record
  1030.             and use it from there. }
  1031.     FailOSErr ( SetFPos (aRefNum, fsFromStart, 0) );    { starts at first byte of file. }
  1032.     recSize := SIZEOF (FracRecord);                                   { size of header on fractal files. }
  1033.     FailOSErr ( FSRead (aRefNum, recSize, @fFracHeader) );
  1034.     
  1035.         { We have the header for the PICT file.  Now we need to be sure that it is a fractal
  1036.             document, and not something we can't use.  Check the header to be sure, and if
  1037.             not right, error out with a good alert message (using a standard MacApp errcode). }
  1038.     IF fFracHeader.fType <> kSignature  THEN  FailOSErr (errNotMyType);
  1039.  
  1040.         { We have the data from the header, go ahead and set up an offscreen world for this
  1041.             document, using the header rectangle. }
  1042.     BuildOffWorld (fFracHeader.calcRect);
  1043.     
  1044.         { Make sure the file position is right at the start of the picture in the file. }
  1045.     FailOSErr ( SetFPos (aRefNum, fsFromStart, kPICTHeaderSize) );
  1046.  
  1047.         { Allocate a small handle that will be used as the Pict handle for drawing from
  1048.             the disk.  This is just the picture header. }
  1049.     gPictHandle := PicHandle (NewHandle (SIZEOF(Picture)));
  1050.     FailNil (gPictHandle);
  1051.     
  1052.         { If the read of the picture header fails, we want to dispose the handle allocated. }
  1053.     CatchFailures(fi, DeathRead);
  1054.  
  1055.         { Tell PictReader what file to read from. }
  1056.     gPictRefNum := aRefNum;
  1057.     gPictError := noErr;
  1058.     
  1059.         { Now fill in the picture header itself, using the data from the disk. }
  1060.     recSize := SIZEOF(Picture);
  1061.     gPictError := FSRead(aRefNum, recSize, Ptr (gPictHandle^));
  1062.     FailOSErr (gPictError);
  1063.     
  1064.         { That is the only call we can╒t recover from immediately, the rest of the
  1065.             routine is not easy to recover from, so we won╒t go through DeathRead. }
  1066.     Success (fi);
  1067.     
  1068.         { The file position is right at the beginning of the picture data, so we can just
  1069.             install the bottleneck and call DrawPicture to fill our offscreen gDevice
  1070.             with the data that was saved.  Set to that port and gDevice for playback. }
  1071.     currDevice := GetGDevice;                        { save current to get back. }
  1072.     GetPort (currPort);
  1073.     
  1074.     SetGDevice (fDrawingDevice);
  1075.     SetPort (GrafPtr(fDrawingPort));
  1076.  
  1077.         { Save the pointer to the current CGrafProcs }
  1078.     oldProcs := thePort^.grafProcs;
  1079.     
  1080.         { Set our GrafProc record up to have the standard pieces. }
  1081.     SetStdCProcs(newGrafs);
  1082.     
  1083.         { Change the port to use those GrafProcs instead. }
  1084.     thePort^.grafProcs := @newGrafs;
  1085.     
  1086.         { We are in our offscreen port.  Change the GrafProc pointer for picture reading. }
  1087.     newGrafs.getPicProc := @PictReader;
  1088.         
  1089.         { Now we have the buffer and the offscreen port.  We can draw the picture that
  1090.             will be read out of the file into this port in order to init the port for later use in
  1091.             updating the window.  We are already set to draw in the offscreen port.  Do the
  1092.             DrawPicture to have PictReader read the data out of the file while it is being
  1093.             played into the offscreen Port. }
  1094.     DrawPicture(gPictHandle, gPictHandle^^.picFrame);
  1095.     
  1096.         { Done reading the data of the picture itself.  Now set the GrafProcs back to normal. }
  1097.     thePort^.grafProcs := oldProcs;
  1098.     
  1099.         { Bag the handle we made for playing back the picture. }
  1100.     KillPicture (gPictHandle);
  1101.     gPictHandle := NIL;
  1102.  
  1103.         { Set back to the normal drawing environment. }
  1104.     SetGDevice (currDevice);
  1105.     SetPort (currPort);
  1106.         
  1107.         { If we had an error while reading the data, we must error out. }
  1108.     FailOSErr (gPictError);
  1109. END;        { TFracAppDocument.DoRead }
  1110.  
  1111.  
  1112.     { This is typically used in a Revert case which is not really meaningful here, but
  1113.         the structure is the same so we use it anyway.  Frees the data associated with
  1114.         a document, that is strictly program data, not MacApp data. }
  1115. PROCEDURE TFracAppDocument.FreeData; OVERRIDE;
  1116.  
  1117. BEGIN
  1118.         { Kill the bits for the offscreen bitMap if they were allocated. }
  1119.     IF fBigBuff <> NIL  THEN  DisposPtr (fBigBuff);
  1120.         { Close the port: remove from portList, kill visRgn and clipRgn, kill the penPixPat
  1121.             and fill PixPat and back PixPat, kill PixMap handle, kill grafVars handle. }
  1122.     IF fDrawingPort <> NIL  THEN  BEGIN
  1123.         CloseCPort (fDrawingPort);
  1124.         DisposPtr (Ptr (fDrawingPort) );
  1125.     END;
  1126.         { DisposGDevice does: kills the ITable, kills Cursor expanded data and mask if
  1127.             nonzero, calls DisposPixMap if gdPMap is nonzero, then disposes the gDevice
  1128.             handle itself.  DisposPixMap kills the colorTable and the pixMap record. }
  1129.     IF fDrawingDevice <> NIL  THEN DisposGDevice (fDrawingDevice);
  1130. END;    { TFracAppDocument.FreeData }
  1131.  
  1132.             
  1133.     { Free method for the documents themselves.  We need to override so that we
  1134.         can throw away the data object that was read in from the disk if it exists. 
  1135.         Also chuck the gDevice and port used for the document data. }
  1136. PROCEDURE TFracAppDocument.Free; OVERRIDE;
  1137.  
  1138. BEGIN
  1139.     FreeData;
  1140.     
  1141.     INHERITED Free;
  1142. END;    { TFracAppDocument.Free }
  1143.  
  1144.  
  1145.     { The procedure to do the idle time processing in the document.  This will do the    
  1146.         entire fractal calculation so as to be able to do it in the background.  It
  1147.         does it one pixel at a time to avoid any hit on performance for the
  1148.         foreground application.  This is called in response to the DoIdle for the
  1149.         application.  The fIdlePriority is not set for this method, so it won't get
  1150.         time except when the application calls specifically.  It is done this way
  1151.         since otherwise the target chain would need to have each document in
  1152.         the list, which is not desireable for other event handling.  Notably the
  1153.         time keeper in here is not too accurate.  Each pixel takes less than a 
  1154.         tick to calculate, making it a bit tougher.  A way to make it more 
  1155.         accurate would be to figure out the maximum time for a full black
  1156.         document, and divide by the number of pixels in the screen and the
  1157.         number of loops.  That number (in microseconds) could be added each
  1158.         time through the calculation loop to give a more accurate timestamp.
  1159.         This would be wrong if the clock changes, so perhaps it should use the
  1160.         low memory TimeDBRA value as units instead.
  1161.         This is left as an exercise for the reader. }
  1162. PROCEDURE  TFracAppDocument.CalcCity;
  1163.  
  1164. CONST    M                = 100;                    { this decides what 'infinity' is.  If value less than this, loop. }
  1165.             K                = kNumColors;        { number of colors to choose from. Also iterations times.  This
  1166.                                                             is 195 to match the clut created for it. }
  1167.             BlackPen    = 255;                    { entry in our modified color table for black. }
  1168.  
  1169. VAR        currTime:            LongInt;        { temp var for time check. }
  1170.     
  1171.             x,y,x1,y1:            Extended;        { for interim values of current point. }
  1172.             Po,Qo:                Extended;
  1173.     
  1174.             kol:                    Integer;        { color we are currently on. }
  1175.             r:                        Extended;        { 'distance' from root. }
  1176.             currDevice:        GDHandle;        { current gDevice handle, so we can get back there. }
  1177.             currPort:            GrafPtr;
  1178.             drawRect:            Rect;            { for updating the screen as we calculate. }
  1179.  
  1180. BEGIN
  1181.         { Calculate the fractal as we go.  Do next pixel here, based on the state saved
  1182.             in the document object.  When done, the variables are updated to go to the
  1183.             next location to do.  It sets the pixel in the offscreen port to be whatever
  1184.             we calculate it to be.  The buffer will be copied to the screen at update time. 
  1185.             The global state is saved in the FracHeader record in the document object.
  1186.             That state is saved across the use of a document, so it will always be right. }
  1187.     
  1188.         { If we are done, or not started, we can split. }
  1189.     IF  fFracHeader.done THEN  Exit(CalcCity);
  1190.     
  1191.     currDevice := GetGDevice;                    { save off current one. }
  1192.     GetPort (currPort);
  1193.     
  1194.     SetGDevice (fDrawingDevice);                { set to ours for drawing in it. }
  1195.     SetPort (GrafPtr(fDrawingPort));        { draw in offscreen guy. }
  1196.  
  1197.     { Now do the calculation to determine the color of the pixel at the
  1198.         current location.  Uses the header saved state. }
  1199.  
  1200.     With  fFracHeader  DO BEGIN
  1201. (*        x := realMin + curCol * deltaP;                    { Use these for a Julia set calculation. } 
  1202.         y := imagMin + curRow * deltaQ;
  1203.         kol := 0;
  1204.         Po := -0.39054;
  1205.         Qo := 0.58679;
  1206. *)        
  1207.         Po := realMin + curCol * deltaP;                { next starting point  }
  1208.         Qo := imagMin + curRow * deltaQ;
  1209.         kol := 0; 
  1210.         x := 0;                                                        { Mandel set starts with 0 always. }
  1211.         y := 0;                                                        { For Julia set you start with previous number. }
  1212.     END;        { With }
  1213.     
  1214.     REPEAT
  1215.         { the following is for y = X^2 + C for imaginary numbers.  
  1216.         pt1 = x + yi,  C = Po + Qoi,  in pt2 := pt1^2 + C  }
  1217.         
  1218.         x1 := x*x - y*y + Po;
  1219.         y1 :=2*x*y + Qo;
  1220.         
  1221.         kol := kol + 1;
  1222.         x := x1;  y := y1;
  1223.         
  1224.         r := x1*x1 + y1*y1;
  1225.     UNTIL  (r > M) OR (kol > K);                { Until 'distance' > our infinity, or out of colors. }
  1226.     
  1227.         { It's only legal to set the foreground color directly here because we are
  1228.             setting it in the offscreen port.  This should not be done for ports that are
  1229.             not completely owned by the application, like those going to the screen. }
  1230.     IF kol <= K  THEN                                { r must be > M. }
  1231.         fDrawingPort^.fgColor := kol            { set the color }
  1232.     ELSE                                                    { must be kol > K, ran out of colors. }
  1233.         fDrawingPort^.fgColor := BlackPen;
  1234.     
  1235.         { Move to the pixel we calculated for, then draw the pixel in right color.  This 
  1236.             could be done by setting the bytes in pixel map directly, since we own the
  1237.             PixMap and the buffer. }
  1238.     MoveTo (fFracHeader.curCol, fFracHeader.curRow);
  1239.     Line (0,0);                                            { draw that 'pixel' in the right color }
  1240.     
  1241.  
  1242.         { up the counters to the next pixel location to do. }
  1243.     WITH  fFracHeader  DO BEGIN
  1244.         curCol := curCol + 1;                                    { up the column count. }
  1245.         drawRect := thePort^.portRect;                    { in case we finished a line. }
  1246.         IF curCol >= plotWidth  THEN  BEGIN            { did we run off end of row? }
  1247.                 { Have the line just calculated drawn to window. }
  1248.             drawRect.top := curRow;
  1249.             drawRect.bottom := curRow+1;
  1250.             
  1251.             curCol := 0;                                            { start on the next row. }
  1252.             curRow := curRow + 1;                            { and up the counter of the next row to do. }
  1253.         END;  { start at next row. }
  1254.         
  1255.     END;  { with  fFracHeader }
  1256.  
  1257.         { Check if we are done, and if so, set the flag to stop calculations.  Set the
  1258.             elapsed time counter in the header. }
  1259.     IF fFracHeader.curRow >= fFracHeader.plotHeight  THEN  BEGIN
  1260.         fFracHeader.done := TRUE;
  1261.         GetDateTime(currTime);
  1262.         fFracHeader.elapsedTime := currTime - fStartTime;
  1263.     END;
  1264.     
  1265.     IF NOT EqualRect (thePort^.portRect, drawRect) THEN 
  1266.         fFracAppView.InvalidRect (drawRect);
  1267.  
  1268.     SetGDevice (currDevice);                                { set back to main for normal drawing. }
  1269.     SetPort (currPort);
  1270.  
  1271.     { Now we have changed another point in the document.  We need to mark it as
  1272.         changed so we can save the document. }
  1273.     fChangeCount := fChangeCount + 1;
  1274.     
  1275. END;        { TFracAppDocument.DoIdle } 
  1276.  
  1277.  
  1278. {-------------------------------  View  -------------------------------}
  1279.  
  1280.     { Initialize the view, basically set up the view object and clear the selection. }
  1281. PROCEDURE     TFracAppView.IFracAppView (itsDocument: TFracAppDocument;
  1282.         sizeOfView: Rect);
  1283.  
  1284. BEGIN
  1285.     fSelectionRect := gZeroRect;                    { no selection to start with. }
  1286.     fFracAppDocument := itsDocument;        { save off parent document for convenience. }
  1287.     
  1288.         { This view will be the full size of the screen since we have an offscreen
  1289.             bitMap as the view.  This will be clipped to fit the frame of the window.
  1290.             There is no parent view, and the horizontal and vertical are fixed.  The
  1291.             selection is to be shown, and is initially off. }
  1292.     IView(NIL, itsDocument, sizeOfView, sizeFixed, sizeFixed, TRUE, hlOff);
  1293.  
  1294. END;        { TFracAppView.IFracAppView }
  1295.  
  1296.  
  1297.     { Our routine to do the drawing of the fractal.  This is the display routine
  1298.         to take the data out of the offscreen buffer and whip it up to the window,
  1299.         as the current view. The fractal is full screen size, clips without
  1300.         scaling into the window. }
  1301. PROCEDURE TFracAppView.Draw(area: Rect); OVERRIDE;    
  1302.  
  1303. BEGIN        
  1304.         { Copy the bits to the screen, allowing CopyBits to sort out the colors.  
  1305.             A little slower for updates, but reasonable. }
  1306.     CopyBits ( GrafPtr(fFracAppDocument.fDrawingPort)^.portBits,
  1307.             thePort^.portBits, area, area, srcCopy, Nil);
  1308. END;        { TFracAppView.Draw }
  1309.  
  1310.  
  1311.     { Handle the menu choice for New Fractal out of the Fractal Menu.  This makes a new
  1312.         Fractal based on the current selection.  It does it by calling on the application
  1313.         object to make a new document.  The communication to the DoInitialState is
  1314.         through the global variables. }
  1315. FUNCTION TFracAppView.DoMenuCommand(aCmdNumber: CmdNumber): TCommand;  OVERRIDE;
  1316.  
  1317. VAR        oldDeltaP,
  1318.             oldDeltaQ,
  1319.             oldRealMin,
  1320.             oldImagMin:    Extended;                    { for figuring new fractal area. }
  1321.  
  1322. BEGIN
  1323.     { Assume that we have no command to return, since none of our commands currently
  1324.         change the document. }
  1325.     DoMenuCommand := gNoChanges;            { no command object returned. }
  1326.  
  1327.     { Case off on the various menus.  Currently we have the new fractal item.
  1328.         Any out of that list are handled by Mr. MacApp and we pass it on. }
  1329.     CASE  aCmdNumber  OF
  1330.     
  1331.         kNewFractal:
  1332.             { If the option chosen was the New Fractal item, then we need to start 
  1333.                 up a fresh one based on the selection rectangle.  This new fractal is 
  1334.                 based on parts of the old one, since it is
  1335.                 a zoom in operation.  We make a new document/window/view
  1336.                 as if it were a New operation.  We then change the fields we need to in
  1337.                 that document to make it start calculating based on the selection from
  1338.                 the current view. }
  1339.             
  1340.             BEGIN
  1341.                 { Make a new document and initialize it to the base state.  If we fail in 
  1342.                     opening it, we won't return here, the failure handler will kill it.  We
  1343.                     have nothing else to dispose of, so we don't make a CatchSignals here. 
  1344.                     This will come out of permanent memory.  The aCmdNumber is so that
  1345.                     the new document knows it came from a zoom in operation.  Since this
  1346.                     is somewhat funky, we communicate to the other part of the program
  1347.                     with the global variables.  If nonzero, the code that makes a
  1348.                     new document will know to use these numbers in order to do the zoom. 
  1349.                     This is less than completely desireable, but there are no good places
  1350.                     to override in order to get both the selection rectangle and the new
  1351.                     document objects. }
  1352.     
  1353.                     { The basic fractal has been set up.  We now need to change the calculation
  1354.                         area based on the current selection, in order to effect the zoom in. } 
  1355.                 WITH  fFracAppDocument.fFracHeader DO BEGIN
  1356.                     oldDeltaP := deltaP;                            { from SELF, the old document. }
  1357.                     oldDeltaQ := deltaQ;
  1358.                     oldRealMin := realMin;
  1359.                     oldImagMin := imagMin;
  1360.                 END;
  1361.  
  1362.                 { calculate new min/max for real and imaginary parts based on how far
  1363.                     into the old fractal plane we were.  This is an extended calculation
  1364.                     since our plane is in extendeds.  We get the new locations of min and
  1365.                     max, and save them off.  We reset the deltaP or Q with SetUpConstants,
  1366.                     in order to force a 1:1 ratio, but we need all sides to determine
  1367.                     which one to force.  }
  1368.                 gRealMin := oldRealMin + oldDeltaP * fSelectionRect.left;
  1369.                 gImagMin := oldImagMin + oldDeltaQ * fSelectionRect.top;
  1370.                 gRealMax := oldRealMin + oldDeltaP * fSelectionRect.right;
  1371.                 gImagMax := oldImagMin + oldDeltaQ * fSelectionRect.bottom;
  1372.  
  1373.                 gApplication.OpenNew (aCmdNumber);
  1374.             END;
  1375.             
  1376.         OTHERWISE
  1377.             DoMenuCommand := INHERITED  DoMenuCommand (aCmdNumber);    { next guy in chain. }
  1378.     END;        { CASE on aCmdNumber }
  1379.         
  1380. END;    { TFracAppView.DoMenuCommand }
  1381.  
  1382.  
  1383.     { Set up the New Fractal menus choice in Fractal Menu, based on selection. }
  1384. PROCEDURE TFracAppView.DoSetupMenus;  OVERRIDE;
  1385.  
  1386. BEGIN
  1387.     INHERITED DoSetupMenus;                            { Do mainline stuff first. }
  1388.     
  1389.         { If we have a non-zero selection, then we can enable the menu item to use
  1390.             it as the new fractal dimensions for this document. }
  1391.     Enable (kNewFractal, NOT EmptyRect (fSelectionRect));
  1392. END;    { TFracAppView.DoSetupMenus }
  1393.  
  1394.  
  1395.     { The way to handle mouse events in the content region of the view.  This will
  1396.         pass back the command object to handle tracking the mouse and creating a
  1397.         new selection in preparation for making a new fractal. }
  1398. FUNCTION  TFracAppView.DoMouseCommand(VAR downLocalPoint: Point; 
  1399.                         VAR info: EventInfo;  VAR hysteresis: Point): TCommand;    OVERRIDE;
  1400.                         
  1401. VAR        tracker:    TAreaSelector;
  1402.         
  1403. BEGIN
  1404.     New(tracker);                                        { make a new command object. }
  1405.     FailNIL(tracker);                                    { no memory, trash out. }
  1406.     tracker.IAreaSelector(SELF, downLocalPoint); { Initialize the command object. }
  1407.     DoMouseCommand := tracker;                { return it for later use. }
  1408. END;        { TFracAppView.DoMouseCommand }
  1409.  
  1410.  
  1411.     { Highlight the current selection rectangle if there is one.  This is drawn in scrCopy
  1412.         mode to make it stand out better when it is a final selection.  XOR is used for
  1413.         the rubberband, until mouseUp. }
  1414. PROCEDURE TFracAppView.DoHighLightSelection(fromHL, toHL: HLState); OVERRIDE;
  1415.  
  1416. VAR        selPatHandle:    PatHandle;
  1417.     
  1418. BEGIN
  1419.     IF toHL = hlOn THEN  BEGIN
  1420.         selPatHandle := GetPattern(kSelPattern);    { get the pattern we use. }
  1421.         IF selPatHandle <> NIL  THEN                         { If pattern available, use it. }
  1422.             PenPat (selPatHandle^^);                            { set pen pattern to our selection kind. }
  1423.         PenMode(srcCopy);                                        { copy mode on pattern selection. }
  1424.         
  1425.             { We have a selection, so go ahead and draw the selection rectangle. }
  1426.         FrameRect (fSelectionRect);                        { outline the frame of selection. }
  1427.     END;        { highlight turned on. }
  1428.     
  1429.         { Turning off the highlight, we need to remove the traces of the selection.
  1430.             To do this, redraw that rectangle. }
  1431.     IF toHL = hlOff THEN   Draw (fSelectionRect);    { ReDraw it to clear selection. }
  1432. END;        { TFracAppView.DoHighlightSelection }
  1433.  
  1434.  
  1435. {-------------------------------  Command  -------------------------------}
  1436.  
  1437.     { Initialize the selector object itself.  Sets up the normal fields. }
  1438. PROCEDURE TAreaSelector.IAreaSelector(ownerView: TFracAppView; startPt: Point);
  1439.  
  1440. BEGIN
  1441.     ICommand(cMouseCommand);                    { initialize normal parts of command }
  1442.  
  1443.     fCausesChange := FALSE;                            { just selection, not changing document. }
  1444.     fCanUndo := FALSE;                                    { therefore, no Undo of no change. }
  1445.     fConstrainsMouse := TRUE;                        { do the constrain to match to screen. }
  1446.     fOwnerView := ownerView;                        { save the view for use in tracking. }
  1447. END;    { TAreaSelector.IAreaSelector }
  1448.  
  1449.  
  1450.     { Track the mouse while the button is down.  This is overridden so we can leave
  1451.         the command object as not having changed, ie. so we can pass back the 
  1452.         gNoChanges as the last step since this is not an undoable operation.  It 
  1453.         doesn't change the view, so we don't need to DoIt or Commit. }
  1454. FUNCTION  TAreaSelector.TrackMouse(aTrackPhase: TrackPhase;
  1455.                         VAR anchorPoint, previousPoint, nextPoint: Point;
  1456.                         mouseDidMove: BOOLEAN): TCommand;  OVERRIDE;
  1457.  
  1458. VAR        selPatHandle:        PatHandle;
  1459.  
  1460. BEGIN
  1461.     TrackMouse := SELF;                                { Assume we are not in release phase. }
  1462.     
  1463.     CASE aTrackPhase OF
  1464.         trackPress:
  1465.         BEGIN
  1466.             fOwnerView.DoHighLightSelection (hlOn, hlOff);        { turn off old selection if any. }
  1467.             fOwnerView.fSelectionRect := gZeroRect;                { clear rect, there isn't one. }
  1468.         END;
  1469.  
  1470.         trackRelease:
  1471.         BEGIN
  1472.             Pt2Rect(anchorPoint, nextPoint, fOwnerView.fSelectionRect);
  1473.             fOwnerView.DoHighlightSelection (hlOff, hlOn);        { leave on selection. }
  1474.             TrackMouse := gNoChanges;
  1475.         END;
  1476.     END;    { Case on aTrackPhase }
  1477. END;    { TAreaSelector.TrackMouse }
  1478.  
  1479.  
  1480.     { Track the mouse giving the feedback of a different rectangle kind.  This is so
  1481.         we can use the selection pattern to give a preferred rectangle.  The selection
  1482.         pattern comes out of temporary memory so as to not fail needlessly. }
  1483. PROCEDURE TAreaSelector.TrackFeedback(anchorPoint, nextPoint: Point;
  1484.                         turnItOn, mouseDidMove: BOOLEAN);  OVERRIDE;
  1485.                         
  1486. VAR        selBoy:                    Rect;
  1487.             selPatHandle:        PatHandle;
  1488.             
  1489. BEGIN
  1490.     IF mouseDidMove THEN
  1491.         BEGIN {the pen is already in patXOR mode, black, one wide}
  1492.             selPatHandle := GetPattern(kSelPattern);    { get the pattern we use. }
  1493.             IF selPatHandle <> NIL  THEN                        { use our pattern if available. }
  1494.                 PenPat (selPatHandle^^);                            { set pen pattern to our selection kind. }
  1495.         
  1496.             Pt2Rect(anchorPoint, nextPoint, selBoy);
  1497.             FrameRect(selBoy);
  1498.         END;
  1499. END;    { TAreaSelector.TrackFeedback }
  1500.  
  1501.  
  1502.     { Constrain the mouse to a rectangle that is the same proportion as the screen, so
  1503.         we can make the selection match better without having to guess at the length
  1504.         or width, or scaling the chosen rect to fit the screen.  Small piece chosen will
  1505.         blow up to fit easily.  This will make it easier to choose a selection that 
  1506.         gives a 1:1 aspect ratio.  This also chooses which direction the mouse has
  1507.         moved, deciding which is larger in order to decide the direction to constrain. }
  1508. PROCEDURE TAreaSelector.TrackConstrain(anchorPoint, previousPoint: Point; 
  1509.                             VAR nextPoint: Point);  OVERRIDE;
  1510.             
  1511. VAR        newWidth, newHeight:        LongInt;
  1512.             mouseRatio, plotRatio:        Real;
  1513.             constrainRect:                    Rect;
  1514.     
  1515.     PROCEDURE  ChangeWidth;
  1516.     BEGIN
  1517.         WITH  fOwnerView.fFracAppDocument.fFracHeader  DO BEGIN
  1518.                 { Get the new width as a positive number, a displacement that is constrained. }
  1519.             newWidth := ABS (nextPoint.v - anchorPoint.v) * plotWidth DIV plotHeight;
  1520.                 { Decide which quadrant we are in, moving the right direction. }
  1521.             IF nextPoint.h < anchorPoint.h  THEN newWidth := -newWidth;
  1522.                 { Actually change the final point to pass back. }
  1523.             nextPoint.h := anchorPoint.h + newWidth;                        { add offset to get new pt. }                
  1524.         END;
  1525.     END;
  1526.     
  1527.     PROCEDURE  ChangeHeight;
  1528.     BEGIN
  1529.         WITH  fOwnerView.fFracAppDocument.fFracHeader  DO BEGIN
  1530.             newHeight := ABS (nextPoint.h - anchorPoint.h) * plotHeight DIV plotWidth;
  1531.             IF nextPoint.v < anchorPoint.v  THEN newHeight := -newHeight;
  1532.             nextPoint.v := anchorPoint.v + newHeight;                    { add offset to get new pt. }
  1533.         END;
  1534.     END;
  1535.     
  1536.     PROCEDURE  PinPoint;                    { Pin the rectangle to the edge of the document. }
  1537.     BEGIN
  1538.         WITH  fOwnerView.fFracAppDocument.fFracHeader  DO BEGIN
  1539.             SetRect(constrainRect, 0, 0, plotWidth, plotHeight);
  1540.             nextPoint := Point (PinRect(constrainRect, nextPoint));
  1541.         END;
  1542.     END;
  1543.     
  1544. BEGIN
  1545.     WITH  fOwnerView.fFracAppDocument.fFracHeader  DO BEGIN
  1546.         mouseRatio := ABS ((nextPoint.h - anchorPoint.h)/(nextPoint.v - anchorPoint.v));
  1547.         plotRatio := plotWidth/plotHeight;
  1548.         
  1549.             { The deltaX, deltaY can be thought of as a rect too.  If the ratio of sides on
  1550.                 that rect (width/height) is greater than the ratio of width/height of the
  1551.                 plot rectangle, then we need to grow the height of the rect.  If it is less,
  1552.                 we need to grow the width.  This is a ratio of sides to decide which way
  1553.                 to grow.  We grow to make the new rect still touch the mouse position.
  1554.                 It can be thought of as the rectangle being thicker than tall wanting to 
  1555.                 grow the tall part in a constrained way, and the corollary for the width. }
  1556.         IF mouseRatio > plotRatio  THEN BEGIN        { constrain height to new value. }
  1557.                 ChangeHeight;
  1558.                 PinPoint;
  1559.                 ChangeWidth;
  1560.             END
  1561.         ELSE        BEGIN        { constrain width to new value. }
  1562.                 ChangeWidth;
  1563.                 PinPoint;
  1564.                 ChangeHeight;
  1565.             END;
  1566.     END;    { With }
  1567. END;    { TAreaSelector.TrackConstrain }
  1568.  
  1569.  
  1570. {$POP}        { Restore the compiler state. }
  1571.