HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HOM_ParmTemplate.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_ParmTemplate_h__
10 #define __HOM_ParmTemplate_h__
11 
12 #include "HOM_API.h"
13 #include "HOM_Defines.h"
14 #include "HOM_Errors.h"
15 #include "HOM_EnumValue.h"
16 #include "HOM_Module.h"
17 #include "HOM_PtrOrNull.h"
18 
19 #include <map>
20 #include <string>
21 
22 SWIGOUT(%rename(ParmTemplate) HOM_ParmTemplate;)
23 
25 {
26 public:
28  { HOM_CONSTRUCT_OBJECT(this) }
29  HOM_ParmTemplate(const HOM_ParmTemplate &parm_template)
30  { HOM_CONSTRUCT_OBJECT(this) }
32  { HOM_DESTRUCT_OBJECT(this) }
33 
34  virtual bool operator==(HOM_PtrOrNull<HOM_ParmTemplate> parm_template) = 0;
35  virtual bool operator!=(HOM_PtrOrNull<HOM_ParmTemplate> parm_template) = 0;
36 
37  virtual int __hash__() = 0;
38  virtual std::string __repr__() = 0;
39 
40  SWIGOUT(%newobject clone;)
41  virtual HOM_ParmTemplate *clone() = 0;
42 
43  virtual std::string name() = 0;
44  virtual void setName(const char *name) = 0;
45 
46  virtual std::string label() = 0;
47  virtual void setLabel(const char *label) = 0;
48 
49  SWIGOUT(%warnfilter(321) type;)
50  virtual HOM_EnumValue &type() = 0;
51  virtual HOM_EnumValue &dataType() = 0;
52 
53  virtual HOM_EnumValue &look() = 0;
54  virtual void setLook(HOM_EnumValue &look) = 0;
55 
56  virtual HOM_EnumValue &namingScheme() = 0;
57  virtual void setNamingScheme(HOM_EnumValue &naming_scheme) = 0;
58 
59  virtual int numComponents() = 0;
60  virtual void setNumComponents(int num_components) = 0;
61 
62  virtual std::string disableWhen() = 0;
63  virtual void setDisableWhen(const char *disable_when) = 0;
64 
65  virtual std::map<HOM_EnumValue *, std::string> conditionals() = 0;
66  virtual void setConditional(const HOM_EnumValue &cond_type,
67  const char *conditional) = 0;
68 
69  virtual bool isHidden() = 0;
70  virtual void hide(bool on) = 0;
71 
72  virtual bool isLabelHidden() = 0;
73  virtual void hideLabel(bool on) = 0;
74 
75  virtual bool joinsWithNext() = 0;
76  virtual void setJoinWithNext(bool on) = 0;
77  // joinWithNext is deprecated in favor of joinsWithNext.
78  bool joinWithNext()
79  { return joinsWithNext(); }
80 
81  virtual std::string help() = 0;
82  virtual void setHelp(const char *help) = 0;
83 
84  virtual std::string scriptCallback() = 0;
85  virtual void setScriptCallback(const char *script_callback) = 0;
86 
87  virtual HOM_EnumValue &scriptCallbackLanguage() = 0;
88  virtual void setScriptCallbackLanguage(
89  HOM_EnumValue &script_callback_language) = 0;
90 
91  virtual std::map<std::string, std::string> tags() = 0;
92  virtual void setTags(const std::map<std::string, std::string> &tags) = 0;
93 
94  SWIGOUT(%kwargs asCode;)
95  virtual std::string asCode(
96  const char *function_name=NULL, const char *variable_name=NULL) = 0;
97 };
98 
99 #endif
#define HOM_DESTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1210
GLuint const GLchar * name
Definition: glew.h:1814
OIIO_API bool rename(string_view from, string_view to, std::string &err)
#define SWIGOUT(x)
Definition: HOM_Defines.h:24
string __repr__(VtArray< T > const &self)
Definition: wrapArray.h:349
#define HOM_API
Definition: HOM_API.h:13
#define HOM_CONSTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1209
bool operator!=(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Inequality operator, does exact floating point comparisons.
Definition: Mat3.h:563
INT GLenum dataType
Definition: wglew.h:145
GLuint GLuint GLsizei GLenum type
Definition: glew.h:1253
GLuint GLsizei GLsizei GLchar * label
Definition: glew.h:8986
GLsizei const GLchar *const * string
Definition: glew.h:1844
HOM_ParmTemplate(const HOM_ParmTemplate &parm_template)
virtual ~HOM_ParmTemplate()
bool operator==(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Equality operator, does exact floating point comparisons.
Definition: Mat3.h:549
type
Definition: core.h:528