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 #include <string>
19 
20 SWIGOUT(%rename(ParmTemplate) HOM_ParmTemplate;)
21 
23 {
24 public:
26  { HOM_CONSTRUCT_OBJECT(this) }
27  HOM_ParmTemplate(const HOM_ParmTemplate &parm_template)
28  { HOM_CONSTRUCT_OBJECT(this) }
30  { HOM_DESTRUCT_OBJECT(this) }
31 
32  virtual bool operator==(HOM_PtrOrNull<HOM_ParmTemplate> parm_template) = 0;
33  virtual bool operator!=(HOM_PtrOrNull<HOM_ParmTemplate> parm_template) = 0;
34 
35  virtual int __hash__() = 0;
36  virtual std::string __repr__() = 0;
37 
38  SWIGOUT(%newobject clone;)
39  virtual HOM_ParmTemplate *clone() = 0;
40 
41  virtual std::string name() = 0;
42  virtual void setName(const char *name) = 0;
43 
44  virtual std::string label() = 0;
45  virtual void setLabel(const char *label) = 0;
46 
47  virtual HOM_EnumValue &type() = 0;
48  virtual HOM_EnumValue &dataType() = 0;
49 
50  virtual HOM_EnumValue &look() = 0;
51  virtual void setLook(HOM_EnumValue &look) = 0;
52 
53  virtual HOM_EnumValue &namingScheme() = 0;
54  virtual void setNamingScheme(HOM_EnumValue &naming_scheme) = 0;
55 
56  virtual int numComponents() = 0;
57  virtual void setNumComponents(int num_components) = 0;
58 
59  virtual std::string disableWhen() = 0;
60  virtual void setDisableWhen(const char *disable_when) = 0;
61 
62  virtual std::map<HOM_EnumValue, std::string> conditionals() = 0;
63  virtual void setConditional(const HOM_EnumValue &cond_type,
64  const char *conditional) = 0;
65 
66  virtual bool isHidden() = 0;
67  virtual void hide(bool on) = 0;
68 
69  virtual bool isLabelHidden() = 0;
70  virtual void hideLabel(bool on) = 0;
71 
72  virtual bool joinsWithNext() = 0;
73  virtual void setJoinWithNext(bool on) = 0;
74  // joinWithNext is deprecated in favor of joinsWithNext.
75  bool joinWithNext()
76  { return joinsWithNext(); }
77 
78  virtual std::string help() = 0;
79  virtual void setHelp(const char *help) = 0;
80 
81  virtual std::string scriptCallback() = 0;
82  virtual void setScriptCallback(const char *script_callback) = 0;
83 
84  virtual HOM_EnumValue &scriptCallbackLanguage() = 0;
85  virtual void setScriptCallbackLanguage(
86  HOM_EnumValue &script_callback_language) = 0;
87 
88  virtual std::map<std::string, std::string> tags() = 0;
89  virtual void setTags(const std::map<std::string, std::string> &tags) = 0;
90 
91  SWIGOUT(%kwargs asCode;)
92  virtual std::string asCode(
93  const char *function_name=NULL, const char *variable_name=NULL) = 0;
94 };
95 
96 #endif
#define HOM_DESTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1056
GLuint GLsizei const GLchar * label
Definition: glcorearb.h:2544
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
#define SWIGOUT(x)
Definition: HOM_Defines.h:24
string __repr__(VtArray< T > const &self)
Definition: wrapArray.h:344
#define HOM_API
Definition: HOM_API.h:13
#define HOM_CONSTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1055
bool operator!=(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Inequality operator, does exact floating point comparisons.
Definition: Mat3.h:604
GLuint const GLchar * name
Definition: glcorearb.h:785
GLint GLint GLsizei GLint GLenum GLenum type
Definition: glcorearb.h:107
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:590