svn merge ^/trunk/blender -r41226:41227 .
[blender.git] / source / gameengine / SceneGraph / SG_Node.cpp
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file gameengine/SceneGraph/SG_Node.cpp
29  *  \ingroup bgesg
30  */
31
32
33 #include "SG_Node.h"
34 #include "SG_ParentRelation.h"
35 #include <algorithm>
36
37 using namespace std;
38
39
40 SG_Node::SG_Node(
41         void* clientobj,
42         void* clientinfo,
43         SG_Callbacks& callbacks
44
45 )
46         : SG_Spatial(clientobj,clientinfo,callbacks),
47         m_SGparent(NULL)
48 {
49         m_modified = true;
50 }
51
52 SG_Node::SG_Node(
53         const SG_Node & other
54 ) :
55         SG_Spatial(other),
56         m_children(other.m_children),
57         m_SGparent(other.m_SGparent)
58 {
59         m_modified = true;
60 }
61
62 SG_Node::~SG_Node()
63 {
64 }
65
66
67 SG_Node* SG_Node::GetSGReplica()
68 {
69         SG_Node* replica = new SG_Node(*this);
70         if (replica == NULL) return NULL;
71
72         ProcessSGReplica(&replica);
73         
74         return replica;
75 }
76
77         void 
78 SG_Node::
79 ProcessSGReplica(
80         SG_Node** replica
81 ){
82         // Apply the replication call back function.
83         if (!ActivateReplicationCallback(*replica)) 
84         {
85                 delete (*replica);
86                 *replica = NULL;
87                 return;
88         }
89
90         // clear the replica node of it's parent.
91         static_cast<SG_Node*>(*replica)->m_SGparent = NULL;
92
93         if (m_children.begin() != m_children.end())
94         {
95                 // if this node has children, the replica has too, so clear and clone children
96                 (*replica)->ClearSGChildren();
97         
98                 NodeList::iterator childit;
99                 for (childit = m_children.begin();childit!=m_children.end();++childit)
100                 {
101                         SG_Node* childnode = (*childit)->GetSGReplica();
102                         if (childnode)
103                                 (*replica)->AddChild(childnode);
104                 }
105         }
106         // Nodes without children and without client object are
107         // not worth to keep, they will just take up CPU
108         // This can happen in partial replication of hierarchy
109         // during group duplication.
110         if ((*replica)->m_children.empty() && 
111                 (*replica)->GetSGClientObject() == NULL)
112         {
113                 delete (*replica);
114                 *replica = NULL;
115         }
116 }
117
118
119         void 
120 SG_Node::
121 Destruct()
122 {
123         // Not entirely sure what Destruct() expects to happen.
124         // I think it probably means just to call the DestructionCallback
125         // in the right order on all the children - rather than free any memory
126         
127         // We'll delete m_parent_relation now anyway.
128         
129         delete(m_parent_relation);
130         m_parent_relation = NULL;
131
132         if (m_children.begin() != m_children.end())
133         {
134                 NodeList::iterator childit;
135                 for (childit = m_children.begin();childit!=m_children.end();++childit)
136                 {
137                         // call the SG_Node destruct method on each of our children }-)
138                         (*childit)->Destruct();
139                 }
140         }
141
142         ActivateDestructionCallback();
143 }
144
145 const 
146         SG_Node*        
147 SG_Node::
148 GetRootSGParent(
149 ) const {
150         return (m_SGparent ? (const SG_Node*) m_SGparent->GetRootSGParent() : (const SG_Node*) this);
151 }
152
153 bool SG_Node::IsAncessor(const SG_Node* child) const
154 {
155         return (!child->m_SGparent) ? false : 
156                 (child->m_SGparent == this) ? true : IsAncessor(child->m_SGparent);
157 }
158
159         void 
160 SG_Node::
161 DisconnectFromParent(
162 ){
163         if (m_SGparent)
164         {
165                 m_SGparent->RemoveChild(this);
166                 m_SGparent = NULL;
167         }
168
169 }
170
171 void SG_Node::AddChild(SG_Node* child)
172 {
173         m_children.push_back(child);
174         child->SetSGParent(this); // this way ?
175 }
176
177 void SG_Node::RemoveChild(SG_Node* child)
178 {
179         NodeList::iterator childfound = find(m_children.begin(),m_children.end(),child);
180
181         if (childfound != m_children.end())
182         {
183                 m_children.erase(childfound);
184         }
185 }
186
187
188
189 void SG_Node::UpdateWorldData(double time, bool parentUpdated)
190 {
191         //if (!GetSGParent())
192         //      return;
193
194         if (UpdateSpatialData(GetSGParent(),time,parentUpdated))
195                 // to update the 
196                 ActivateUpdateTransformCallback();
197
198         // The node is updated, remove it from the update list
199         Delink();
200
201         // update children's worlddata
202         for (NodeList::iterator it = m_children.begin();it!=m_children.end();++it)
203         {
204                 (*it)->UpdateWorldData(time, parentUpdated);
205         }
206 }
207
208
209
210 void SG_Node::SetSimulatedTime(double time,bool recurse)
211 {
212
213         // update the controllers of this node.
214         SetControllerTime(time);
215
216         // update children's simulate time.
217         if (recurse)
218         {
219                 for (NodeList::iterator it = m_children.begin();it!=m_children.end();++it)
220                 {
221                         (*it)->SetSimulatedTime(time,recurse);
222                 }
223         }
224 }
225
226
227