variableInspector.h

Engine/source/gui/editor/inspector/variableInspector.h
Classes:

class
Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _GUI_VARIABLEINSPECTOR_H_
25#define _GUI_VARIABLEINSPECTOR_H_
26
27#ifndef _GUI_INSPECTOR_H_
28#include "gui/editor/guiInspector.h"
29#endif
30#ifndef _GUI_INSPECTOR_VARIABLEGROUP_H_
31#include "gui/editor/inspector/variableGroup.h"
32#endif
33
34
35class GuiVariableInspector : public GuiInspector
36{
37   typedef GuiInspector Parent;
38
39public:
40
41   GuiVariableInspector();
42   virtual ~GuiVariableInspector();
43
44   DECLARE_CONOBJECT( GuiVariableInspector );
45   DECLARE_CATEGORY( "Gui Editor" );
46
47   virtual void inspectObject( SimObject *object ) {}
48
49   virtual void loadVars( String searchString );
50
51   void update();
52
53   void startGroup(const char* name);
54   void endGroup();
55   void setGroupExpanded(const char* groupName, bool isExpanded);
56   void setGroupsExpanded(bool isExpanded);
57
58   void addField(const char* name, const char* label, const char* typeName, const char* description, 
59      const char* defaultValue, const char* dataValues, const char* callbackName, SimObject* ownerObj);
60   void addCallbackField(const char* name, const char* label, const char* typeName, const char* description,
61      const char* defaultValue, const char* dataValues, const char* callbackName, SimObject* ownerObj);
62   void setFieldEnabled(const char* name, bool enabled);
63   void clearFields();
64
65   void setAutoUpdate(bool doAutoUpdate) { mAutoUpdate = doAutoUpdate; }
66
67protected:
68   
69   Vector<VariableField> mFields;
70
71   String mCurrentGroup;
72
73   bool mAutoUpdate;
74
75};
76
77#endif // _GUI_VARIABLEINSPECTOR_H_
78