bplayer stub update + remove some tabs
[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 /** \file SG_Controller.h
33  *  \ingroup bgesg
34  */
35  
36 #ifndef __SG_CONTROLLER_H
37 #define __SG_CONTROLLER_H
38
39 #include "SG_IObject.h"
40
41 /**
42  * A scenegraph controller
43  */
44 class SG_Controller 
45 {
46 public:
47
48 #ifdef WITH_CXX_GUARDEDALLOC
49         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "SG_Controller"); }
50         void operator delete( void *mem ) { MEM_freeN(mem); }
51 #endif
52
53         SG_Controller(
54         ) :
55                 m_pObject(NULL) {
56         }
57
58         virtual 
59         ~SG_Controller(
60         ) {};
61
62         virtual 
63                 bool    
64         Update(
65                 double time
66         )=0;
67
68         virtual 
69                 void 
70         SetObject (
71                 SG_IObject* object
72         );
73
74                 void
75         ClearObject(
76         );
77
78         virtual 
79                 void    
80         SetSimulatedTime(
81                 double time
82         )=0;
83
84         virtual 
85                 SG_Controller*  
86         GetReplica(
87                 class SG_Node* destnode
88         )=0;
89
90         /**
91          * Hacky way of passing options to specific controllers
92          * @param option An integer identifying the option.
93          * @param value  The value of this option.
94          * @attention This has been placed here to give sca-elements 
95          * @attention some control over the controllers. This is 
96          * @attention necessary because the identity of the controller
97          * @attention is lost on the way here.
98          */
99         virtual
100                 void
101         SetOption(
102                 int option,
103                 int value
104         )=0;
105
106         /**
107          * Option-identifiers: SG_CONTR_<controller-type>_<option>. 
108          * Options only apply to a specific controller type. The 
109          * semantics are defined by whoever uses the setting.
110          */
111         enum SG_Controller_option {
112                 SG_CONTR_NODEF = 0,
113                 SG_CONTR_IPO_IPO_AS_FORCE,
114                 SG_CONTR_IPO_IPO_ADD,
115                 SG_CONTR_IPO_LOCAL,
116                 SG_CONTR_IPO_RESET,
117                 SG_CONTR_CAMIPO_LENS,
118                 SG_CONTR_CAMIPO_CLIPEND,
119                 SG_CONTR_CAMIPO_CLIPSTART,
120                 SG_CONTR_MAX
121         };
122
123 protected:
124         SG_IObject*             m_pObject;
125
126 };
127
128 #endif //__SG_CONTROLLER_H
129