source/gameengine/SceneGraph/SG_ParentRelation.h

   1 /**
   2  * @mainpage SG_ParentRelation
   3
   4  * @section
   5  *
   6  * This is an abstract interface class to the Scene Graph library.
   7  * It allows you to specify how child nodes react to parent nodes.
   8  * Normally a child will use it's parent's transforms to compute
   9  * it's own global transforms. How this is performed depends on
  10  * the type of relation. For example if the parent is a vertex
  11  * parent to this child then the child should not inherit any
  12  * rotation information from the parent. Or if the parent is a
  13  * 'slow parent' to this child then the child should react
  14  * slowly to changes in the parent's position. The exact relation
  15  * is left for you to implement by filling out this interface
  16  * with concrete examples.
  17  *
  18  * There is exactly one SG_ParentRelation per SG_Node. Subclasses
  19  * should not be value types and should be allocated on the heap.
  20  *
  21  * $Id$
  22  *
  23  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
  24  *
  25  * This program is free software; you can redistribute it and/or
  26  * modify it under the terms of the GNU General Public License
  27  * as published by the Free Software Foundation; either version 2
  28  * of the License, or (at your option) any later version. The Blender
  29  * Foundation also sells licenses for use in proprietary software under
  30  * the Blender License.  See http://www.blender.org/BL/ for information
  31  * about this.
  32  *
  33  * This program is distributed in the hope that it will be useful,
  34  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  35  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  36  * GNU General Public License for more details.
  37  *
  38  * You should have received a copy of the GNU General Public License
  39  * along with this program; if not, write to the Free Software Foundation,
  40  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  41  *
  42  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  43  * All rights reserved.
  44  *
  45  * The Original Code is: all of this file.
  46  *
  47  * Contributor(s): none yet.
  48  *
  49  * ***** END GPL/BL DUAL LICENSE BLOCK *****
  50  *
  51  */
  52
  53 #ifndef __SG_ParentRelation_h
  54 #define __SG_ParentRelation_h
  55
  56 #ifdef HAVE_CONFIG_H
  57 #include <config.h>
  58 #endif
  59
  60 class SG_Spatial;
  61
  62 class SG_ParentRelation {
  63
  64 public :
  65
  66         /**
  67          * Update the childs local and global coordinates
  68          * based upon the parents global coordinates.
  69          * You must also handle the case when this node has no
  70          * parent (parent == NULL). Usually you should just
  71          * copy the local coordinates of the child to the
  72          * world coordinates.
  73          */
  74
  75         virtual
  76                 void
  77         UpdateChildCoordinates(
  78                 SG_Spatial * child,
  79                 const SG_Spatial * parent
  80         ) = 0;
  81
  82         virtual
  83         ~SG_ParentRelation(
  84         ){
  85         };
  86
  87         /**
  88          * You must provide a way of duplicating an
  89          * instance of an SG_ParentRelation. This should
  90          * return a pointer to a new duplicate allocated
  91          * on the heap. Responsibilty for deleting the
  92          * duplicate resides with the caller of this method.
  93          */
  94
  95         virtual
  96                 SG_ParentRelation *
  97         NewCopy(
  98         ) = 0;
  99
 100 protected :
 101
 102         /**
 103          * Protected constructors
 104          * this class is not meant to be instantiated.
 105          */
 106
 107         SG_ParentRelation(
 108         ) {
 109         };
 110
 111         /**
 112          * Copy construction should not be implemented
 113          */
 114
 115         SG_ParentRelation(
 116                 const SG_ParentRelation &
 117         );
 118 };
 119
 120 #endif
 121