doxygen: BGE Network, Physics, Rasterizer

This commit is contained in:
Nathan Letwory 2011-02-22 12:42:55 +00:00
parent eac95abdf2
commit 79f79e0cac
51 changed files with 299 additions and 63 deletions

@ -637,7 +637,10 @@ INPUT = doxygen.main \
../source/gameengine/Expressions \
../source/gameengine/GameLogic \
../source/gameengine/GamePlayer \
../source/gameengine/Ketsji
../source/gameengine/Ketsji \
../source/gameengine/Rasterizer \
../source/gameengine/Network \
../source/gameengine/Physics
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

@ -6,6 +6,7 @@
*
* These pages document the source code of blender.
*
*
* For more information on using Blender browse to http://www.blender.org
*
*/
@ -70,6 +71,30 @@
/** \defgroup ketsjinet Ketsji Network
* \ingroup ketsji
*/
/** \defgroup bgenet Network
* \ingroup bge
*/
/** \defgroup bgenetlb Loopback Network
* \ingroup bgenet
*/
/** \defgroup phys Physics
* \ingroup bge
*/
/** \defgroup physbullet Bullet Physics
* \ingroup phys
*/
/** \defgroup physdummy Dummy Physics (none)
* \ingroup phys
*/
/** \defgroup bgerast Rasterizer
* \ingroup bge
*/
/** \defgroup bgerastoglfilters OpenGL Filters
* \ingroup bgerast
*/
/** \defgroup bgerastogl OpenGL Rasterizer
* \ingroup bgerast
*/
/** \defgroup audaspace Audaspace
* \ingroup intern undoc

@ -47,7 +47,7 @@ public:
private:
T_InterpolatorList m_interpolators;
unsigned short m_modify_mist_color : 1;
unsigned short m_modify_mist_color : 1;
unsigned short m_modify_mist_start : 1;
unsigned short m_modify_mist_dist : 1;
bool m_modified;

@ -25,7 +25,11 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
* LoopbackNetworkDeviceInterface derived from NG_NetworkDeviceInterface
*/
/** \file NG_LoopBackNetworkDeviceInterface.h
* \ingroup bgenetlb
* \brief LoopbackNetworkDeviceInterface derived from NG_NetworkDeviceInterface
*/
#ifndef NG_LOOPBACKNETWORKDEVICEINTERFACE_H
#define NG_LOOPBACKNETWORKDEVICEINTERFACE_H

@ -25,10 +25,14 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
* NetworkGameengine_NetworkDeviceInterface
* Functions like (de)initialize network, get library version
*/
/** \file NG_NetworkDeviceInterface.h
* \ingroup bgenet
* \brief Functions like (de)initialize network, get library version
* To be derived by loopback and network libraries
*/
#ifndef NG_NETWORKDEVICEINTERFACE_H
#define NG_NETWORKDEVICEINTERFACE_H

@ -25,7 +25,11 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
* NetworkGame_NetworkMessage generic Network Message class
*/
/** \file NG_NetworkMessage.h
* \ingroup bgenet
* \brief generic Network Message class
*/
#ifndef NG_NETWORKMESSAGE_H
#define NG_NETWORKMESSAGE_H

@ -25,7 +25,11 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
* NetworkGame_NetworkObject generic Network Object class
*/
/** \file NG_NetworkObject.h
* \ingroup bgenet
* \brief generic Network Object class
*/
#ifndef NG_NETWORKOBJECT_H
#define NG_NETWORKOBJECT_H

@ -25,7 +25,11 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
* NetworkSceneManagement generic class
*/
/** \file NG_NetworkScene.h
* \ingroup bgenet
* \brief NetworkSceneManagement generic class
*/
#ifndef __NG_NETWORKSCENE_H
#define __NG_NETWORKSCENE_H

@ -13,6 +13,10 @@ subject to the following restrictions:
3. This notice may not be removed or altered from any source distribution.
*/
/** \file CcdGraphicController.h
* \ingroup physbullet
*/
#ifndef BULLET2_GRAPHICCONTROLLER_H
#define BULLET2_GRAPHICCONTROLLER_H

@ -13,6 +13,10 @@ subject to the following restrictions:
3. This notice may not be removed or altered from any source distribution.
*/
/** \file CcdPhysicsController.h
* \ingroup physbullet
*/
#ifndef BULLET2_PHYSICSCONTROLLER_H
#define BULLET2_PHYSICSCONTROLLER_H

@ -13,6 +13,10 @@ subject to the following restrictions:
3. This notice may not be removed or altered from any source distribution.
*/
/** \file CcdPhysicsEnvironment.h
* \ingroup physbullet
*/
#ifndef CCDPHYSICSENVIRONMENT
#define CCDPHYSICSENVIRONMENT
@ -47,10 +51,11 @@ class btIDebugDraw;
class PHY_IVehicle;
class CcdOverlapFilterCallBack;
/// CcdPhysicsEnvironment is an experimental mainloop for physics simulation using optional continuous collision detection.
/// Physics Environment takes care of stepping the simulation and is a container for physics entities.
/// It stores rigidbodies,constraints, materials etc.
/// A derived class may be able to 'construct' entities by loading and/or converting
/** CcdPhysicsEnvironment is an experimental mainloop for physics simulation using optional continuous collision detection.
* Physics Environment takes care of stepping the simulation and is a container for physics entities.
* It stores rigidbodies,constraints, materials etc.
* A derived class may be able to 'construct' entities by loading and/or converting
*/
class CcdPhysicsEnvironment : public PHY_IPhysicsEnvironment
{
friend class CcdOverlapFilterCallBack;

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file DummyPhysicsEnvironment.h
* \ingroup physdummy
*/
#ifndef _DUMMYPHYSICSENVIRONMENT
#define _DUMMYPHYSICSENVIRONMENT

@ -13,6 +13,9 @@ subject to the following restrictions:
3. This notice may not be removed or altered from any source distribution.
*/
/** \file PHY_DynamicTypes.h
* \ingroup phys
*/
#ifndef __PHY_DYNAMIC_TYPES
#define __PHY_DYNAMIC_TYPES

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file PHY_IController.h
* \ingroup phys
*/
#ifndef PHY_ICONTROLLER_H
#define PHY_ICONTROLLER_H

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file PHY_IGraphicsController.h
* \ingroup phys
*/
#ifndef PHY_IGRAPHICCONTROLLER_H
#define PHY_IGRAPHICCONTROLLER_H

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file PHY_IMotionState.h
* \ingroup phys
*/
#ifndef PHY__MOTIONSTATE_H
#define PHY__MOTIONSTATE_H

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file PHY_IPhysicsController.h
* \ingroup phys
*/
#ifndef PHY_IPHYSICSCONTROLLER_H
#define PHY_IPHYSICSCONTROLLER_H

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file PHY_IPhysicsEnvironment.h
* \ingroup phys
*/
#ifndef _IPHYSICSENVIRONMENT
#define _IPHYSICSENVIRONMENT

@ -1,3 +1,8 @@
/** \file PHY_IVehicle.h
* \ingroup phys
*/
#ifndef PHY_IVEHICLE_H
#define PHY_IVEHICLE_H

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file PHY_Pro.h
* \ingroup phys
*/
#ifndef PHY_PROPSH
#define PHY_PROPSH

@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_2DFilterManager.h
* \ingroup bgerast
*/
#ifndef __RAS_I2DFILTER
#define __RAS_I2DFILTER

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,7 +26,10 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
// this will be put in a class later on
/** \file RAS_BucketManager.h
* \ingroup bgerast
*/
#ifndef __RAS_BUCKETMANAGER
#define __RAS_BUCKETMANAGER

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_CameraData.h
* \ingroup bgerast
*/
#ifndef __RAS_CAMERADATA_H
#define __RAS_CAMERADATA_H

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_Deformer.h
* \ingroup bgerast
*/
#ifndef RAS_DEFORMER
#define RAS_DEFORMER

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_FramingManager.h
* \ingroup bgerast
*/
#ifndef RAS_FRAMINGMANAGER_H
#define RAS_FRAMINGMANAGER_H

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,20 +26,23 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_ICanvas.h
* \ingroup bgerast
*/
#ifndef __RAS_ICANVAS
#define __RAS_ICANVAS
/**
* 2D rendering device context. The connection from 3d rendercontext to 2d surface.
*/
#ifdef WITH_CXX_GUARDEDALLOC
#include "MEM_guardedalloc.h"
#endif
class RAS_Rect;
/**
* 2D rendering device context. The connection from 3d rendercontext to 2d surface.
*/
class RAS_ICanvas
{
public:

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,15 +26,16 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_IPolygonMaterial.h
* \ingroup bgerast
*/
#ifndef __RAS_IPOLYGONMATERIAL
#define __RAS_IPOLYGONMATERIAL
#include "STR_HashedString.h"
/**
* Polygon Material on which the material buckets are sorted
*
*/
#include "MT_Vector3.h"
#include "STR_HashedString.h"
@ -65,7 +66,8 @@ enum MaterialProps
};
/**
* Material properties.
* Polygon Material on which the material buckets are sorted
*
*/
class RAS_IPolyMaterial
{

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_IRasterizer.h
* \ingroup bgerast
*/
#ifndef __RAS_IRASTERIZER
#define __RAS_IRASTERIZER

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_IRenderTools.h
* \ingroup bgerast
*/
#ifndef __RAS_IRENDERTOOLS
#define __RAS_IRENDERTOOLS

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_LightObject.h
* \ingroup bgerast
*/
#ifndef __RAS_LIGHTOBJECT_H
#define __RAS_LIGHTOBJECT_H

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_MaterialBucket.h
* \ingroup bgerast
*/
#ifndef __RAS_MATERIALBUCKET
#define __RAS_MATERIALBUCKET

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_MeshObject.h
* \ingroup bgerast
*/
#ifndef __RAS_MESHOBJECT
#define __RAS_MESHOBJECT

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_ObjectColor.h
* \ingroup bgerast
*/
#ifndef __RAS_OBJECTCOLOR_H
#define __RAS_OBJECTCOLOR_H

@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_Blur2DFilter.h
* \ingroup bgerastoglfilters
*/
#ifndef __RAS_BLUR2DFILTER
#define __RAS_BLUR2DFILTER

@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_Dilation2DFilter.h
* \ingroup bgerastoglfilters
*/
#ifndef __RAS_DILATION2DFILTER
#define __RAS_DILATION2DFILTER

@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_Erosion2DFilter.h
* \ingroup bgerastoglfilters
*/
#ifndef __RAS_EROSION2DFILTER
#define __RAS_EROSION2DFILTER

@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_GrayScale2DFilter.h
* \ingroup bgerastoglfilters
*/
#ifndef __RAS_GRAYSCALE2DFILTER
#define __RAS_GRAYSCALE2DFILTER

@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_Invert2DFilter.h
* \ingroup bgerastoglfilters
*/
#ifndef __RAS_INVERT2DFILTER
#define __RAS_INVERT2DFILTER

@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_Laplacian2DFilter.h
* \ingroup bgerastoglfilters
*/
#ifndef __RAS_LAPLACION2DFILTER
#define __RAS_LAPLACION2DFILTER

@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_Prewitt2DFilter.h
* \ingroup bgerastoglfilters
*/
#ifndef __RAS_PREWITT2DFILTER
#define __RAS_PREWITT2DFILTER

@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_Sepia2DFilter.h
* \ingroup bgerastoglfilters
*/
#ifndef __RAS_SEPIA2DFILTER
#define __RAS_SEPIA2DFILTER

@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_Sharpen2DFilter.h
* \ingroup bgerastoglfilters
*/
#ifndef __RAS_SHARPEN2DFILTER
#define __RAS_SHARPEN2DFILTER

@ -1,4 +1,4 @@
/**
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
@ -25,6 +25,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_Sobel2DFilter.h
* \ingroup bgerastoglfilters
*/
#ifndef __RAS_SOBEL2DFILTER
#define __RAS_SOBEL2DFILTER

@ -1,4 +1,4 @@
/**
/*
* $Id$
* ***** BEGIN GPL LICENSE BLOCK *****
*
@ -26,6 +26,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_GLExtensionManager.h
* \ingroup bgerastogl
*/
#ifndef __RAS_GLEXTENSIONMANAGER_H__
#define __RAS_GLEXTENSIONMANAGER_H__

@ -1,3 +1,8 @@
/** \file RAS_ListRasterizer.h
* \ingroup bgerastogl
*/
#ifndef __RAS_LISTRASTERIZER_H__
#define __RAS_LISTRASTERIZER_H__

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_OpenGLRasterizer.h
* \ingroup bgerastogl
*/
#ifndef __RAS_OPENGLRASTERIZER
#define __RAS_OPENGLRASTERIZER

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_VAOpenGLRasterizer.h
* \ingroup bgerastogl
*/
#ifndef __KX_VERTEXARRAYOPENGLRASTERIZER
#define __KX_VERTEXARRAYOPENGLRASTERIZER

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_Polygon.h
* \ingroup bgerast
*/
#ifndef __RAS_POLYGON
#define __RAS_POLYGON

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_Rect.h
* \ingroup bgerast
*/
#ifndef _RAS_RECT
#define _RAS_RECT
@ -35,11 +39,10 @@
#endif
/**
* @section interface class.
* \section interface class.
* RAS_Rect just encodes a simple rectangle.
* Should be part of a generic library
* \note Should be part of a generic library
*/
class RAS_Rect
{
public: // todo: make a decent class, and make private

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_TexMatrix.h
* \ingroup bgerast
*/
#ifndef __RASTEXMATRIX
#define __RASTEXMATRIX

@ -1,4 +1,4 @@
/**
/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_TexVert.h
* \ingroup bgerast
*/
#ifndef __RAS_TEXVERT
#define __RAS_TEXVERT