HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HOM_ViewportVisualizer.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_ViewportVisualizer_h__
10 #define __HOM_ViewportVisualizer_h__
11 
12 #include "HOM_API.h"
13 #include "HOM_Defines.h"
14 #include "HOM_Errors.h"
15 #include "HOM_Module.h"
16 
17 #include <string>
18 #include <vector>
19 
21 class HOM_Ramp;
24 
25 SWIGOUT(%rename(ViewportVisualizer) HOM_ViewportVisualizer;)
26 
28 {
29 public:
31  { HOM_CONSTRUCT_OBJECT(this) }
33  { HOM_DESTRUCT_OBJECT(this) }
34 
35  virtual bool operator==(HOM_PtrOrNull<HOM_ViewportVisualizer> visualizer) = 0;
36  virtual bool operator!=(HOM_PtrOrNull<HOM_ViewportVisualizer> visualizer) = 0;
37 
38  virtual std::string __repr__() = 0;
39 
40  virtual std::string name() = 0;
41  virtual void setName(const char *name) = 0;
42 
43  virtual std::string label() = 0;
44  virtual void setLabel(const char *label) = 0;
45 
46  virtual std::string icon() = 0;
47  virtual void setIcon(const char *icon) = 0;
48 
49 
50  // We set the %newobject directive for isActive() and setIsActive()
51  // because they internally call categoryNode().
52  SWIGOUT(%kwargs isActive;)
53  virtual bool isActive(HOM_GeometryViewport *viewport=NULL) = 0;
54  SWIGOUT(%kwargs setIsActive;)
55  virtual void setIsActive(bool on, HOM_GeometryViewport *viewport=NULL) = 0;
56 
57  SWIGOUT(%warnfilter(321) type;)
58  SWIGOUT(%newobject type;)
59  virtual HOM_ViewportVisualizerType *type() = 0;
60  virtual void setType(HOM_ViewportVisualizerType *type) = 0;
61 
62  virtual HOM_EnumValue &category() = 0;
63  SWIGOUT(%newobject categoryNode;)
64  virtual HOM_Node *categoryNode() = 0;
65 
66  virtual HOM_EnumValue &scope() = 0;
67  virtual void setScope(HOM_EnumValue &scope) = 0;
68 
69  virtual bool isShownInToolbar() = 0;
70  virtual void showInToolbar(bool on) = 0;
71 
72  virtual bool isActiveWhenUnselected() = 0;
73  virtual void setIsActiveWhenUnselected(bool on) = 0;
74  virtual bool isActiveWhenSelected() = 0;
75  virtual void setIsActiveWhenSelected(bool on) = 0;
76  virtual bool isActiveWhenGhosted() = 0;
77  virtual void setIsActiveWhenGhosted(bool on) = 0;
78  virtual bool isActiveWhenDisplayed() = 0;
79  virtual void setIsActiveWhenDisplayed(bool on) = 0;
80  virtual bool isActiveWhenCurrent() = 0;
81  virtual void setIsActiveWhenCurrent(bool on) = 0;
82  virtual bool isActiveWhenTemplated() = 0;
83  virtual void setIsActiveWhenTemplated(bool on) = 0;
84 
85  virtual std::vector<std::string> parmNames() = 0;
86  virtual double evalParmAsFloat(const char *parm_name) = 0;
87  virtual int evalParmAsInt(const char *parm_name) = 0;
88  virtual std::string evalParmAsString(const char *parm_name) = 0;
89  SWIGOUT(%newobject evalParmAsRamp;)
90  virtual HOM_Ramp *evalParmAsRamp(const char *parm_name) = 0;
91 
92 #ifdef SWIG
93 %extend
94 {
95  InterpreterObject evalParm(const char *parm_name)
96  {
97  return HOMevalViewportVisualizerParm(*self, parm_name);
98  }
99 }
100 #endif
101 
102  virtual void setParm(const char *parm_name, double float_value) = 0;
103  virtual void setParm(const char *parm_name, int int_value) = 0;
104  virtual void setParm(const char *parm_name, const char *string_value) = 0;
105  virtual void setParm(const char *parm_name, HOM_Ramp *ramp_value) = 0;
106 
107  SWIGOUT(%ignore parmDataTypeEnumId;)
108  virtual int parmDataTypeEnumId(const char *parm_name) = 0;
109 
110  virtual void destroy() = 0;
111 
112 };
113 
114 #endif
115 
#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
PUGI__FN xpath_string string_value(const xpath_node &na, xpath_allocator *alloc)
Definition: pugixml.cpp:7757
#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
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
virtual std::string icon()=0
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