Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 3186 in orxonox.OLD for orxonox/trunk/importer/material.h


Ignore:
Timestamp:
Dec 15, 2004, 7:51:10 PM (20 years ago)
Author:
bensch
Message:

orxonox/trunk: mainly importer: doxygen Tags updated for real.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/importer/material.h

    r3184 r3186  
    22  \file material.h
    33  \brief Contains the Material Class that handles Material for 3D-Objects.
     4  \todo free SDL-surface when deleting Material.
     5  \todo delete imgNameWithPath after use creation.
    46*/
    57
    68#ifndef _MATERIAL_H
    79#define _MATERIAL_H
     10
     11
    812
    913extern int verbose; //!< will be obsolete soon.
    … …  
    2933#endif /* HAVE_SDL_SDL_IMAGE_H */
    3034
     35//! Class to handle lists of paths.
     36/**
     37   \todo Ability to return Paths by itself.
     38
     39   It is simple to use, and good, for all PathList you want.
     40   just create a new Pathlist, and add Paths.
     41*/
    3142class PathList
    3243{
    … …  
    3748  ~PathList();
    3849  void addPath (char* pName);
    39   char* pathName;
    40   PathList* next;
     50  char* pathName;          //!< The Name of the current Path.
     51  PathList* next;          //!< Pointer to the next Pathlist.
    4152};
    4253
    … …  
    8192
    8293 private:
     94  //! Struct to handle Infos about an Image
    8395  struct Image
    8496  {
    85     int rowSpan;
    86     GLuint width;
    87     GLuint height;
    88     GLuint bpp;
    89     GLuint type;
    90     GLubyte *data;
     97    int rowSpan;    //!< The count of the rows this Image has.
     98    GLuint width;   //!< The width of the Image.
     99    GLuint height;  //!< The height of the Image.
     100    GLuint bpp;     //!< BitsPerPixel
     101    GLuint type;    //!< Type of the Image.
     102    GLubyte *data;  //!< The Image Data comes here! DANGER: uncompressed data.
    91103  };
    92104
    93105
    94   char* name;
    95   int illumModel;
    96   float diffuse [4];
    97   float ambient [4];
    98   float specular [4];
    99   float shininess;
    100   float transparency;
     106  char* name;        //!< The Name of the Material.
     107  int illumModel;    //!< The IlluminationModel is either flat or smooth.
     108  float diffuse [4]; //!< The diffuse color of the Material.
     109  float ambient [4]; //!< The ambient color of the Material.
     110  float specular [4];//!< The specular color of the Material.
     111  float shininess;   //!< The shininess of the Material.
     112  float transparency;//!< The transperency of the Material.
    101113
    102   static PathList* pathList;
     114  static PathList* pathList; //!< A pointer to the first element of Pathlist. This is static, because pathlists are global \todo copy this to the Globals.h or DataTank for deletion at the end.
    103115 
    104   GLuint diffuseTexture;
    105   GLuint ambientTexture;
    106   GLuint specularTexture;
     116  GLuint diffuseTexture; //!< The diffuse texture of the Material.
     117  GLuint ambientTexture; //!< The ambient texture of the Material.
     118  GLuint specularTexture;//!< The specular texture of the Material.
    107119 
    108   bool diffuseTextureSet;
    109   bool ambientTextureSet;
    110   bool specularTextureSet;
     120  bool diffuseTextureSet; //!< Chekcs if the diffuse texture is Set.
     121  bool ambientTextureSet; //!< Chekcs if the ambient texture is Set.
     122  bool specularTextureSet;//!< Chekcs if the specular texture is Set.
    111123
    112124  Material* nextMat; //!< pointer to the Next Material of the List. NULL if no next exists.
Note: See TracChangeset for help on using the changeset viewer.