home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / GRAPHICS / MISC / STK100.ZIP / STKSRC.COM / SPR_ANIM.H < prev    next >
Encoding:
C/C++ Source or Header  |  1990-10-20  |  7.9 KB  |  190 lines
  1. /**********************************************************************
  2. * spr_anim.h
  3. * 
  4. * Routines for automatic sprite animation and movement.
  5. **********************************************************************
  6.                     This file is part of
  7.  
  8.           STK -- The sprite toolkit -- version 1.0
  9.  
  10.               Copyright (C) Jari Karjala 1990
  11.  
  12. The sprite toolkit (STK) is a FreeWare toolkit for creating high
  13. resolution sprite graphics with PCompatible hardware. This toolkit 
  14. is provided as is without any warranty or such thing. See the file
  15. COPYING for further information.
  16.  
  17. **********************************************************************
  18. **********************************************************************/
  19.  
  20. #ifndef __SPR_ANIM_H_
  21. #define __SPR_ANIM_H_
  22.  
  23. #include "grtypes.h"
  24.  
  25.  
  26. #ifndef __ANIM_SPRITE_
  27. typedef void *ANIM_SPRITE;
  28. #endif
  29.  
  30. /**********************************************************************
  31. * The information structure returned by the spr_anim_get_info()
  32. **********************************************************************/
  33. typedef struct _anim_spr_info {
  34.     int     x,y;                            /** location        **/
  35.     int     dx,dy;                          /** movement vector **/
  36.     int     lef, top, rig, bot;             /** limits          **/
  37.     WORD    frame, frame_delay, timeout;    /** time info       **/
  38.     WORD    id;     /** the user spesified id of current sprite **/
  39.     int     w,h;                            /** width&height    **/
  40. } ANIM_SPR_INFO;
  41.  
  42.  
  43. /**********************************************************************
  44. * The values for fx_mode and fx_type. (See spr_anim_set_fx_handler)
  45. **********************************************************************/
  46. #define SPR_ANIM_FX_ALL       (0xFFFF) /** all fx       **/
  47. #define SPR_ANIM_FX_TIMEOUT     (1<<0) /** timeout      **/
  48. #define SPR_ANIM_FX_HIT_X_LIMIT (1<<1) /** hit x limit  **/
  49. #define SPR_ANIM_FX_HIT_Y_LIMIT (1<<2) /** hit y limit  **/
  50. #define SPR_ANIM_FX_HIT_SPRITE  (1<<3) /** hit other spr**/
  51.  
  52. /**********************************************************************
  53. * The FX_RET values for the fx_handler return
  54. **********************************************************************/
  55. #define SPR_ANIM_FX_RET_NOTHING (0)     /** continue normally       **/
  56. #define SPR_ANIM_FX_RET_RE_PUT  (1)     /** put the sprite again    **/
  57. #define SPR_ANIM_FX_RET_STOP    (2)     /** stop the animation      **/
  58. #define SPR_ANIM_FX_RET_DELETE  (3)     /** delete the anim.sprite  **/
  59. #define SPR_ANIM_FX_RET_DESTROY (4)     /** destroy the anim.sprite **/
  60.  
  61.  
  62.  
  63. /**********************************************************************
  64. * Create an animated sprite from the given simple sprites.
  65. * The sprites must have the same width and height attributes.
  66. * Set the following defaults:
  67. *   x,y = 0,0
  68. *   dx,dy = 0,0
  69. *   lef,top,rig,bot = 0,0,spr_max_x,spr_max_y
  70. *   frame_delay, timeout = 0,0
  71. *   fx_mode = FX_ALL 
  72. *   fx_handler = default_fx (TIMEOUT & HIT_SPRITE delete, LIMITs bounce.)
  73. *
  74. * count The number of simple sprites
  75. * ...   The simple sprites
  76. *
  77. * Return: ANIM_SPRITE if no errors or 
  78. *          NULL if memory allocation error, count>ANIM_SPRITE_MAX 
  79. *           or ... contains a NULL sprite.
  80. **********************************************************************/
  81. ANIM_SPRITE spr_anim_create(WORD count, ...);
  82.  
  83. /**********************************************************************
  84. * Start the sprite animation. 
  85. *
  86. * aspr  The animated sprite to use
  87. **********************************************************************/
  88. void spr_anim_start(ANIM_SPRITE aspr);
  89.  
  90. /**********************************************************************
  91. * Stop the animation of the given sprite. This means that after the 
  92. * next pass this sprite will not be shown nor updated.
  93. *
  94. * aspr  The animated sprite to stop
  95. **********************************************************************/
  96. void spr_anim_stop(ANIM_SPRITE aspr);
  97.  
  98. /**********************************************************************
  99. * Delete the given animated sprite. The simple sprites it contains are 
  100. * NOT deleted.
  101. *
  102. * aspr  The animated sprite to use
  103. **********************************************************************/
  104. void spr_anim_delete(ANIM_SPRITE aspr);
  105.  
  106. /**********************************************************************
  107. * Delete the given animated sprite. The simple sprites it contains are 
  108. * ALSO deleted.
  109. *
  110. * aspr  The animated sprite to destroy
  111. **********************************************************************/
  112. void spr_anim_destroy(ANIM_SPRITE aspr);
  113.  
  114. /**********************************************************************
  115. * spr_put all animated sprites then check for special effects (call
  116. * fx_handler(s) if necessary, and act according to the return values). 
  117. * Call spr_next_pass and after that update frame indices and locations 
  118. * of all animated sprites.
  119. *
  120. * Return: The current visual page
  121. **********************************************************************/
  122. WORD spr_anim_next_pass(void);
  123.  
  124.  
  125.  
  126. /**********************************************************************
  127. * Return a pointer into a static info structure of the sprite.
  128. * Note: the structure is only a copy which is overwritten by the 
  129. *       next call to this function.
  130. **********************************************************************/
  131. ANIM_SPR_INFO *spr_anim_get_info(ANIM_SPRITE aspr);
  132.  
  133. /**********************************************************************
  134. * Set the location of the animated sprite.
  135. **********************************************************************/
  136. void spr_anim_set_location(ANIM_SPRITE aspr, WORD x, WORD y);
  137.  
  138. /**********************************************************************
  139. * Set the movement vector of the animated sprite.
  140. **********************************************************************/
  141. void spr_anim_set_vector(ANIM_SPRITE aspr, int dx, int dy);
  142.  
  143. /**********************************************************************
  144. * Set the limits for the animated sprite. The function takes care
  145. * of the bottom/right adjustments due to the size of the sprite.
  146. *
  147. * Note again, that all simple sprites belonging to the animated sprite
  148. * must have the same width & heigth.
  149. **********************************************************************/
  150. void spr_anim_set_limits(ANIM_SPRITE aspr,
  151.                          WORD lef, WORD top, WORD rig, WORD bot);
  152.  
  153.  
  154. /**********************************************************************
  155. * Set the frame delay and timeout values. (-1 means no change for
  156. * that value). 
  157. *
  158. * NOTE: The 'frame' MUST NOT be changed from an fx_handler!!
  159. *
  160. * frame         The current animation frame number (0..nr of frames-1)
  161. * frame_delay   The number of passes for each frame change (0=no change)
  162. * timeout       The number of passes before timeout action (0=infinite)
  163. **********************************************************************/
  164. void spr_anim_set_time(ANIM_SPRITE aspr,
  165.                        int frame, int frame_delay, int timeout);
  166.  
  167. /**********************************************************************
  168. * Sets the special effects handler function.
  169. * The function should have the following prototype:
  170. *
  171. *   WORD func(ANIM_SPRITE aspr, WORD fx_type, SPRITE spr);
  172. *
  173. * The aspr is the animated sprite, fx_type is the type of the
  174. * effect which caused this call and spr is the colliding sprite
  175. * (if fx_type was HIT_SPRITE). 
  176. *
  177. * The function should return one of the FX_RET values defined above.
  178. *
  179. * A NULL handler means that all special effects cause spr_anim_delete.
  180. *
  181. * fx_mask     The types of effects relayed to the handler.
  182. * fx_handler  The handler function.
  183. **********************************************************************/
  184. void spr_anim_set_fx_handler(ANIM_SPRITE aspr, 
  185.                              WORD fx_mask, 
  186.                              WORD (fx_handler)(ANIM_SPRITE,WORD,SPRITE));
  187.  
  188. #endif
  189.  
  190.