HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SOP_Comb.h
Go to the documentation of this file.
1 /*
2  * PROPRIETARY INFORMATION. This software is proprietary to
3  * Side Effects Software Inc., and is not to be reproduced,
4  * transmitted, or disclosed in any way without written permission.
5  *
6  * NAME: SOP Library (C++)
7  *
8  * COMMENTS: The Comb SOP, which works in conjunction with the
9  * Comb State and the GDT classes.
10  *
11  */
12 
13 #ifndef __SOP_Comb_h__
14 #define __SOP_Comb_h__
15 
16 #include "SOP_API.h"
17 #include <GU/GU_Brush.h>
18 
19 #include "SOP_GDT.h"
20 #include "SOP_BrushBase.h"
21 
22 class PRM_MenuEntry;
23 
24 enum {
25  // Group parameters
27 
29 
30 #define SOP_COMB_NUM_DEFORM_PARMS (6)
37 
38 #define SOP_COMB_NUM_NIB_PARMS (18)
57 
58 #define SOP_COMB_NUM_SYM_PARMS (9)
68 
69 #define SOP_COMB_NUM_RAY_PARMS (11)
81 };
82 
84 {
85 public:
86  SOP_Comb(OP_Network *net, const char *name, OP_Operator *entry);
87  ~SOP_Comb() override;
88 
89  bool updateParmsFlags() override;
90 
91  static OP_Node *myConstructor(OP_Network *net,
92  const char *name,
93  OP_Operator *entry);
94 
95  static PRM_Template myTemplateList[];
96  static PRM_Template myObsoleteList[];
97 
98  void setAccumulateStencil(bool) override
99  {
100  }
101  void setRayOrigin(const UT_Vector3 &orig, fpreal t) override
102  {
103  setFloat(SOP_COMB_RAY_HITPOS_IDX, 0, t, orig.x());
104  setFloat(SOP_COMB_RAY_HITPOS_IDX, 1, t, orig.y());
105  setFloat(SOP_COMB_RAY_HITPOS_IDX, 2, t, orig.z());
106  }
107  void setRayOrientation(const UT_Vector3 &orient, fpreal t) override
108  {
109  setFloat(SOP_COMB_RAY_ORIENT_IDX, 0, t, orient.x());
110  setFloat(SOP_COMB_RAY_ORIENT_IDX, 1, t, orient.y());
111  setFloat(SOP_COMB_RAY_ORIENT_IDX, 2, t, orient.z());
112  }
113  void setHitPrimitive(int primidx, fpreal t) override
114  {
115  setInt(SOP_COMB_RAY_HITPRIM_IDX, 0, t, primidx);
116  }
117  void setRadius(fpreal r, fpreal t) override
118  {
119  setFloat(SOP_COMB_RAD_IDX, 0, t, r);
120  }
121  void setUVRadius(fpreal r, fpreal t) override
122  {
123  setFloat(SOP_COMB_UVRAD_IDX, 0, t, r);
124  }
125  void setHitPoint(int pt, fpreal t) override
126  {
127  setInt(SOP_COMB_RAY_HITPT_IDX, 0, t, pt);
128  }
129  void setHitUVW(fpreal u, fpreal v, fpreal w, fpreal t) override
130  {
134  }
135  void setHitPressure(fpreal p, fpreal t) override
136  {
138  }
140  {
141  setInt(SOP_COMB_RAY_EVENT_IDX, 0, 0, int(event));
142  }
143  void setBrushOp(SOP_BrushOp op) override
144  {
145  int iop;
146  switch (op)
147  {
148  default:
149  case SOP_BRUSHOP_COMB: iop = 0; break;
150  case SOP_BRUSHOP_SMOOTHNORMAL: iop = 1; break;
151  case SOP_BRUSHOP_ERASE: iop = 2; break;
152  case SOP_BRUSHOP_LIFT: iop = 3; break;
153  case SOP_BRUSHOP_ROTATE: iop = 4; break;
154  }
155  setInt(SOP_COMB_OP_IDX, 0, 0, iop);
156  }
157  void setBrushShape(SOP_BrushShape shape) override
158  {
159  setInt(SOP_COMB_SHAPE_IDX, 0, 0, int(shape));
160  }
161  void setProjectionType(int projtype) override
162  {
163  setInt(SOP_COMB_PROJTYPE_IDX, 0, 0, projtype);
164  }
165  void useForegroundColor() override
166  {
167  }
168  void useBackgroundColor() override
169  {
170  }
171 
172  int altersGeometry() const override { return 0; }
173  int altersColor() const override { return 0; }
175  { return evalFloat(SOP_COMB_RAD_IDX, 0, t); }
177  { return evalFloat(SOP_COMB_UVRAD_IDX, 0, t); }
179  { return evalFloat(SOP_COMB_RADPRESSURE_IDX, 0, t); }
181  {return evalFloat(SOP_COMB_OPAC_IDX, 0, t); }
183  {return evalFloat(SOP_COMB_OPACPRESSURE_IDX, 0, t) ; }
184 
185  SOP_BrushOp OP() override
186  {
187  switch (evalInt(SOP_COMB_OP_IDX, 0, 0))
188  {
189  default:
190  case 0: return SOP_BRUSHOP_COMB;
191  case 1: return SOP_BRUSHOP_SMOOTHNORMAL;
192  case 2: return SOP_BRUSHOP_ERASE;
193  case 3: return SOP_BRUSHOP_LIFT;
194  case 4: return SOP_BRUSHOP_ROTATE;
195  }
196  }
197  int ACCUMSTENCIL() override { return 0; }
198  int PROJECTIONTYPE() override
199  { return evalInt(SOP_COMB_PROJTYPE_IDX, 0, 0); }
200  int REALTIME() override
201  { return evalInt(SOP_COMB_REALTIME_IDX, 0, 0); }
202  int SHAPE(fpreal t) override
203  { return evalInt(SOP_COMB_SHAPE_IDX, 0, t); }
204  int OVERRIDENML() override
205  { return evalInt(SOP_COMB_OVRNML_IDX, 0, 0); }
206  void NMLNAME(UT_String &str, fpreal t) override
207  { evalString(str, SOP_COMB_NMLNAME_IDX, 0, t); }
208 
209 protected:
210  const char *inputLabel(OP_InputIdx idx) const override;
211  void doErase() override;
212  void addEraseAttributes(GU_Brush &brush) override;
213 
214 
215  int MERGEMODE() override { return 0; }
216  void SCRIPT(UT_String &, fpreal ) override {}
217  int AXIS() override { return 0 ; }
218  fpreal USERX(fpreal) override { return 0.0; }
219  fpreal USERY(fpreal) override { return 0.0; }
220  fpreal USERZ(fpreal) override { return 0.0; }
221 
223  { return evalFloat(SOP_COMB_RAY_ORIENT_IDX, 0, t); }
225  { return evalFloat(SOP_COMB_RAY_ORIENT_IDX, 1, t); }
227  { return evalFloat(SOP_COMB_RAY_ORIENT_IDX, 2, t); }
228  fpreal RAYHITX(fpreal t) override
229  { return evalFloat(SOP_COMB_RAY_HITPOS_IDX, 0, t); }
230  fpreal RAYHITY(fpreal t) override
231  { return evalFloat(SOP_COMB_RAY_HITPOS_IDX, 1, t); }
232  fpreal RAYHITZ(fpreal t) override
233  { return evalFloat(SOP_COMB_RAY_HITPOS_IDX, 2, t); }
234  fpreal RAYHITU(fpreal t) override
235  { return evalFloat(SOP_COMB_RAY_HITUVW_IDX, 0, t); }
236  fpreal RAYHITV(fpreal t) override
237  { return evalFloat(SOP_COMB_RAY_HITUVW_IDX, 1, t); }
238  fpreal RAYHITW(fpreal t) override
239  { return evalFloat(SOP_COMB_RAY_HITUVW_IDX, 2, t); }
241  { return evalFloat(SOP_COMB_RAY_HITPRESSURE_IDX, 0, t); }
242  int PRIMHIT(fpreal t) override
243  { return evalInt(SOP_COMB_RAY_HITPRIM_IDX,0, t); }
244  int PTHIT(fpreal t) override
245  { return evalInt(SOP_COMB_RAY_HITPT_IDX, 0, t); }
246  int EVENT() override
247  { return evalInt(SOP_COMB_RAY_EVENT_IDX, 0, 0); }
248  bool USE_FOREGROUND() override
249  { return 1; }
250 
251  // We return the lift as our first entry of the foreground colour.
252  fpreal FGR(fpreal t) override
253  { return evalFloat(SOP_COMB_LIFT_IDX, 0, t); }
254  fpreal FGG(fpreal) override { return 0.0; }
255  fpreal FGB(fpreal) override { return 0.0; }
256  fpreal BGR(fpreal) override { return 0.0; }
257  fpreal BGG(fpreal) override { return 0.0; }
258  fpreal BGB(fpreal) override { return 0.0; }
259 
261  { return evalFloat(SOP_COMB_SOFTEDGE_IDX, 0, t); }
262  void KERNEL(UT_String &str, fpreal t) override
263  { evalString(str, SOP_COMB_KERNEL_IDX, 0, t); }
264  int UPTYPE(fpreal t) override
265  { return evalInt(SOP_COMB_UPTYPE_IDX, 0, t); }
266  fpreal UPX(fpreal t) override
267  { return evalFloat(SOP_COMB_UPVECTOR_IDX, 0, t); }
268  fpreal UPY(fpreal t) override
269  { return evalFloat(SOP_COMB_UPVECTOR_IDX, 1, t); }
270  fpreal UPZ(fpreal t) override
271  { return evalFloat(SOP_COMB_UPVECTOR_IDX, 2, t); }
272 
274  { return evalFloat(SOP_COMB_PAPER_IDX, 0, t); }
276  { return evalFloat(SOP_COMB_SPLATTER_IDX, 0, t); }
277  void BITMAP(UT_String &str, fpreal t) override
278  { evalString(str, SOP_COMB_BITMAP_IDX, 0, t); }
279  int BITMAPCHAN(fpreal t) override
280  { return evalInt(SOP_COMB_BITMAPCHAN_IDX, 0, t); }
281  fpreal ANGLE(fpreal t) override
282  { return evalFloat(SOP_COMB_ANGLE_IDX, 0, t); }
283  fpreal SQUASH(fpreal t) override
284  { return evalFloat(SOP_COMB_SQUASH_IDX, 0, t); }
285 
286  int DOSTAMPING() override { return 0; }
287  int WRITEALPHA() override { return 0; }
288  int OVERRIDECD() override { return 0; }
289  void CDNAME(UT_String &, fpreal) override { }
290  int OVERRIDEALPHA() override { return 0; }
291  void ALPHANAME(UT_String &, fpreal) override { }
292  int ADDATTRIB() override { return 1; }
293  int PRESERVENML() override
294  { return evalInt(SOP_COMB_PRESERVENML_IDX, 0, 0); }
296  { return evalFloat(SOP_COMB_SYMAXIS_IDX, 0, t); }
298  { return evalFloat(SOP_COMB_SYMAXIS_IDX, 1, t); }
300  { return evalFloat(SOP_COMB_SYMAXIS_IDX, 2, t); }
302  { return evalFloat(SOP_COMB_SYMORIG_IDX, 0, t); }
304  { return evalFloat(SOP_COMB_SYMORIG_IDX, 1, t); }
306  { return evalFloat(SOP_COMB_SYMORIG_IDX, 2, t); }
307  int DOREFLECTION() override
308  { return evalInt(SOP_COMB_DOREFLECT_IDX,0, 0); }
309  int DOROTATION() override
310  { return evalInt(SOP_COMB_DOROTATION_IDX,0, 0); }
311  int SYMMETRYROT(fpreal t) override
312  { return evalInt(SOP_COMB_SYMROT_IDX,0, t); }
314  { return evalFloat(SOP_COMB_SYMDIST_IDX,0, t); }
315 
316  int DOUVREFLECTION() override
317  { return evalInt(SOP_COMB_DOUVREFLECT_IDX, 0, 0); }
319  { return evalFloat(SOP_COMB_SYMUVORIG_IDX, 0, t); }
321  { return evalFloat(SOP_COMB_SYMUVORIG_IDX, 1, t); }
323  { return evalFloat(SOP_COMB_SYMUVANGLE_IDX, 0, t);}
324 
325  int USECONNECTIVITY() override
326  { return evalInt(SOP_COMB_USECONNECTIVITY_IDX, 0, 0); }
327  int USENORMALS() override
328  { return evalInt(SOP_COMB_USENORMALS_IDX, 0, 0); }
329  int USEDEPTH() override
330  { return evalInt(SOP_COMB_USEDEPTH_IDX, 0, 0); }
331  fpreal DEPTH(fpreal t) override
332  { return evalFloat(SOP_COMB_DEPTH_IDX, 0, t); }
333  fpreal HEIGHT(fpreal t) override
334  { return evalFloat(SOP_COMB_DEPTH_IDX, 1, t); }
335 
336  // Find out if the brush has moved or done anything to cause us to add its
337  // effect to the current gdp.
338  bool hasStrokeChanged(fpreal t) override;
339  bool hasStyleChanged(fpreal t) override;
340 
341  // Find if the nib file has changed:
342  bool hasNibFileChanged(fpreal t) override;
343  bool hasAccumStencilChanged(fpreal t) override;
344  bool hasNibLookChanged(fpreal t) override;
345 
346  // Do we want our cook selection to be updated and displayed?
347  bool wantsCookSelection() const override { return true; }
348 
349 };
350 
351 #endif
void setHitUVW(fpreal u, fpreal v, fpreal w, fpreal t) override
Definition: SOP_Comb.h:129
fpreal SYMMETRYDIRZ(fpreal t) override
Definition: SOP_Comb.h:299
fpreal USERY(fpreal) override
Definition: SOP_Comb.h:219
void setHitPrimitive(int primidx, fpreal t) override
Definition: SOP_Comb.h:113
fpreal BGG(fpreal) override
Definition: SOP_Comb.h:257
virtual bool updateParmsFlags()
void useBackgroundColor() override
Definition: SOP_Comb.h:168
fpreal RAWOPACITY(fpreal t) override
Definition: SOP_Comb.h:180
int DOROTATION() override
Definition: SOP_Comb.h:309
fpreal BGB(fpreal) override
Definition: SOP_Comb.h:258
virtual bool hasAccumStencilChanged(fpreal t)=0
fpreal SQUASH(fpreal t) override
Definition: SOP_Comb.h:283
int PTHIT(fpreal t) override
Definition: SOP_Comb.h:244
int USENORMALS() override
Definition: SOP_Comb.h:327
fpreal RAYHITV(fpreal t) override
Definition: SOP_Comb.h:236
fpreal BGR(fpreal) override
Definition: SOP_Comb.h:256
fpreal FGG(fpreal) override
Definition: SOP_Comb.h:254
const GLdouble * v
Definition: glcorearb.h:837
int EVENT() override
Definition: SOP_Comb.h:246
int WRITEALPHA() override
Definition: SOP_Comb.h:287
fpreal RAWUVRADIUS(fpreal t) override
Definition: SOP_Comb.h:176
int OP_InputIdx
Definition: OP_DataTypes.h:184
fpreal RAYORIENTZ(fpreal t) override
Definition: SOP_Comb.h:226
virtual bool hasStyleChanged(fpreal t)=0
int OVERRIDECD() override
Definition: SOP_Comb.h:288
fpreal SYMMETRYORIGZ(fpreal t) override
Definition: SOP_Comb.h:305
fpreal RAYORIENTX(fpreal t) override
Definition: SOP_Comb.h:222
constexpr SYS_FORCE_INLINE T & z() noexcept
Definition: UT_Vector3.h:669
int SHAPE(fpreal t) override
Definition: SOP_Comb.h:202
fpreal evalFloat(int pi, int vi, fpreal t) const
int altersGeometry() const override
Definition: SOP_Comb.h:172
int altersColor() const override
Definition: SOP_Comb.h:173
fpreal USERX(fpreal) override
Definition: SOP_Comb.h:218
void setHitPoint(int pt, fpreal t) override
Definition: SOP_Comb.h:125
fpreal SYMMETRYDIRX(fpreal t) override
Definition: SOP_Comb.h:295
void useForegroundColor() override
Definition: SOP_Comb.h:165
void CDNAME(UT_String &, fpreal) override
Definition: SOP_Comb.h:289
int ADDATTRIB() override
Definition: SOP_Comb.h:292
fpreal USERZ(fpreal) override
Definition: SOP_Comb.h:220
int MERGEMODE() override
Definition: SOP_Comb.h:215
void BITMAP(UT_String &str, fpreal t) override
Definition: SOP_Comb.h:277
bool USE_FOREGROUND() override
Definition: SOP_Comb.h:248
struct _cl_event * event
Definition: glcorearb.h:2961
fpreal UPX(fpreal t) override
Definition: SOP_Comb.h:266
void setProjectionType(int projtype) override
Definition: SOP_Comb.h:161
virtual bool hasNibFileChanged(fpreal t)=0
SOP_BrushOp OP() override
Definition: SOP_Comb.h:185
fpreal RAYORIENTY(fpreal t) override
Definition: SOP_Comb.h:224
void SCRIPT(UT_String &, fpreal) override
Definition: SOP_Comb.h:216
int UPTYPE(fpreal t) override
Definition: SOP_Comb.h:264
fpreal SYMMETRYUVORIGV(fpreal t) override
Definition: SOP_Comb.h:320
fpreal SOFTEDGE(fpreal t) override
Definition: SOP_Comb.h:260
void KERNEL(UT_String &str, fpreal t) override
Definition: SOP_Comb.h:262
virtual void addEraseAttributes(GU_Brush &brush)
fpreal UPZ(fpreal t) override
Definition: SOP_Comb.h:270
int ACCUMSTENCIL() override
Definition: SOP_Comb.h:197
fpreal RAYHITPRESSURE(fpreal t) override
Definition: SOP_Comb.h:240
void NMLNAME(UT_String &str, fpreal t) override
Definition: SOP_Comb.h:206
int DOREFLECTION() override
Definition: SOP_Comb.h:307
void evalString(UT_String &val, int pi, int vi, fpreal t) const
fpreal SYMMETRYUVORIGU(fpreal t) override
Definition: SOP_Comb.h:318
fpreal FGB(fpreal) override
Definition: SOP_Comb.h:255
fpreal SYMMETRYUVANGLE(fpreal t) override
Definition: SOP_Comb.h:322
int PROJECTIONTYPE() override
Definition: SOP_Comb.h:198
int BITMAPCHAN(fpreal t) override
Definition: SOP_Comb.h:279
int DOSTAMPING() override
Definition: SOP_Comb.h:286
void setRayOrigin(const UT_Vector3 &orig, fpreal t) override
Definition: SOP_Comb.h:101
fpreal RAYHITU(fpreal t) override
Definition: SOP_Comb.h:234
SOP_BrushOp
Definition: SOP_BrushBase.h:39
int OVERRIDENML() override
Definition: SOP_Comb.h:204
int PRESERVENML() override
Definition: SOP_Comb.h:293
virtual void doErase()=0
void setBrushOp(SOP_BrushOp op) override
Definition: SOP_Comb.h:143
GLuint const GLchar * name
Definition: glcorearb.h:786
fpreal PAPERNOISE(fpreal t) override
Definition: SOP_Comb.h:273
fpreal RAYHITX(fpreal t) override
Definition: SOP_Comb.h:228
int SYMMETRYROT(fpreal t) override
Definition: SOP_Comb.h:311
fpreal SYMMETRYDIRY(fpreal t) override
Definition: SOP_Comb.h:297
void setBrushShape(SOP_BrushShape shape) override
Definition: SOP_Comb.h:157
GA_API const UT_StringHolder orient
int USEDEPTH() override
Definition: SOP_Comb.h:329
GLdouble t
Definition: glad.h:2397
int REALTIME() override
Definition: SOP_Comb.h:200
#define SOP_GDT_GRP_IDX
Definition: SOP_GDT.h:22
fpreal SYMMETRYORIGX(fpreal t) override
Definition: SOP_Comb.h:301
fpreal RAWRADIUS(fpreal t) override
Definition: SOP_Comb.h:174
fpreal OPACITYPRESSURE(fpreal t) override
Definition: SOP_Comb.h:182
void setHitPressure(fpreal p, fpreal t) override
Definition: SOP_Comb.h:135
fpreal HEIGHT(fpreal t) override
Definition: SOP_Comb.h:333
bool wantsCookSelection() const override
Definition: SOP_Comb.h:347
fpreal SYMMETRYORIGY(fpreal t) override
Definition: SOP_Comb.h:303
virtual bool hasStrokeChanged(fpreal t)=0
int AXIS() override
Definition: SOP_Comb.h:217
fpreal FGR(fpreal t) override
Definition: SOP_Comb.h:252
void setFloat(int parmi, int vectori, fpreal t, fpreal value, PRM_AddKeyType add_key=PRM_AK_MARK_PENDING)
fpreal64 fpreal
Definition: SYS_Types.h:283
void setInt(int parmi, int vectori, fpreal t, exint value)
fpreal UPY(fpreal t) override
Definition: SOP_Comb.h:268
fpreal RAYHITW(fpreal t) override
Definition: SOP_Comb.h:238
int PRIMHIT(fpreal t) override
Definition: SOP_Comb.h:242
void ALPHANAME(UT_String &, fpreal) override
Definition: SOP_Comb.h:291
#define SOP_API
Definition: SOP_API.h:10
fpreal ANGLE(fpreal t) override
Definition: SOP_Comb.h:281
int DOUVREFLECTION() override
Definition: SOP_Comb.h:316
fpreal SPLATTER(fpreal t) override
Definition: SOP_Comb.h:275
void setRayOrientation(const UT_Vector3 &orient, fpreal t) override
Definition: SOP_Comb.h:107
void setBrushEvent(SOP_BrushEvent event) override
Definition: SOP_Comb.h:139
GLubyte GLubyte GLubyte GLubyte w
Definition: glcorearb.h:857
virtual bool hasNibLookChanged(fpreal t)=0
exint evalInt(int pi, int vi, fpreal t) const
int USECONNECTIVITY() override
Definition: SOP_Comb.h:325
SOP_BrushEvent
Definition: SOP_BrushBase.h:31
GLboolean r
Definition: glcorearb.h:1222
fpreal SYMMETRYDIST(fpreal t) override
Definition: SOP_Comb.h:313
SOP_BrushShape
Definition: SOP_BrushBase.h:65
constexpr SYS_FORCE_INLINE T & y() noexcept
Definition: UT_Vector3.h:667
const char * inputLabel(OP_InputIdx idx) const override
int OVERRIDEALPHA() override
Definition: SOP_Comb.h:290
fpreal DEPTH(fpreal t) override
Definition: SOP_Comb.h:331
fpreal RAYHITZ(fpreal t) override
Definition: SOP_Comb.h:232
fpreal RAYHITY(fpreal t) override
Definition: SOP_Comb.h:230
fpreal RADIUSPRESSURE(fpreal t) override
Definition: SOP_Comb.h:178
void setRadius(fpreal r, fpreal t) override
Definition: SOP_Comb.h:117
constexpr SYS_FORCE_INLINE T & x() noexcept
Definition: UT_Vector3.h:665
void setUVRadius(fpreal r, fpreal t) override
Definition: SOP_Comb.h:121
void setAccumulateStencil(bool) override
Definition: SOP_Comb.h:98