Synchronise game engine with Tuhopuu2 tree.
[blender.git] / source / gameengine / Expressions / VoidValue.h
1 /**
2  * VoidValue.h: interface for the CVoidValue class.
3  * $Id$
4  *
5  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version. The Blender
11  * Foundation also sells licenses for use in proprietary software under
12  * the Blender License.  See http://www.blender.org/BL/ for information
13  * about this.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  *
24  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
25  * All rights reserved.
26  *
27  * The Original Code is: all of this file.
28  *
29  * Contributor(s): none yet.
30  *
31  * ***** END GPL/BL DUAL LICENSE BLOCK *****
32  */
33 #ifndef __VOIDVALUE_H__
34 #define __VOIDVALUE_H__
35
36 #include "Value.h"
37
38 //
39 // Void value, used to transport *any* type of data
40 //
41 class CVoidValue : public CPropValue  
42 {
43         //PLUGIN_DECLARE_SERIAL (CVoidValue,CValue)
44
45 public:
46         /// Construction/destruction
47         CVoidValue()                                                                                                                            : m_bDeleteOnDestruct(false), m_pAnything(NULL)  { }
48         CVoidValue(void * voidptr, bool bDeleteOnDestruct, AllocationTYPE alloctype)    : m_bDeleteOnDestruct(bDeleteOnDestruct), m_pAnything(voidptr)  { if (alloctype == STACKVALUE) CValue::DisableRefCount(); }
49         virtual                         ~CVoidValue();                                                                                  // Destruct void value, delete memory if we're owning it
50
51         /// Value -> String or number
52         virtual const STR_String &      GetText();                                                                                              // Get string description of void value (unimplemented)
53         virtual float           GetNumber()                                                                                             { return -1; }
54
55         /// Value calculation
56         virtual CValue*         Calc(VALUE_OPERATOR op, CValue *val);
57         virtual CValue*         CalcFinal(VALUE_DATA_TYPE dtype, VALUE_OPERATOR op, CValue* val);
58
59         /// Value replication
60         virtual CValue*         GetReplica();
61         
62         /// Data members
63         bool                            m_bDeleteOnDestruct;
64         void*                           m_pAnything;
65 };
66
67 #endif // !defined _VOIDVALUE_H
68