HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HOM_IPRViewer.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_IPRViewer_h__
10 #define __HOM_IPRViewer_h__
11 
12 #include "HOM_PaneTab.h"
13 #include "HOM_EnumModules.h"
14 #include <vector>
15 #include <utility>
16 
17 class HOM_Node;
18 class HOM_Prim;
19 
20 SWIGOUT(%rename(IPRViewer) HOM_IPRViewer;)
21 
22 class HOM_API HOM_IPRViewer : virtual public HOM_PaneTab
23 {
24 public:
26  { HOM_CONSTRUCT_OBJECT(this) }
27 
29  : HOM_PaneTab(pane)
30  { HOM_CONSTRUCT_OBJECT(this) }
31 
32  ~HOM_IPRViewer() override
33  { HOM_DESTRUCT_OBJECT(this) }
34 
35  // Let swig know we're overriding __repr__ for this class so it doesn't
36  // provide its own __repr__.
37  SWIGOUT(virtual std::string __repr__() = 0;)
38 
39  virtual bool isPaused() = 0;
40 
41  virtual bool isRendering() = 0;
42 
43  virtual bool isActive() = 0;
44 
45  virtual void killRender() = 0;
46 
47  virtual void pauseRender() = 0;
48 
49  virtual void resumeRender() = 0;
50 
51  virtual void startRender() = 0;
52 
53  virtual bool isPreviewOn() = 0;
54 
55  virtual void setPreview(bool on) = 0;
56 
57  virtual bool isAutoSaveOn() = 0;
58 
59  virtual void setAutoSave(bool on) = 0;
60 
61  virtual std::string autoSavePath() = 0;
62 
63  virtual void setAutoSavePath(const char *path) = 0;
64 
65  virtual bool isAutoUpdateOn() = 0;
66 
67  virtual void setAutoUpdate(bool on) = 0;
68 
69  virtual double autoSaveTime() = 0;
70 
71  virtual void setAutoSaveTime(double time) = 0;
72 
73  virtual double delay() = 0;
74 
75  virtual void setDelay(double time) = 0;
76 
77  virtual double updateTime() = 0;
78 
79  virtual void setUpdateTime(double time) = 0;
80 
81  virtual std::vector<int> lastClickLocation() = 0;
82 
83  SWIGOUT(%newobject ropNode;)
84  virtual HOM_Node *ropNode() = 0;
85 
86  virtual void setRopNode(HOM_Node *rop_node) = 0;
87 
88  virtual std::vector<int> imageResolution() = 0;
89 
90  virtual std::vector<double> cropRegion() = 0;
91 
92  virtual std::vector<std::string> planes() = 0;
93 
94  virtual std::string displayedPlane() = 0;
95 
96  virtual std::vector<double> pixel(const char *plane_name, int x, int y) = 0;
97 
98  virtual std::vector<std::vector<double> > pixels(const char *plane_name) = 0;
99 
100  virtual std::string evaluatedStyleSheetJSON(int x, int y) = 0;
101 
102  virtual std::vector<std::pair<std::string, int> >
103  evaluatedStyleSheetPaths(int x, int y) = 0;
104 
105  virtual bool saveFrame(const char *file_path, int source=0, int xres=-1,
106  int yres=-1, const char *color="C",
107  const char *alpha="C", const char *scope="*",
108  const char *lut="", float gamma=1.0,
109  bool convert=true) = 0;
110 
111  SWIGOUT(%newobject objectNode;)
112  virtual HOM_Node *objectNode(int x, int y) = 0;
113 
114  SWIGOUT(%newobject prim;)
115  virtual HOM_Prim *prim(int x, int y) = 0;
116 
117  SWIGOUT(%newobject materialNode;)
118  virtual HOM_Node *materialNode(int x, int y) = 0;
119 
120  virtual bool usingOCIO() = 0;
121  virtual void setUsingOCIO(bool enable) = 0;
122 
123  SWIGOUT(%kwargs setOCIODisplayView;)
124  virtual void setOCIODisplayView(const char *display = nullptr,
125  const char *view = nullptr) = 0;
126  virtual std::string getOCIODisplay() = 0;
127  virtual std::string getOCIOView() = 0;
128 
129 };
130 
131 #endif
#define HOM_DESTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1291
GT_API const UT_StringHolder time
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
#define SWIGOUT(x)
Definition: HOM_Defines.h:24
string __repr__(VtArray< T > const &self)
Definition: wrapArray.h:352
GLint GLint GLsizei GLint GLenum GLenum const void * pixels
Definition: glcorearb.h:108
GLint y
Definition: glcorearb.h:103
Tto convert(const Tfrom &source)
~HOM_IPRViewer() override
Definition: HOM_IPRViewer.h:32
#define HOM_API
Definition: HOM_API.h:13
#define HOM_CONSTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1290
GLsizei GLsizei GLchar * source
Definition: glcorearb.h:803
GLfloat GLfloat GLfloat alpha
Definition: glcorearb.h:112
GLint GLenum GLint x
Definition: glcorearb.h:409
GLuint color
Definition: glcorearb.h:1261
OIIO_UTIL_API bool rename(string_view from, string_view to, std::string &err)
Definition: core.h:982
HOM_IPRViewer(const HOM_IPRViewer &pane)
Definition: HOM_IPRViewer.h:28