add missing files after merging
[blender.git] / source / gameengine / Ketsji / KX_SG_BoneParentNodeRelationship.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  * 
29  */
30
31 /** \file KX_SG_BoneParentNodeRelationship.h
32  *  \ingroup ketsji
33  */
34
35 #ifndef __KX_SG_BONEPARENTRELATION_H__
36 #define __KX_SG_BONEPARENTRELATION_H__
37  
38 #include "SG_Spatial.h"
39 #include "SG_ParentRelation.h"
40
41 struct Bone;
42
43 /**
44  *  Bone parent relationship parents a child SG_Spatial frame to a 
45  *  bone in an armature object.
46  */
47 class KX_BoneParentRelation : public SG_ParentRelation
48 {
49
50 public :
51         /**
52          * Allocate and construct a new KX_SG_BoneParentRelation
53          * on the heap.
54          *
55          * bone is the bone id to use.  Currently it is a pointer
56          * to a Blender struct Bone - this should be fixed if
57          */
58
59         static 
60                 KX_BoneParentRelation *
61         New(Bone* bone
62         );              
63
64         /**
65          *  Updates the childs world coordinates relative to the parent's
66          *  world coordinates.
67          *
68          *  Parent should be a BL_ArmatureObject.
69          */
70                 bool
71         UpdateChildCoordinates(
72                 SG_Spatial * child,
73                 const SG_Spatial * parent,
74                 bool& parentUpdated
75         );
76
77         /**
78          *  Create a copy of this relationship
79          */
80                 SG_ParentRelation *
81         NewCopy(
82         );
83
84         ~KX_BoneParentRelation(
85         );
86
87 private :
88         Bone* m_bone;
89         KX_BoneParentRelation(Bone* bone
90         );
91
92
93 #ifdef WITH_CXX_GUARDEDALLOC
94 public:
95         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_BoneParentRelation"); }
96         void operator delete( void *mem ) { MEM_freeN(mem); }
97 #endif
98 };
99
100 #endif