HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros 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(%newobject type;)
58  virtual HOM_ViewportVisualizerType *type() = 0;
59  virtual void setType(HOM_ViewportVisualizerType *type) = 0;
60 
61  virtual HOM_EnumValue &category() = 0;
62  SWIGOUT(%newobject categoryNode;)
63  virtual HOM_Node *categoryNode() = 0;
64 
65  virtual HOM_EnumValue &scope() = 0;
66  virtual void setScope(HOM_EnumValue &scope) = 0;
67 
68  virtual bool isShownInToolbar() = 0;
69  virtual void showInToolbar(bool on) = 0;
70 
71  virtual bool isActiveWhenUnselected() = 0;
72  virtual void setIsActiveWhenUnselected(bool on) = 0;
73  virtual bool isActiveWhenSelected() = 0;
74  virtual void setIsActiveWhenSelected(bool on) = 0;
75  virtual bool isActiveWhenGhosted() = 0;
76  virtual void setIsActiveWhenGhosted(bool on) = 0;
77  virtual bool isActiveWhenDisplayed() = 0;
78  virtual void setIsActiveWhenDisplayed(bool on) = 0;
79  virtual bool isActiveWhenCurrent() = 0;
80  virtual void setIsActiveWhenCurrent(bool on) = 0;
81  virtual bool isActiveWhenTemplated() = 0;
82  virtual void setIsActiveWhenTemplated(bool on) = 0;
83 
84  virtual std::vector<std::string> parmNames() = 0;
85  virtual double evalParmAsFloat(const char *parm_name) = 0;
86  virtual int evalParmAsInt(const char *parm_name) = 0;
87  virtual std::string evalParmAsString(const char *parm_name) = 0;
88  SWIGOUT(%newobject evalParmAsRamp;)
89  virtual HOM_Ramp *evalParmAsRamp(const char *parm_name) = 0;
90 
91 #ifdef SWIG
92 %extend
93 {
94  InterpreterObject evalParm(const char *parm_name)
95  {
96  return HOMevalViewportVisualizerParm(*self, parm_name);
97  }
98 }
99 #endif
100 
101  virtual void setParm(const char *parm_name, double float_value) = 0;
102  virtual void setParm(const char *parm_name, int int_value) = 0;
103  virtual void setParm(const char *parm_name, const char *string_value) = 0;
104  virtual void setParm(const char *parm_name, HOM_Ramp *ramp_value) = 0;
105 
106  SWIGOUT(%ignore parmDataTypeEnumId;)
107  virtual int parmDataTypeEnumId(const char *parm_name) = 0;
108 
109  virtual void destroy() = 0;
110 
111 };
112 
113 #endif
114 
#define HOM_DESTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:973
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
virtual std::string __repr__()=0
#define HOM_API
Definition: HOM_API.h:13
#define HOM_CONSTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:972
bool operator!=(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Inequality operator, does exact floating point comparisons.
Definition: Mat3.h:610
GLuint const GLchar * name
Definition: glcorearb.h:785
virtual std::string icon()=0
GLint GLint GLsizei GLint GLenum GLenum type
Definition: glcorearb.h:107
bool operator==(const Mat3< T0 > &m0, const Mat3< T1 > &m1)
Equality operator, does exact floating point comparisons.
Definition: Mat3.h:596