Changeset 4467 in orxonox.OLD for orxonox/trunk/src/lib/graphics

Timestamp:

Jun 2, 2005, 1:45:40 AM (19 years ago)

Author:

patrick

Message:

orxonox/trunk: commented the abstract_class.h right

File:

• orxonox/trunk/src/lib/graphics/importer/abstract_model.h (modified) (4 diffs)

orxonox/trunk/src/lib/graphics/importer/abstract_model.h

@@ -35 +35 @@
 typedef float sVec3D[3];
 
+
 //! small and performant 2D vector
 typedef float sVec2D[2];
+
 
 //! compressed vertex data: char insetead of float, the value will be expanded by the scale value. only for loading
 typedef struct
 {
-  byte v[3];
-  unsigned char lightNormalIndex;
+  byte             v[3];                 //!< the vector of the vertex
+  unsigned char    lightNormalIndex;     //!< the index of the light normal
 } sVertex;
+
 
 //! compressed texture offset data: coords scaled by the texture size. Only for loading
 typedef struct
 {
-  short s,t;
+  short            s;                    //!< the s,t coordinates of a texture
+  short            t;                    //!< the s,t coordinates of a texture
 } sTexCoor;
 
@@ -55 +59 @@
 typedef struct
 {
-  sVec3D scale;                        //!< scales values of the model
-  sVec3D translate;                    //!< translates the model
-  char name[16];                       //!< frame name: something like "run32"
-  sVertex pVertices[1];                //!< first vertex of thes frame
+  sVec3D           scale;                //!< scales values of the model
+  sVec3D           translate;            //!< translates the model
+  char             name[16];             //!< frame name: something like "run32"
+  sVertex          pVertices[1];         //!< first vertex of thes frame
 } sFrame;
 
@@ -65 +69 @@
 typedef struct
 {
-  short indexToVertices[3];             //!< index to the verteces of the triangle
-  short indexToTexCoor[3];              //!< index to the texture coordinates
+  short            indexToVertices[3];   //!< index to the verteces of the triangle
+  short            indexToTexCoor[3];    //!< index to the texture coordinates
 } sTriangle;
 
 
+//! the command list of the md2 model, very md2 specific
 typedef struct
 {
-   float s, t;
-   int vertexIndex;
+  float            s;                    //!< texture coordinate 1
+  float            t;                    //!< texture coordinate 2
+  int              vertexIndex;          //!< index of the vertex in the vertex list
 } glCommandVertex;
 
@@ -80 +86 @@
 typedef struct
 {
-  int firstFrame;                       //!< first frame of the animation
-  int lastFrame;                        //!< last frame of the animation
-  int fps;                              //!< speed: number of frames per second
+  int              firstFrame;           //!< first frame of the animation
+  int              lastFrame;            //!< last frame of the animation
+  int              fps;                  //!< speed: number of frames per second
 } sAnim;
+
 
 //! animation state definition
 typedef struct
 {
-  int startFrame;
-  int endFrame;
-  int fps;
+  int              startFrame;           //!< the start frame of an animation
+  int              endFrame;             //!< last frame of the animation
+  int              fps;                  //!< fps of the animaion (speed)
 
-  float localTime;
-  float lastTime;
-  float interpolationState;            //!< the state of the animation [0..1]
+  float            localTime;            //!< the local time
+  float            lastTime;             //!< last time stamp
+  float            interpolationState;   //!< the state of the animation [0..1]
   
-  int type;                            //!< animation type
+  int              type;                 //!< animation type
 
-  int currentFrame;
-  int nextFrame;
+  int              currentFrame;         //!< the current frame
+  int              nextFrame;            //!< the next frame in the list
 } sAnimState;