1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
/****************************************************************************
**
** Copyright (C) 1999-2002 NVIDIA Corporation.
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
//==============================================================================
// Prefix
//==============================================================================
#ifndef __IINSPECTABLEITEM_H__
#define __IINSPECTABLEITEM_H__
//==============================================================================
// Includes
//==============================================================================
#include "Qt3DSDMDataTypes.h"
#include "Qt3DSDMHandles.h"
#include "Qt3DSDMActionInfo.h"
#include "Qt3DSDMMetaData.h"
#include "Qt3DSString.h"
//==============================================================================
// Forwards
//==============================================================================
class CStudioApp;
class IInspectableItem;
//==============================================================================
// Abstract Base Classes
//==============================================================================
enum EInspectableItemTypes {
INSPECTABLEITEMTYPE_VANILLA = 1,
INSPECTABLEITEMTYPE_PROPERTY,
INSPECTABLEITEMTYPE_DEPENDENT,
INSPECTABLEITEMTYPE_SLIDE,
INSPECTABLEITEMTYPE_OBJECTREFERENCE,
INSPECTABLEITEMTYPE_EVENTSOURCE,
INSPECTABLEITEMTYPE_ACTION,
INSPECTABLEITEMTYPE_CONDITIONS,
};
//==============================================================================
/**
* @class IInspectableItemChangeListener
* @brief Listener class for inspectable item changes.
*/
class IInspectableItemChangeListener
{
public:
virtual void OnInspectablePropertyChanged(IInspectableItem *inProperty) = 0;
};
class IInspectableObject
{
public:
virtual qt3dsdm::Qt3DSDMInstanceHandle GetInspectableBaseInstance() = 0;
virtual void SetInspectableObject(const qt3dsdm::SObjectRefType &) = 0;
virtual qt3dsdm::SObjectRefType GetInspectableObject() = 0;
};
class IInspectableEvent
{
public:
virtual qt3dsdm::Qt3DSDMInstanceHandle GetInspectableInstance() = 0;
virtual qt3dsdm::Qt3DSDMEventHandle GetInspectableEvent() = 0;
virtual void SetInspectableEvent(const qt3dsdm::Qt3DSDMEventHandle &inEventHandle) = 0;
};
class IInspectableTargetSection : public IInspectableObject
{
public:
virtual qt3dsdm::Qt3DSDMActionHandle GetInspectableAction() const = 0;
};
class IInspectableEventSection : public IInspectableObject, public IInspectableEvent
{
public:
virtual qt3dsdm::Qt3DSDMActionHandle GetInspectableAction() const = 0;
};
class IInspectableHandlerSection
{
public:
virtual qt3dsdm::Qt3DSDMActionHandle GetInspectableAction() const = 0;
virtual qt3dsdm::Qt3DSDMHandlerHandle GetInspectableHandler() = 0;
virtual void SetInspectableHandler(const qt3dsdm::Qt3DSDMHandlerHandle &inHandlerHandle) = 0;
virtual qt3dsdm::THandlerHandleList GetInspectableHandlerList() = 0;
virtual long GetArgumentCount() = 0;
virtual IInspectableItem *GetArgument(long inIndex) = 0;
virtual Q3DStudio::CString GetInspectableDescription() = 0;
};
//==============================================================================
/**
* @class IInspectableItem
* @brief Abstract base class for inspectable items.
*/
class IInspectableItem
{
public:
virtual ~IInspectableItem() {}
virtual EInspectableItemTypes GetInspectableKind() { return INSPECTABLEITEMTYPE_VANILLA; }
virtual qt3dsdm::HandlerArgumentType::Value
GetInspectableSubType() const = 0; // TODO : Make this method name correct
virtual QString GetInspectableName() const = 0;
virtual QString GetInspectableFormalName() const = 0;
virtual QString GetInspectableDescription() const = 0;
virtual qt3dsdm::SValue GetInspectableData() const = 0;
virtual void SetInspectableData(const qt3dsdm::SValue &) = 0;
// TODO: Remove from here onwards after cleaning up the rest of the UI classes
// This is the non-commital version of SetInspectableData, which must be called
// after ChangeInspectableData to commit the action.
virtual bool GetInspectableReadOnly() const { return false; }
virtual void ChangeInspectableData(const qt3dsdm::SValue & /*inAttr*/){};
virtual void CancelInspectableData(){}
virtual void AddInspectableChangeListener(IInspectableItemChangeListener * /*inListener*/){};
virtual void RemoveInspectableChangeListener(IInspectableItemChangeListener * /*inListener*/){};
};
//==============================================================================
/**
* Property specialization
*/
class IInspectablePropertyItem : public IInspectableItem
{
public:
EInspectableItemTypes GetInspectableKind() override { return INSPECTABLEITEMTYPE_PROPERTY; }
virtual void GetInspectablePropertyList(qt3dsdm::TPropertyHandleList &outList) = 0;
virtual qt3dsdm::Qt3DSDMInstanceHandle GetInspectableInstance() = 0;
};
//==============================================================================
/**
* Attribute specialization
*/
class IInspectableAttributeItem : public IInspectableItem
{
public:
EInspectableItemTypes GetInspectableKind() override { return INSPECTABLEITEMTYPE_DEPENDENT; }
virtual float GetInspectableMin() const = 0;
virtual float GetInspectableMax() const = 0;
virtual qt3dsdm::TMetaDataStringList GetInspectableList() const = 0;
virtual qt3dsdm::DataModelDataType::Value GetInspectableType() const = 0;
virtual qt3dsdm::AdditionalMetaDataType::Value GetInspectableAdditionalType() const = 0;
};
//==============================================================================
/**
* Slide specialization
*/
class IInspectableSlideItem : public IInspectableItem
{
public:
EInspectableItemTypes GetInspectableKind() override { return INSPECTABLEITEMTYPE_SLIDE; }
virtual void GetSlideNames(std::list<Q3DStudio::CString> &outSlideNames) = 0;
};
//==============================================================================
/**
* ObjectReference specialiaztion
*/
class IInspectableObjectRefItem : public IInspectableObject, public IInspectableItem
{
public:
EInspectableItemTypes GetInspectableKind() override
{
return INSPECTABLEITEMTYPE_OBJECTREFERENCE;
}
};
//==============================================================================
/**
* Event specialization
*/
class IInspectableEventItem : public IInspectableEvent, public IInspectableItem
{
public:
EInspectableItemTypes GetInspectableKind() override { return INSPECTABLEITEMTYPE_EVENTSOURCE; }
};
#endif // #ifndef __IINSPECTABLEITEM_H__
|
