svn merge -r 15392:15551 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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         SG_Controller(
44         ) :
45                 m_pObject(NULL) {
46         }
47
48         virtual 
49         ~SG_Controller(
50         ) {};
51
52         virtual 
53                 bool    
54         Update(
55                 double time
56         )=0;
57
58         virtual 
59                 void 
60         SetObject (
61                 SG_IObject* object
62         );
63
64                 void
65         ClearObject(
66         );
67
68         virtual 
69                 void    
70         SetSimulatedTime(
71                 double time
72         )=0;
73
74         virtual 
75                 SG_Controller*  
76         GetReplica(
77                 class SG_Node* destnode
78         )=0;
79
80         /**
81          * Hacky way of passing options to specific controllers
82          * @param option An integer identifying the option.
83          * @param value  The value of this option.
84          * @attention This has been placed here to give sca-elements 
85          * @attention some control over the controllers. This is 
86          * @attention necessary because the identity of the controller
87          * @attention is lost on the way here.
88          */
89         virtual
90                 void
91         SetOption(
92                 int option,
93                 int value
94         )=0;
95
96         /**
97          * Option-identifiers: SG_CONTR_<controller-type>_<option>. 
98          * Options only apply to a specific controller type. The 
99          * semantics are defined by whoever uses the setting.
100          */
101         enum SG_Controller_option {
102                 SG_CONTR_NODEF = 0,
103                 SG_CONTR_IPO_IPO_AS_FORCE,
104                 SG_CONTR_IPO_IPO_ADD,
105                 SG_CONTR_IPO_LOCAL,
106                 SG_CONTR_IPO_RESET,
107                 SG_CONTR_CAMIPO_LENS,
108                 SG_CONTR_CAMIPO_CLIPEND,
109                 SG_CONTR_CAMIPO_CLIPSTART,
110                 SG_CONTR_MAX
111         };
112
113 protected:
114         SG_IObject*             m_pObject;
115
116 };
117
118 #endif //__SG_CONTROLLER_H
119