HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PRM_SpareData.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: PRM_SpareData.h ( PRM Library, C++)
7  *
8  * COMMENTS: This class is used to add additional token/value pairs to a
9  * parameter.
10  */
11 
12 #ifndef __PRM_SpareData__
13 #define __PRM_SpareData__
14 
15 #include "PRM_API.h"
16 #include "PRM_Type.h"
17 
18 #include <CH/CH_ExprLanguage.h>
19 #include <UT/UT_ArrayStringMap.h>
20 #include <UT/UT_Color.h>
21 #include <UT/UT_Variadic.h>
22 
23 #include <SYS/SYS_Types.h>
24 
25 #include <utility>
26 
27 
28 // Namespace to use for built-in parameter tags.
29 // Note that we cannot add the namespace to old built-in tags
30 // for compatibility reasons.
31 #define PRM_SPARE_BUILTIN_NAMESPACE "sidefx::"
32 
33 //
34 // Declarations of built-in parm spare data tokens (tag names).
35 // The entries in this list must be included in `theBuiltInTokenMap`
36 // (see PRM_SpareData.C).
37 //
38 // NOTE: You *must* include the SideFX namespace in the token
39 // when adding a new spare data token.
40 //
41 #define PRM_SPARE_KEY_VALUE_DICT_KEY_LABEL_TOKEN \
42  PRM_SPARE_BUILTIN_NAMESPACE "key_value_dict_key_label"
43 #define PRM_SPARE_KEY_VALUE_DICT_VALUE_LABEL_TOKEN \
44  PRM_SPARE_BUILTIN_NAMESPACE "key_value_dict_value_label"
45 #define PRM_SPARE_KEY_VALUE_DICT_USE_CHOOSER_TOKEN \
46  PRM_SPARE_BUILTIN_NAMESPACE "key_value_dict_use_chooser"
47 #define PRM_SPARE_KEY_VALUE_DICT_CHOOSER_LABEL_TOKEN \
48  PRM_SPARE_BUILTIN_NAMESPACE "key_value_dict_chooser_label"
49 #define PRM_SPARE_KEY_VALUE_DICT_CHOOSER_CALLBACK_TOKEN \
50  PRM_SPARE_BUILTIN_NAMESPACE "key_value_dict_chooser_callback"
51 #define PRM_SPARE_ATTRIB_ACCESS_TOKEN \
52  PRM_SPARE_BUILTIN_NAMESPACE "attrib_access"
53 #define PRM_SPARE_CONNECTOR_KIND \
54  PRM_SPARE_BUILTIN_NAMESPACE "connector_kind"
55 #define PRM_SPARE_CONNECTOR_TYPE \
56  PRM_SPARE_BUILTIN_NAMESPACE "connector_type"
57 #define PRM_SPARE_USDPATHTYPE_TOKEN \
58  PRM_SPARE_BUILTIN_NAMESPACE "usdpathtype"
59 #define PRM_SPARE_USDPATHINPUT_TOKEN \
60  PRM_SPARE_BUILTIN_NAMESPACE "usdpathinput"
61 #define PRM_SPARE_IS_SHADER_PARM_TOKEN \
62  PRM_SPARE_BUILTIN_NAMESPACE "shader_isparm"
63 #define PRM_SPARE_FORCE_SHADER_PARM_VAL_TOKEN \
64  PRM_SPARE_BUILTIN_NAMESPACE "shader_forceparmval"
65 #define PRM_SPARE_SHADER_PARM_TYPE_TOKEN \
66  PRM_SPARE_BUILTIN_NAMESPACE "shader_parmtype"
67 #define PRM_SPARE_SHADER_PARM_NAME_TOKEN \
68  PRM_SPARE_BUILTIN_NAMESPACE "shader_parmname"
69 #define PRM_SPARE_SAVE_VALUE_TOKEN \
70  PRM_SPARE_BUILTIN_NAMESPACE "save_value"
71 #define PRM_SPARE_MAYA_COMPONENT_SELECTION_TYPE_TOKEN \
72  PRM_SPARE_BUILTIN_NAMESPACE "maya_component_selection_type"
73 #define PRM_SPARE_LOOK_TOKEN \
74  PRM_SPARE_BUILTIN_NAMESPACE "look"
75 #define PRM_SPARE_LAYOUT_HEIGHT_TOKEN \
76  PRM_SPARE_BUILTIN_NAMESPACE "layout_height"
77 #define PRM_SPARE_HEADER_TOGGLE_TOKEN \
78  PRM_SPARE_BUILTIN_NAMESPACE "header_toggle"
79 #define PRM_SPARE_HEADER_PARM_TOKEN \
80  PRM_SPARE_BUILTIN_NAMESPACE "header_parm"
81 #define PRM_SPARE_HEADER_LABEL_TOKEN \
82  PRM_SPARE_BUILTIN_NAMESPACE "header_label"
83 #define PRM_SPARE_SLIDER_TOKEN \
84  PRM_SPARE_BUILTIN_NAMESPACE "slider"
85 
86 // When you add a tag above, make sure to add it to $SHS/properties/other/standardparmtags.ds
87 
88 //
89 // Declarations of *old*, built-in parm spare data tokens (tag names).
90 // WARNING: Do not add new spare data tokens to this list!!!
91 // Add the tokens to the new list above and include the SideFX
92 // namespace in the tokens.
93 //
94 #define PRM_SPARE_AUTOSCOPE_TOKEN "autoscope"
95 #define PRM_SPARE_BUTTON_ICON_TOKEN "button_icon"
96 #define PRM_SPARE_CODE_GENERATION_TOKEN "code_generation"
97 #define PRM_SPARE_COLOR_DYN_TOKEN "colordyn"
98 #define PRM_SPARE_COLOR_TYPE_TOKEN "colortype"
99 #define PRM_SPARE_COLOR_WHEEL_TOKEN "colorwheel"
100 #define PRM_SPARE_COOK_DEPENDENT_TOKEN "cook_dependent"
101 #define PRM_SPARE_EDITOR_LANG_TOKEN "editorlang"
102 #define PRM_SPARE_EDITOR_LINES_TOKEN "editorlines"
103 #define PRM_SPARE_EDITOR_TOKEN "editor"
104 #define PRM_SPARE_FILE_CHOOSER_MODE_TOKEN "filechooser_mode"
105 #define PRM_SPARE_FILE_CHOOSER_PATTERN_TOKEN "filechooser_pattern"
106 #define PRM_SPARE_GROUP_TYPE_TOKEN "group_type"
107 #define PRM_SPARE_GROUP_DEFAULT_TOKEN "group_default"
108 #define PRM_SPARE_MULTI_START_OFFSET_TOKEN "multistartoffset"
109 #define PRM_SPARE_NETREF_TOKEN "netref"
110 #define PRM_SPARE_OPFILTER_TOKEN "opfilter"
111 #define PRM_SPARE_OPPATH_KEYWORDS_TOKEN "oppathkeywords"
112 #define PRM_SPARE_OPRELATIVE_TOKEN "oprelative"
113 #define PRM_SPARE_PARM_VOP_TOKEN "parmvop"
114 #define PRM_SPARE_RAMP_BASIS_DEFAULT_TOKEN "rampbasisdefault"
115 #define PRM_SPARE_RAMP_BASIS_TOKEN "rampbasis"
116 #define PRM_SPARE_RAMP_BASIS_VAR_TOKEN "rampbasis_var"
117 #define PRM_SPARE_RAMP_COLOR_DEFAULT_TOKEN "rampcolordefault"
118 #define PRM_SPARE_RAMP_COLOR_TYPE_TOKEN "rampcolortype"
119 #define PRM_SPARE_RAMP_FLOAT_DEFAULT_TOKEN "rampfloatdefault"
120 #define PRM_SPARE_RAMP_KEYS_TOKEN "rampkeys"
121 #define PRM_SPARE_RAMP_KEYS_VAR_TOKEN "rampkeys_var"
122 #define PRM_SPARE_RAMP_SHOW_CONTROLS_DEFAULT_TOKEN "rampshowcontrolsdefault"
123 #define PRM_SPARE_RAMP_VALUES_TOKEN "rampvalues"
124 #define PRM_SPARE_RAMP_VALUES_VAR_TOKEN "rampvalues_var"
125 #define PRM_SPARE_SCRIPT_ACTION_HELP_TOKEN "script_action_help"
126 #define PRM_SPARE_SCRIPT_ACTION_ICON_TOKEN "script_action_icon"
127 #define PRM_SPARE_SCRIPT_ACTION_TOKEN "script_action"
128 #define PRM_SPARE_SCRIPT_CALLBACK_TOKEN "script_callback"
129 #define PRM_SPARE_SCRIPT_CALLBACK_LANGUAGE_TOKEN "script_callback_language"
130 #define PRM_SPARE_SCRIPT_RITYPE_TOKEN "script_ritype"
131 #define PRM_SPARE_SCRIPT_UNQUOTED_TOKEN "script_unquoted"
132 #define PRM_SPARE_SHADER_PARM_CONTEXTS_TOKEN "shaderparmcontexts"
133 #define PRM_SPARE_UNITS_TOKEN "units"
134 #define PRM_SPARE_XCF_MODE_TOKEN "xcfmode"
135 #define PRM_SPARE_VARYING_DEFAULT_TOKEN "varying_default"
136 
137 class UT_BitArray;
138 class UT_StringArray;
139 class UT_StringHolder;
140 class UT_StringRef;
141 class PRM_Parm;
142 class prm_SharedString;
143 
144 typedef int (*PRM_SpareCallback)(const char *token, const char *value);
145 typedef int (*PRM_SpareCallbackWithData)(const char *token,
146  const char *value, void *data);
147 
148 typedef std::pair<const char *, const char *> PRM_SpareToken;
150 
152 {
153 public:
154  /// The constructor for the PRM_SpareData should takes a variadic number of
155  /// token/value pairs. For example:
156  /// static PRM_SpareData(PRM_SpareArgs()
157  /// << PRM_SpareToken("token1", "value1")
158  /// << PRM_SpareToken("token2", "value2")
159  /// ...);
160  explicit PRM_SpareData(const PRM_SpareArgs &args);
161 
162  /// A single token value pair
163  explicit PRM_SpareData(const PRM_SpareToken &pair);
164  PRM_SpareData();
165  ~PRM_SpareData();
166 
168  PRM_SpareData &operator=(const PRM_SpareData &copy);
169 
170  uint entries() const;
171 
172  void clear();
173  void mergeFrom(const PRM_SpareData &ref);
174  void copyFrom(const PRM_SpareData &ref);
175 
176  bool containsAny(const PRM_SpareData &ref) const;
177  bool containsAll(const PRM_SpareData &ref) const;
178 
179  // The the value associated with a particular token.
180  const char *getValue(const UT_StringRef &token) const;
181 
182  // Because these are traverseConst functions, we can't remove any items
183  // from the table in the traversal functions.
184  void traverseConst(PRM_SpareCallback f) const;
185  void traverseConst(PRM_SpareCallbackWithData f, void *data) const;
186 
187 
188  // NOTE: When addTokenValue is called with a null pointer for the value,
189  // the token is deleted from the spare data.
190  void addTokenValue(const UT_StringHolder &token, const char *value);
191  void deleteTokenValue(const UT_StringRef &token);
192 
193  // For backward compatibility with the ScriptParmSpareData class, we have
194  // these functions.
195  static const char *getScriptCallbackToken()
197  void setCallbackData(const char *str)
198  { addTokenValue(getScriptCallbackToken(), str); }
199  const char *getCallbackData() const
200  { return getValue(getScriptCallbackToken()); }
201 
202  static const char *getScriptCallbackLanguageToken()
204  void setCallbackLanguage(CH_ScriptLanguage language);
205  CH_ScriptLanguage getCallbackLanguage() const;
206 
207  void setRenderManType(const char *str)
208  { addTokenValue(PRM_SPARE_SCRIPT_RITYPE_TOKEN, str); }
209  const char *getRenderManType() const
210  { return getValue(PRM_SPARE_SCRIPT_RITYPE_TOKEN); }
211 
212  void setOpFilter(const char *str)
213  { addTokenValue(PRM_SPARE_OPFILTER_TOKEN, str); }
214  const char *getOpFilter() const
215  { return getValue(PRM_SPARE_OPFILTER_TOKEN); }
216 
217  void setOpRelative(const char *str)
218  { addTokenValue(PRM_SPARE_OPRELATIVE_TOKEN, str); }
219  const char *getOpRelative() const
220  { return getValue(PRM_SPARE_OPRELATIVE_TOKEN); }
221 
222  static const char * getUnquotedStateToken()
225  { addTokenValue(getUnquotedStateToken(), "1"); }
226  bool getUnquotedState() const
227  { return getValue(getUnquotedStateToken()) != 0; }
228 
229  void setMultiStartOffset(int value);
230  int getMultiStartOffset() const;
231 
232  void setVisibleTabs(const UT_BitArray &values);
233  void getVisibleTabs(UT_BitArray &values) const;
234  bool getVisibleTab(int tabidx) const;
235 
236  // Ramp
237  static const char * getRampBasisDefaultToken()
239  void setRampBasisDefault(const char *value)
240  { addTokenValue(getRampBasisDefaultToken(),value); }
241  const char * getRampBasisDefault() const
242  { return getValue(getRampBasisDefaultToken()); }
243 
244  static const char * getRampShowControlsDefaultToken()
246  void setRampShowControlsDefault(bool value)
247  {
248  addTokenValue(getRampShowControlsDefaultToken(),
249  value ? "1" : "0");
250  }
252  {
253  const char *n, *v;
254  n = getRampShowControlsDefaultToken();
255  v = getValue(n);
256  if (!v)
257  return true;
258  else
259  return *v != '0';
260  }
261 
262  static const char * getRampColorTypeToken()
264  static const char * getRampColorTypeValueToken(UT_ColorType color_type);
265  void setRampColorType(UT_ColorType color_type);
266  UT_ColorType getRampColorType() const;
267 
268  static const char * getRampBasisVarToken()
270  static const char * getRampKeysVarToken()
272  static const char * getRampValuesVarToken()
274 
275  void setRampBasisVar(const char *value)
276  { addTokenValue(getRampBasisVarToken(), value); }
277  const char * getRampBasisVar() const
278  { return getValue(getRampBasisVarToken()); }
279  void setRampKeysVar(const char *value)
280  { addTokenValue(getRampKeysVarToken(), value); }
281  const char * getRampKeysVar() const
282  { return getValue(getRampKeysVarToken()); }
283  void setRampValuesVar(const char *value)
284  { addTokenValue(getRampValuesVarToken(), value); }
285  const char * getRampValuesVar() const
286  { return getValue(getRampValuesVarToken()); }
287 
288  static const char * getColorRampDefaultToken()
290  const char * getColorRampDefaultValue() const
291  { return getValue(getColorRampDefaultToken()); }
292  static const char * getFloatRampDefaultToken()
294  const char * getFloatRampDefaultValue() const
295  { return getValue(getFloatRampDefaultToken()); }
296  void setRampDefaultFromParm(const PRM_Parm &ramp_parm);
297  void getRampDefaultToParm(PRM_Parm &ramp_parm) const;
298 
299  // Color UI Mode, Wheel flag and Dynamic flag
300  static const char * getColorTypeToken()
301  { return PRM_SPARE_COLOR_TYPE_TOKEN; }
302  static const char * getColorTypeValueToken(PRM_ColorType color_type);
303  void setColorType(PRM_ColorType color_type);
304  PRM_ColorType getColorType() const;
305 
306  static const char * getColorWheelToken()
307  { return PRM_SPARE_COLOR_WHEEL_TOKEN; }
308  void setColorWheel(bool value);
309  bool getColorWheel() const;
310 
311  static const char * getColorDynamicToken()
312  { return PRM_SPARE_COLOR_DYN_TOKEN; }
313  void setColorDynamic(bool value);
314  bool getColorDynamic() const;
315 
316  static const char * getKeyValueDictKeyLabelToken()
318  void setKeyValueDictKeyLabel(const char *label);
319  const char *getKeyValueDictKeyLabel() const;
320  static const char * getKeyValueDictValueLabelToken()
322  void setKeyValueDictValueLabel(const char *label);
323  const char *getKeyValueDictValueLabel() const;
324  static const char * getKeyValueDictUseChooserToken()
326  void setKeyValueDictUseChooser(bool use_chooser);
327  bool getKeyValueDictUseChooser() const;
328  static const char * getKeyValueDictChooserLabelToken()
330  void setKeyValueDictChooserLabel(const char *label);
331  const char *getKeyValueDictChooserLabel() const;
334  void setKeyValueDictChooserCallback(const char *label);
335  const char *getKeyValueDictChooserCallback() const;
336 
337  void setXCFMode(const char *value)
338  { return addTokenValue(PRM_SPARE_XCF_MODE_TOKEN, value); }
339  const char *getXCFMode() const
340  { return getValue(PRM_SPARE_XCF_MODE_TOKEN); }
341 
342  const char *getScriptAction() const;
343  const char *getScriptActionHelp() const;
344  const char *getScriptActionIcon() const;
345  const char *getButtonIcon() const;
346 
347  bool getUseEditor() const;
348  /// The string will be treated as this language for syntax highlighting
349  /// and and completion. NOTE: Language names are case insensitive, you
350  /// should accept both VEX, Vex, and vex.
351  const char *getEditorLanguage() const
352  { return getValue(PRM_SPARE_EDITOR_LANG_TOKEN); }
353  void getEditorLinesRange(int &lines_min, int &lines_max) const;
354  static inline int getEditorLinesRangeDefaultMin() { return 8; }
355  static inline int getEditorLinesRangeDefaultMax() { return 40; }
356 
357  static const char *getXCFModeFloatValToken() { return "float"; }
358 
359  // Token for whether the template will be used for cooking
360  static const char * getCookDependentToken()
362  // Get state of cook_dependent flag.
363  // This is only used for SPARE parameters, which if this tag doesn't exist,
364  // the spare parm defaults to false for cook dependent.
365  bool getCookDependent() const;
366  // Set state of cook_dependent flag.
367  // This is only used for SPARE parameters, which if this tag doesn't exist,
368  // the spare parm defaults to false for cook dependent.
369  void setCookDependent(bool flag);
370 
371  // Token for whether the parm on the VOP should regenerate code
372  static const char *getCodeGenDependentToken()
374  // Get the state of the code_generation flag
375  // This is only used for SPARE parameters, which if this tag doesn't exist,
376  // the spare parm defaults to true for code generation
377  bool getCodeGenDependent() const;
378  // Set state of code_generation flag.
379  // This is only used for SPARE parameters, which if this tag doesn't exist,
380  // the spare parm defaults to true for code generation
381  void setCodeGenDependent(bool flag);
382 
383  int64 getMemoryUsage(bool inclusive) const;
384 
385  static const char *getOpFilterKeyFromName(const char *name);
386  static const char *getOpFilterKeyFromLabel(const char *name);
387  static const char *getOpFilterNameFromKey(const char *key);
388  static const char *getOpFilterLabelFromKey(const char *key);
389  // End of backward compatibility
390 
391  // Convenience spare data you might want to use
392  static PRM_SpareData objNetRef; // /obj
393  static PRM_SpareData chNetRef; // /ch
394  static PRM_SpareData ropNetRef; // /out
395 
396  static PRM_SpareData objPath; // !!OBJ!!
397  static PRM_SpareData objGeometryPath; // !!OBJ/GEOMETRY!!
398  static PRM_SpareData objLightPath; // !!OBJ/LIGHT!!
399  static PRM_SpareData objBonePath; // !!OBJ/BONE!!
400  static PRM_SpareData objMusclePath; // !!OBJ/MUSCLE!!
401  static PRM_SpareData objCameraPath; // !!OBJ/CAMERA!!
402  static PRM_SpareData dopPath; // !!DOP!!
403  static PRM_SpareData sopPath; // !!SOP!!
404  static PRM_SpareData popPath; // !!POP!!
405  static PRM_SpareData ropPath; // !!ROP!!
406  static PRM_SpareData cop2Path; // !!COP2!!
407  static PRM_SpareData chopPath; // !!CHOP!!
408  static PRM_SpareData constraintsPath; // !!CHOP!!
409  static PRM_SpareData shopPath; // !!SHOP!!
410  static PRM_SpareData shopProperties; // !!SHOP/PROPERTIES!!
411  static PRM_SpareData shopMaterial; // !!SHOP/MATERIAL!!
412  static PRM_SpareData shopSurface; // !!SHOP/SURFACE!!
413  static PRM_SpareData shopDisplacement; // !!SHOP/DISPLACEMENT!!
414  static PRM_SpareData shopSurfaceShadow; // !!SHOP/SURFACE_SHADOW!!
415  static PRM_SpareData shopBackground; // !!SHOP/BACKGROUND!!
416  static PRM_SpareData shopGeometry; // !!SHOP/GEOMETRY!!
417  static PRM_SpareData shopAtmosphere; // !!SHOP/ATMOSPHERE!!
418  static PRM_SpareData shopPhoton; // !!SHOP/PHOTON!!
419  static PRM_SpareData shopPhotonVolume; // !!SHOP/PHOTONVOLUME!!
420  static PRM_SpareData shopContour; // !!SHOP/CONTOUR!!
421  static PRM_SpareData shopLight; // !!SHOP/LIGHT!!
422  static PRM_SpareData shopEmitter; // !!SHOP/EMITTER!!
423  static PRM_SpareData shopLightShadow; // !!SHOP/LIGHT_SHADOW!!
424  static PRM_SpareData shopLens; // !!SHOP/LENS!!
425  static PRM_SpareData shopOutput; // !!SHOP/OUTPUT!!
426  static PRM_SpareData shopContourStore; // !!SHOP/CONTOUR_STORE!!
427  static PRM_SpareData shopContourContrast; // !!SHOP/CONTOUR_CONTRAST!!
428  static PRM_SpareData shopImage3d; // !!SHOP/IMAGE3D!!
429  static PRM_SpareData shopCVEX; // !!SHOP/CVEX!!
430  static PRM_SpareData shopCoShader; // !!SHOP/COSHADER!!
431  static PRM_SpareData vopPath; // !!VOP!!
432  static PRM_SpareData lopPath; // !!LOP!!
433  static PRM_SpareData topPath; // !!TOP!!
434  static PRM_SpareData topSchedulerPath; // !!TOP/SCHEDULER!!
435  static PRM_SpareData topProcessorPath; // !!TOP/PROCESSOR!!
436  static PRM_SpareData topPartitionerPath; // !!TOP/PARTITIONER!!
437  static PRM_SpareData topMapperPath; // !!TOP/MAPPER!!
438  static PRM_SpareData filterMaterial; // !!CUSTOM/MATERIAL!!
439 
440  static PRM_SpareData autoScope; // autoscope
441 
442  static PRM_SpareData multiStartOffsetZero; // multistart offset of zero
443  static PRM_SpareData multiStartOffsetOne; // multistart offset of one
444 
448  static PRM_SpareData unitsMass; // kg1
449  static PRM_SpareData unitsPerMass; // kg-1
450  static PRM_SpareData unitsTime; // s1
453  static PRM_SpareData unitsVelocity; // m1s-1
457  static PRM_SpareData unitsForce; // kg1m1s-2
458  static PRM_SpareData unitsForceDensity; // kg1m-2s-2
459  static PRM_SpareData unitsImpulse; // kg1m1s-1
460  static PRM_SpareData unitsTorque; // kg1m2s-2
461  static PRM_SpareData unitsDrag; // kg1s-1
462  static PRM_SpareData unitsAngDrag; // kg1m2s-1
463  static PRM_SpareData unitsPressure; // kg1m-1s-2
468  static PRM_SpareData unitsAreaDensity; // kg1m-2
471  static PRM_SpareData unitsDensity; // kg1m-3
472  static PRM_SpareData unitsDensityPerTime; // kg1m-3s-1
474  static PRM_SpareData unitsNone; // ""
475 
476  static PRM_SpareData rampBasisDefault; // rampbasis "ramp_basis"
477  static PRM_SpareData rampKeysDefault; // rampkeys "ramp_keys"
478  static PRM_SpareData rampValuesDefault; // rampvalues "ramp_values"
479 
480  static PRM_SpareData attribAccessR; // "sidefx::attrib_access" "read"
481  static PRM_SpareData attribAccessW; // "sidefx::attrib_access" "write"
482  static PRM_SpareData attribAccessRW; // "sidefx::attrib_access" "readwrite"
483 
484  static PRM_SpareData connectorKindNone; // "sidefx::connector_kind" "none"
485  static PRM_SpareData connectorKindIn; // "sidefx::connector_kind" "in"
486  static PRM_SpareData connectorKindOut; // "sidefx::connector_kind" "out"
487  static PRM_SpareData connectorKindInOut;// "sidefx::connector_kind" "inout"
488 
489  static PRM_SpareData shaderIsShaderParm; // "sidefx::shader_isparm" "1"
490  static PRM_SpareData shaderIsNotShaderParm; // "sidefx::shader_isparm" "0"
491 
492  /// Used to set a space- or comma-separated list of globs to use as
493  /// file filter for parameters of type @c PRM_FILE (e.g. "*.txt *.log").
494  static const char *getFileChooserPatternToken()
496 
497  static const char *getFileChooserModeToken()
499  static const char *getFileChooserModeValRead()
500  { return "read"; }
501  static const char *getFileChooserModeValWrite()
502  { return "write"; }
503  static const char *getFileChooserModeValReadAndWrite()
504  { return "read_and_write"; }
505 
506  static PRM_SpareData fileChooserModeRead; // filechooser_mode "read"
507  static PRM_SpareData fileChooserModeWrite; // filechooser_mode "write"
508  static PRM_SpareData fileChooserModeReadAndWrite; // ... "read_and_write"
509 
510  static PRM_SpareData stringFloatXCF; // float XCF in string field
511 
512  static const char *getScriptActionToken()
514  static const char *getScriptActionHelpToken()
516  static const char *getScriptActionIconToken()
518  static const char *getButtonIconToken()
519  { return PRM_SPARE_BUTTON_ICON_TOKEN; }
520 
521  static const char *getEditorToken()
522  { return PRM_SPARE_EDITOR_TOKEN; }
523  static PRM_SpareData stringEditor; // Use a text editor for strings
524 
525  static const char *getEditorLanguageToken()
526  { return PRM_SPARE_EDITOR_LANG_TOKEN; }
531 
532  /// Number of lines to show by default. This value can be set as either
533  /// a single number or a range, e.g. '10-50'. The minimum number is what
534  /// the editor will originally show up as, but will attempt to expand up to
535  /// the maximum.
536  static const char *getEditorLinesRangeToken()
537  { return PRM_SPARE_EDITOR_LINES_TOKEN; }
538 
539  // token indicating the parameter comes from a Parameter VOP (ie it is a
540  // shader parameter)
541  static const char * getParmVopVarToken()
542  { return PRM_SPARE_PARM_VOP_TOKEN; }
543 
544  // space-separated list of shading contexts, which a material parameter
545  // belongs to, ie, shaders for each of these contexts actually have
546  // this parameter as an argument, since material may contain other shaders
547  // for other contexts to which a parameter does not apply
548  static const char * getShaderParmContextsToken()
550 
551  // token specifying special keywords that are legal in an oppath parameter
552  // (in addition to the node path itself)
553  static const char * getOpPathKeywordsToken()
555 
556  // token for unit specification
557  static const char * getUnitsToken()
558  { return PRM_SPARE_UNITS_TOKEN; }
559 
560  // token for group specialization (simple/collapsible/toggle groups).
561  static const char *getGroupTypeToken()
562  { return PRM_SPARE_GROUP_TYPE_TOKEN; }
568  static const char *getGroupDefaultToken()
570 
571  // Marks parameter has having varying default values
572  // Defaults to "0"
573  static const char *getVaryingDefaultToken()
576  bool getHasVaryingDefault() const;
577  void setHasVaryingDefault(bool f);
578 
579  // Gets information about whether this parm accepts one or more USD
580  // primitive paths, and/or USD collections.
581  static const char *getUsdPathTypeToken()
582  { return PRM_SPARE_USDPATHTYPE_TOKEN; }
585  const char *getUsdPathType() const;
586 
587  // Gets a value that describes which input's stage is the source for
588  // the primitive(s) in this parameter. This string is evaluated by the
589  // CH_Manager, so it can be a constant (0, 1, or 2) or an expression
590  // that looks at other parameter values.
591  static const char *getUsdPathInputToken()
592  { return PRM_SPARE_USDPATHINPUT_TOKEN; }
595  const char *getUsdPathInput() const;
596 
597  // Identifies the node parameter as shader parameter.
598  static const char *getIsShaderParmToken()
600 
601  // Forces the translation of shader parameter even if it's at default value.
602  static const char *getForceParmValueToken()
604 
605  // Marks a data parm for whether or not it should be saved to disk
606  static const char *getSaveValueToken()
607  { return PRM_SPARE_SAVE_VALUE_TOKEN; }
608  static PRM_SpareData saveValueAlways; // "sidefx::save_value" "1"
609  static PRM_SpareData saveValueNever; // "sidefx::save_value" "0"
610  const char *getSaveValue() const;
611  void setSaveValue(bool flag);
612 
613  // Houdini Engine for Maya: Informs Maya that this parameter should be able
614  // to be set by component selection.
621 
622  // Changes the look of the parm. Used to switch between separator and spacer
623  // Height is used to adjust the dimension of the parameter (value * 0.1 inches)
624  static const char *getLookToken()
625  { return PRM_SPARE_LOOK_TOKEN; }
626  static const char *getLayoutHeightToken()
628  const char *getLookValue() const;
629  void setLookValue(const char *value);
630  const char *getLayoutHeightValue() const;
631  void setLayoutHeightValue(const char *value);
632  static PRM_SpareData lookBlank; // "sidefx::look" "blank"
633  static PRM_SpareData lookClassic; // "sidefx::look" "classic"
634  static PRM_SpareData lookIcon; // "sidefx::look" "icon"
635  static PRM_SpareData lookHeading; // "sidefx::look" "heading"
636  static PRM_SpareData lookBlock; // "sidefx::look" "block"
637  static PRM_SpareData layoutHeightSmall; // "sidefx::layout_height" "small"
638  static PRM_SpareData layoutHeightMedium; // "sidefx::layout_height" "medium"
639  static PRM_SpareData layoutHeightLarge; // "sidefx::layout_height" "large"
640 
641  // Header toggle reference for the collapsible folder
642  static const char *getHeaderToggleToken()
644 
645  // Header parm reference for the collapsible folder
646  static const char *getHeaderParmToken()
647  { return PRM_SPARE_HEADER_PARM_TOKEN; }
648 
649  // Header label reference for the collapsible folder
650  static const char *getHeaderLabelToken()
651  { return PRM_SPARE_HEADER_LABEL_TOKEN; }
652 
653  // Slider options. Snap or non-snap
654  static const char *getSliderToken()
655  { return PRM_SPARE_SLIDER_TOKEN; }
656  static PRM_SpareData sliderSnapToInt; // "sidefx::slider" "snap_to_int"
657  static PRM_SpareData sliderNone; // "sidefx::slider" "none"
658 
659  /// Return true if the given token is a built-in (internally used) spare
660  /// data token.
661  static bool isBuiltInToken(const UT_StringRef &token);
662 
663  /// Return a range of the built-in tags names.
664  static void builtInTokens(UT_StringArray &tokens);
665 
666 private:
668 };
669 
670 #endif
static PRM_SpareData mayaComponentSelectionTypeFace
static PRM_SpareData objLightPath
static PRM_SpareData objMusclePath
static PRM_SpareData shopOutput
GLint ref
Definition: glcorearb.h:124
static const char * getVaryingDefaultToken()
static PRM_SpareData shopEmitter
static PRM_SpareToken groupTypeCollapsibleToken
static PRM_SpareData stringEditorLangPython
static const char * getColorWheelToken()
static PRM_SpareData rampValuesDefault
#define PRM_SPARE_OPRELATIVE_TOKEN
static PRM_SpareData unitsTime
const char * getXCFMode() const
#define PRM_SPARE_SCRIPT_ACTION_HELP_TOKEN
static PRM_SpareData shopCVEX
#define PRM_SPARE_COLOR_TYPE_TOKEN
Definition: PRM_SpareData.h:98
#define PRM_SPARE_CODE_GENERATION_TOKEN
Definition: PRM_SpareData.h:96
#define PRM_SPARE_MAYA_COMPONENT_SELECTION_TYPE_TOKEN
Definition: PRM_SpareData.h:71
static PRM_SpareData unitsLinearDensity
static PRM_SpareData topSchedulerPath
static const char * getEditorLanguageToken()
static const char * getRampColorTypeToken()
static const char * getXCFModeFloatValToken()
static PRM_SpareData vopPath
static PRM_SpareData ropPath
static PRM_SpareData connectorKindIn
const char * getEditorLanguage() const
const char * getOpFilter() const
static PRM_SpareData sliderSnapToInt
static const char * getLookToken()
#define PRM_SPARE_USDPATHINPUT_TOKEN
Definition: PRM_SpareData.h:59
void setCallbackData(const char *str)
static PRM_SpareData shopPath
static PRM_SpareData dopPath
static PRM_SpareData unitsImpulse
static PRM_SpareData shopDisplacement
static PRM_SpareData connectorKindNone
static PRM_SpareData fileChooserModeReadAndWrite
OIIO_UTIL_API bool copy(string_view from, string_view to, std::string &err)
static const char * getCookDependentToken()
#define PRM_SPARE_XCF_MODE_TOKEN
void setXCFMode(const char *value)
#define PRM_SPARE_RAMP_BASIS_DEFAULT_TOKEN
static const char * getRampKeysVarToken()
#define PRM_SPARE_RAMP_BASIS_VAR_TOKEN
static PRM_SpareData shaderIsShaderParm
#define PRM_SPARE_SCRIPT_CALLBACK_LANGUAGE_TOKEN
static const char * getScriptCallbackLanguageToken()
static const char * getParmVopVarToken()
#define PRM_SPARE_SCRIPT_ACTION_ICON_TOKEN
static PRM_SpareData stringFloatXCF
#define PRM_SPARE_SLIDER_TOKEN
Definition: PRM_SpareData.h:83
static PRM_SpareData unitsPerMass
static PRM_SpareData stringEditorLangExpr
static const char * getButtonIconToken()
#define PRM_SPARE_LOOK_TOKEN
Definition: PRM_SpareData.h:73
static PRM_SpareData shopSurface
static const char * getScriptCallbackToken()
static PRM_SpareData objGeometryPath
bool getUnquotedState() const
static const char * getRampBasisDefaultToken()
static PRM_SpareData unitsPressure
static PRM_SpareData topProcessorPath
#define PRM_SPARE_SCRIPT_RITYPE_TOKEN
#define PRM_SPARE_RAMP_FLOAT_DEFAULT_TOKEN
const char * getRampBasisDefault() const
static const char * getHeaderParmToken()
static const char * getKeyValueDictChooserLabelToken()
static PRM_SpareToken usdPathTypePrim
static PRM_SpareData layoutHeightMedium
static const char * getGroupTypeToken()
#define PRM_SPARE_KEY_VALUE_DICT_CHOOSER_CALLBACK_TOKEN
Definition: PRM_SpareData.h:49
static PRM_SpareData stringEditor
GLuint const GLchar * name
Definition: glcorearb.h:786
static PRM_SpareData shopPhoton
static PRM_SpareData groupTypeCollapsibleExpanded
static PRM_SpareData unitsPerSquareTime
void setUnquotedState()
std::pair< const char *, const char * > PRM_SpareToken
UT_VariadicT< PRM_SpareToken > PRM_SpareArgs
#define PRM_SPARE_SAVE_VALUE_TOKEN
Definition: PRM_SpareData.h:69
static const char * getFileChooserPatternToken()
static PRM_SpareData unitsPerLength
#define PRM_SPARE_IS_SHADER_PARM_TOKEN
Definition: PRM_SpareData.h:61
static PRM_SpareData attribAccessW
#define PRM_SPARE_RAMP_VALUES_VAR_TOKEN
static PRM_SpareData shopContourContrast
static PRM_SpareData attribAccessRW
static PRM_SpareData topPath
#define PRM_SPARE_UNITS_TOKEN
static const char * getHeaderToggleToken()
#define PRM_SPARE_OPPATH_KEYWORDS_TOKEN
static const char * getIsShaderParmToken()
#define PRM_SPARE_HEADER_TOGGLE_TOKEN
Definition: PRM_SpareData.h:77
static PRM_SpareData multiStartOffsetOne
GLenum GLsizei GLsizei GLint * values
Definition: glcorearb.h:1602
static PRM_SpareData unitsAngVelocity
static PRM_SpareData cop2Path
static const char * getSliderToken()
#define PRM_SPARE_KEY_VALUE_DICT_USE_CHOOSER_TOKEN
Definition: PRM_SpareData.h:45
static const char * getKeyValueDictUseChooserToken()
static PRM_SpareData groupTypeCollapsible
#define PRM_SPARE_GROUP_DEFAULT_TOKEN
#define PRM_SPARE_SCRIPT_CALLBACK_TOKEN
static PRM_SpareData shopAtmosphere
#define PRM_SPARE_KEY_VALUE_DICT_VALUE_LABEL_TOKEN
Definition: PRM_SpareData.h:43
static PRM_SpareData unitsAreaDensity
static PRM_SpareData unitsLinearDensityPerSquareTime
static const char * getUnitsToken()
#define PRM_SPARE_FILE_CHOOSER_MODE_TOKEN
static PRM_SpareData chNetRef
const char * getCallbackData() const
static int getEditorLinesRangeDefaultMin()
static PRM_SpareData unitsMass
static PRM_SpareData rampBasisDefault
static PRM_SpareData unitsDrag
static PRM_SpareData objNetRef
static const char * getKeyValueDictKeyLabelToken()
#define PRM_SPARE_EDITOR_LINES_TOKEN
static PRM_SpareData sopPath
static PRM_SpareData topMapperPath
static const char * getScriptActionIconToken()
static PRM_SpareData connectorKindInOut
static PRM_SpareData filterMaterial
static PRM_SpareToken usdPathInputFirst
static PRM_SpareData varyingDefault
static PRM_SpareData unitsLength
const GLdouble * v
Definition: glcorearb.h:837
const char * getFloatRampDefaultValue() const
static const char * getOpPathKeywordsToken()
static PRM_SpareData unitsAngDrag
GLuint GLsizei const GLchar * label
Definition: glcorearb.h:2545
#define PRM_SPARE_COLOR_WHEEL_TOKEN
Definition: PRM_SpareData.h:99
#define PRM_SPARE_VARYING_DEFAULT_TOKEN
static PRM_SpareData saveValueAlways
static PRM_SpareData topPartitionerPath
static PRM_SpareToken groupTypeSimpleToken
static PRM_SpareData shopContour
const char * getOpRelative() const
static const char * getKeyValueDictChooserCallbackToken()
static PRM_SpareData unitsTorque
static const char * getEditorLinesRangeToken()
#define PRM_SPARE_RAMP_COLOR_DEFAULT_TOKEN
long long int64
Definition: SYS_Types.h:116
static const char * getCodeGenDependentToken()
static PRM_SpareData unitsLinearDensityPerTime
typedef int(WINAPI *PFNWGLRELEASEPBUFFERDCARBPROC)(HPBUFFERARB hPbuffer
static PRM_SpareData rampKeysDefault
bool getRampShowControlsDefault() const
static PRM_SpareData shopBackground
static const char * getKeyValueDictValueLabelToken()
static PRM_SpareData shopContourStore
static const char * getColorDynamicToken()
static PRM_SpareData unitsForce
static const char * getColorRampDefaultToken()
static PRM_SpareData saveValueNever
#define PRM_SPARE_LAYOUT_HEIGHT_TOKEN
Definition: PRM_SpareData.h:75
static PRM_SpareData sliderNone
static PRM_SpareData multiStartOffsetZero
static PRM_SpareData shopProperties
static const char * getUsdPathTypeToken()
const char * getRampBasisVar() const
static PRM_SpareData constraintsPath
static const char * getRampValuesVarToken()
static const char * getGroupDefaultToken()
#define PRM_SPARE_COOK_DEPENDENT_TOKEN
GLdouble n
Definition: glcorearb.h:2008
static PRM_SpareData layoutHeightSmall
static PRM_SpareData shaderIsNotShaderParm
GLboolean * data
Definition: glcorearb.h:131
static PRM_SpareData unitsNone
static const char * getRampShowControlsDefaultToken()
void setOpFilter(const char *str)
#define PRM_SPARE_HEADER_LABEL_TOKEN
Definition: PRM_SpareData.h:81
#define PRM_SPARE_KEY_VALUE_DICT_CHOOSER_LABEL_TOKEN
Definition: PRM_SpareData.h:47
static const char * getShaderParmContextsToken()
#define PRM_SPARE_RAMP_COLOR_TYPE_TOKEN
static const char * getMayaComponentSelectionTypeToken()
static PRM_SpareData ropNetRef
#define PRM_SPARE_KEY_VALUE_DICT_KEY_LABEL_TOKEN
Definition: PRM_SpareData.h:41
static PRM_SpareData unitsAcceleration
static PRM_SpareData shopGeometry
static const char * getFileChooserModeToken()
PRM_ColorType
Definition: PRM_Type.h:434
static PRM_SpareData unitsAreaDensityPerSquareTime
static PRM_SpareData shopMaterial
static PRM_SpareData chopPath
UT_ColorType
Definition: UT_Color.h:24
static const char * getHeaderLabelToken()
const char * getColorRampDefaultValue() const
void setRampBasisDefault(const char *value)
#define PRM_SPARE_PARM_VOP_TOKEN
#define PRM_SPARE_SCRIPT_ACTION_TOKEN
#define PRM_SPARE_SCRIPT_UNQUOTED_TOKEN
void setRampKeysVar(const char *value)
static PRM_SpareData objCameraPath
static PRM_SpareData groupTypeSimple
void setRenderManType(const char *str)
#define PRM_SPARE_OPFILTER_TOKEN
static PRM_SpareData shopLightShadow
static PRM_SpareData fileChooserModeWrite
#define PRM_SPARE_RAMP_SHOW_CONTROLS_DEFAULT_TOKEN
const char * getRampValuesVar() const
const char * getRampKeysVar() const
static PRM_SpareData stringEditorLangHScript
static const char * getFloatRampDefaultToken()
static PRM_SpareData unitsDensityPerSquareTime
#define PRM_SPARE_EDITOR_LANG_TOKEN
#define PRM_SPARE_FORCE_SHADER_PARM_VAL_TOKEN
Definition: PRM_SpareData.h:63
static PRM_SpareData unitsAngAcceleration
static PRM_SpareData shopImage3d
static PRM_SpareData stringEditorLangVex
static PRM_SpareData connectorKindOut
static int getEditorLinesRangeDefaultMax()
const char * getRenderManType() const
#define PRM_SPARE_BUTTON_ICON_TOKEN
Definition: PRM_SpareData.h:95
#define PRM_SPARE_HEADER_PARM_TOKEN
Definition: PRM_SpareData.h:79
static PRM_SpareData lookHeading
static const char * getColorTypeToken()
static PRM_SpareData mayaComponentSelectionTypeVertex
#define PRM_SPARE_RAMP_KEYS_VAR_TOKEN
GLsizei const GLfloat * value
Definition: glcorearb.h:824
static const char * getFileChooserModeValRead()
GLfloat f
Definition: glcorearb.h:1926
**If you just want to fire and args
Definition: thread.h:609
static PRM_SpareData objBonePath
void setRampShowControlsDefault(bool value)
static PRM_SpareData shopPhotonVolume
static PRM_SpareData unitsDensity
static PRM_SpareToken usdPathInputSecond
static const char * getUsdPathInputToken()
Definition: core.h:1131
static PRM_SpareData mayaComponentSelectionTypeUV
static PRM_SpareData lookBlock
static PRM_SpareData mayaComponentSelectionTypeEdge
static const char * getScriptActionHelpToken()
static PRM_SpareData autoScope
static PRM_SpareData shopLens
static const char * getUnquotedStateToken()
static const char * getSaveValueToken()
static PRM_SpareData shopLight
static PRM_SpareData unitsPerArea
static const char * getEditorToken()
static PRM_SpareData unitsSpringConstant
void setOpRelative(const char *str)
static PRM_SpareData lopPath
static PRM_SpareData unitsDensityPerTime
static PRM_SpareData unitsForceDensity
#define PRM_SPARE_SHADER_PARM_CONTEXTS_TOKEN
static const char * getScriptActionToken()
static const char * getRampBasisVarToken()
static PRM_SpareData shopSurfaceShadow
static const char * getFileChooserModeValWrite()
void setRampBasisVar(const char *value)
static const char * getForceParmValueToken()
#define PRM_API
Definition: PRM_API.h:10
static PRM_SpareData unitsAreaDensityPerTime
#define PRM_SPARE_COLOR_DYN_TOKEN
Definition: PRM_SpareData.h:97
unsigned int uint
Definition: SYS_Types.h:45
static PRM_SpareData shopCoShader
int(* PRM_SpareCallbackWithData)(const char *token, const char *value, void *data)
void setRampValuesVar(const char *value)
static PRM_SpareData lookIcon
#define PRM_SPARE_USDPATHTYPE_TOKEN
Definition: PRM_SpareData.h:57
static PRM_SpareData layoutHeightLarge
static PRM_SpareData popPath
static PRM_SpareData lookBlank
Definition: format.h:895
static PRM_SpareData unitsPerTime
static PRM_SpareData lookClassic
static PRM_SpareData objPath
CH_ScriptLanguage
#define PRM_SPARE_GROUP_TYPE_TOKEN
static const char * getLayoutHeightToken()
static PRM_SpareData unitsVelocity
static PRM_SpareData attribAccessR
int(* PRM_SpareCallback)(const char *token, const char *value)
static PRM_SpareToken usdPathTypePrimList
#define PRM_SPARE_FILE_CHOOSER_PATTERN_TOKEN
static PRM_SpareData fileChooserModeRead
static const char * getFileChooserModeValReadAndWrite()
#define PRM_SPARE_EDITOR_TOKEN