b4636d5fa62877fe9eb4a6c373b4a7a8cc03ba78
[blender-staging.git] / source / gameengine / SceneGraph / SG_Controller.h
1 /**
2  * Implementationclass to derive controllers from
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32 #ifndef __SG_CONTROLLER_H
33 #define __SG_CONTROLLER_H
34
35 #include "SG_IObject.h"
36
37 /**
38  * A scenegraph controller
39  */
40 class SG_Controller 
41 {
42 public:
43
44 #ifdef WITH_CXX_GUARDEDALLOC
45         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "SG_Controller"); }
46         void operator delete( void *mem ) { MEM_freeN(mem); }
47 #endif
48
49         SG_Controller(
50         ) :
51                 m_pObject(NULL) {
52         }
53
54         virtual 
55         ~SG_Controller(
56         ) {};
57
58         virtual 
59                 bool    
60         Update(
61                 double time
62         )=0;
63
64         virtual 
65                 void 
66         SetObject (
67                 SG_IObject* object
68         );
69
70                 void
71         ClearObject(
72         );
73
74         virtual 
75                 void    
76         SetSimulatedTime(
77                 double time
78         )=0;
79
80         virtual 
81                 SG_Controller*  
82         GetReplica(
83                 class SG_Node* destnode
84         )=0;
85
86         /**
87          * Hacky way of passing options to specific controllers
88          * @param option An integer identifying the option.
89          * @param value  The value of this option.
90          * @attention This has been placed here to give sca-elements 
91          * @attention some control over the controllers. This is 
92          * @attention necessary because the identity of the controller
93          * @attention is lost on the way here.
94          */
95         virtual
96                 void
97         SetOption(
98                 int option,
99                 int value
100         )=0;
101
102         /**
103          * Option-identifiers: SG_CONTR_<controller-type>_<option>. 
104          * Options only apply to a specific controller type. The 
105          * semantics are defined by whoever uses the setting.
106          */
107         enum SG_Controller_option {
108                 SG_CONTR_NODEF = 0,
109                 SG_CONTR_IPO_IPO_AS_FORCE,
110                 SG_CONTR_IPO_IPO_ADD,
111                 SG_CONTR_IPO_LOCAL,
112                 SG_CONTR_IPO_RESET,
113                 SG_CONTR_CAMIPO_LENS,
114                 SG_CONTR_CAMIPO_CLIPEND,
115                 SG_CONTR_CAMIPO_CLIPSTART,
116                 SG_CONTR_MAX
117         };
118
119 protected:
120         SG_IObject*             m_pObject;
121
122 };
123
124 #endif //__SG_CONTROLLER_H
125