forked from mcneel/rpc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
IRhRdkRegisteredProperty.h
313 lines (233 loc) · 11.9 KB
/
IRhRdkRegisteredProperty.h
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
#pragma once
class CRhRdkVariant;
class RHRDK_SDK IRhRdkRegisteredProperty
{
public:
enum units
{
no_units = 0,
// SI units.
meters=1, square_meters=2, cubic_meters=3, kilograms=4, seconds=5, radians=6,
// Rhino units.
rhino_units=7, square_rhino_units=8, cubic_rhino_units=9,
// Others.
percent=10, // The property will be of type vtDouble in the range 0..1 for 0..100%
force32bit_units=0xFFFFFFFF
};
class ConduitData
{
public:
ConduitData();
CRhinoDisplayConduit* m_pConduit;
CRhinoView* m_pView;
CRhinoViewport* m_pVP;
CChannelAttributes* m_pChannelAttrs;
CDisplayPipelineAttributes* m_pDisplayAttrs;
UINT m_iChannel;
CRhinoDisplayPipeline* m_dp;
void* m_pReserved;
};
// Unnamed enum - these can be combined for the iterator.
enum
{
object = 1, document = 2, view = 4, application = 8, layer = 16, rdk_content = 32, light = 64,
all = object | document | view | application | layer | rdk_content | light,
force32bit_pt = 0xFFFFFFFF
};
typedef DWORD prop_type;
public:
/** Display pipeline channels requested for dynamic display support - see subclasses SetDisplayToValue for more details */
virtual CSupportChannels RequestedDisplayChannels(void) const = 0;
/** You must implement this method as \code delete this; \endcode */
virtual void DeleteThis(void) = 0;
// Property Identification.
virtual ON_wString LocalPropertyName(void) const = 0; // Was previously virtual ON_wString PropertyName(void) const = 0;
virtual ON_wString EnglishPropertyName(void) const = 0;
virtual ON_wString PropertyCategory(void) const = 0;
virtual ON_wString LocalPropertyDescription(void) const = 0; // Was previously virtual ON_wString PropertyDescription(void) const = 0;
virtual UUID PropertyUuid(void) const = 0;
virtual prop_type PropertyType(void) const = 0;
// Plugin identification.
virtual ON_wString PlugInName(void) const = 0;
virtual ON_wString PlugInDescription(void) const = 0;
virtual UUID PlugInId(void) const = 0;
public:
// For all types.
virtual CRhRdkVariant DefaultValue(void) const = 0;
virtual bool IsAnimatable(void) const = 0;
virtual bool IsReadOnly(void) const = 0;
virtual bool IsEnabled(void) const = 0;
virtual CRhRdkVariant::VariantType ValueType(void) const = 0;
// For integer and real types.
virtual CRhRdkVariant MaxValue(void) const = 0;
virtual CRhRdkVariant MinValue(void) const = 0;
virtual units Units(void) const = 0;
// For enumeration types.
virtual int NumberOfValidValues(void) const = 0;
virtual CRhRdkVariant GetValidValue(int iIndex) const = 0;
/** Emergency virtual function for future expansion. */
virtual void* EVF(const wchar_t*, void*) = 0;
//Defined EVF calls: L"fixed-decimal-places", pvData: int*. Return NULL - use defaults.
protected:
virtual ~IRhRdkRegisteredProperty() { }
};
// Specialized interface classes and sub-classes for the different property types.
// Object Properties
class RHRDK_SDK IRhRdkRegisteredObjectProperty : public IRhRdkRegisteredProperty
{
public:
virtual bool SetValue(CRhinoDoc& doc, const UUID& objectId, ON_COMPONENT_INDEX ci, const CRhRdkVariant& value) = 0;
virtual bool SetDisplayToValue(CRhinoDoc& doc, const UUID& objectId, ON_COMPONENT_INDEX ci, ConduitData& conduit, const CRhRdkVariant& value) const = 0;
/** Should return CRhRdkVariant with type vtNull if the call fails.
If IsEnabledForObject() returns \e true, this should return a value. */
virtual CRhRdkVariant GetValue(const CRhinoDoc& doc, const UUID& objectID, ON_COMPONENT_INDEX ci) const = 0;
virtual bool IsEnabledForObject(const CRhinoDoc& doc, const UUID& objectId, ON_COMPONENT_INDEX ci) const = 0;
/** Should determine whether the input class is supported by this property.
Return \e true if you want to decide on a per-object basis. Otherwise implement like this:
\code return id.IsDerivedFrom(ON_Object::ClassId()); \endcode */
virtual bool IsEnabledForObjectClass(const ON_ClassId& id) const = 0;
};
class RHRDK_SDK CRhRdkRegisteredObjectProperty : public IRhRdkRegisteredObjectProperty
{
public:
virtual void DeleteThis(void) override { delete this; }
virtual prop_type PropertyType(void) const override { return object; }
virtual CRhRdkVariant::VariantType ValueType(void) const override { return DefaultValue().Type(); }
virtual void* EVF(const wchar_t*, void*) override { return nullptr; }
/** Call this function after changing a value on this property. */
virtual void CallPropertyChangedEvent(const CRhinoDoc& doc, const UUID& objectId, ON_COMPONENT_INDEX ci, const CRhRdkVariant& valueOld) const;
};
// View Properties
class RHRDK_SDK IRhRdkRegisteredViewProperty : public IRhRdkRegisteredProperty
{
public:
virtual bool SetValue(CRhinoDoc& doc, const UUID& viewId, const CRhRdkVariant& value) = 0;
virtual bool SetDisplayToValue(CRhinoDoc& doc, const UUID& viewId, ConduitData& conduit, const CRhRdkVariant& value) const = 0;
/** Should return CRhRdkVariant with type vtNull if the call fails.
If IsEnabledForView() returns \e true, this should return a value. */
virtual CRhRdkVariant GetValue(const CRhinoDoc& doc, const UUID& viewId) const = 0;
virtual bool IsEnabledForView(const CRhinoDoc& doc, const UUID& viewId) const = 0;
};
class RHRDK_SDK CRhRdkRegisteredViewProperty : public IRhRdkRegisteredViewProperty
{
public:
virtual void DeleteThis(void) { delete this; }
virtual prop_type PropertyType(void) const { return view; }
virtual CRhRdkVariant::VariantType ValueType(void) const { return DefaultValue().Type(); }
/** Call this function after changing a value on this property. */
virtual void CallPropertyChangedEvent(const CRhinoDoc& doc, const UUID& viewId, const CRhRdkVariant& valueOld) const;
};
// Application Properties
class RHRDK_SDK IRhRdkRegisteredAppProperty : public IRhRdkRegisteredProperty
{
public:
virtual bool SetValue(const CRhRdkVariant& value) = 0;
virtual bool SetDisplayToValue(ConduitData& conduit, const CRhRdkVariant& value) const = 0;
/** Should return CRhRdkVariant with type vtNull if the call fails. */
virtual CRhRdkVariant GetValue() const = 0;
};
class RHRDK_SDK CRhRdkRegisteredAppProperty : public IRhRdkRegisteredAppProperty
{
public:
virtual void DeleteThis(void) { delete this; }
virtual prop_type PropertyType(void) const { return application; }
virtual CRhRdkVariant::VariantType ValueType(void) const { return DefaultValue().Type(); }
/** Call this function after changing a value on this property. */
virtual void CallPropertyChangedEvent(const CRhRdkVariant& valueOld) const;
};
// Document Properties
class RHRDK_SDK IRhRdkRegisteredDocProperty : public IRhRdkRegisteredProperty
{
public:
virtual bool SetValue(CRhinoDoc& doc, const CRhRdkVariant& value) = 0;
virtual bool SetDisplayToValue(CRhinoDoc& doc, ConduitData& conduit, const CRhRdkVariant& value) const = 0;
/** Should return CRhRdkVariant with type vtNull if the call fails.
If IsEnabledForDoc() returns \e true, this should return a value. */
virtual CRhRdkVariant GetValue(const CRhinoDoc& doc) const = 0;
virtual bool IsEnabledForDoc(const CRhinoDoc& doc) const = 0;
};
class RHRDK_SDK CRhRdkRegisteredDocProperty : public IRhRdkRegisteredDocProperty
{
public:
virtual void DeleteThis(void) { delete this; }
virtual prop_type PropertyType(void) const { return document; }
virtual CRhRdkVariant::VariantType ValueType(void) const { return DefaultValue().Type(); }
/** Call this function after changing a value on this property. */
virtual void CallPropertyChangedEvent(const CRhinoDoc& doc, const CRhRdkVariant& valueOld) const;
/** Implemented inline for Rhino without multiple document support. */
virtual bool IsEnabledForDoc(const CRhinoDoc&) const { return IsEnabled(); }
/** Emergency virtual function for future expansion. */
virtual void* EVF(const wchar_t* wszFunc, void* pvData);
};
// Layer Properties
class RHRDK_SDK IRhRdkRegisteredLayerProperty : public IRhRdkRegisteredProperty
{
public:
virtual bool SetValue(CRhinoDoc& doc, const UUID& layer_id, const CRhRdkVariant& value) = 0;
virtual bool SetDisplayToValue(CRhinoDoc& doc, const UUID& layer_id, ConduitData& conduit, const CRhRdkVariant& value) const = 0;
/** Should return CRhRdkVariant with type vtNull if the call fails.
If IsEnabledForDoc() returns \e true, this should return a value. */
virtual CRhRdkVariant GetValue(const CRhinoDoc& doc, const UUID& layer_id) const = 0;
virtual bool IsEnabledForLayer(const CRhinoDoc& doc, const UUID& layer_id) const = 0;
};
class RHRDK_SDK CRhRdkRegisteredLayerProperty : public IRhRdkRegisteredLayerProperty
{
public:
virtual void DeleteThis(void) { delete this; }
virtual prop_type PropertyType(void) const { return layer; }
virtual CRhRdkVariant::VariantType ValueType(void) const { return DefaultValue().Type(); }
/** Call this function after changing a value on this property. */
virtual void CallPropertyChangedEvent(const CRhinoDoc& doc, const UUID& layer_id, const CRhRdkVariant& valueOld) const;
/** Implemented inline for Rhino without multiple document support. */
virtual bool IsEnabledForLayer(const CRhinoDoc&, const UUID& /*layer_id*/) const { return IsEnabled(); }
/** Emergency virtual function for future expansion. */
virtual void* EVF(const wchar_t* wszFunc, void* pvData);
};
// RDK Content Properties
class RHRDK_SDK IRhRdkRegisteredRdkContentProperty : public IRhRdkRegisteredProperty
{
public:
virtual bool SetValue(CRhinoDoc& doc, const UUID& instance_id, const CRhRdkVariant& value) = 0;
virtual bool SetDisplayToValue(CRhinoDoc& doc, const UUID& instance_id, ConduitData& conduit, const CRhRdkVariant& value) const = 0;
/** Should return CRhRdkVariant with type vtNull if the call fails.
If IsEnabledForDoc() returns \e true, this should return a value. */
virtual CRhRdkVariant GetValue(const CRhinoDoc& doc, const UUID& instance_id) const = 0;
virtual bool IsEnabledForContent(const CRhinoDoc& doc, const UUID& instance_id) const = 0;
};
class RHRDK_SDK CRhRdkRegisteredRdkContentProperty : public IRhRdkRegisteredRdkContentProperty
{
public:
virtual void DeleteThis(void) { delete this; }
virtual prop_type PropertyType(void) const { return rdk_content; }
virtual CRhRdkVariant::VariantType ValueType(void) const { return DefaultValue().Type(); }
/** Call this function after changing a value on this property. */
virtual void CallPropertyChangedEvent(const CRhinoDoc& doc, const UUID& instance_id, const CRhRdkVariant& valueOld) const;
/** Implemented inline for Rhino without multiple document support. */
virtual bool IsEnabledForContent(const CRhinoDoc&, const UUID& /*instance_id*/) const { return IsEnabled(); }
/** Emergency virtual function for future expansion. */
virtual void* EVF(const wchar_t* wszFunc, void* pvData);
};
// Light Properties
class RHRDK_SDK IRhRdkRegisteredLightProperty : public IRhRdkRegisteredProperty
{
public:
virtual bool SetValue(CRhinoDoc& doc, const UUID& light_id, const CRhRdkVariant& value) = 0;
virtual bool SetDisplayToValue(CRhinoDoc& doc, const UUID& light_id, ConduitData& conduit, const CRhRdkVariant& value) const = 0;
/** Should return CRhRdkVariant with type vtNull if the call fails.
If IsEnabledForLight() returns \e true, this should return a value. */
virtual CRhRdkVariant GetValue(const CRhinoDoc& doc, const UUID& light_id) const = 0;
virtual bool IsEnabledForLight(const CRhinoDoc& doc, const UUID& light_id) const = 0;
};
class RHRDK_SDK CRhRdkRegisteredLightProperty : public IRhRdkRegisteredLightProperty
{
public:
virtual void DeleteThis(void) { delete this; }
virtual prop_type PropertyType(void) const { return light; }
virtual CRhRdkVariant::VariantType ValueType(void) const { return DefaultValue().Type(); }
/** Call this function after changing a value on this property. */
virtual void CallPropertyChangedEvent(const CRhinoDoc& doc, const UUID& light_id, const CRhRdkVariant& valueOld) const;
/** Implemented inline for Rhino without multiple document support. */
virtual bool IsEnabledForLight(const CRhinoDoc&, const UUID& /*light_id*/) const { return IsEnabled(); }
/** Emergency virtual function for future expansion. */
virtual void* EVF(const wchar_t* wszFunc, void* pvData);
};