doxygen: prevent GPL license block from being parsed as doxygen comment.
[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 #include "SG_Node.h"
30 #include "SG_ParentRelation.h"
31 #include <algorithm>
32
33 using namespace std;
34
35
36 SG_Node::SG_Node(
37         void* clientobj,
38         void* clientinfo,
39         SG_Callbacks& callbacks
40
41 )
42         : SG_Spatial(clientobj,clientinfo,callbacks),
43         m_SGparent(NULL)
44 {
45         m_modified = true;
46 }
47
48 SG_Node::SG_Node(
49         const SG_Node & other
50 ) :
51         SG_Spatial(other),
52         m_children(other.m_children),
53         m_SGparent(other.m_SGparent)
54 {
55         m_modified = true;
56 }
57
58 SG_Node::~SG_Node()
59 {
60 }
61
62
63 SG_Node* SG_Node::GetSGReplica()
64 {
65         SG_Node* replica = new SG_Node(*this);
66         if (replica == NULL) return NULL;
67
68         ProcessSGReplica(&replica);
69         
70         return replica;
71 }
72
73         void 
74 SG_Node::
75 ProcessSGReplica(
76         SG_Node** replica
77 ){
78         // Apply the replication call back function.
79         if (!ActivateReplicationCallback(*replica)) 
80         {
81                 delete (*replica);
82                 *replica = NULL;
83                 return;
84         }
85
86         // clear the replica node of it's parent.
87         static_cast<SG_Node*>(*replica)->m_SGparent = NULL;
88
89         if (m_children.begin() != m_children.end())
90         {
91                 // if this node has children, the replica has too, so clear and clone children
92                 (*replica)->ClearSGChildren();
93         
94                 NodeList::iterator childit;
95                 for (childit = m_children.begin();childit!=m_children.end();++childit)
96                 {
97                         SG_Node* childnode = (*childit)->GetSGReplica();
98                         if (childnode)
99                                 (*replica)->AddChild(childnode);
100                 }
101         }
102         // Nodes without children and without client object are
103         // not worth to keep, they will just take up CPU
104         // This can happen in partial replication of hierarchy
105         // during group duplication.
106         if ((*replica)->m_children.empty() && 
107                 (*replica)->GetSGClientObject() == NULL)
108         {
109                 delete (*replica);
110                 *replica = NULL;
111         }
112 }
113
114
115         void 
116 SG_Node::
117 Destruct()
118 {
119         // Not entirely sure what Destruct() expects to happen.
120         // I think it probably means just to call the DestructionCallback
121         // in the right order on all the children - rather than free any memory
122         
123         // We'll delete m_parent_relation now anyway.
124         
125         delete(m_parent_relation);
126         m_parent_relation = NULL;               
127
128         if (m_children.begin() != m_children.end())
129         {
130                 NodeList::iterator childit;
131                 for (childit = m_children.begin();childit!=m_children.end();++childit)
132                 {
133                         // call the SG_Node destruct method on each of our children }-)
134                         (*childit)->Destruct();
135                 }
136         }
137
138         ActivateDestructionCallback();
139 }
140
141 const 
142         SG_Node*        
143 SG_Node::
144 GetRootSGParent(
145 ) const {
146         return (m_SGparent ? (const SG_Node*) m_SGparent->GetRootSGParent() : (const SG_Node*) this);
147 }
148
149 bool SG_Node::IsAncessor(const SG_Node* child) const
150 {
151         return (!child->m_SGparent) ? false : 
152                 (child->m_SGparent == this) ? true : IsAncessor(child->m_SGparent);
153 }
154
155         void 
156 SG_Node::
157 DisconnectFromParent(
158 ){
159         if (m_SGparent)
160         {
161                 m_SGparent->RemoveChild(this);
162                 m_SGparent = NULL;
163         }
164
165 }
166
167 void SG_Node::AddChild(SG_Node* child)
168 {
169         m_children.push_back(child);
170         child->SetSGParent(this); // this way ?
171 }
172
173 void SG_Node::RemoveChild(SG_Node* child)
174 {
175         NodeList::iterator childfound = find(m_children.begin(),m_children.end(),child);
176
177         if (childfound != m_children.end())
178         {
179                 m_children.erase(childfound);
180         }
181 }
182
183
184
185 void SG_Node::UpdateWorldData(double time, bool parentUpdated)
186 {
187         //if (!GetSGParent())
188         //      return;
189
190         if (UpdateSpatialData(GetSGParent(),time,parentUpdated))
191                 // to update the 
192                 ActivateUpdateTransformCallback();
193
194         // The node is updated, remove it from the update list
195         Delink();
196
197         // update children's worlddata
198         for (NodeList::iterator it = m_children.begin();it!=m_children.end();++it)
199         {
200                 (*it)->UpdateWorldData(time, parentUpdated);
201         }
202 }
203
204
205
206 void SG_Node::SetSimulatedTime(double time,bool recurse)
207 {
208
209         // update the controllers of this node.
210         SetControllerTime(time);
211
212         // update children's simulate time.
213         if (recurse)
214         {
215                 for (NodeList::iterator it = m_children.begin();it!=m_children.end();++it)
216                 {
217                         (*it)->SetSimulatedTime(time,recurse);
218                 }
219         }
220 }
221
222
223