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 
74 //
75 // Declarations of *old*, built-in parm spare data tokens (tag names).
76 // WARNING: Do not add new spare data tokens to this list!!!
77 // Add the tokens to the new list above and include the SideFX
78 // namespace in the tokens.
79 //
80 #define PRM_SPARE_AUTOSCOPE_TOKEN "autoscope"
81 #define PRM_SPARE_BUTTON_ICON_TOKEN "button_icon"
82 #define PRM_SPARE_CODE_GENERATION_TOKEN "code_generation"
83 #define PRM_SPARE_COLOR_DYN_TOKEN "colordyn"
84 #define PRM_SPARE_COLOR_TYPE_TOKEN "colortype"
85 #define PRM_SPARE_COLOR_WHEEL_TOKEN "colorwheel"
86 #define PRM_SPARE_COOK_DEPENDENT_TOKEN "cook_dependent"
87 #define PRM_SPARE_EDITOR_LANG_TOKEN "editorlang"
88 #define PRM_SPARE_EDITOR_LINES_TOKEN "editorlines"
89 #define PRM_SPARE_EDITOR_TOKEN "editor"
90 #define PRM_SPARE_FILE_CHOOSER_MODE_TOKEN "filechooser_mode"
91 #define PRM_SPARE_FILE_CHOOSER_PATTERN_TOKEN "filechooser_pattern"
92 #define PRM_SPARE_GROUP_TYPE_TOKEN "group_type"
93 #define PRM_SPARE_GROUP_DEFAULT_TOKEN "group_default"
94 #define PRM_SPARE_MULTI_START_OFFSET_TOKEN "multistartoffset"
95 #define PRM_SPARE_NETREF_TOKEN "netref"
96 #define PRM_SPARE_OPFILTER_TOKEN "opfilter"
97 #define PRM_SPARE_OPPATH_KEYWORDS_TOKEN "oppathkeywords"
98 #define PRM_SPARE_OPRELATIVE_TOKEN "oprelative"
99 #define PRM_SPARE_PARM_VOP_TOKEN "parmvop"
100 #define PRM_SPARE_RAMP_BASIS_DEFAULT_TOKEN "rampbasisdefault"
101 #define PRM_SPARE_RAMP_BASIS_TOKEN "rampbasis"
102 #define PRM_SPARE_RAMP_BASIS_VAR_TOKEN "rampbasis_var"
103 #define PRM_SPARE_RAMP_COLOR_DEFAULT_TOKEN "rampcolordefault"
104 #define PRM_SPARE_RAMP_COLOR_TYPE_TOKEN "rampcolortype"
105 #define PRM_SPARE_RAMP_FLOAT_DEFAULT_TOKEN "rampfloatdefault"
106 #define PRM_SPARE_RAMP_KEYS_TOKEN "rampkeys"
107 #define PRM_SPARE_RAMP_KEYS_VAR_TOKEN "rampkeys_var"
108 #define PRM_SPARE_RAMP_SHOW_CONTROLS_DEFAULT_TOKEN "rampshowcontrolsdefault"
109 #define PRM_SPARE_RAMP_VALUES_TOKEN "rampvalues"
110 #define PRM_SPARE_RAMP_VALUES_VAR_TOKEN "rampvalues_var"
111 #define PRM_SPARE_SCRIPT_ACTION_HELP_TOKEN "script_action_help"
112 #define PRM_SPARE_SCRIPT_ACTION_ICON_TOKEN "script_action_icon"
113 #define PRM_SPARE_SCRIPT_ACTION_TOKEN "script_action"
114 #define PRM_SPARE_SCRIPT_CALLBACK_TOKEN "script_callback"
115 #define PRM_SPARE_SCRIPT_CALLBACK_LANGUAGE_TOKEN "script_callback_language"
116 #define PRM_SPARE_SCRIPT_RITYPE_TOKEN "script_ritype"
117 #define PRM_SPARE_SCRIPT_UNQUOTED_TOKEN "script_unquoted"
118 #define PRM_SPARE_SHADER_PARM_CONTEXTS_TOKEN "shaderparmcontexts"
119 #define PRM_SPARE_UNITS_TOKEN "units"
120 #define PRM_SPARE_XCF_MODE_TOKEN "xcfmode"
121 #define PRM_SPARE_VARYING_DEFAULT_TOKEN "varying_default"
122 
123 class UT_BitArray;
124 class UT_StringArray;
125 class UT_StringHolder;
126 class UT_StringRef;
127 class PRM_Parm;
128 class prm_SharedString;
129 
130 typedef int (*PRM_SpareCallback)(const char *token, const char *value);
131 typedef int (*PRM_SpareCallbackWithData)(const char *token,
132  const char *value, void *data);
133 
134 typedef std::pair<const char *, const char *> PRM_SpareToken;
136 
138 {
139 public:
140  /// The constructor for the PRM_SpareData should takes a variadic number of
141  /// token/value pairs. For example:
142  /// static PRM_SpareData(PRM_SpareArgs()
143  /// << PRM_SpareToken("token1", "value1")
144  /// << PRM_SpareToken("token2", "value2")
145  /// ...);
146  explicit PRM_SpareData(const PRM_SpareArgs &args);
147 
148  /// A single token value pair
149  explicit PRM_SpareData(const PRM_SpareToken &pair);
150  PRM_SpareData();
151  ~PRM_SpareData();
152 
154  PRM_SpareData &operator=(const PRM_SpareData &copy);
155 
156  uint entries() const;
157 
158  void clear();
159  void mergeFrom(const PRM_SpareData &ref);
160  void copyFrom(const PRM_SpareData &ref);
161 
162  bool containsAny(const PRM_SpareData &ref) const;
163  bool containsAll(const PRM_SpareData &ref) const;
164 
165  // The the value associated with a particular token.
166  const char *getValue(const UT_StringRef &token) const;
167 
168  // Because these are traverseConst functions, we can't remove any items
169  // from the table in the traversal functions.
170  void traverseConst(PRM_SpareCallback f) const;
171  void traverseConst(PRM_SpareCallbackWithData f, void *data) const;
172 
173 
174  // NOTE: When addTokenValue is called with a null pointer for the value,
175  // the token is deleted from the spare data.
176  void addTokenValue(const UT_StringHolder &token, const char *value);
177  void deleteTokenValue(const UT_StringRef &token);
178 
179  // For backward compatibility with the ScriptParmSpareData class, we have
180  // these functions.
181  static const char *getScriptCallbackToken()
183  void setCallbackData(const char *str)
184  { addTokenValue(getScriptCallbackToken(), str); }
185  const char *getCallbackData() const
186  { return getValue(getScriptCallbackToken()); }
187 
188  static const char *getScriptCallbackLanguageToken()
190  void setCallbackLanguage(CH_ScriptLanguage language);
191  CH_ScriptLanguage getCallbackLanguage() const;
192 
193  void setRenderManType(const char *str)
194  { addTokenValue(PRM_SPARE_SCRIPT_RITYPE_TOKEN, str); }
195  const char *getRenderManType() const
196  { return getValue(PRM_SPARE_SCRIPT_RITYPE_TOKEN); }
197 
198  void setOpFilter(const char *str)
199  { addTokenValue(PRM_SPARE_OPFILTER_TOKEN, str); }
200  const char *getOpFilter() const
201  { return getValue(PRM_SPARE_OPFILTER_TOKEN); }
202 
203  void setOpRelative(const char *str)
204  { addTokenValue(PRM_SPARE_OPRELATIVE_TOKEN, str); }
205  const char *getOpRelative() const
206  { return getValue(PRM_SPARE_OPRELATIVE_TOKEN); }
207 
208  static const char * getUnquotedStateToken()
211  { addTokenValue(getUnquotedStateToken(), "1"); }
212  bool getUnquotedState() const
213  { return getValue(getUnquotedStateToken()) != 0; }
214 
215  void setMultiStartOffset(int value);
216  int getMultiStartOffset() const;
217 
218  void setVisibleTabs(const UT_BitArray &values);
219  void getVisibleTabs(UT_BitArray &values) const;
220  bool getVisibleTab(int tabidx) const;
221 
222  // Ramp
223  static const char * getRampBasisDefaultToken()
225  void setRampBasisDefault(const char *value)
226  { addTokenValue(getRampBasisDefaultToken(),value); }
227  const char * getRampBasisDefault() const
228  { return getValue(getRampBasisDefaultToken()); }
229 
230  static const char * getRampShowControlsDefaultToken()
232  void setRampShowControlsDefault(bool value)
233  {
234  addTokenValue(getRampShowControlsDefaultToken(),
235  value ? "1" : "0");
236  }
238  {
239  const char *n, *v;
240  n = getRampShowControlsDefaultToken();
241  v = getValue(n);
242  if (!v)
243  return true;
244  else
245  return *v != '0';
246  }
247 
248  static const char * getRampColorTypeToken()
250  static const char * getRampColorTypeValueToken(UT_ColorType color_type);
251  void setRampColorType(UT_ColorType color_type);
252  UT_ColorType getRampColorType() const;
253 
254  static const char * getRampBasisVarToken()
256  static const char * getRampKeysVarToken()
258  static const char * getRampValuesVarToken()
260 
261  void setRampBasisVar(const char *value)
262  { addTokenValue(getRampBasisVarToken(), value); }
263  const char * getRampBasisVar() const
264  { return getValue(getRampBasisVarToken()); }
265  void setRampKeysVar(const char *value)
266  { addTokenValue(getRampKeysVarToken(), value); }
267  const char * getRampKeysVar() const
268  { return getValue(getRampKeysVarToken()); }
269  void setRampValuesVar(const char *value)
270  { addTokenValue(getRampValuesVarToken(), value); }
271  const char * getRampValuesVar() const
272  { return getValue(getRampValuesVarToken()); }
273 
274  static const char * getColorRampDefaultToken()
276  const char * getColorRampDefaultValue() const
277  { return getValue(getColorRampDefaultToken()); }
278  static const char * getFloatRampDefaultToken()
280  const char * getFloatRampDefaultValue() const
281  { return getValue(getFloatRampDefaultToken()); }
282  void setRampDefaultFromParm(const PRM_Parm &ramp_parm);
283  void getRampDefaultToParm(PRM_Parm &ramp_parm) const;
284 
285  // Color UI Mode, Wheel flag and Dynamic flag
286  static const char * getColorTypeToken()
287  { return PRM_SPARE_COLOR_TYPE_TOKEN; }
288  static const char * getColorTypeValueToken(PRM_ColorType color_type);
289  void setColorType(PRM_ColorType color_type);
290  PRM_ColorType getColorType() const;
291 
292  static const char * getColorWheelToken()
293  { return PRM_SPARE_COLOR_WHEEL_TOKEN; }
294  void setColorWheel(bool value);
295  bool getColorWheel() const;
296 
297  static const char * getColorDynamicToken()
298  { return PRM_SPARE_COLOR_DYN_TOKEN; }
299  void setColorDynamic(bool value);
300  bool getColorDynamic() const;
301 
302  static const char * getKeyValueDictKeyLabelToken()
304  void setKeyValueDictKeyLabel(const char *label);
305  const char *getKeyValueDictKeyLabel() const;
306  static const char * getKeyValueDictValueLabelToken()
308  void setKeyValueDictValueLabel(const char *label);
309  const char *getKeyValueDictValueLabel() const;
310  static const char * getKeyValueDictUseChooserToken()
312  void setKeyValueDictUseChooser(bool use_chooser);
313  bool getKeyValueDictUseChooser() const;
314  static const char * getKeyValueDictChooserLabelToken()
316  void setKeyValueDictChooserLabel(const char *label);
317  const char *getKeyValueDictChooserLabel() const;
320  void setKeyValueDictChooserCallback(const char *label);
321  const char *getKeyValueDictChooserCallback() const;
322 
323  void setXCFMode(const char *value)
324  { return addTokenValue(PRM_SPARE_XCF_MODE_TOKEN, value); }
325  const char *getXCFMode() const
326  { return getValue(PRM_SPARE_XCF_MODE_TOKEN); }
327 
328  const char *getScriptAction() const;
329  const char *getScriptActionHelp() const;
330  const char *getScriptActionIcon() const;
331  const char *getButtonIcon() const;
332 
333  bool getUseEditor() const;
334  const char *getEditorLanguage() const
335  { return getValue(PRM_SPARE_EDITOR_LANG_TOKEN); }
336  void getEditorLinesRange(int &lines_min, int &lines_max) const;
337  static inline int getEditorLinesRangeDefaultMin() { return 8; }
338  static inline int getEditorLinesRangeDefaultMax() { return 40; }
339 
340  static const char *getXCFModeFloatValToken() { return "float"; }
341 
342  // Token for whether the template will be used for cooking
343  static const char * getCookDependentToken()
345  // Get state of cook_dependent flag.
346  // This is only used for SPARE parameters, which if this tag doesn't exist,
347  // the spare parm defaults to false for cook dependent.
348  bool getCookDependent() const;
349  // Set state of cook_dependent flag.
350  // This is only used for SPARE parameters, which if this tag doesn't exist,
351  // the spare parm defaults to false for cook dependent.
352  void setCookDependent(bool flag);
353 
354  // Token for whether the parm on the VOP should regenerate code
355  static const char *getCodeGenDependentToken()
357  // Get the state of the code_generation flag
358  // This is only used for SPARE parameters, which if this tag doesn't exist,
359  // the spare parm defaults to true for code generation
360  bool getCodeGenDependent() const;
361  // Set state of code_generation flag.
362  // This is only used for SPARE parameters, which if this tag doesn't exist,
363  // the spare parm defaults to true for code generation
364  void setCodeGenDependent(bool flag);
365 
366  int64 getMemoryUsage(bool inclusive) const;
367 
368  static const char *getOpFilterKeyFromName(const char *name);
369  static const char *getOpFilterKeyFromLabel(const char *name);
370  static const char *getOpFilterNameFromKey(const char *key);
371  static const char *getOpFilterLabelFromKey(const char *key);
372  // End of backward compatibility
373 
374  // Convenience spare data you might want to use
375  static PRM_SpareData objNetRef; // /obj
376  static PRM_SpareData chNetRef; // /ch
377  static PRM_SpareData ropNetRef; // /out
378 
379  static PRM_SpareData objPath; // !!OBJ!!
380  static PRM_SpareData objGeometryPath; // !!OBJ/GEOMETRY!!
381  static PRM_SpareData objLightPath; // !!OBJ/LIGHT!!
382  static PRM_SpareData objBonePath; // !!OBJ/BONE!!
383  static PRM_SpareData objMusclePath; // !!OBJ/MUSCLE!!
384  static PRM_SpareData objCameraPath; // !!OBJ/CAMERA!!
385  static PRM_SpareData dopPath; // !!DOP!!
386  static PRM_SpareData sopPath; // !!SOP!!
387  static PRM_SpareData popPath; // !!POP!!
388  static PRM_SpareData ropPath; // !!ROP!!
389  static PRM_SpareData cop2Path; // !!COP2!!
390  static PRM_SpareData chopPath; // !!CHOP!!
391  static PRM_SpareData constraintsPath; // !!CHOP!!
392  static PRM_SpareData shopPath; // !!SHOP!!
393  static PRM_SpareData shopProperties; // !!SHOP/PROPERTIES!!
394  static PRM_SpareData shopMaterial; // !!SHOP/MATERIAL!!
395  static PRM_SpareData shopSurface; // !!SHOP/SURFACE!!
396  static PRM_SpareData shopDisplacement; // !!SHOP/DISPLACEMENT!!
397  static PRM_SpareData shopSurfaceShadow; // !!SHOP/SURFACE_SHADOW!!
398  static PRM_SpareData shopBackground; // !!SHOP/BACKGROUND!!
399  static PRM_SpareData shopGeometry; // !!SHOP/GEOMETRY!!
400  static PRM_SpareData shopAtmosphere; // !!SHOP/ATMOSPHERE!!
401  static PRM_SpareData shopPhoton; // !!SHOP/PHOTON!!
402  static PRM_SpareData shopPhotonVolume; // !!SHOP/PHOTONVOLUME!!
403  static PRM_SpareData shopContour; // !!SHOP/CONTOUR!!
404  static PRM_SpareData shopLight; // !!SHOP/LIGHT!!
405  static PRM_SpareData shopEmitter; // !!SHOP/EMITTER!!
406  static PRM_SpareData shopLightShadow; // !!SHOP/LIGHT_SHADOW!!
407  static PRM_SpareData shopLens; // !!SHOP/LENS!!
408  static PRM_SpareData shopOutput; // !!SHOP/OUTPUT!!
409  static PRM_SpareData shopContourStore; // !!SHOP/CONTOUR_STORE!!
410  static PRM_SpareData shopContourContrast; // !!SHOP/CONTOUR_CONTRAST!!
411  static PRM_SpareData shopImage3d; // !!SHOP/IMAGE3D!!
412  static PRM_SpareData shopCVEX; // !!SHOP/CVEX!!
413  static PRM_SpareData shopCoShader; // !!SHOP/COSHADER!!
414  static PRM_SpareData vopPath; // !!VOP!!
415  static PRM_SpareData lopPath; // !!LOP!!
416  static PRM_SpareData topPath; // !!TOP!!
417  static PRM_SpareData filterMaterial; // !!CUSTOM/MATERIAL!!
418 
419  static PRM_SpareData autoScope; // autoscope
420 
421  static PRM_SpareData multiStartOffsetZero; // multistart offset of zero
422  static PRM_SpareData multiStartOffsetOne; // multistart offset of one
423 
427  static PRM_SpareData unitsMass; // kg1
428  static PRM_SpareData unitsPerMass; // kg-1
429  static PRM_SpareData unitsTime; // s1
432  static PRM_SpareData unitsVelocity; // m1s-1
436  static PRM_SpareData unitsForce; // kg1m1s-2
437  static PRM_SpareData unitsForceDensity; // kg1m-2s-2
438  static PRM_SpareData unitsImpulse; // kg1m1s-1
439  static PRM_SpareData unitsTorque; // kg1m2s-2
440  static PRM_SpareData unitsDrag; // kg1s-1
441  static PRM_SpareData unitsAngDrag; // kg1m2s-1
442  static PRM_SpareData unitsPressure; // kg1m-1s-2
447  static PRM_SpareData unitsAreaDensity; // kg1m-2
450  static PRM_SpareData unitsDensity; // kg1m-3
451  static PRM_SpareData unitsDensityPerTime; // kg1m-3s-1
453  static PRM_SpareData unitsNone; // ""
454 
455  static PRM_SpareData rampBasisDefault; // rampbasis "ramp_basis"
456  static PRM_SpareData rampKeysDefault; // rampkeys "ramp_keys"
457  static PRM_SpareData rampValuesDefault; // rampvalues "ramp_values"
458 
459  static PRM_SpareData attribAccessR; // "sidefx::attrib_access" "read"
460  static PRM_SpareData attribAccessW; // "sidefx::attrib_access" "write"
461  static PRM_SpareData attribAccessRW; // "sidefx::attrib_access" "readwrite"
462 
463  static PRM_SpareData connectorKindNone; // "sidefx::connector_kind" "none"
464  static PRM_SpareData connectorKindIn; // "sidefx::connector_kind" "in"
465  static PRM_SpareData connectorKindOut; // "sidefx::connector_kind" "out"
466  static PRM_SpareData connectorKindInOut;// "sidefx::connector_kind" "inout"
467 
468  static PRM_SpareData shaderIsShaderParm; // "sidefx::shader_isparm" "1"
469  static PRM_SpareData shaderIsNotShaderParm; // "sidefx::shader_isparm" "0"
470 
471  /// Used to set a space- or comma-separated list of globs to use as
472  /// file filter for parameters of type @c PRM_FILE (e.g. "*.txt *.log").
473  static const char *getFileChooserPatternToken()
475 
476  static const char *getFileChooserModeToken()
478  static const char *getFileChooserModeValRead()
479  { return "read"; }
480  static const char *getFileChooserModeValWrite()
481  { return "write"; }
482  static const char *getFileChooserModeValReadAndWrite()
483  { return "read_and_write"; }
484 
485  static PRM_SpareData fileChooserModeRead; // filechooser_mode "read"
486  static PRM_SpareData fileChooserModeWrite; // filechooser_mode "write"
487  static PRM_SpareData fileChooserModeReadAndWrite; // ... "read_and_write"
488 
489  static PRM_SpareData stringFloatXCF; // float XCF in string field
490 
491  static const char *getScriptActionToken()
493  static const char *getScriptActionHelpToken()
495  static const char *getScriptActionIconToken()
497  static const char *getButtonIconToken()
498  { return PRM_SPARE_BUTTON_ICON_TOKEN; }
499 
500  static const char *getEditorToken()
501  { return PRM_SPARE_EDITOR_TOKEN; }
502  static PRM_SpareData stringEditor; // Use a text editor for strings
503 
504  static const char *getEditorLanguageToken()
505  { return PRM_SPARE_EDITOR_LANG_TOKEN; }
510 
511  /// Number of lines to show by default. This value can be set as either
512  /// a single number or a range, e.g. '10-50'. The minimum number is what
513  /// the editor will originally show up as, but will attempt to expand up to
514  /// the maximum.
515  static const char *getEditorLinesRangeToken()
516  { return PRM_SPARE_EDITOR_LINES_TOKEN; }
517 
518  // token indicating the parameter comes from a Parameter VOP (ie it is a
519  // shader parameter)
520  static const char * getParmVopVarToken()
521  { return PRM_SPARE_PARM_VOP_TOKEN; }
522 
523  // space-separated list of shading contexts, which a material parameter
524  // belongs to, ie, shaders for each of these contexts actually have
525  // this parameter as an argument, since material may contain other shaders
526  // for other contexts to which a parameter does not apply
527  static const char * getShaderParmContextsToken()
529 
530  // token specifying special keywords that are legal in an oppath parameter
531  // (in addition to the node path itself)
532  static const char * getOpPathKeywordsToken()
534 
535  // token for unit specification
536  static const char * getUnitsToken()
537  { return PRM_SPARE_UNITS_TOKEN; }
538 
539  // token for group specialization (simple/collapsible/toggle groups).
540  static const char *getGroupTypeToken()
541  { return PRM_SPARE_GROUP_TYPE_TOKEN; }
545  static const char *getGroupDefaultToken()
547 
548  // Marks parameter has having varying default values
549  // Defaults to "0"
550  static const char *getVaryingDefaultToken()
553  bool getHasVaryingDefault() const;
554  void setHasVaryingDefault(bool f);
555 
556  // Gets information about whether this parm accepts one or more USD
557  // primitive paths, and/or USD collections.
558  static const char *getUsdPathTypeToken()
559  { return PRM_SPARE_USDPATHTYPE_TOKEN; }
562  const char *getUsdPathType() const;
563 
564  // Gets a value that describes which input's stage is the source for
565  // the primitive(s) in this parameter. This string is evaluated by the
566  // CH_Manager, so it can be a constant (0, 1, or 2) or an expression
567  // that looks at other parameter values.
568  static const char *getUsdPathInputToken()
569  { return PRM_SPARE_USDPATHINPUT_TOKEN; }
572  const char *getUsdPathInput() const;
573 
574  // Identifies the node parameter as shader parameter.
575  static const char *getIsShaderParmToken()
577 
578  // Forces the translation of shader parameter even if it's at default value.
579  static const char *getForceParmValueToken()
581 
582  // Marks a data parm for whether or not it should be saved to disk
583  static const char *getSaveValueToken()
584  { return PRM_SPARE_SAVE_VALUE_TOKEN; }
585  static PRM_SpareData saveValueAlways; // "sidefx::save_value" "1"
586  static PRM_SpareData saveValueNever; // "sidefx::save_value" "0"
587  const char *getSaveValue() const;
588  void setSaveValue(bool flag);
589 
590  // Houdini Engine for Maya: Informs Maya that this parameter should be able
591  // to be set by component selection.
598 
599  /// Return true if the given token is a built-in (internally used) spare
600  /// data token.
601  static bool isBuiltInToken(const UT_StringRef &token);
602 
603  /// Return a range of the built-in tags names.
604  static void builtInTokens(UT_StringArray &tokens);
605 
606 private:
608 };
609 
610 #endif
static PRM_SpareData mayaComponentSelectionTypeFace
static PRM_SpareData objLightPath
static PRM_SpareData objMusclePath
static PRM_SpareData shopOutput
static const char * getVaryingDefaultToken()
static PRM_SpareData shopEmitter
static PRM_SpareData stringEditorLangPython
static const char * getColorWheelToken()
static PRM_SpareData rampValuesDefault
#define PRM_SPARE_OPRELATIVE_TOKEN
Definition: PRM_SpareData.h:98
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:84
#define PRM_SPARE_CODE_GENERATION_TOKEN
Definition: PRM_SpareData.h:82
#define PRM_SPARE_MAYA_COMPONENT_SELECTION_TYPE_TOKEN
Definition: PRM_SpareData.h:71
static PRM_SpareData unitsLinearDensity
static const char * getEditorLanguageToken()
static const char * getRampColorTypeToken()
static const char * getXCFModeFloatValToken()
static PRM_SpareData vopPath
static PRM_SpareData ropPath
GLenum GLint ref
Definition: glew.h:1845
static PRM_SpareData connectorKindIn
GLuint const GLchar * name
Definition: glew.h:1814
const char * getEditorLanguage() const
const char * getOpFilter() const
#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
const Args & args
Definition: printf.h:628
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
GLint GLsizei const GLuint64 * values
Definition: glew.h:3612
static PRM_SpareData stringFloatXCF
static PRM_SpareData unitsPerMass
static PRM_SpareData stringEditorLangExpr
static const char * getButtonIconToken()
static PRM_SpareData shopSurface
static const char * getScriptCallbackToken()
static PRM_SpareData objGeometryPath
bool getUnquotedState() const
static const char * getRampBasisDefaultToken()
static PRM_SpareData unitsPressure
#define PRM_SPARE_SCRIPT_RITYPE_TOKEN
#define PRM_SPARE_RAMP_FLOAT_DEFAULT_TOKEN
const char * getRampBasisDefault() const
static const char * getKeyValueDictChooserLabelToken()
static PRM_SpareToken usdPathTypePrim
static const char * getGroupTypeToken()
#define PRM_SPARE_KEY_VALUE_DICT_CHOOSER_CALLBACK_TOKEN
Definition: PRM_SpareData.h:49
const GLdouble * v
Definition: glew.h:1391
static PRM_SpareData stringEditor
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
#define PRM_SPARE_OPPATH_KEYWORDS_TOKEN
Definition: PRM_SpareData.h:97
static const char * getIsShaderParmToken()
static PRM_SpareData multiStartOffsetOne
static PRM_SpareData unitsAngVelocity
static PRM_SpareData cop2Path
#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
Definition: PRM_SpareData.h:93
#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
Definition: PRM_SpareData.h:90
static PRM_SpareData chNetRef
const char * getCallbackData() const
static int getEditorLinesRangeDefaultMin()
static PRM_SpareData unitsMass
static PRM_SpareData rampBasisDefault
GLclampf f
Definition: glew.h:3499
static PRM_SpareData unitsDrag
static PRM_SpareData objNetRef
static const char * getKeyValueDictKeyLabelToken()
#define PRM_SPARE_EDITOR_LINES_TOKEN
Definition: PRM_SpareData.h:88
static PRM_SpareData sopPath
static const char * getScriptActionIconToken()
GLint GLenum GLsizei GLint GLsizei const void * data
Definition: glew.h:1379
static PRM_SpareData connectorKindInOut
static PRM_SpareData filterMaterial
static PRM_SpareToken usdPathInputFirst
static PRM_SpareData varyingDefault
static PRM_SpareData unitsLength
const char * getFloatRampDefaultValue() const
static const char * getOpPathKeywordsToken()
static PRM_SpareData unitsAngDrag
#define PRM_SPARE_COLOR_WHEEL_TOKEN
Definition: PRM_SpareData.h:85
#define PRM_SPARE_VARYING_DEFAULT_TOKEN
GLsizei n
Definition: glew.h:4040
static PRM_SpareData saveValueAlways
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
static PRM_SpareData multiStartOffsetZero
static PRM_SpareData shopProperties
static const char * getUsdPathTypeToken()
const char * getRampBasisVar() const
static PRM_SpareData constraintsPath
static const char * getRampValuesVarToken()
GLuint GLsizei GLsizei GLchar * label
Definition: glew.h:8986
static const char * getGroupDefaultToken()
#define PRM_SPARE_COOK_DEPENDENT_TOKEN
Definition: PRM_SpareData.h:86
static PRM_SpareData shaderIsNotShaderParm
static PRM_SpareData unitsNone
static const char * getRampShowControlsDefaultToken()
void setOpFilter(const char *str)
#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
const char * getColorRampDefaultValue() const
void setRampBasisDefault(const char *value)
#define PRM_SPARE_PARM_VOP_TOKEN
Definition: PRM_SpareData.h:99
#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
Definition: PRM_SpareData.h:96
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
Definition: PRM_SpareData.h:87
#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:81
OIIO_API bool copy(string_view from, string_view to, std::string &err)
static const char * getColorTypeToken()
static PRM_SpareData mayaComponentSelectionTypeVertex
#define PRM_SPARE_RAMP_KEYS_VAR_TOKEN
static const char * getFileChooserModeValRead()
static PRM_SpareData objBonePath
void setRampShowControlsDefault(bool value)
static PRM_SpareData shopPhotonVolume
static PRM_SpareData unitsDensity
static PRM_SpareToken usdPathInputSecond
static const char * getUsdPathInputToken()
static PRM_SpareData mayaComponentSelectionTypeUV
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
GLsizei const GLfloat * value
Definition: glew.h:1849
static PRM_SpareData unitsAreaDensityPerTime
#define PRM_SPARE_COLOR_DYN_TOKEN
Definition: PRM_SpareData.h:83
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)
#define PRM_SPARE_USDPATHTYPE_TOKEN
Definition: PRM_SpareData.h:57
static PRM_SpareData popPath
static PRM_SpareData unitsPerTime
static PRM_SpareData objPath
CH_ScriptLanguage
#define PRM_SPARE_GROUP_TYPE_TOKEN
Definition: PRM_SpareData.h:92
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
Definition: PRM_SpareData.h:91
static PRM_SpareData fileChooserModeRead
static const char * getFileChooserModeValReadAndWrite()
#define PRM_SPARE_EDITOR_TOKEN
Definition: PRM_SpareData.h:89