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