HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HOM_Handle.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_Handle_h
10 #define HOM_Handle_h
11 
12 #include "HOM_API.h"
13 #include "HOM_Module.h"
14 #include "HOM_Defines.h"
15 
17 SWIGOUT(%feature("notabstract") HOM_Handle;)
18 
20 {
21 public:
22 #ifdef SWIG
23 %extend
24 {
25  HOM_Handle(
26  HOM_SceneViewer& scene_viewer,
27  std::string const &name )
28  {
29  return HOM().newHandle(scene_viewer, name);
30  }
31 }
32 #else
34  {
36  }
37 #endif
38 
39  virtual ~HOM_Handle()
40  {
41  HOM_DESTRUCT_OBJECT(this)
42  }
43 
44  virtual std::string __repr__() = 0;
45  virtual std::string name() const = 0;
46  virtual std::string label() const = 0;
47  SWIGOUT(%warnfilter(321) type;)
48  virtual std::string type() const = 0;
49  virtual void show(bool value) = 0;
50  SWIGOUT(%kwargs update;)
51  virtual void update(bool immediate=false, bool node_update=false, bool force_update=false) = 0;
52  virtual bool visible() const = 0;
53  virtual void enableParms(std::vector<std::string> const & parm_names=std::vector<std::string>()) = 0;
54  virtual void disableParms(std::vector<std::string> const & parm_names=std::vector<std::string>()) = 0;
55  virtual void applySettings(std::string const& settings) = 0;
56  virtual void makePersistent(bool value) = 0;
57  virtual bool isPersistent() const = 0;
58  virtual bool isValid() const = 0;
59  virtual bool isActive() const = 0;
60  virtual std::vector<std::string>
61  parmPaths() const = 0;
62  virtual bool isDynamic() const = 0;
63  virtual std::string info() const = 0;
64  SWIGOUT(%kwargs nodePath;)
65  virtual std::string nodePath(int index = 0) const = 0;
66 
67  virtual void makeAsDefault() = 0;
68  virtual void revertToDefault() = 0;
69  virtual void revertToFactoryDefault() = 0;
70  virtual void exportToHDA() = 0;
71  virtual void exportParmsToHDA() = 0;
72 
73  virtual void beginUndo() = 0;
74  virtual void endUndo() = 0;
75 };
76 
77 #endif // HOM_Handle_h
78 
virtual HOM_Handle * newHandle(HOM_SceneViewer &scene_viewer, std::string const &name)=0
#define HOM_DESTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1303
GLuint GLsizei const GLchar * label
Definition: glcorearb.h:2545
virtual ~HOM_Handle()
Definition: HOM_Handle.h:39
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:349
#define HOM_API
Definition: HOM_API.h:13
#define HOM_CONSTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1302
GLuint const GLchar * name
Definition: glcorearb.h:786
OIIO_UTIL_API bool rename(string_view from, string_view to, std::string &err)
GLuint index
Definition: glcorearb.h:786
Definition: core.h:1131
HOM_API HOM_Module & HOM()
type
Definition: core.h:1059
virtual bool isValid()=0
void * Handle
Definition: plugin.h:27