home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / bgui.lzx / bgui / docs / vectorclass.doc < prev    next >
Encoding:
Text File  |  1995-04-24  |  5.6 KB  |  165 lines
  1.  
  2.                File: vectorclass.doc
  3.         Description: Vectorclass documentation.
  4.           Copyright: (C) Copyright 1994-1995 Jaba Development.
  5.                      (C) Copyright 1994-1995 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8. ------------------------------------------------------------------------------
  9.  
  10. TABLE OF CONTENTS
  11.  
  12. vectorclass/--background--
  13. vectorclass/Methods
  14. vectorclass/Attributes
  15.  
  16. vectorclass/--background--                          vectorclass/--background--
  17.  
  18.     NAME
  19.         Class:          vectorclass
  20.         Superclass:     IMAGECLASS
  21.         Include File:   <libraries/bgui.h>
  22.  
  23.     FUNCTION
  24.         To  provide  you  with  an  easy  way to create simple, fully scalable
  25.         images.  The  image  consists  of  an  array of small structures which
  26.         contains coordinates and command flags.
  27.  
  28. vectorclass/Methods                                        vectorclass/Methods
  29.  
  30.     NEW METHODS
  31.         None.
  32.  
  33.     CHANGED METHODS
  34.         None.
  35.  
  36. vectorclass/Attributes                                  vectorclass/Attributes
  37.  
  38.     NAME
  39.         VIT_VectorArray -- ( struct VectorItem * )
  40.  
  41.     FUNCTION
  42.         Set  or  get  a  pointer  to  an  array  of  VectorItem structure. The
  43.         VectorItem  structure  is a small structure which contains information
  44.         on the coordinates and command flags.
  45.  
  46.         struct VectorItem {
  47.                 WORD            vi_x;
  48.                 WORD            vi_y;
  49.                 ULONG           vi_Flags;
  50.         };
  51.  
  52.         vi_x -- This field contains either the x-coordinate of the  next point
  53.                 or  other  data  depending  which command flags are set in the
  54.                 vi_Flags field.
  55.  
  56.         vi_y -- This field contains either the y-coordinate of the  next point
  57.                 or  other  data  depending  which command flags are set in the
  58.                 vi_Flags field.
  59.  
  60.         vi_Flags -- This field can contain any of the following flags:
  61.  
  62.                 VIF_MOVE -- Move to the location described in vi_x and vi_y.
  63.  
  64.                 VIF_DRAW -- Draw to the location described in vi_x and vi_y.
  65.  
  66.                 VIF AREASTART -- Start area-filling at  the location described
  67.                         in vi_x, vi_y.  All  VIF_MOVE  and  VIF_DRAW  commands
  68.                         will now AreaMove() and AreaDraw().
  69.  
  70.                 VIF_AREAEND -- End area-filling at the  location  described in
  71.                         vi_x, vi_y. All VIF_MOVE and  VIF_DRAW  commands  will
  72.                         now Move() and Draw().
  73.  
  74.                 VIF_XRELRIGHT -- vi_x is releative to the right image border.
  75.  
  76.                 VIF_YRELBOTTOM -- vi_y   is  releative  to  the  bottom  image
  77.                         border.
  78.  
  79.                 VIF_SHADOWPEN -- Set the SHADOWPEN and move/draw.
  80.  
  81.                 VIF_SHINEPEN -- Set the SHINEPEN and move/draw.
  82.  
  83.                 VIF_FILLPEN -- Set the FILLPEN and move/draw.
  84.  
  85.                 VIF_TEXTPEN -- Set the TEXTPEN and move/draw.
  86.  
  87.                 VIF_COLOR -- Set the pen described in vi_x. No move/draw.
  88.  
  89.                 VIF_LASTITEM -- This flag  terminates  the  VectorItem  array.
  90.                         This flag _must_ be set in the last VectorItem  of the
  91.                         array as it's the only way for the class  to know when
  92.                         it has reached the end.
  93.  
  94.                 VIF_SCALE -- vi_x  and  vi_y contain  the  design  size of the
  95.                         image.  The  design  size  usually  is the size of the
  96.                         image when using a 8x8 font.  Without this information
  97.                         the image cannot and will not scale.
  98.  
  99.                 VIF_DRIPEN -- Set the drawinfo pen described in vi_x. No move/
  100.                         draw. See <intuition/screens.h> about drawinfo pens.
  101.  
  102.                 VIF_AOLPEN -- Set the area-outline pen to the pen described in
  103.                         vi_x. No move/draw.
  104.  
  105.                 VIF_AOLDRIPEN -- Set the area-ouline pen  to the  drawinfo pen
  106.                         described in vi_x.   No move/draw.   See   <intuition/
  107.                         screens.h> about drawinfo pens.
  108.  
  109.                 VIF_ENDOPEN -- Terminate the area-outline mode.
  110.  
  111.         Default is NULL. Applicability is (ISG).
  112.  
  113.     NAME
  114.         VIT_BuiltIn -- ( ULONG )
  115.  
  116.     FUNCTION
  117.         Set  or  get  any  of  the  built-in images. You can select any of the
  118.         following images:
  119.  
  120.         BUILTIN_GETPATH -- Also know as a folder image.  This image is usually
  121.                 used in a button which  pops  up a  filerequester to  select a
  122.                 drawer.
  123.  
  124.         BUILTIN_GETFILE -- This imahe is usually used in a  button  which pops
  125.                 up a filerequester to select a file.
  126.  
  127.         BUILTIN_CHECKMARK -- Standard,   fully  scalable,   checkmark/checkbox
  128.                 image.
  129.  
  130.         BUILTIN_POPUP -- This image is usually used in a button  which pops up
  131.                 a requester to select  some  sort of  data  like screen  mode,
  132.                 fonts etc.
  133.  
  134.         BUILTIN_ARROW_UP -- A up arrow image.
  135.  
  136.         BUILTIN_ARROW_DOWN -- A down arrao image.
  137.  
  138.         BUILTIN_ARROW_LEFT -- A left arrow image.
  139.  
  140.         BUILTIN_ARROW_RIGHT -- A right arrow image.
  141.  
  142.         Default is 0 (none). Applicability is (ISG).
  143.  
  144.     NAME
  145.         VIT_Pen -- ( UWORD )
  146.  
  147.     FUNCTION
  148.         Set or get the pen which is used to render the image.
  149.  
  150.         Default is ~0. Applicability is (ISG).
  151.  
  152.     SEE ALSO
  153.         VIT_DriPen
  154.  
  155.     NAME
  156.         VIT_DriPen -- ( UWORD )
  157.  
  158.     FUNCTION
  159.         Set or get the drawinfo pen used to render the image.
  160.  
  161.         Default is ~0. Applicability is (ISG).
  162.  
  163.     SEE ALSO
  164.         <intuition/screens.h>, VIT_Pen
  165.