HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HOM_IntParmTemplate.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  * COMMENTS:
7  */
8 
9 #ifndef __HOM_IntParmTemplate_h__
10 #define __HOM_IntParmTemplate_h__
11 
12 #include "HOM_API.h"
13 #include "HOM_ParmTemplate.h"
14 
15 SWIGOUT(%feature("notabstract") HOM_IntParmTemplate;)
16 SWIGOUT(%rename(IntParmTemplate) HOM_IntParmTemplate;)
17 
19 {
20 public:
21 #ifdef SWIG
22 %extend {
23  %kwargs HOM_IntParmTemplate;
24  HOM_IntParmTemplate(
25  const char *name,
26  const char *label,
27  int num_components,
28  const std::vector<int> &default_value = std::vector<int>(),
29  int min = 0, int max = 10,
30  bool min_is_strict = false, bool max_is_strict = false,
31  HOM_EnumValue &look = HOM_parmLook::Regular,
32  HOM_EnumValue &naming_scheme = HOM_parmNamingScheme::XYZW,
33  const std::vector<std::string> &menu_items =
34  std::vector<std::string>(),
35  const std::vector<std::string> &menu_labels =
36  std::vector<std::string>(),
37  const std::vector<std::string> &icon_names =
38  std::vector<std::string>(),
39  const std::string &item_generator_script = "",
40  HOM_EnumValue *item_generator_script_language = NULL,
41  HOM_EnumValue &menu_type = HOM_menuType::Normal,
42  const char *disable_when = NULL,
43  bool is_hidden = false,
44  bool is_label_hidden = false,
45  bool join_with_next = false,
46  const char *help = NULL,
47  const char *script_callback = NULL,
48  HOM_EnumValue &script_callback_language =
49  HOM_scriptLanguage::Hscript,
50  const std::map<std::string, std::string> &tags =
52  const std::map<HOM_EnumValue *, std::string> &conditionals =
54  const std::vector<std::string> &default_expression =
55  std::vector<std::string>(),
56  const std::vector<HOM_EnumValue *> &default_expression_language =
57  std::vector<HOM_EnumValue *>(),
58  bool menu_use_token = false)
59  {
60  return HOM().newIntParmTemplate(
61  name, label, num_components, default_value,
62  min, max, min_is_strict, max_is_strict, look, naming_scheme,
63  menu_items, menu_labels, icon_names, item_generator_script,
64  item_generator_script_language, menu_type, menu_use_token, disable_when, is_hidden,
65  is_label_hidden, join_with_next, help, script_callback,
66  script_callback_language, tags, conditionals, default_expression,
67  default_expression_language);
68  }
69 };
70 #else
72  { HOM_CONSTRUCT_OBJECT(this) }
73 
75  : HOM_ParmTemplate(parm_template)
76  { HOM_CONSTRUCT_OBJECT(this) }
77 #endif
78 
80  { HOM_DESTRUCT_OBJECT(this) }
81 
82  // Let swig think we're overriding __repr__ for this class so it doesn't
83  // provide its own __repr__.
84  SWIGOUT(virtual std::string __repr__();)
85 
86  virtual int minValue() = 0;
87  virtual void setMinValue(int min_value) = 0;
88  virtual int maxValue() = 0;
89  virtual void setMaxValue(int max_value) = 0;
90  virtual bool minIsStrict() = 0;
91  virtual void setMinIsStrict(bool on) = 0;
92  virtual bool maxIsStrict() = 0;
93  virtual void setMaxIsStrict(bool on) = 0;
94 
95  virtual std::vector<int> defaultValue() = 0;
96  virtual void setDefaultValue(const std::vector<int> &default_value) = 0;
97  virtual std::vector<std::string> defaultExpression() = 0;
98  virtual void setDefaultExpression(
99  const std::vector<std::string> &default_expression) = 0;
100  virtual std::vector<HOM_EnumValue *> defaultExpressionLanguage() = 0;
101  virtual void setDefaultExpressionLanguage(
102  const std::vector<HOM_EnumValue *> &default_expression_language) = 0;
103 
104  virtual std::vector<std::string> menuItems() = 0;
105  virtual void setMenuItems(const std::vector<std::string> &menu_items) = 0;
106 
107  virtual std::vector<std::string> menuLabels() = 0;
108  virtual void setMenuLabels(const std::vector<std::string> &menu_labels) = 0;
109 
110  virtual std::vector<std::string> iconNames() = 0;
111  virtual void setIconNames(const std::vector<std::string> &icon_names) = 0;
112 
113  virtual std::string itemGeneratorScript() = 0;
114  virtual void setItemGeneratorScript(const char *item_generator_script) = 0;
115 
116  virtual HOM_EnumValue &itemGeneratorScriptLanguage() = 0;
117  virtual void setItemGeneratorScriptLanguage(HOM_EnumValue &language) = 0;
118 
119  virtual HOM_EnumValue &menuType() = 0;
120  virtual void setMenuType(HOM_EnumValue &menu_type) = 0;
121 
122  virtual bool menuUseToken() = 0;
123  virtual void setMenuUseToken(bool menuusetoken) = 0;
124 };
125 
126 #endif
constexpr auto max_value() -> T
Definition: format.h:303
virtual HOM_IntParmTemplate * newIntParmTemplate(const char *name, const char *label, int num_components, const std::vector< int > &default_value, int min, int max, bool min_is_strict, bool max_is_strict, HOM_EnumValue &look, HOM_EnumValue &naming_scheme, const std::vector< std::string > &menu_items, const std::vector< std::string > &menu_labels, const std::vector< std::string > &icon_names, const std::string &item_generator_script, HOM_EnumValue *item_generator_script_language, HOM_EnumValue &menu_type, bool menu_use_token, const char *disable_when, bool is_hidden, bool is_label_hidden, bool join_with_next, const char *help, const char *script_callback, HOM_EnumValue &script_callback_language, const std::map< std::string, std::string > &tags, const std::map< HOM_EnumValue *, std::string > &conditionals, const std::vector< std::string > &default_expression, const std::vector< HOM_EnumValue * > &default_expression_language)=0
#define HOM_DESTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1291
GLuint GLsizei const GLchar * label
Definition: glcorearb.h:2545
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
#define SWIGOUT(x)
Definition: HOM_Defines.h:24
string __repr__(VtArray< T > const &self)
Definition: wrapArray.h:352
ImageBuf OIIO_API min(Image_or_Const A, Image_or_Const B, ROI roi={}, int nthreads=0)
std::string help(const App *app, const Error &e)
Printout the full help string on error (if this fn is set, the old default for CLI11) ...
Definition: CLI11.h:8978
#define HOM_API
Definition: HOM_API.h:13
#define HOM_CONSTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1290
HOM_IntParmTemplate(const HOM_IntParmTemplate &parm_template)
GLuint const GLchar * name
Definition: glcorearb.h:786
std::map< HOM_EnumValue *, std::string > HOM_StdMapEnumString
Definition: HOM_Module.h:1300
OIIO_UTIL_API bool rename(string_view from, string_view to, std::string &err)
ImageBuf OIIO_API max(Image_or_Const A, Image_or_Const B, ROI roi={}, int nthreads=0)
HOM_API HOM_Module & HOM()
std::map< std::string, std::string > HOM_StdMapStringString
Definition: HOM_Module.h:1299