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