diff options
author | Nathan Letwory <nathan@letworyinteractive.com> | 2011-02-22 22:30:37 +0300 |
---|---|---|
committer | Nathan Letwory <nathan@letworyinteractive.com> | 2011-02-22 22:30:37 +0300 |
commit | 1f4fc992ef7840931439c161514bff710c6e6dca (patch) | |
tree | e021724e015d7a3c791d809f09ef8d3013419a8a /source/gameengine/SceneGraph | |
parent | 86e6c39f60b2b0f1a03d376015bdd6af6f8c76c7 (diff) |
doxygen: bge scenegraph and videotexture
Diffstat (limited to 'source/gameengine/SceneGraph')
-rw-r--r-- | source/gameengine/SceneGraph/SG_BBox.h | 8 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_Controller.h | 6 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_DList.h | 7 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_IObject.h | 7 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_Node.h | 7 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_ParentRelation.h | 44 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_QList.h | 7 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_Spatial.h | 6 | ||||
-rw-r--r-- | source/gameengine/SceneGraph/SG_Tree.h | 7 |
9 files changed, 69 insertions, 30 deletions
diff --git a/source/gameengine/SceneGraph/SG_BBox.h b/source/gameengine/SceneGraph/SG_BBox.h index 1a65fc7ef6f..9b18c121919 100644 --- a/source/gameengine/SceneGraph/SG_BBox.h +++ b/source/gameengine/SceneGraph/SG_BBox.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Bounding Box + */ + +/** \file SG_BBox.h + * \ingroup bgesg + * \brief Bounding Box */ #ifndef __SG_BBOX_H__ diff --git a/source/gameengine/SceneGraph/SG_Controller.h b/source/gameengine/SceneGraph/SG_Controller.h index b4636d5fa62..fbc27bb93f3 100644 --- a/source/gameengine/SceneGraph/SG_Controller.h +++ b/source/gameengine/SceneGraph/SG_Controller.h @@ -1,4 +1,4 @@ -/** +/* * Implementationclass to derive controllers from * * $Id$ @@ -29,6 +29,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SG_Controller.h + * \ingroup bgesg + */ + #ifndef __SG_CONTROLLER_H #define __SG_CONTROLLER_H diff --git a/source/gameengine/SceneGraph/SG_DList.h b/source/gameengine/SceneGraph/SG_DList.h index 0768eaa5021..b82e51e0d2f 100644 --- a/source/gameengine/SceneGraph/SG_DList.h +++ b/source/gameengine/SceneGraph/SG_DList.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SG_DList.h + * \ingroup bgesg + */ + #ifndef __SG_DLIST #define __SG_DLIST diff --git a/source/gameengine/SceneGraph/SG_IObject.h b/source/gameengine/SceneGraph/SG_IObject.h index 4c9c31e4934..26e317bdcd9 100644 --- a/source/gameengine/SceneGraph/SG_IObject.h +++ b/source/gameengine/SceneGraph/SG_IObject.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SG_IObject.h + * \ingroup bgesg + */ + #ifndef __SG_IOBJECT #define __SG_IOBJECT diff --git a/source/gameengine/SceneGraph/SG_Node.h b/source/gameengine/SceneGraph/SG_Node.h index 30d09b5bdfd..1116cc53672 100644 --- a/source/gameengine/SceneGraph/SG_Node.h +++ b/source/gameengine/SceneGraph/SG_Node.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SG_Node.h + * \ingroup bgesg + */ + #ifndef __SG_NODE_H #define __SG_NODE_H diff --git a/source/gameengine/SceneGraph/SG_ParentRelation.h b/source/gameengine/SceneGraph/SG_ParentRelation.h index 0bc04245c93..52e41803185 100644 --- a/source/gameengine/SceneGraph/SG_ParentRelation.h +++ b/source/gameengine/SceneGraph/SG_ParentRelation.h @@ -1,23 +1,4 @@ -/** - * @mainpage SG_ParentRelation - - * @section - * - * This is an abstract interface class to the Scene Graph library. - * It allows you to specify how child nodes react to parent nodes. - * Normally a child will use it's parent's transforms to compute - * it's own global transforms. How this is performed depends on - * the type of relation. For example if the parent is a vertex - * parent to this child then the child should not inherit any - * rotation information from the parent. Or if the parent is a - * 'slow parent' to this child then the child should react - * slowly to changes in the parent's position. The exact relation - * is left for you to implement by filling out this interface - * with concrete examples. - * - * There is exactly one SG_ParentRelation per SG_Node. Subclasses - * should not be value types and should be allocated on the heap. - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -47,6 +28,29 @@ * */ +/** \file SG_ParentRelation.h + * \ingroup bgesg + * @page SG_ParentRelationPage SG_ParentRelation + + * @section + * + * This is an abstract interface class to the Scene Graph library. + * It allows you to specify how child nodes react to parent nodes. + * Normally a child will use it's parent's transforms to compute + * it's own global transforms. How this is performed depends on + * the type of relation. For example if the parent is a vertex + * parent to this child then the child should not inherit any + * rotation information from the parent. Or if the parent is a + * 'slow parent' to this child then the child should react + * slowly to changes in the parent's position. The exact relation + * is left for you to implement by filling out this interface + * with concrete examples. + * + * There is exactly one SG_ParentRelation per SG_Node. Subclasses + * should not be value types and should be allocated on the heap. + * + */ + #ifndef __SG_ParentRelation_h #define __SG_ParentRelation_h diff --git a/source/gameengine/SceneGraph/SG_QList.h b/source/gameengine/SceneGraph/SG_QList.h index 691ec9e1262..de79c35821e 100644 --- a/source/gameengine/SceneGraph/SG_QList.h +++ b/source/gameengine/SceneGraph/SG_QList.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SG_QList.h + * \ingroup bgesg + */ + #ifndef __SG_QLIST #define __SG_QLIST diff --git a/source/gameengine/SceneGraph/SG_Spatial.h b/source/gameengine/SceneGraph/SG_Spatial.h index b8193806ecb..e15a3f3cc32 100644 --- a/source/gameengine/SceneGraph/SG_Spatial.h +++ b/source/gameengine/SceneGraph/SG_Spatial.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SG_Spatial.h + * \ingroup bgesg + */ + #ifndef __SG_SPATIAL_H #define __SG_SPATIAL_H diff --git a/source/gameengine/SceneGraph/SG_Tree.h b/source/gameengine/SceneGraph/SG_Tree.h index fa6facde66c..4ab8586f09f 100644 --- a/source/gameengine/SceneGraph/SG_Tree.h +++ b/source/gameengine/SceneGraph/SG_Tree.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,10 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Bounding Box + */ + +/** \file SG_Tree.h + * \ingroup bgesg */ #ifndef __SG_TREE_H__ |