home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD2.iso / Misc / 3_1DOCS.DMS / in.adf / autodocs.lha / doc / animation_dtc.doc < prev    next >
Encoding:
Text File  |  1993-10-15  |  4.1 KB  |  170 lines
  1. TABLE OF CONTENTS
  2.  
  3. animation.datatype/animation.datatype
  4. animation.datatype/animation.datatype   animation.datatype/animation.datatype
  5.  
  6.     NAME
  7.     animation.datatype -- root data type for animations.
  8.  
  9.     FUNCTION
  10.     The animation.datatype is the super-class for any animation related
  11.     classes.
  12.  
  13.     This class is responsible for creating the controls, scaling,
  14.     remapping and synchronization.
  15.  
  16.     METHODS
  17.     OM_NEW -- Create a new animation object.
  18.  
  19.     OM_GET -- Obtain the value of an attribute.
  20.  
  21.     OM_SET -- Set the values of multiple attributes.
  22.  
  23.     OM_UPDATE -- Update the values of multiple attributes.
  24.  
  25.     OM_DISPOSE -- Dispose of a animation object.
  26.  
  27.     GM_LAYOUT -- Layout the object and notify the application of the
  28.         title and size.
  29.  
  30.     GM_HITTEST -- Determine if the object has been hit with the
  31.         mouse.
  32.  
  33.     GM_GOACTIVE -- Tell the object to go active.  On SELECTDOWN, the
  34.         animation will start playing.
  35.  
  36.     GM_HANDLEINPUT -- Handle input.  Currently input (other than
  37.         SELECTDOWN) doesn't affect the animation.
  38.  
  39.     GM_RENDER -- Cause the current frame to render.
  40.  
  41.     DTM_FRAMEBOX -- Obtain the display environment that the animation
  42.         requires.
  43.  
  44.     DTM_TRIGGER -- Cause an event to occur.  Currently the only
  45.         trigger event is STM_PLAY, which will cause the animation to start
  46.         playing.
  47.  
  48.     DTM_COPY -- Copy the current frame to the clipboard as an IFF ILBM.
  49.  
  50.     DTM_WRITE -- Write the current frame to a file as an IFF ILBM.
  51.  
  52.     DTM_PRINT -- Print the current frame.
  53.  
  54.     ADTM_LOADFRAME -- Load a frame of the animation.
  55.  
  56.     ADTM_UNLOADFRAME -- Deallocate any memory allocated by ADTM_LOADFRAME.
  57.  
  58.     ADTM_START -- Start the animation.  This MUST be passed to the
  59.         super-class AFTER the sub-class has started.
  60.  
  61.     ADTM_PAUSE -- Pause the animation.  This MUST be passed to the
  62.         super-class BEFORE the sub-class pauses.
  63.  
  64.     ADTM_STOP -- Stop the animation.  This MUST be passed to the
  65.         super-class BEFORE the sub-class stops.
  66.  
  67.     ADTM_LOCATE -- Used to locate a frame of the animation.
  68.  
  69.     TAGS
  70.     DTA_ControlPanel (BOOL) -- Determine whether the control
  71.         panel is shown.  Defaults to TRUE.
  72.  
  73.         Applicability is (I).
  74.  
  75.     DTA_Immediate (BOOL) -- Indicate whether the animation
  76.         should immediately begin playing.  Defaults to
  77.         FALSE.
  78.  
  79.         Applicability is (I).
  80.  
  81.     ADTA_Remap (BOOL) -- Indicate whether the animation should be
  82.         remapped or not.
  83.  
  84.         Applicability is (I).
  85.  
  86.     ADTA_ModeID (ULONG) -- Set and get the graphic mode id of the
  87.         picture.
  88.  
  89.         Applicability is (ISG).
  90.  
  91.     ADTA_Width (ULONG) -- Width of a frame in pixels.
  92.  
  93.         Applicability is (IG).
  94.  
  95.     ADTA_Height (ULONG) -- Height of a frame in pixels.
  96.  
  97.         Applicability is (IG).
  98.  
  99.     ADTA_Depth (ULONG) -- Depth of the frame.
  100.  
  101.         Applicability is (IG).
  102.  
  103.     ADTA_Frames (ULONG) -- Number of frames in animation.
  104.  
  105.         Applicability is (ISG).
  106.  
  107.     ADTA_KeyFrame (struct BitMap *) -- Pointer to the key
  108.         frame.
  109.  
  110.         Applicability is (ISG).
  111.  
  112.     ADTA_FramesPerSecond (ULONG) -- Number of frames per
  113.         second to play.
  114.  
  115.     ADTA_NumColors (WORD) -- Number of colors used by the picture.
  116.  
  117.         Applicability is (ISG).
  118.  
  119.     ADTA_ColorRegisters (struct ColorRegister *) -- Color table.
  120.  
  121.         Applicability is (G).
  122.  
  123.     ADTA_CRegs (ULONG *) -- Color table to use with SetRGB32CM().
  124.  
  125.         Applicability is (G).
  126.  
  127.     ADTA_GRegs (ULONG *) -- Color table.
  128.  
  129.         Applicability is (G).
  130.  
  131.     ADTA_ColorTable (ULONG *) -- Shared pen table.
  132.  
  133.         Applicability is (G).
  134.  
  135.     ADTA_ColorTable2 (ULONG *) -- Shared pen table.
  136.  
  137.         Applicability is (G).
  138.  
  139.     ADTA_Allocated (ULONG) --  Number of shared colors allocated.
  140.  
  141.         Applicability is (G).
  142.  
  143.     ADTA_NumAlloc (WORD) -- Number of colors allocated by the picture.
  144.  
  145.         Applicability is (G).
  146.  
  147.     ADTA_BitMapHeader (struct BitMapHeader *) -- Set and get the
  148.         base information for the animation.  BitMapHeader is defined in
  149.         <datatypes/pictureclass.h>
  150.  
  151.         Applicability is (G).
  152.  
  153.     SDTA_Sample (BYTE *) -- Pointer to sample data.
  154.  
  155.         Applicability is (ISG).
  156.  
  157.     SDTA_SampleLength (ULONG) -- Length of sample data.
  158.  
  159.         Applicability is (ISG).
  160.  
  161.     SDTA_Period (ULONG) -- Period to play back sample at.
  162.  
  163.         Applicability is (ISG).
  164.  
  165.     SDTA_Volume (ULONG) -- Volume to play back sample at.
  166.  
  167.         Applicability is (ISG).
  168.  
  169.  
  170.