HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
HOM_ParmTemplateGroup.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_ParmTemplateGroup_h__
10 #define __HOM_ParmTemplateGroup_h__
11 
12 #include "HOM_API.h"
13 #include "HOM_Defines.h"
14 #include "HOM_Errors.h"
15 #include "HOM_ElemPtr.h"
16 #include "HOM_PtrOrNull.h"
17 #include "HOM_Module.h"
18 #include <vector>
19 
20 class HOM_ParmTemplate;
21 
22 SWIGOUT(%feature("notabstract") HOM_ParmTemplateGroup;)
23 SWIGOUT(%rename(ParmTemplateGroup) HOM_ParmTemplateGroup;)
24 
26 {
27 public:
28 #ifdef SWIG
29 %extend {
31  const std::vector<HOM_ParmTemplate *> &parm_templates =
32  std::vector<HOM_ParmTemplate *>())
33  {
34  return HOM().newParmTemplateGroup(parm_templates);
35  }
36 };
37 #else
39  { HOM_CONSTRUCT_OBJECT(this) }
41  { HOM_CONSTRUCT_OBJECT(this) }
43  { HOM_DESTRUCT_OBJECT(this) }
44 #endif
45 
46  virtual std::string __repr__() = 0;
47 
48  virtual bool operator==(
49  HOM_PtrOrNull<HOM_ParmTemplateGroup> parm_template_group) = 0;
50  virtual bool operator!=(
51  HOM_PtrOrNull<HOM_ParmTemplateGroup> parm_template_group) = 0;
52 
53  SWIGOUT(%newobject find;)
54  virtual HOM_ParmTemplate *find(const char *name) = 0;
55 
56  virtual std::vector<int> findIndices(const char *name) = 0;
57 
58  virtual std::vector<int> findIndices(HOM_ParmTemplate &parm_template) = 0;
59 
60  SWIGOUT(%newobject findFolder;)
61  virtual HOM_ParmTemplate *findFolder(const char *label) = 0;
62 
63  virtual HOM_ParmTemplate *findFolder(
64  const std::vector<std::string> &labels) = 0;
65 
66  virtual std::vector<int> findIndicesForFolder(const char *label) = 0;
67 
68  virtual std::vector<int> findIndicesForFolder(
69  const std::vector<std::string> &labels) = 0;
70 
71  SWIGOUT(%newobject entryAtIndices;)
72  virtual HOM_ParmTemplate *entryAtIndices(const std::vector<int> &indices) = 0;
73 
74  virtual std::vector<int> containingFolderIndices(const char *name) = 0;
75 
76  virtual std::vector<int> containingFolderIndices(
77  HOM_ParmTemplate &parm_template) = 0;
78 
79  virtual std::vector<int> containingFolderIndices(
80  const std::vector<int> &indices) = 0;
81 
82  SWIGOUT(%newobject containingFolder;)
83  virtual HOM_ParmTemplate *containingFolder(const char *name) = 0;
84 
85  SWIGOUT(%newobject containingFolder;)
86  virtual HOM_ParmTemplate *containingFolder(HOM_ParmTemplate &parm_template) = 0;
87 
88  virtual std::vector<HOM_ElemPtr<HOM_ParmTemplate> > entries() = 0;
89 
90  // This method is an alias for entries that makes it easier to search
91  // down through a parm template group into items nested in folders.
92  std::vector<HOM_ElemPtr<HOM_ParmTemplate> > parmTemplates()
93  { return entries(); }
94 
95  virtual std::vector<HOM_ElemPtr<HOM_ParmTemplate> > entriesWithoutFolders() = 0;
96 
97  virtual void replace(
98  const char *name, HOM_ParmTemplate &parm_template) = 0;
99 
100  virtual void replace(
101  HOM_ParmTemplate &parm_template_to_replace,
102  HOM_ParmTemplate &parm_template) = 0;
103 
104  virtual void replace(
105  const std::vector<int> &indices, HOM_ParmTemplate &parm_template) = 0;
106 
107  virtual void insertBefore(
108  const char *name, HOM_ParmTemplate &parm_template) = 0;
109 
110  virtual void insertBefore(
111  const std::vector<int> &indices, HOM_ParmTemplate &parm_template) = 0;
112 
113  virtual void insertBefore(
114  HOM_ParmTemplate &before_parm_template,
115  HOM_ParmTemplate &parm_template) = 0;
116 
117  virtual void insertAfter(
118  const char *name, HOM_ParmTemplate &parm_template) = 0;
119 
120  virtual void insertAfter(
121  const std::vector<int> &indices, HOM_ParmTemplate &parm_template) = 0;
122 
123  virtual void insertAfter(
124  HOM_ParmTemplate &after_parm_template,
125  HOM_ParmTemplate &parm_template) = 0;
126 
127  virtual void append(HOM_ParmTemplate &parm_template) = 0;
128 
129  virtual void appendToFolder(
130  const std::vector<int> &indices, HOM_ParmTemplate &parm_template) = 0;
131 
132  virtual void appendToFolder(
133  const std::vector<std::string> &labels,
134  HOM_ParmTemplate &parm_template) = 0;
135 
136  virtual void appendToFolder(
137  const char *label, HOM_ParmTemplate &parm_template) = 0;
138 
139  virtual void appendToFolder(
140  HOM_ParmTemplate &folder_parm_template,
141  HOM_ParmTemplate &parm_template) = 0;
142 
143  // This method is an alias for append that makes it easier to treat
144  // ParmTemplateGroups and folders uniformly.
145  void addParmTemplate(HOM_ParmTemplate &parm_template)
146  { append(parm_template); }
147 
148  virtual void remove(const char *name) = 0;
149 
150  virtual void remove(HOM_ParmTemplate &parm_template) = 0;
151 
152  virtual void remove(const std::vector<int> &indices) = 0;
153 
154  virtual void hide(const std::vector<int> &indices, bool on) = 0;
155 
156  virtual void hide(const char *name, bool on) = 0;
157 
158  virtual void hide(HOM_ParmTemplate &parm_template, bool on) = 0;
159 
160  virtual void hideFolder(const char *label, bool on) = 0;
161 
162  virtual void hideFolder(const std::vector<std::string> &labels, bool on) = 0;
163 
164  virtual bool isHidden(const std::vector<int> &indices) = 0;
165 
166  virtual bool isHidden(const char *name) = 0;
167 
168  virtual bool isHidden(HOM_ParmTemplate &parm_template) = 0;
169 
170  virtual bool isFolderHidden(const char *label) = 0;
171 
172  virtual bool isFolderHidden(const std::vector<std::string> &labels) = 0;
173 
174  virtual void clear() = 0;
175 
176  SWIGOUT(%kwargs asDialogScript;)
177  virtual std::string asDialogScript(bool rename_conflicting_parms=false,
178  bool full_info=false) = 0;
179 
180  virtual void setToDialogScript(const char *dialog_script) = 0;
181 
182  virtual std::string asCode(
183  const char *function_name=NULL, const char *variable_name=NULL) = 0;
184 
185  SWIGOUT(%newobject sourceNode;)
186  virtual HOM_Node* sourceNode() = 0;
187  SWIGOUT(%newobject sourceNodeType;)
188  virtual HOM_NodeType* sourceNodeType() = 0;
189 };
190 
191 #endif
#define HOM_DESTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:983
GLsizei GLenum const void * indices
Definition: glcorearb.h:405
GLuint GLsizei const GLchar * label
Definition: glcorearb.h:2544
virtual std::string __repr__()=0
std::vector< HOM_ElemPtr< HOM_ParmTemplate > > parmTemplates()
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
#define SWIGOUT(x)
Definition: HOM_Defines.h:24
void addParmTemplate(HOM_ParmTemplate &parm_template)
#define HOM_API
Definition: HOM_API.h:13
virtual HOM_ParmTemplateGroup * newParmTemplateGroup(const std::vector< HOM_ParmTemplate * > &parm_templates)=0
#define HOM_CONSTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:982
bool operator!=(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Inequality operator, does exact floating point comparisons.
Definition: Mat3.h:610
HOM_ParmTemplateGroup(const HOM_ParmTemplateGroup &face)
GLuint const GLchar * name
Definition: glcorearb.h:785
virtual void hide(bool on)=0
png_infop png_sPLT_tpp entries
Definition: png.h:2481
virtual std::string asCode(const char *function_name=NULL, const char *variable_name=NULL)=0
HOM_API HOM_Module & HOM()
bool operator==(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Equality operator, does exact floating point comparisons.
Definition: Mat3.h:596
virtual bool isHidden()=0