Commit: 1890168b0dd4820e4b266014a310dc273e4169dc
Author: Ines Almeida
Date: Mon Jul 14 13:35:25 2014 +0100
https://developer.blender.org/rB1890168b0dd4820e4b266014a310dc273e4169dc
gameengine scenegraph: whitespace and comment cleanup
===================================================================
M source/gameengine/Ketsji/KX_SG_NodeRelationships.h
M source/gameengine/SceneGraph/SG_ParentRelation.h
===================================================================
diff --git a/source/gameengine/Ketsji/KX_SG_NodeRelationships.h
b/source/gameengine/Ketsji/KX_SG_NodeRelationships.h
index f8df5a5..3b3f499 100644
--- a/source/gameengine/Ketsji/KX_SG_NodeRelationships.h
+++ b/source/gameengine/Ketsji/KX_SG_NodeRelationships.h
@@ -50,18 +50,20 @@ class KX_NormalParentRelation : public SG_ParentRelation
public :
/**
- * Allocate and construct a new KX_NormalParentRelation
- * on the heap.
+ * Allocate and construct a new KX_NormalParentRelation on the heap.
*/
static KX_NormalParentRelation* New();
/**
* Method inherited from KX_ParentRelation
+ * Update the child's global coordinates based upon the local ones and
the parent's global coordinates.
*/
bool UpdateChildCoordinates(SG_Spatial *child, const SG_Spatial
*parent, bool &parentUpdated);
/**
* Method inherited from KX_ParentRelation
+ * This should return a pointer to a new duplicate allocated on the
heap.
+ * Responsibility for deleting the duplicate resides with the caller of
this method.
*/
SG_ParentRelation* NewCopy();
diff --git a/source/gameengine/SceneGraph/SG_ParentRelation.h
b/source/gameengine/SceneGraph/SG_ParentRelation.h
index edf949e..7712c10 100644
--- a/source/gameengine/SceneGraph/SG_ParentRelation.h
+++ b/source/gameengine/SceneGraph/SG_ParentRelation.h
@@ -32,17 +32,18 @@
*
* \section SG_ParentRelationSection SG_ParentRelation
*
- * This is an abstract interface class to the Scene Graph library.
+ * 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
+ * its 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
XXX
* rotation information from the parent. Or if the parent is a
- * 'slow parent' to this child then the child should react
+ * '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.
+ * 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.
@@ -57,21 +58,15 @@ class SG_Spatial;
class SG_ParentRelation {
public :
+
/**
- * Update the childs local and global coordinates
- * based upon the parents global coordinates.
- * You must also handle the case when this node has no
- * parent (parent == NULL). Usually you should just
- * copy the local coordinates of the child to the
- * world coordinates.
- */
-
- virtual bool UpdateChildCoordinates(
- SG_Spatial * child,
- const SG_Spatial * parent,
- bool& parentUpdated
- ) = 0;
+ * Update the child's local and global coordinates based upon the
parents global coordinates.
+ * You must also handle the case when this node has no parent (parent
== NULL).
+ * Usually you should just copy the local coordinates of the child to
the world coordinates.
+ */
+ virtual bool UpdateChildCoordinates(SG_Spatial * child, const
SG_Spatial * parent, bool& parentUpdated) = 0;
+ /* XXXX */
virtual ~SG_ParentRelation() {}
/**
@@ -102,8 +97,7 @@ public :
protected :
/**
- * Protected constructors
- * this class is not meant to be instantiated.
+ * Protected constructors this class is not meant to be instantiated.
*/
SG_ParentRelation() {}
_______________________________________________
Bf-blender-cvs mailing list
[email protected]
http://lists.blender.org/mailman/listinfo/bf-blender-cvs
