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 `theBuiltInTokens` map
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 #define PRM_SPARE_SWITCHER_BASE \
86  PRM_SPARE_BUILTIN_NAMESPACE "switcher"
87 #define PRM_SPARE_IMAGE_ALLOW_VIDEO_TOKEN \
88  PRM_SPARE_BUILTIN_NAMESPACE "allow_video"
89 
90 // When you add a tag above, make sure to add it to $SHS/properties/other/standardparmtags.ds
91 
92 //
93 // Declarations of *old*, built-in parm spare data tokens (tag names).
94 // WARNING: Do not add new spare data tokens to this list!!!
95 // Add the tokens to the new list above and include the SideFX
96 // namespace in the tokens.
97 //
98 #define PRM_SPARE_AUTOSCOPE_TOKEN "autoscope"
99 #define PRM_SPARE_BUTTON_ICON_TOKEN "button_icon"
100 #define PRM_SPARE_CODE_GENERATION_TOKEN "code_generation"
101 #define PRM_SPARE_COLOR_DYN_TOKEN "colordyn"
102 #define PRM_SPARE_COLOR_TYPE_TOKEN "colortype"
103 #define PRM_SPARE_COLOR_WHEEL_TOKEN "colorwheel"
104 #define PRM_SPARE_COOK_DEPENDENT_TOKEN "cook_dependent"
105 #define PRM_SPARE_EDITOR_LANG_TOKEN "editorlang"
106 #define PRM_SPARE_EDITOR_LINES_TOKEN "editorlines"
107 #define PRM_SPARE_EDITOR_TOKEN "editor"
108 #define PRM_SPARE_FILE_CHOOSER_MODE_TOKEN "filechooser_mode"
109 #define PRM_SPARE_FILE_CHOOSER_PATTERN_TOKEN "filechooser_pattern"
110 #define PRM_SPARE_GROUP_TYPE_TOKEN "group_type"
111 #define PRM_SPARE_GROUP_DEFAULT_TOKEN "group_default"
112 #define PRM_SPARE_MULTI_START_OFFSET_TOKEN "multistartoffset"
113 #define PRM_SPARE_NETREF_TOKEN "netref"
114 #define PRM_SPARE_OPFILTER_TOKEN "opfilter"
115 #define PRM_SPARE_OPPATH_KEYWORDS_TOKEN "oppathkeywords"
116 #define PRM_SPARE_OPRELATIVE_TOKEN "oprelative"
117 #define PRM_SPARE_PARM_VOP_TOKEN "parmvop"
118 #define PRM_SPARE_RAMP_BASIS_DEFAULT_TOKEN "rampbasisdefault"
119 #define PRM_SPARE_RAMP_BASIS_TOKEN "rampbasis"
120 #define PRM_SPARE_RAMP_BASIS_VAR_TOKEN "rampbasis_var"
121 #define PRM_SPARE_RAMP_COLOR_DEFAULT_TOKEN "rampcolordefault"
122 #define PRM_SPARE_RAMP_COLOR_TYPE_TOKEN "rampcolortype"
123 #define PRM_SPARE_RAMP_FLOAT_DEFAULT_TOKEN "rampfloatdefault"
124 #define PRM_SPARE_RAMP_KEYS_TOKEN "rampkeys"
125 #define PRM_SPARE_RAMP_KEYS_VAR_TOKEN "rampkeys_var"
126 #define PRM_SPARE_RAMP_SHOW_CONTROLS_DEFAULT_TOKEN "rampshowcontrolsdefault"
127 #define PRM_SPARE_RAMP_VALUES_TOKEN "rampvalues"
128 #define PRM_SPARE_RAMP_VALUES_VAR_TOKEN "rampvalues_var"
129 #define PRM_SPARE_SCRIPT_ACTION_HELP_TOKEN "script_action_help"
130 #define PRM_SPARE_SCRIPT_ACTION_ICON_TOKEN "script_action_icon"
131 #define PRM_SPARE_SCRIPT_ACTION_TOKEN "script_action"
132 #define PRM_SPARE_SCRIPT_CALLBACK_TOKEN "script_callback"
133 #define PRM_SPARE_SCRIPT_CALLBACK_LANGUAGE_TOKEN "script_callback_language"
134 #define PRM_SPARE_SCRIPT_RITYPE_TOKEN "script_ritype"
135 #define PRM_SPARE_SCRIPT_UNQUOTED_TOKEN "script_unquoted"
136 #define PRM_SPARE_SHADER_PARM_CONTEXTS_TOKEN "shaderparmcontexts"
137 #define PRM_SPARE_UNITS_TOKEN "units"
138 #define PRM_SPARE_XCF_MODE_TOKEN "xcfmode"
139 #define PRM_SPARE_VARYING_DEFAULT_TOKEN "varying_default"
140 
141 class UT_BitArray;
142 class UT_StringArray;
143 class UT_StringHolder;
144 class UT_StringRef;
145 class PRM_Parm;
146 class prm_SharedString;
147 
148 typedef int (*PRM_SpareCallback)(const char *token, const char *value);
149 typedef int (*PRM_SpareCallbackWithData)(const char *token,
150  const char *value, void *data);
151 
152 typedef std::pair<const char *, const char *> PRM_SpareToken;
154 
156 {
157 public:
158  /// The constructor for the PRM_SpareData should takes a variadic number of
159  /// token/value pairs. For example:
160  /// static PRM_SpareData(PRM_SpareArgs()
161  /// << PRM_SpareToken("token1", "value1")
162  /// << PRM_SpareToken("token2", "value2")
163  /// ...);
164  explicit PRM_SpareData(const PRM_SpareArgs &args);
165 
166  /// A single token value pair
167  explicit PRM_SpareData(const PRM_SpareToken &pair);
168  PRM_SpareData();
169  ~PRM_SpareData();
170 
172  PRM_SpareData &operator=(const PRM_SpareData &copy);
173 
174  uint entries() const;
175 
176  void clear();
177  void mergeFrom(const PRM_SpareData &ref);
178  void copyFrom(const PRM_SpareData &ref);
179 
180  bool containsAny(const PRM_SpareData &ref) const;
181  bool containsAll(const PRM_SpareData &ref) const;
182 
183  // The the value associated with a particular token.
184  const char *getValue(const UT_StringRef &token) const;
185 
186  // Because these are traverseConst functions, we can't remove any items
187  // from the table in the traversal functions.
188  void traverseConst(PRM_SpareCallback f) const;
189  void traverseConst(PRM_SpareCallbackWithData f, void *data) const;
190 
191 
192  // NOTE: When addTokenValue is called with a null pointer for the value,
193  // the token is deleted from the spare data.
194  void addTokenValue(const UT_StringHolder &token, const char *value);
195  void deleteTokenValue(const UT_StringRef &token);
196 
197  // For backward compatibility with the ScriptParmSpareData class, we have
198  // these functions.
199  static const char *getScriptCallbackToken()
201  void setCallbackData(const char *str)
202  { addTokenValue(getScriptCallbackToken(), str); }
203  const char *getCallbackData() const
204  { return getValue(getScriptCallbackToken()); }
205 
206  static const char *getScriptCallbackLanguageToken()
208  void setCallbackLanguage(CH_ScriptLanguage language);
209  CH_ScriptLanguage getCallbackLanguage() const;
210 
211  void setRenderManType(const char *str)
212  { addTokenValue(PRM_SPARE_SCRIPT_RITYPE_TOKEN, str); }
213  const char *getRenderManType() const
214  { return getValue(PRM_SPARE_SCRIPT_RITYPE_TOKEN); }
215 
216  void setOpFilter(const char *str)
217  { addTokenValue(PRM_SPARE_OPFILTER_TOKEN, str); }
218  const char *getOpFilter() const
219  { return getValue(PRM_SPARE_OPFILTER_TOKEN); }
220 
221  void setOpRelative(const char *str)
222  { addTokenValue(PRM_SPARE_OPRELATIVE_TOKEN, str); }
223  const char *getOpRelative() const
224  { return getValue(PRM_SPARE_OPRELATIVE_TOKEN); }
225 
226  static const char * getUnquotedStateToken()
229  { addTokenValue(getUnquotedStateToken(), "1"); }
230  bool getUnquotedState() const
231  { return getValue(getUnquotedStateToken()) != 0; }
232 
233  void setMultiStartOffset(int value);
234  int getMultiStartOffset() const;
235 
236  void setVisibleTabs(const UT_BitArray &values);
237  void getVisibleTabs(UT_BitArray &values) const;
238  bool getVisibleTab(int tabidx) const;
239 
240  // Ramp
241  static const char * getRampBasisDefaultToken()
243  void setRampBasisDefault(const char *value)
244  { addTokenValue(getRampBasisDefaultToken(),value); }
245  const char * getRampBasisDefault() const
246  { return getValue(getRampBasisDefaultToken()); }
247 
248  static const char * getRampShowControlsDefaultToken()
250  void setRampShowControlsDefault(bool value)
251  {
252  addTokenValue(getRampShowControlsDefaultToken(),
253  value ? "1" : "0");
254  }
256  {
257  const char *n, *v;
258  n = getRampShowControlsDefaultToken();
259  v = getValue(n);
260  if (!v)
261  return true;
262  else
263  return *v != '0';
264  }
265 
266  static const char * getRampColorTypeToken()
268  static const char * getRampColorTypeValueToken(UT_ColorType color_type);
269  void setRampColorType(UT_ColorType color_type);
270  UT_ColorType getRampColorType() const;
271 
272  static const char * getRampBasisVarToken()
274  static const char * getRampKeysVarToken()
276  static const char * getRampValuesVarToken()
278 
279  void setRampBasisVar(const char *value)
280  { addTokenValue(getRampBasisVarToken(), value); }
281  const char * getRampBasisVar() const
282  { return getValue(getRampBasisVarToken()); }
283  void setRampKeysVar(const char *value)
284  { addTokenValue(getRampKeysVarToken(), value); }
285  const char * getRampKeysVar() const
286  { return getValue(getRampKeysVarToken()); }
287  void setRampValuesVar(const char *value)
288  { addTokenValue(getRampValuesVarToken(), value); }
289  const char * getRampValuesVar() const
290  { return getValue(getRampValuesVarToken()); }
291 
292  static const char * getColorRampDefaultToken()
294  const char * getColorRampDefaultValue() const
295  { return getValue(getColorRampDefaultToken()); }
296  static const char * getFloatRampDefaultToken()
298  const char * getFloatRampDefaultValue() const
299  { return getValue(getFloatRampDefaultToken()); }
300  void setRampDefaultFromParm(const PRM_Parm &ramp_parm);
301  void getRampDefaultToParm(PRM_Parm &ramp_parm) const;
302 
303  // Color UI Mode, Wheel flag and Dynamic flag
304  static const char * getColorTypeToken()
305  { return PRM_SPARE_COLOR_TYPE_TOKEN; }
306  static const char * getColorTypeValueToken(PRM_ColorType color_type);
307  void setColorType(PRM_ColorType color_type);
308  PRM_ColorType getColorType() const;
309 
310  static const char * getColorWheelToken()
311  { return PRM_SPARE_COLOR_WHEEL_TOKEN; }
312  void setColorWheel(bool value);
313  bool getColorWheel() const;
314 
315  static const char * getColorDynamicToken()
316  { return PRM_SPARE_COLOR_DYN_TOKEN; }
317  void setColorDynamic(bool value);
318  bool getColorDynamic() const;
319 
320  static const char * getKeyValueDictKeyLabelToken()
322  void setKeyValueDictKeyLabel(const char *label);
323  const char *getKeyValueDictKeyLabel() const;
324  static const char * getKeyValueDictValueLabelToken()
326  void setKeyValueDictValueLabel(const char *label);
327  const char *getKeyValueDictValueLabel() const;
328  static const char * getKeyValueDictUseChooserToken()
330  void setKeyValueDictUseChooser(bool use_chooser);
331  bool getKeyValueDictUseChooser() const;
332  static const char * getKeyValueDictChooserLabelToken()
334  void setKeyValueDictChooserLabel(const char *label);
335  const char *getKeyValueDictChooserLabel() const;
338  void setKeyValueDictChooserCallback(const char *label);
339  const char *getKeyValueDictChooserCallback() const;
340 
341  void setXCFMode(const char *value)
342  { return addTokenValue(PRM_SPARE_XCF_MODE_TOKEN, value); }
343  const char *getXCFMode() const
344  { return getValue(PRM_SPARE_XCF_MODE_TOKEN); }
345 
346  const char *getScriptAction() const;
347  const char *getScriptActionHelp() const;
348  const char *getScriptActionIcon() const;
349  const char *getButtonIcon() const;
350 
351  bool getUseEditor() const;
352  /// The string will be treated as this language for syntax highlighting
353  /// and and completion. NOTE: Language names are case insensitive, you
354  /// should accept both VEX, Vex, and vex.
355  const char *getEditorLanguage() const
356  { return getValue(PRM_SPARE_EDITOR_LANG_TOKEN); }
357  void getEditorLinesRange(int &lines_min, int &lines_max) const;
358  static inline int getEditorLinesRangeDefaultMin() { return 8; }
359  static inline int getEditorLinesRangeDefaultMax() { return 40; }
360 
361  static const char *getXCFModeFloatValToken() { return "float"; }
362 
363  // Token for whether the template will be used for cooking
364  static const char * getCookDependentToken()
366  // Get 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  bool getCookDependent() const;
370  // Set state of cook_dependent flag.
371  // This is only used for SPARE parameters, which if this tag doesn't exist,
372  // the spare parm defaults to false for cook dependent.
373  void setCookDependent(bool flag);
374 
375  // Token for whether the parm on the VOP should regenerate code
376  static const char *getCodeGenDependentToken()
378  // Get the state of the 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  bool getCodeGenDependent() const;
382  // Set state of code_generation flag.
383  // This is only used for SPARE parameters, which if this tag doesn't exist,
384  // the spare parm defaults to true for code generation
385  void setCodeGenDependent(bool flag);
386 
387  int64 getMemoryUsage(bool inclusive) const;
388 
389  static const char *getOpFilterKeyFromName(const char *name);
390  static const char *getOpFilterKeyFromLabel(const char *name);
391  static const char *getOpFilterNameFromKey(const char *key);
392  static const char *getOpFilterLabelFromKey(const char *key);
393  // End of backward compatibility
394 
395  // Convenience spare data you might want to use
396  static PRM_SpareData objNetRef; // /obj
397  static PRM_SpareData chNetRef; // /ch
398  static PRM_SpareData ropNetRef; // /out
399 
400  static PRM_SpareData objPath; // !!OBJ!!
401  static PRM_SpareData objGeometryPath; // !!OBJ/GEOMETRY!!
402  static PRM_SpareData objLightPath; // !!OBJ/LIGHT!!
403  static PRM_SpareData objBonePath; // !!OBJ/BONE!!
404  static PRM_SpareData objMusclePath; // !!OBJ/MUSCLE!!
405  static PRM_SpareData objCameraPath; // !!OBJ/CAMERA!!
406  static PRM_SpareData dopPath; // !!DOP!!
407  static PRM_SpareData sopPath; // !!SOP!!
408  static PRM_SpareData popPath; // !!POP!!
409  static PRM_SpareData ropPath; // !!ROP!!
410  static PRM_SpareData cop2Path; // !!COP2!!
411  static PRM_SpareData chopPath; // !!CHOP!!
412  static PRM_SpareData constraintsPath; // !!CHOP!!
413  static PRM_SpareData shopPath; // !!SHOP!!
414  static PRM_SpareData shopProperties; // !!SHOP/PROPERTIES!!
415  static PRM_SpareData shopMaterial; // !!SHOP/MATERIAL!!
416  static PRM_SpareData shopSurface; // !!SHOP/SURFACE!!
417  static PRM_SpareData shopDisplacement; // !!SHOP/DISPLACEMENT!!
418  static PRM_SpareData shopSurfaceShadow; // !!SHOP/SURFACE_SHADOW!!
419  static PRM_SpareData shopBackground; // !!SHOP/BACKGROUND!!
420  static PRM_SpareData shopGeometry; // !!SHOP/GEOMETRY!!
421  static PRM_SpareData shopAtmosphere; // !!SHOP/ATMOSPHERE!!
422  static PRM_SpareData shopPhoton; // !!SHOP/PHOTON!!
423  static PRM_SpareData shopPhotonVolume; // !!SHOP/PHOTONVOLUME!!
424  static PRM_SpareData shopContour; // !!SHOP/CONTOUR!!
425  static PRM_SpareData shopLight; // !!SHOP/LIGHT!!
426  static PRM_SpareData shopEmitter; // !!SHOP/EMITTER!!
427  static PRM_SpareData shopLightShadow; // !!SHOP/LIGHT_SHADOW!!
428  static PRM_SpareData shopLens; // !!SHOP/LENS!!
429  static PRM_SpareData shopOutput; // !!SHOP/OUTPUT!!
430  static PRM_SpareData shopContourStore; // !!SHOP/CONTOUR_STORE!!
431  static PRM_SpareData shopContourContrast; // !!SHOP/CONTOUR_CONTRAST!!
432  static PRM_SpareData shopImage3d; // !!SHOP/IMAGE3D!!
433  static PRM_SpareData shopCVEX; // !!SHOP/CVEX!!
434  static PRM_SpareData shopCoShader; // !!SHOP/COSHADER!!
435  static PRM_SpareData vopPath; // !!VOP!!
436  static PRM_SpareData lopPath; // !!LOP!!
437  static PRM_SpareData topPath; // !!TOP!!
438  static PRM_SpareData topSchedulerPath; // !!TOP/SCHEDULER!!
439  static PRM_SpareData topProcessorPath; // !!TOP/PROCESSOR!!
440  static PRM_SpareData topPartitionerPath; // !!TOP/PARTITIONER!!
441  static PRM_SpareData topMapperPath; // !!TOP/MAPPER!!
442  static PRM_SpareData filterMaterial; // !!CUSTOM/MATERIAL!!
443 
444  static PRM_SpareData autoScope; // autoscope
445 
446  static PRM_SpareData multiStartOffsetZero; // multistart offset of zero
447  static PRM_SpareData multiStartOffsetOne; // multistart offset of one
448 
452  static PRM_SpareData unitsMass; // kg1
453  static PRM_SpareData unitsPerMass; // kg-1
454  static PRM_SpareData unitsTime; // s1
457  static PRM_SpareData unitsVelocity; // m1s-1
461  static PRM_SpareData unitsForce; // kg1m1s-2
462  static PRM_SpareData unitsForceDensity; // kg1m-2s-2
463  static PRM_SpareData unitsImpulse; // kg1m1s-1
464  static PRM_SpareData unitsTorque; // kg1m2s-2
465  static PRM_SpareData unitsDrag; // kg1s-1
466  static PRM_SpareData unitsAngDrag; // kg1m2s-1
467  static PRM_SpareData unitsPressure; // kg1m-1s-2
472  static PRM_SpareData unitsAreaDensity; // kg1m-2
475  static PRM_SpareData unitsDensity; // kg1m-3
476  static PRM_SpareData unitsDensityPerTime; // kg1m-3s-1
478  static PRM_SpareData unitsNone; // ""
479 
480  static PRM_SpareData rampBasisDefault; // rampbasis "ramp_basis"
481  static PRM_SpareData rampKeysDefault; // rampkeys "ramp_keys"
482  static PRM_SpareData rampValuesDefault; // rampvalues "ramp_values"
483 
484  static PRM_SpareData attribAccessR; // "sidefx::attrib_access" "read"
485  static PRM_SpareData attribAccessW; // "sidefx::attrib_access" "write"
486  static PRM_SpareData attribAccessRW; // "sidefx::attrib_access" "readwrite"
487 
488  static PRM_SpareData connectorKindNone; // "sidefx::connector_kind" "none"
489  static PRM_SpareData connectorKindIn; // "sidefx::connector_kind" "in"
490  static PRM_SpareData connectorKindOut; // "sidefx::connector_kind" "out"
491  static PRM_SpareData connectorKindInOut;// "sidefx::connector_kind" "inout"
492 
493  static PRM_SpareData shaderIsShaderParm; // "sidefx::shader_isparm" "1"
494  static PRM_SpareData shaderIsNotShaderParm; // "sidefx::shader_isparm" "0"
495 
496  /// Used to set a space- or comma-separated list of globs to use as
497  /// file filter for parameters of type @c PRM_FILE (e.g. "*.txt *.log").
498  static const char *getFileChooserPatternToken()
500 
501  static const char *getFileChooserModeToken()
503  static const char *getFileChooserModeValRead()
504  { return "read"; }
505  static const char *getFileChooserModeValWrite()
506  { return "write"; }
507  static const char *getFileChooserModeValReadAndWrite()
508  { return "read_and_write"; }
509 
510  static PRM_SpareData fileChooserModeRead; // filechooser_mode "read"
511  static PRM_SpareData fileChooserModeWrite; // filechooser_mode "write"
512  static PRM_SpareData fileChooserModeReadAndWrite; // ... "read_and_write"
513 
514  static PRM_SpareData imageAllowsVideo; // "sidefx::allow_video" "1"
515  static PRM_SpareData imageDisallowsVideo; // "sidefx::allow_video" "0"
516 
517  static PRM_SpareData stringFloatXCF; // float XCF in string field
518 
519  static const char *getScriptActionToken()
521  static const char *getScriptActionHelpToken()
523  static const char *getScriptActionIconToken()
525  static const char *getButtonIconToken()
526  { return PRM_SPARE_BUTTON_ICON_TOKEN; }
527 
528  static const char *getEditorToken()
529  { return PRM_SPARE_EDITOR_TOKEN; }
530  static PRM_SpareData stringEditor; // Use a text editor for strings
531 
532  static const char *getEditorLanguageToken()
533  { return PRM_SPARE_EDITOR_LANG_TOKEN; }
538 
539  /// Number of lines to show by default. This value can be set as either
540  /// a single number or a range, e.g. '10-50'. The minimum number is what
541  /// the editor will originally show up as, but will attempt to expand up to
542  /// the maximum.
543  static const char *getEditorLinesRangeToken()
544  { return PRM_SPARE_EDITOR_LINES_TOKEN; }
545 
546  // token indicating the parameter comes from a Parameter VOP (ie it is a
547  // shader parameter)
548  static const char * getParmVopVarToken()
549  { return PRM_SPARE_PARM_VOP_TOKEN; }
550 
551  // space-separated list of shading contexts, which a material parameter
552  // belongs to, ie, shaders for each of these contexts actually have
553  // this parameter as an argument, since material may contain other shaders
554  // for other contexts to which a parameter does not apply
555  static const char * getShaderParmContextsToken()
557 
558  // token specifying special keywords that are legal in an oppath parameter
559  // (in addition to the node path itself)
560  static const char * getOpPathKeywordsToken()
562 
563  // token for unit specification
564  static const char * getUnitsToken()
565  { return PRM_SPARE_UNITS_TOKEN; }
566 
567  // token for group specialization (simple/collapsible/toggle groups).
568  static const char *getGroupTypeToken()
569  { return PRM_SPARE_GROUP_TYPE_TOKEN; }
575  static const char *getGroupDefaultToken()
577 
578  // Marks parameter has having varying default values
579  // Defaults to "0"
580  static const char *getVaryingDefaultToken()
583  bool getHasVaryingDefault() const;
584  void setHasVaryingDefault(bool f);
585 
586  // Gets information about whether this parm accepts one or more USD
587  // primitive paths, and/or USD collections.
588  static const char *getUsdPathTypeToken()
589  { return PRM_SPARE_USDPATHTYPE_TOKEN; }
592  const char *getUsdPathType() const;
593 
594  // Gets a value that describes which input's stage is the source for
595  // the primitive(s) in this parameter. This string is evaluated by the
596  // CH_Manager, so it can be a constant (0, 1, or 2) or an expression
597  // that looks at other parameter values.
598  static const char *getUsdPathInputToken()
599  { return PRM_SPARE_USDPATHINPUT_TOKEN; }
602  const char *getUsdPathInput() const;
603 
604  // Identifies the node parameter as shader parameter.
605  static const char *getIsShaderParmToken()
607 
608  // Forces the translation of shader parameter even if it's at default value.
609  static const char *getForceParmValueToken()
611 
612  // Marks a data parm for whether or not it should be saved to disk
613  static const char *getSaveValueToken()
614  { return PRM_SPARE_SAVE_VALUE_TOKEN; }
615  static PRM_SpareData saveValueAlways; // "sidefx::save_value" "1"
616  static PRM_SpareData saveValueNever; // "sidefx::save_value" "0"
617  const char *getSaveValue() const;
618  void setSaveValue(bool flag);
619 
620  // Houdini Engine for Maya: Informs Maya that this parameter should be able
621  // to be set by component selection.
628 
629  // Changes the look of the parm. Used to switch between separator and spacer
630  // Height is used to adjust the dimension of the parameter (value * 0.1 inches)
631  static const char *getLookToken()
632  { return PRM_SPARE_LOOK_TOKEN; }
633  static const char *getLayoutHeightToken()
635  const char *getLookValue() const;
636  void setLookValue(const char *value);
637  const char *getLayoutHeightValue() const;
638  void setLayoutHeightValue(const char *value);
639  static PRM_SpareData lookBlank; // "sidefx::look" "blank"
640  static PRM_SpareData lookClassic; // "sidefx::look" "classic"
641  static PRM_SpareData lookIcon; // "sidefx::look" "icon"
642  static PRM_SpareData lookHeading; // "sidefx::look" "heading"
643  static PRM_SpareData lookBlock; // "sidefx::look" "block"
644  static PRM_SpareData layoutHeightSmall; // "sidefx::layout_height" "small"
645  static PRM_SpareData layoutHeightMedium; // "sidefx::layout_height" "medium"
646  static PRM_SpareData layoutHeightLarge; // "sidefx::layout_height" "large"
647 
648  // Header toggle reference for the collapsible folder
649  static const char *getHeaderToggleToken()
651 
652  // Header parm reference for the collapsible folder
653  static const char *getHeaderParmToken()
654  { return PRM_SPARE_HEADER_PARM_TOKEN; }
655 
656  // Header label reference for the collapsible folder
657  static const char *getHeaderLabelToken()
658  { return PRM_SPARE_HEADER_LABEL_TOKEN; }
659 
660  // Slider options. Snap or non-snap
661  static const char *getSliderToken()
662  { return PRM_SPARE_SLIDER_TOKEN; }
663  static PRM_SpareData sliderSnapToInt; // "sidefx::slider" "snap_to_int"
664  static PRM_SpareData sliderNone; // "sidefx::slider" "none"
665 
666  // The original switcher name before auto-renaming
667  static const char *getSwitcherBaseToken()
668  { return PRM_SPARE_SWITCHER_BASE; }
669 
670  // Specifies if this image parm can accept videos
671  static const char *getImageAllowVideoToken()
673 
674  /// Return true if the given token is a built-in (internally used) spare
675  /// data token.
676  static bool isBuiltInToken(const UT_StringRef &token);
677 
678  /// Return a range of the built-in tags names.
679  static void builtInTokens(UT_StringArray &tokens);
680 
681 private:
683 };
684 
685 #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_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
typedef int(APIENTRYP RE_PFNGLXSWAPINTERVALSGIPROC)(int)
#define PRM_SPARE_COLOR_TYPE_TOKEN
#define PRM_SPARE_CODE_GENERATION_TOKEN
#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
GLuint GLsizei const GLchar * label
Definition: glcorearb.h:2545
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
GLboolean * data
Definition: glcorearb.h:131
OIIO_UTIL_API bool copy(string_view from, string_view to, std::string &err)
const GLdouble * v
Definition: glcorearb.h:837
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
GLsizei const GLfloat * value
Definition: glcorearb.h:824
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
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 const char * getImageAllowVideoToken()
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
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
GLdouble n
Definition: glcorearb.h:2008
GLfloat f
Definition: glcorearb.h:1926
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()
GLint ref
Definition: glcorearb.h:124
#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 char * getFloatRampDefaultValue() const
static const char * getOpPathKeywordsToken()
static PRM_SpareData unitsAngDrag
#define PRM_SPARE_COLOR_WHEEL_TOKEN
#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
static PRM_SpareData rampKeysDefault
bool getRampShowControlsDefault() const
static PRM_SpareData shopBackground
static PRM_SpareData imageAllowsVideo
static const char * getKeyValueDictValueLabelToken()
static PRM_SpareData shopContourStore
static const char * getColorDynamicToken()
static PRM_SpareData unitsForce
GLuint const GLchar * name
Definition: glcorearb.h:786
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
static PRM_SpareData layoutHeightSmall
static PRM_SpareData shaderIsNotShaderParm
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
#define PRM_SPARE_SWITCHER_BASE
Definition: PRM_SpareData.h:85
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
GLenum GLsizei GLsizei GLint * values
Definition: glcorearb.h:1602
#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:99
#define PRM_SPARE_HEADER_PARM_TOKEN
Definition: PRM_SpareData.h:79
static PRM_SpareData lookHeading
static const char * getColorTypeToken()
static PRM_SpareData imageDisallowsVideo
static PRM_SpareData mayaComponentSelectionTypeVertex
#define PRM_SPARE_RAMP_KEYS_VAR_TOKEN
static const char * getFileChooserModeValRead()
**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 * getSwitcherBaseToken()
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()
#define PRM_SPARE_IMAGE_ALLOW_VIDEO_TOKEN
Definition: PRM_SpareData.h:87
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
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