HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SOP_VolumePatch.proto.h
Go to the documentation of this file.
1 /* Automagically Generated by generate_proto.py
2  * Do not Edit
3  */
4 #pragma once
5 
6 #include <SOP/SOP_NodeVerb.h>
7 #include <OP/OP_Utils.h>
8 #include <PRM/PRM_Parm.h>
9 #include <UT/UT_IStream.h>
10 #include <UT/UT_NTStreamUtil.h>
11 #include <UT/UT_Ramp.h>
12 #include <UT/UT_SharedPtr.h>
13 #include <UT/UT_StringHolder.h>
14 #include <UT/UT_StringStream.h>
15 #include <UT/UT_VectorTypes.h>
16 #include <SYS/SYS_Types.h>
17 
18 using namespace UT::Literal;
19 
20 class DEP_MicroNode;
21 
23 {
24 public:
25  static int version() { return 1; }
26 
28  {
29  myBasegroup = ""_sh;
30  myPatchgroup = ""_sh;
31  myMaskgroup = ""_sh;
32  myMaskcutoff = 0.5;
33  myPatchislaplacian = false;
34  myTolerance = 0.0001;
35 
36  }
37 
38  explicit SOP_VolumePatchParms(const SOP_VolumePatchParms &) = default;
39 
40  virtual ~SOP_VolumePatchParms() {}
41 
42  bool operator==(const SOP_VolumePatchParms &src) const
43  {
44  if (myBasegroup != src.myBasegroup) return false;
45  if (myPatchgroup != src.myPatchgroup) return false;
46  if (myMaskgroup != src.myMaskgroup) return false;
47  if (myMaskcutoff != src.myMaskcutoff) return false;
48  if (myPatchislaplacian != src.myPatchislaplacian) return false;
49  if (myTolerance != src.myTolerance) return false;
50 
51  return true;
52  }
53 
54 
55 
56  void buildFromOp(const OP_Node *node, fpreal time, DEP_MicroNode *depnode)
57  {
58  if (true)
59  OP_Utils::evalOpParm(myBasegroup, node, "basegroup", time, 0);
60  else myBasegroup = ""_sh;
61  if (true)
62  OP_Utils::evalOpParm(myPatchgroup, node, "patchgroup", time, 0);
63  else myPatchgroup = ""_sh;
64  if (true)
65  OP_Utils::evalOpParm(myMaskgroup, node, "maskgroup", time, 0);
66  else myMaskgroup = ""_sh;
67  if (true)
68  OP_Utils::evalOpParm(myMaskcutoff, node, "maskcutoff", time, 0);
69  else myMaskcutoff = 0.5;
70  if (true)
71  OP_Utils::evalOpParm(myPatchislaplacian, node, "patchislaplacian", time, 0);
72  else myPatchislaplacian = false;
73  if (true)
74  OP_Utils::evalOpParm(myTolerance, node, "tolerance", time, 0);
75  else myTolerance = 0.0001;
76 
77  }
78 
79 
80  virtual void loadFromOpSubclass(const LoadParms &loadparms)
81  {
82  buildFromOp(loadparms.node(), loadparms.context().getTime(), loadparms.depnode());
83  }
84 
85 
86  virtual void copyFrom(const SOP_NodeParms *src)
87  {
88  *this = *((const SOP_VolumePatchParms *)src);
89  }
90 
91  template <typename T>
92  void
93  doGetParmValue(exint idx, T &value) const
94  {
95  switch (idx)
96  {
97  case 0:
98  coerceValue(value, myBasegroup);
99  break;
100  case 1:
101  coerceValue(value, myPatchgroup);
102  break;
103  case 2:
104  coerceValue(value, myMaskgroup);
105  break;
106  case 3:
107  coerceValue(value, myMaskcutoff);
108  break;
109  case 4:
110  coerceValue(value, myPatchislaplacian);
111  break;
112  case 5:
113  coerceValue(value, myTolerance);
114  break;
115 
116  }
117  }
118 
119  void getParmValue(exint idx, exint &value) const
120  { doGetParmValue(idx, value); }
121  void getParmValue(exint idx, fpreal &value) const
122  { doGetParmValue(idx, value); }
124  { doGetParmValue(idx, value); }
126  { doGetParmValue(idx, value); }
128  { doGetParmValue(idx, value); }
130  { doGetParmValue(idx, value); }
132  { doGetParmValue(idx, value); }
134  { doGetParmValue(idx, value); }
136  { doGetParmValue(idx, value); }
138  { doGetParmValue(idx, value); }
140  { doGetParmValue(idx, value); }
141 
142  template <typename T>
143  void
144  doSetParmValue(exint idx, const T &value)
145  {
146  switch (idx)
147  {
148  case 0:
149  coerceValue(myBasegroup, value);
150  break;
151  case 1:
152  coerceValue(myPatchgroup, value);
153  break;
154  case 2:
155  coerceValue(myMaskgroup, value);
156  break;
157  case 3:
158  coerceValue(myMaskcutoff, value);
159  break;
160  case 4:
161  coerceValue(myPatchislaplacian, value);
162  break;
163  case 5:
164  coerceValue(myTolerance, value);
165  break;
166 
167  }
168  }
169 
170  void setParmValue(exint idx, const exint &value)
171  { doSetParmValue(idx, value); }
172  void setParmValue(exint idx, const fpreal &value)
173  { doSetParmValue(idx, value); }
174  void setParmValue(exint idx, const UT_Vector2D &value)
175  { doSetParmValue(idx, value); }
176  void setParmValue(exint idx, const UT_Vector3D &value)
177  { doSetParmValue(idx, value); }
178  void setParmValue(exint idx, const UT_Vector4D &value)
179  { doSetParmValue(idx, value); }
180  void setParmValue(exint idx, const UT_Matrix2D &value)
181  { doSetParmValue(idx, value); }
182  void setParmValue(exint idx, const UT_Matrix3D &value)
183  { doSetParmValue(idx, value); }
184  void setParmValue(exint idx, const UT_Matrix4D &value)
185  { doSetParmValue(idx, value); }
187  { doSetParmValue(idx, value); }
189  { doSetParmValue(idx, value); }
191  { doSetParmValue(idx, value); }
192 
193  virtual exint getNumParms() const
194  {
195  return 6;
196  }
197 
198  virtual const char *getParmName(exint fieldnum) const
199  {
200  switch (fieldnum)
201  {
202  case 0:
203  return "basegroup";
204  case 1:
205  return "patchgroup";
206  case 2:
207  return "maskgroup";
208  case 3:
209  return "maskcutoff";
210  case 4:
211  return "patchislaplacian";
212  case 5:
213  return "tolerance";
214 
215  }
216  return 0;
217  }
218 
219  virtual ParmType getParmType(exint fieldnum) const
220  {
221  switch (fieldnum)
222  {
223  case 0:
224  return PARM_STRING;
225  case 1:
226  return PARM_STRING;
227  case 2:
228  return PARM_STRING;
229  case 3:
230  return PARM_FLOAT;
231  case 4:
232  return PARM_INTEGER;
233  case 5:
234  return PARM_FLOAT;
235 
236  }
237  return PARM_UNSUPPORTED;
238  }
239 
240  // Boiler plate to load individual types.
241  static void loadData(UT_IStream &is, int64 &v)
242  { is.bread(&v, 1); }
243  static void loadData(UT_IStream &is, bool &v)
244  { int64 iv; is.bread(&iv, 1); v = iv; }
245  static void loadData(UT_IStream &is, fpreal64 &v)
246  { is.bread<fpreal64>(&v, 1); }
247  static void loadData(UT_IStream &is, UT_Vector2D &v)
248  { is.bread<fpreal64>(&v.x(), 1); is.bread<fpreal64>(&v.y(), 1); }
249  static void loadData(UT_IStream &is, UT_Vector3D &v)
250  { is.bread<fpreal64>(&v.x(), 1); is.bread<fpreal64>(&v.y(), 1);
251  is.bread<fpreal64>(&v.z(), 1); }
252  static void loadData(UT_IStream &is, UT_Vector4D &v)
253  { is.bread<fpreal64>(&v.x(), 1); is.bread<fpreal64>(&v.y(), 1);
254  is.bread<fpreal64>(&v.z(), 1); is.bread<fpreal64>(&v.w(), 1); }
255  static void loadData(UT_IStream &is, UT_Matrix2D &v)
256  { for (int r = 0; r < 2; r++) for (int c = 0; c < 2; c++) is.bread<fpreal64>(&v(r, c), 1); }
257  static void loadData(UT_IStream &is, UT_Matrix3D &v)
258  { for (int r = 0; r < 3; r++) for (int c = 0; c < 3; c++) is.bread<fpreal64>(&v(r, c), 1); }
259  static void loadData(UT_IStream &is, UT_Matrix4D &v)
260  { for (int r = 0; r < 4; r++) for (int c = 0; c < 4; c++) is.bread<fpreal64>(&v(r, c), 1); }
261  static void loadData(UT_IStream &is, UT_Vector2I &v)
262  { is.bread<int64>(&v.x(), 1); is.bread<int64>(&v.y(), 1); }
263  static void loadData(UT_IStream &is, UT_Vector3I &v)
264  { is.bread<int64>(&v.x(), 1); is.bread<int64>(&v.y(), 1);
265  is.bread<int64>(&v.z(), 1); }
266  static void loadData(UT_IStream &is, UT_Vector4I &v)
267  { is.bread<int64>(&v.x(), 1); is.bread<int64>(&v.y(), 1);
268  is.bread<int64>(&v.z(), 1); is.bread<int64>(&v.w(), 1); }
270  { is.bread(v); }
272  { UT_StringHolder rampdata;
273  loadData(is, rampdata);
274  if (rampdata.isstring())
275  {
276  v.reset(new UT_Ramp());
277  UT_IStream istr((const char *) rampdata, rampdata.length(), UT_ISTREAM_ASCII);
278  v->load(istr);
279  }
280  else v.reset();
281  }
284  loadData(is, data);
285  if (data.isstring())
286  {
287  // Find the data type.
288  char *colon = UT_StringWrap(data).findChar(':');
289  if (colon)
290  {
291  int typelen = colon - data.buffer();
293  type.strncpy(data.buffer(), typelen);
294  UT_IStream istr(((const char *) data) + typelen + 1, data.length() - (typelen + 1), UT_ISTREAM_BINARY);
295 
296  v = PRM_DataFactory::parseBinary(type.buffer(), istr);
297  }
298  }
299  else v.reset();
300  }
301 
302  static void saveData(std::ostream &os, int64 v)
303  { UTwrite(os, &v); }
304  static void saveData(std::ostream &os, bool v)
305  { int64 iv = v; UTwrite(os, &iv); }
306  static void saveData(std::ostream &os, fpreal64 v)
307  { UTwrite<fpreal64>(os, &v); }
308  static void saveData(std::ostream &os, UT_Vector2D v)
309  { UTwrite<fpreal64>(os, &v.x()); UTwrite<fpreal64>(os, &v.y()); }
310  static void saveData(std::ostream &os, UT_Vector3D v)
311  { UTwrite<fpreal64>(os, &v.x()); UTwrite<fpreal64>(os, &v.y());
312  UTwrite<fpreal64>(os, &v.z()); }
313  static void saveData(std::ostream &os, UT_Vector4D v)
314  { UTwrite<fpreal64>(os, &v.x()); UTwrite<fpreal64>(os, &v.y());
315  UTwrite<fpreal64>(os, &v.z()); UTwrite<fpreal64>(os, &v.w()); }
316  static void saveData(std::ostream &os, UT_Matrix2D v)
318  static void saveData(std::ostream &os, UT_Matrix3D v)
320  static void saveData(std::ostream &os, UT_Matrix4D v)
322  static void saveData(std::ostream &os, UT_StringHolder s)
323  { UT_StringWrap(s).saveBinary(os); }
324  static void saveData(std::ostream &os, UT_SharedPtr<UT_Ramp> s)
325  { UT_StringHolder result;
326  UT_OStringStream ostr;
327  if (s) s->save(ostr);
328  result = ostr.str();
329  saveData(os, result);
330  }
331  static void saveData(std::ostream &os, PRM_DataItemHandle s)
332  { UT_StringHolder result;
333  UT_OStringStream ostr;
334  if (s)
335  {
336  ostr << s->getDataTypeToken();
337  ostr << ":";
338  s->saveBinary(ostr);
339  }
340  result = ostr.str();
341  saveData(os, result);
342  }
343 
344 
345  void save(std::ostream &os) const
346  {
347  int32 v = version();
348  UTwrite(os, &v);
349  saveData(os, myBasegroup);
350  saveData(os, myPatchgroup);
351  saveData(os, myMaskgroup);
352  saveData(os, myMaskcutoff);
353  saveData(os, myPatchislaplacian);
354  saveData(os, myTolerance);
355 
356  }
357 
358  bool load(UT_IStream &is)
359  {
360  int32 v;
361  is.bread(&v, 1);
362  if (version() != v)
363  {
364  // Fail incompatible versions
365  return false;
366  }
367  loadData(is, myBasegroup);
368  loadData(is, myPatchgroup);
369  loadData(is, myMaskgroup);
370  loadData(is, myMaskcutoff);
371  loadData(is, myPatchislaplacian);
372  loadData(is, myTolerance);
373 
374  return true;
375  }
376 
377  const UT_StringHolder & getBasegroup() const { return myBasegroup; }
378  void setBasegroup(const UT_StringHolder & val) { myBasegroup = val; }
380  {
381  SOP_Node *thissop = cookparms.getNode();
382  if (!thissop) return getBasegroup();
383  UT_StringHolder result;
384  OP_Utils::evalOpParm(result, thissop, "basegroup", cookparms.getCookTime(), 0);
385  return result;
386  }
387  const UT_StringHolder & getPatchgroup() const { return myPatchgroup; }
388  void setPatchgroup(const UT_StringHolder & val) { myPatchgroup = val; }
390  {
391  SOP_Node *thissop = cookparms.getNode();
392  if (!thissop) return getPatchgroup();
393  UT_StringHolder result;
394  OP_Utils::evalOpParm(result, thissop, "patchgroup", cookparms.getCookTime(), 0);
395  return result;
396  }
397  const UT_StringHolder & getMaskgroup() const { return myMaskgroup; }
398  void setMaskgroup(const UT_StringHolder & val) { myMaskgroup = val; }
400  {
401  SOP_Node *thissop = cookparms.getNode();
402  if (!thissop) return getMaskgroup();
403  UT_StringHolder result;
404  OP_Utils::evalOpParm(result, thissop, "maskgroup", cookparms.getCookTime(), 0);
405  return result;
406  }
407  fpreal64 getMaskcutoff() const { return myMaskcutoff; }
408  void setMaskcutoff(fpreal64 val) { myMaskcutoff = val; }
410  {
411  SOP_Node *thissop = cookparms.getNode();
412  if (!thissop) return getMaskcutoff();
413  fpreal64 result;
414  OP_Utils::evalOpParm(result, thissop, "maskcutoff", cookparms.getCookTime(), 0);
415  return result;
416  }
417  bool getPatchislaplacian() const { return myPatchislaplacian; }
418  void setPatchislaplacian(bool val) { myPatchislaplacian = val; }
419  bool opPatchislaplacian(const SOP_NodeVerb::CookParms &cookparms) const
420  {
421  SOP_Node *thissop = cookparms.getNode();
422  if (!thissop) return getPatchislaplacian();
423  bool result;
424  OP_Utils::evalOpParm(result, thissop, "patchislaplacian", cookparms.getCookTime(), 0);
425  return result;
426  }
427  fpreal64 getTolerance() const { return myTolerance; }
428  void setTolerance(fpreal64 val) { myTolerance = val; }
430  {
431  SOP_Node *thissop = cookparms.getNode();
432  if (!thissop) return getTolerance();
433  fpreal64 result;
434  OP_Utils::evalOpParm(result, thissop, "tolerance", cookparms.getCookTime(), 0);
435  return result;
436  }
437 
438 private:
439  UT_StringHolder myBasegroup;
440  UT_StringHolder myPatchgroup;
441  UT_StringHolder myMaskgroup;
442  fpreal64 myMaskcutoff;
443  bool myPatchislaplacian;
444  fpreal64 myTolerance;
445 
446 };
virtual ParmType getParmType(exint fieldnum) const
virtual exint getNumParms() const
static void saveData(std::ostream &os, fpreal64 v)
void getParmValue(exint idx, UT_Vector3D &value) const
SOP_Node * getNode() const
Definition: SOP_NodeVerb.h:492
static void saveData(std::ostream &os, UT_Vector4D v)
static void loadData(UT_IStream &is, UT_Vector4I &v)
T & z(void)
Definition: UT_Vector4.h:372
void setParmValue(exint idx, const fpreal &value)
static void saveData(std::ostream &os, bool v)
void setParmValue(exint idx, const UT_Matrix4D &value)
exint bread(int32 *buffer, exint asize=1)
void getParmValue(exint idx, PRM_DataItemHandle &value) const
fpreal getTime() const
Definition: OP_Context.h:34
const GLdouble * v
Definition: glcorearb.h:836
const UT_StringHolder & getMaskgroup() const
void buildFromOp(const OP_Node *node, fpreal time, DEP_MicroNode *depnode)
void setParmValue(exint idx, const exint &value)
static void loadData(UT_IStream &is, UT_Vector3I &v)
void getParmValue(exint idx, UT_SharedPtr< UT_Ramp > &value) const
virtual void loadFromOpSubclass(const LoadParms &loadparms)
const UT_StringHolder & getPatchgroup() const
void getParmValue(exint idx, UT_Matrix2D &value) const
T & x(void)
Definition: UT_Vector2.h:284
fpreal64 getTolerance() const
An output stream object that owns its own string buffer storage.
static void loadData(UT_IStream &is, UT_Vector2I &v)
const UT_WorkBuffer & str() const
Returns a read-only reference to the underlying UT_WorkBuffer.
static void loadData(UT_IStream &is, UT_Matrix3D &v)
SYS_FORCE_INLINE T & x(void)
Definition: UT_Vector3.h:581
void setParmValue(exint idx, const PRM_DataItemHandle &value)
static void saveData(std::ostream &os, UT_Matrix2D v)
void setPatchgroup(const UT_StringHolder &val)
static PRM_DataItemHandle parseBinary(const char *type, UT_IStream &is)
void save(std::ostream &os) const
void setPatchislaplacian(bool val)
void setParmValue(exint idx, const UT_SharedPtr< UT_Ramp > &value)
fpreal64 getMaskcutoff() const
SYS_FORCE_INLINE T & z(void)
Definition: UT_Vector3.h:585
fpreal64 opMaskcutoff(const SOP_NodeVerb::CookParms &cookparms) const
long long int64
Definition: SYS_Types.h:100
static void loadData(UT_IStream &is, UT_Vector2D &v)
void doGetParmValue(exint idx, T &value) const
static void saveData(std::ostream &os, UT_Matrix4D v)
void setParmValue(exint idx, const UT_Vector3D &value)
exint length() const
char * findChar(int c) const
Find first occurrance of character. Returns NULL upon failure.
Definition: UT_String.h:550
void setParmValue(exint idx, const UT_Vector4D &value)
void setBasegroup(const UT_StringHolder &val)
bool operator==(const SOP_VolumePatchParms &src) const
SYS_FORCE_INLINE const char * buffer() const
static void loadData(UT_IStream &is, PRM_DataItemHandle &v)
int64 exint
Definition: SYS_Types.h:109
const OP_Node * node() const
Definition: SOP_NodeVerb.h:104
double fpreal64
Definition: SYS_Types.h:185
static void saveData(std::ostream &os, UT_Matrix3D v)
UT_StringHolder opBasegroup(const SOP_NodeVerb::CookParms &cookparms) const
void getParmValue(exint idx, UT_StringHolder &value) const
static void loadData(UT_IStream &is, fpreal64 &v)
void getParmValue(exint idx, UT_Matrix3D &value) const
static void loadData(UT_IStream &is, bool &v)
GLboolean * data
Definition: glcorearb.h:130
void getParmValue(exint idx, UT_Matrix4D &value) const
int int32
Definition: SYS_Types.h:28
T & y(void)
Definition: UT_Vector4.h:370
void saveBinary(std::ostream &os) const
Save string to binary stream.
Definition: UT_String.h:294
DEP_MicroNode * depnode() const
Definition: SOP_NodeVerb.h:111
bool load(UT_IStream &is)
static void loadData(UT_IStream &is, UT_Matrix4D &v)
UT_StringHolder opMaskgroup(const SOP_NodeVerb::CookParms &cookparms) const
static void loadData(UT_IStream &is, UT_StringHolder &v)
SYS_FORCE_INLINE T & y(void)
Definition: UT_Vector3.h:583
GLsizei const GLfloat * value
Definition: glcorearb.h:823
static void saveData(std::ostream &os, UT_Vector2D v)
double fpreal
Definition: SYS_Types.h:263
void getParmValue(exint idx, UT_Vector2D &value) const
void strncpy(const char *src, exint maxlen)
static void saveData(std::ostream &os, int64 v)
static void loadData(UT_IStream &is, UT_SharedPtr< UT_Ramp > &v)
static void saveData(std::ostream &os, UT_Vector3D v)
void setParmValue(exint idx, const UT_Matrix3D &value)
virtual const char * getParmName(exint fieldnum) const
static void loadData(UT_IStream &is, UT_Matrix2D &v)
static void loadData(UT_IStream &is, UT_Vector4D &v)
Utility class for containing a color ramp.
Definition: UT_Ramp.h:84
void getParmValue(exint idx, exint &value) const
void setParmValue(exint idx, const UT_StringHolder &value)
const UT_StringHolder & getBasegroup() const
GLuint GLfloat * val
Definition: glcorearb.h:1607
bool opPatchislaplacian(const SOP_NodeVerb::CookParms &cookparms) const
#define SOP_API
Definition: SOP_API.h:10
UT_StringHolder opPatchgroup(const SOP_NodeVerb::CookParms &cookparms) const
void setParmValue(exint idx, const UT_Vector2D &value)
const char * buffer() const
GLint GLint GLsizei GLint GLenum GLenum type
Definition: glcorearb.h:107
fpreal getCookTime() const
Definition: SOP_NodeVerb.h:499
T & x(void)
Definition: UT_Vector4.h:368
fpreal64 opTolerance(const SOP_NodeVerb::CookParms &cookparms) const
static void saveData(std::ostream &os, UT_StringHolder s)
void getParmValue(exint idx, UT_Vector4D &value) const
T & y(void)
Definition: UT_Vector2.h:286
void setMaskcutoff(fpreal64 val)
virtual void copyFrom(const SOP_NodeParms *src)
GLboolean r
Definition: glcorearb.h:1221
T & w(void)
Definition: UT_Vector4.h:374
void doSetParmValue(exint idx, const T &value)
static void loadData(UT_IStream &is, int64 &v)
const OP_Context & context() const
Definition: SOP_NodeVerb.h:109
void getParmValue(exint idx, fpreal &value) const
SYS_FORCE_INLINE bool isstring() const
void setParmValue(exint idx, const UT_Matrix2D &value)
void setMaskgroup(const UT_StringHolder &val)
void setTolerance(fpreal64 val)
static void saveData(std::ostream &os, PRM_DataItemHandle s)
static void saveData(std::ostream &os, UT_SharedPtr< UT_Ramp > s)
GLenum src
Definition: glcorearb.h:1792
static void loadData(UT_IStream &is, UT_Vector3D &v)