DOOM-3-BFG

DOOM 3 BFG Edition
Log | Files | Refs

SWF_Sprites.h (3101B)

      1 /*
      2 ===========================================================================
      3 
      4 Doom 3 BFG Edition GPL Source Code
      5 Copyright (C) 1993-2012 id Software LLC, a ZeniMax Media company. 
      6 
      7 This file is part of the Doom 3 BFG Edition GPL Source Code ("Doom 3 BFG Edition Source Code").  
      8 
      9 Doom 3 BFG Edition Source Code is free software: you can redistribute it and/or modify
     10 it under the terms of the GNU General Public License as published by
     11 the Free Software Foundation, either version 3 of the License, or
     12 (at your option) any later version.
     13 
     14 Doom 3 BFG Edition Source Code is distributed in the hope that it will be useful,
     15 but WITHOUT ANY WARRANTY; without even the implied warranty of
     16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     17 GNU General Public License for more details.
     18 
     19 You should have received a copy of the GNU General Public License
     20 along with Doom 3 BFG Edition Source Code.  If not, see <http://www.gnu.org/licenses/>.
     21 
     22 In addition, the Doom 3 BFG Edition Source Code is also subject to certain additional terms. You should have received a copy of these additional terms immediately following the terms and conditions of the GNU General Public License which accompanied the Doom 3 BFG Edition Source Code.  If not, please request a copy in writing from id Software at the address below.
     23 
     24 If you have questions concerning this license or the applicable additional terms, you may contact in writing id Software LLC, c/o ZeniMax Media Inc., Suite 120, Rockville, Maryland 20850 USA.
     25 
     26 ===========================================================================
     27 */
     28 #ifndef __SWF_SPRITES_H__
     29 #define __SWF_SPRITES_H__
     30 
     31 /*
     32 ================================================
     33 What the swf file format calls a "sprite" is known as a "movie clip" in Flash
     34 There is one main sprite, and many many sub-sprites
     35 Only the main sprite is allowed to add things to the dictionary
     36 ================================================
     37 */
     38 class idSWFSprite {
     39 public:
     40 	idSWFSprite( class idSWF * swf );
     41 	~idSWFSprite();
     42 
     43 	void	Load( idSWFBitStream & bitstream, bool parseDictionary );
     44 
     45 	void	Read( idFile * f );
     46 	void	Write( idFile * f );
     47 	
     48 	class idSWF * GetSWF() { return swf; }
     49 
     50 private:
     51 	friend class idSWFSpriteInstance;
     52 	friend class idSWFScriptFunction_Script;
     53 
     54 	class idSWF * swf;	// this is required so things can access the dictionary, it would be kind of nice if we just had an idSWFDictionary pointer instead
     55 
     56 	uint16	frameCount;
     57 
     58 	// frameOffsets contains offsets into the commands list for each frame
     59 	// the first command for frame 3 is frameOffsets[2] and the last command is frameOffsets[3]
     60 	idList< uint32, TAG_SWF >	frameOffsets;
     61 
     62 	struct swfFrameLabel_t {
     63 		idStr frameLabel;
     64 		uint32 frameNum;
     65 	};
     66 	idList< swfFrameLabel_t, TAG_SWF > frameLabels;
     67 
     68 	struct swfSpriteCommand_t {
     69 		swfTag_t		tag;
     70 		idSWFBitStream	stream;
     71 	};
     72 	idList< swfSpriteCommand_t, TAG_SWF > commands;
     73 
     74 	//// [ES-BrianBugh 1/16/10] - There can be multiple DoInitAction tags, and all need to be executed.
     75 	idList<idSWFBitStream, TAG_SWF> doInitActions;
     76 
     77 	byte * commandBuffer;
     78 
     79 };
     80 
     81 #endif // !__SWF_SPRITES_H__