diff options
Diffstat (limited to 'source/gameengine/SceneGraph/SG_ParentRelation.h')
| -rw-r--r-- | source/gameengine/SceneGraph/SG_ParentRelation.h | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/source/gameengine/SceneGraph/SG_ParentRelation.h b/source/gameengine/SceneGraph/SG_ParentRelation.h index ce45b42c148..e6cbc358cf4 100644 --- a/source/gameengine/SceneGraph/SG_ParentRelation.h +++ b/source/gameengine/SceneGraph/SG_ParentRelation.h @@ -23,27 +23,27 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * + * */ /** \file SG_ParentRelation.h * \ingroup bgesg - * \page SG_ParentRelationPage SG_ParentRelation + * \page SG_ParentRelationPage SG_ParentRelation * * \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 + * 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 + * '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. * @@ -59,13 +59,13 @@ class SG_ParentRelation { public : /** * Update the childs local and global coordinates - * based upon the parents 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 + * parent (parent == NULL). Usually you should just + * copy the local coordinates of the child to the * world coordinates. - */ - + */ + virtual bool UpdateChildCoordinates( @@ -74,11 +74,11 @@ public : bool& parentUpdated ) = 0; - virtual + virtual ~SG_ParentRelation( ) {}; - /** + /** * You must provide a way of duplicating an * instance of an SG_ParentRelation. This should * return a pointer to a new duplicate allocated @@ -86,7 +86,7 @@ public : * duplicate resides with the caller of this method. */ - virtual + virtual SG_ParentRelation * NewCopy( ) = 0; @@ -97,23 +97,23 @@ public : virtual bool IsVertexRelation( - ) { + ) { return false; } - + /** * Need this to see if we are able to adjust time-offset from the python api */ virtual bool IsSlowRelation( - ) { + ) { return false; } protected : - /** - * Protected constructors + /** + * Protected constructors * this class is not meant to be instantiated. */ @@ -127,9 +127,9 @@ protected : SG_ParentRelation( const SG_ParentRelation & - ); - - + ); + + #ifdef WITH_CXX_GUARDEDALLOC MEM_CXX_CLASS_ALLOC_FUNCS("GE:SG_ParentRelation") #endif |