Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 3454 in orxonox.OLD


Ignore:
Timestamp:
Mar 3, 2005, 6:35:04 PM (19 years ago)
Author:
bensch
Message:

orxonox/trunk/importer: doxygen-tags

Location:
orxonox/trunk/src/importer
Files:
9 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/importer/material.cc

    r3427 r3454  
    110110   \returns Material named mtlName if it is found. NULL otherwise.
    111111*/
    112 Material* Material::search (char* mtlName)
     112Material* Material::search(char* mtlName)
    113113{
    114114  PRINTF(2)("Searching for material %s", mtlName);

  • orxonox/trunk/src/importer/material.h

    r3427 r3454  
    3131  void init(void);
    3232
    33   Material* search (char* mtlName);
     33  Material* search(char* mtlName);
    3434  bool select (void);
    3535
    … …  
    5252 
    5353  void addTexturePath(char* pathName);
    54   char* searchTextureInPaths(char* texName) const;
    5554 // MAPPING //
    5655  void setDiffuseMap(char* dMap);

  • orxonox/trunk/src/importer/model.cc

    r3427 r3454  
    224224}
    225225
     226/**
     227   \brief sets a name to the Model
     228   \param name The name to set to this Model
     229*/
    226230void Model::setName(const char* name)
    227231{
    … …  
    858862}
    859863
    860 
     864/**
     865   \brief Builds a Sphere into the Model
     866*/
    861867void Model::sphereModel()
    862868{

  • orxonox/trunk/src/importer/model.h

    r3427 r3454  
    1717using namespace std;
    1818
     19//! Specification of different primitives the Model knows
    1920enum PRIMITIVE {PLANE, CUBE, SPHERE, CYLINDER};
    2021

  • orxonox/trunk/src/importer/objModel.h

    r3396 r3454  
    11/*!
    2   \file objmodel.h
     2  \file objModel.h
    33  \brief Contains the OBJ-model Class, that reads in a Model from a .obj-file
    44*/

  • orxonox/trunk/src/importer/texture.cc

    r3365 r3454  
    190190   \brief Loads a Texture to the openGL-environment.
    191191   \param pImage The Image to load to openGL
    192    \param texture The Texture to apply it to.
    193192*/
    194193bool Texture::loadTexToGL (Image* pImage)
    … …  
    260259   \brief Makes the Programm ready to Read-in a texture-File
    261260   1. Checks what type of Image should be imported
    262    2. ToDO: Checks where to find the Image
     261   \todo Checks where to find the Image
    263262*/
    264263bool Texture::loadImage(char* imageName)
    … …  
    304303   \brief reads in a Windows BMP-file, and imports it to openGL.
    305304   \param bmpName The name of the Image to load.
    306    \param texture A pointer to the Texture which should be read to.
    307305*/
    308306bool Texture::loadBMP (char* bmpName)
    … …  
    408406   \brief reads in a jpg-file
    409407   \param jpgName the Name of the Image to load
    410    \param texture a reference to the Texture to write the image to
    411408*/
    412409bool Texture::loadJPG (char* jpgName)
    … …  
    508505   \brief reads in a tga-file
    509506   \param tgaName the Name of the Image to load
    510    \param texture a reference to the Texture to write the image to
    511507*/
    512508bool Texture::loadTGA(const char * tgaName)
    … …  
    565561   \param filename the Name of the Image to load
    566562   \param fTGA a Pointer to a File, that should be read
    567    \param texture a reference to the Texture to write the image to
    568563*/
    569564bool Texture::loadUncompressedTGA(const char * filename, FILE * fTGA)
    … …  
    639634   \param filename the Name of the Image to load
    640635   \param fTGA a Pointer to a File, that should be read
    641    \param texture a reference to the Texture to write the image to
    642636*/
    643637bool Texture::loadCompressedTGA(const char * filename, FILE * fTGA)
    … …  
    816810
    817811
    818 /*
    819 static int ST_is_power_of_two(unsigned int number)
    820 {
    821   return (number & (number - 1)) == 0;
    822 }
    823 */
    824 
    825812/**
    826813   \brief reads in a png-file
    827814   \param pngName the Name of the Image to load
    828    \param texture a reference to the Texture to write the image to
    829815*/
    830816bool Texture::loadPNG(const char* pngName)

  • orxonox/trunk/src/importer/texture.h

    r3365 r3454  
    1111
    1212#include "../stdincl.h"
    13 extern int verbose;
    1413#ifdef HAVE_SDL_SDL_IMAGE_H
    1514#include <SDL/SDL_image.h>
    … …  
    6564    GLubyte *data;  //!< The Image Data comes here! DANGER: uncompressed data.
    6665  };
    67   Image* pImage;
    68   GLuint texture;
    69   SDL_Surface* map;
     66  Image* pImage;    //!< The data of an Image
     67  GLuint texture;   //!< The Texture-ID of opengl from this Texture.
     68  SDL_Surface* map; //!< The map SDL initializes for this element.
    7069  char* searchTextureInPaths(char* texName) const;
    7170  inline void swap(unsigned char &a, unsigned char &b);
    … …  
    7372  Texture(void);
    7473  ~Texture(void);
    75 
    76   inline GLuint getTexture(void) {return this->texture;} //!< \returns The textureID of this texture.
     74  /** \returns The textureID of this texture.  */
     75  inline GLuint getTexture(void) {return this->texture;}
    7776  bool loadTexToGL (Image* pImage);
    7877
    … …  
    9089  bool loadCompressedTGA(const char * filename, FILE * fTGA);
    9190
    92   bool loadPNG(const char* pngName, GLuint* texture);
     91  bool loadPNG(const char* pngName);
    9392#endif
    9493

  • orxonox/trunk/src/importer/windowHandler.cc

    r3140 r3454  
    1616#include "windowHandler.h"
    1717#include <stdio.h>
     18
     19/**
     20   \brief Resizes the Window
     21   \param width the new size in the width.
     22   \param height the new size in the height.
     23*/
    1824void WindowHandler::ReSizeGLScene(GLsizei width, GLsizei height) // Resize And Initialize The GL Window
    1925{
    … …  
    3945}
    4046
    41 
     47/**
     48   \brief initializes openGL
     49*/
    4250int WindowHandler::InitGL(GLvoid)                                                                               // All Setup For OpenGL Goes Here
    4351{
    … …  
    5361}
    5462
    55 
     63/**
     64   \brief kills the window
     65*/
    5666GLvoid WindowHandler::KillGLWindow(GLvoid) // Properly Kill The Window
    5767{
    … …  
    5969}
    6070
    61 
     71/**
     72   \brief creates a new Window for the scene
     73   \param title the name of the Window
     74   \param width the width of the window
     75   \param height the height of the window
     76   \param bits the bits per pixel to use
     77   \param fullscreenflag TRUE if fullscreen FALSE if windowed/
     78   \returns FALSE if initialisation failed, TRUE otherwise
     79*/
    6280BOOL WindowHandler::CreateGLWindow(char* title, int width, int height, int bits, BOOL fullscreenflag)
    6381{

  • orxonox/trunk/src/importer/windowHandler.h

    r3196 r3454  
     1/*!
     2  \file windowHandler.h
     3  \brief contains the WindowHandler class for the minimal display system
     4*/
     5
     6
    17#ifndef _WINDOWHANDLER_H
    28#define _WINDOWHANDLER_H
    … …  
    1622#endif /* __WIN32__ */
    1723
    18 #define TRUE 1
    19 #define FALSE 0
    20 #define BOOL int
     24#define TRUE 1     //!< define true
     25#define FALSE 0    //!< define false
     26#define BOOL int   //!< define BOOL
    2127
     28//! A simple class to handle a minimal display system
    2229class WindowHandler
    2330{
    … …  
    2734    GLvoid KillGLWindow(GLvoid);
    2835    BOOL CreateGLWindow(char* title, int width, int height, int bits, BOOL fullscreenflag);
    29     SDL_Surface* screen;
     36    SDL_Surface* screen;   //!< The screen to which to display the rendered stuff
    3037  private:
    3138    int InitGL(GLvoid);
Note: See TracChangeset for help on using the changeset viewer.