[4245] | 1 | /*! |
---|
| 2 | \file md2Model.h |
---|
| 3 | \brief Definition of an MD2 Model, a model format invented by ID Software. |
---|
| 4 | |
---|
| 5 | We are deeply thankfull for all the wunderfull things id software made for us gamers! |
---|
| 6 | |
---|
| 7 | The md2 file format is structured in a very simple way: it contains animations which are made out of |
---|
| 8 | frames (so called keyframes). Each frame is a complete draweable model in a specific position. |
---|
| 9 | A frame is a collection of vertex and its compagnions (normals, texture coordinates). |
---|
| 10 | |
---|
| 11 | A typical model has about 200 frames, the maximum frame count is fixed by MD2_MAX_FRAMES to currently |
---|
| 12 | 512 frames. The maximal vetices count is set to 2048 verteces, not enough? |
---|
| 13 | You just have to change the MD2_MAX_* values if it doesn't fit your purposes... |
---|
| 14 | |
---|
| 15 | Surface Culling is fully implemented in md2 models: quake2 uses front face culling. |
---|
| 16 | */ |
---|
| 17 | |
---|
| 18 | #ifndef _MD2MODEL_H |
---|
| 19 | #define _MD2MODEL_H |
---|
| 20 | |
---|
| 21 | #include "abstract_model.h" |
---|
| 22 | #include "base_object.h" |
---|
| 23 | #include "stdincl.h" |
---|
| 24 | |
---|
| 25 | |
---|
| 26 | //! These are the needed defines for the max values when loading .MD2 files |
---|
[4459] | 27 | #define MD2_IDENT (('2'<<24) + ('P'<<16) + ('D'<<8) + 'I') //!< the md2 identifier tag in the bin file |
---|
| 28 | #define MD2_VERSION 8 //!< the md2 version in the header |
---|
| 29 | #define MD2_MAX_TRIANGLES 4096 //!< maximal triangles count |
---|
| 30 | #define MD2_MAX_VERTICES 2048 //!< maximal vertices count |
---|
| 31 | #define MD2_MAX_TEXCOORDS 2048 //!< maximal tex coordinates |
---|
| 32 | #define MD2_MAX_FRAMES 512 //!< maximal frames |
---|
| 33 | #define MD2_MAX_SKINS 32 //!< maximal skins |
---|
| 34 | #define MD2_MAX_FRAMESIZE (MD2_MAX_VERTICES * 4 + 128) //!< maximal framesize |
---|
[4245] | 35 | |
---|
[4461] | 36 | #define NUM_VERTEX_NORMALS 162 //!< number of vertex normals |
---|
| 37 | #define SHADEDOT_QUANT 16 //!< shade dot quantity - no idea what it is |
---|
[4245] | 38 | |
---|
| 39 | //! This stores the speed of the animation between each key frame - currently conflicting with the animation framework |
---|
[4461] | 40 | #define kAnimationSpeed 12.0f //!< animation speed |
---|
[4245] | 41 | |
---|
| 42 | //! This holds the header information that is read in at the beginning of the file: id software definition |
---|
[4279] | 43 | struct MD2Header |
---|
[4245] | 44 | { |
---|
| 45 | int ident; //!< This is used to identify the file |
---|
| 46 | int version; //!< The version number of the file (Must be 8) |
---|
| 47 | |
---|
| 48 | int skinWidth; //!< The skin width in pixels |
---|
| 49 | int skinHeight; //!< The skin height in pixels |
---|
| 50 | int frameSize; //!< The size in bytes the frames are |
---|
| 51 | |
---|
| 52 | int numSkins; //!< The number of skins associated with the model |
---|
| 53 | int numVertices; //!< The number of vertices (constant for each frame) |
---|
| 54 | int numTexCoords; //!< The number of texture coordinates |
---|
| 55 | int numTriangles; //!< The number of faces (polygons) |
---|
| 56 | int numGlCommands; //!< The number of gl commands |
---|
| 57 | int numFrames; //!< The number of animation frames |
---|
| 58 | |
---|
| 59 | int offsetSkins; //!< The offset in the file for the skin data |
---|
| 60 | int offsetTexCoords; //!< The offset in the file for the texture data |
---|
| 61 | int offsetTriangles; //!< The offset in the file for the face data |
---|
| 62 | int offsetFrames; //!< The offset in the file for the frames data |
---|
| 63 | int offsetGlCommands; //!< The offset in the file for the gl commands data |
---|
| 64 | int offsetEnd; //!< The end of the file offset |
---|
| 65 | }; |
---|
| 66 | |
---|
| 67 | |
---|
[4459] | 68 | //! animation names enumeration |
---|
[4488] | 69 | typedef enum animType |
---|
[4245] | 70 | { |
---|
| 71 | STAND, |
---|
| 72 | RUN, |
---|
| 73 | ATTACK, |
---|
| 74 | PAIN_A, |
---|
| 75 | PAIN_B, |
---|
| 76 | PAIN_C, |
---|
| 77 | JUMP, |
---|
| 78 | FLIP, |
---|
| 79 | SALUTE, |
---|
| 80 | FALLBACK, |
---|
| 81 | WAVE, |
---|
[4279] | 82 | POINTT, |
---|
[4245] | 83 | CROUCH_STAND, |
---|
| 84 | CROUCH_WALK, |
---|
| 85 | CROUCH_ATTACK, |
---|
| 86 | CROUCH_PAIN, |
---|
| 87 | CROUCH_DEATH, |
---|
| 88 | DEATH_FALLBACK, |
---|
| 89 | DEATH_FALLFORWARD, |
---|
| 90 | DEATH_FALLBACKSLOW, |
---|
| 91 | BOOM, |
---|
| 92 | |
---|
| 93 | MAX_ANIMATIONS |
---|
[4488] | 94 | }; |
---|
[4245] | 95 | |
---|
| 96 | |
---|
| 97 | |
---|
| 98 | /* forward definitions */ |
---|
| 99 | class Material; |
---|
| 100 | |
---|
| 101 | |
---|
| 102 | |
---|
[4277] | 103 | //! class to store the md2 data in |
---|
| 104 | class MD2Data |
---|
| 105 | { |
---|
| 106 | public: |
---|
[4459] | 107 | MD2Data(const char* modelFileName, const char* skinFileName); |
---|
[4277] | 108 | virtual ~MD2Data(); |
---|
[4245] | 109 | |
---|
[4459] | 110 | private: |
---|
[4277] | 111 | bool loadModel(const char* fileName); |
---|
[4459] | 112 | bool loadSkin(const char* fileName = NULL); |
---|
[4277] | 113 | |
---|
[4459] | 114 | public: |
---|
[4461] | 115 | int numFrames; //!< number of frames |
---|
| 116 | int numVertices; //!< number of vertices |
---|
| 117 | int numTriangles; //!< number of triangles |
---|
| 118 | int numGLCommands; //!< number of gl commands in the glList (tells how to draw) |
---|
| 119 | char* fileName; //!< file name of the model File |
---|
| 120 | char* skinFileName; //!< file name of the skin file |
---|
| 121 | MD2Header* header; //!< the header file |
---|
[4277] | 122 | |
---|
[4461] | 123 | sVec3D* pVertices; //!< pointer to the vertices data block |
---|
| 124 | int* pGLCommands; //!< pointer to the gllist data block |
---|
| 125 | int* pLightNormals; //!< pointer to the light normals |
---|
[4277] | 126 | |
---|
[4461] | 127 | Material* material; //!< pointer to the material |
---|
| 128 | float scaleFactor; //!< the scale factor of the model, (global) |
---|
[4277] | 129 | }; |
---|
| 130 | |
---|
| 131 | |
---|
[4245] | 132 | //! This is a MD2 Model class |
---|
[4276] | 133 | class MD2Model : public AbstractModel { |
---|
[4245] | 134 | |
---|
| 135 | public: |
---|
[4459] | 136 | MD2Model(const char* modelFileName, const char* skinFileName = NULL); |
---|
[4276] | 137 | virtual ~MD2Model(); |
---|
[4459] | 138 | |
---|
[4245] | 139 | void draw(); |
---|
| 140 | |
---|
| 141 | void setAnim(int type); |
---|
[4461] | 142 | /** |
---|
| 143 | \brief scales the current model |
---|
| 144 | \param scaleFactor: the factor [0..1] to use for scaling |
---|
| 145 | */ |
---|
[4245] | 146 | void scaleModel(float scaleFactor) { this->scaleFactor = scaleFactor;} |
---|
| 147 | |
---|
| 148 | void tick(float dtS); |
---|
| 149 | void debug(); |
---|
| 150 | |
---|
| 151 | |
---|
| 152 | private: |
---|
| 153 | void animate(); |
---|
| 154 | void processLighting(); |
---|
| 155 | void interpolate(sVec3D* verticesList); |
---|
| 156 | void renderFrame(); |
---|
| 157 | |
---|
| 158 | public: |
---|
| 159 | /* these variables are static, because they are all the same for every model */ |
---|
[4461] | 160 | static sVec3D anorms[NUM_VERTEX_NORMALS]; //!< the anormals |
---|
| 161 | static float anormsDots[SHADEDOT_QUANT][256]; //!< the anormals dot products |
---|
| 162 | static sAnim animationList[21]; //!< the anomation list |
---|
[4245] | 163 | |
---|
| 164 | private: |
---|
[4461] | 165 | MD2Data* data; //!< the md2 data pointer |
---|
[4245] | 166 | |
---|
[4461] | 167 | float scaleFactor; //!< the scale factor (individual) |
---|
| 168 | sAnimState animationState; //!< animation state of the model |
---|
[4245] | 169 | }; |
---|
| 170 | |
---|
| 171 | |
---|
| 172 | |
---|
| 173 | |
---|
| 174 | |
---|
| 175 | #endif /* _MD2MODEL_H */ |
---|