HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HOM_GeometryViewport.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_GeometryViewport_h__
10 #define __HOM_GeometryViewport_h__
11 
12 #include "HOM_API.h"
13 #include "HOM_Defines.h"
14 #include "HOM_ElemPtr.h"
15 #include "HOM_Errors.h"
16 #include "HOM_Module.h"
17 #include "HOM_ObjNode.h"
18 #include "HOM_EnumValue.h"
19 #include <UT/UT_Tuple.h>
20 
21 class HOM_Drawable;
24 class HOM_Selection;
25 class HOM_Vector2;
26 
27 SWIGOUT(%rename(GeometryViewport) HOM_GeometryViewport;)
28 
30 {
31 public:
33  { HOM_CONSTRUCT_OBJECT(this) }
35  { HOM_CONSTRUCT_OBJECT(this) }
37  { HOM_DESTRUCT_OBJECT(this) }
38 
39  virtual std::string __repr__() = 0;
40 
41  SWIGOUT(%warnfilter(321) type;)
42  virtual HOM_EnumValue& type() = 0;
43  virtual void changeType(HOM_EnumValue &type) = 0;
44 
45  SWIGOUT(%newobject settings;)
46  virtual HOM_GeometryViewportSettings *settings() = 0;
47 
48  virtual std::string name() = 0;
49  virtual void changeName(std::string &name) = 0;
50 
51  virtual void home() = 0;
52 
53  virtual void homeAll() = 0;
54  virtual void homeSelected() = 0;
55  virtual void homeGrid() = 0;
56  virtual void homeNonTemplated() = 0;
57  virtual void homeBoundingBox(HOM_BoundingBox *bbox, bool center_to_origin = false) = 0;
58 
59  virtual void frameAll() = 0;
60  virtual void frameBoundingBox(HOM_BoundingBox *bbox = NULL) = 0;
61  virtual void frameSelected() = 0;
62  virtual void frameGrid() = 0;
63  virtual void frameNonTemplated() = 0;
64 
65  virtual void draw() = 0;
66 
67  SWIGOUT(%newobject viewTransform;)
68  virtual HOM_Matrix4 *viewTransform() = 0;
69 
70  SWIGOUT(%newobject modelToGeometryTransform;)
71  virtual HOM_Matrix4 *modelToGeometryTransform() = 0;
72  SWIGOUT(%newobject cameraToModelTransform;)
73  virtual HOM_Matrix4 *cameraToModelTransform() = 0;
74  SWIGOUT(%newobject ndcToCameraTransform;)
75  virtual HOM_Matrix4 *ndcToCameraTransform() = 0;
76  SWIGOUT(%newobject viewportToNDCTransform;)
77  virtual HOM_Matrix4 *viewportToNDCTransform() = 0;
78  SWIGOUT(%newobject windowToViewportTransform;)
79  virtual HOM_Matrix4 *windowToViewportTransform() = 0;
80 
81  SWIGOUT(%newobject viewPivot;)
82  virtual HOM_Vector3 *viewPivot() = 0;
83 
84  virtual std::vector<int> resolutionInPixels() = 0;
85 
86  SWIGOUT(%newobject camera;)
87  virtual HOM_ObjNode *camera() = 0;
88  virtual std::string cameraPath() = 0;
89  virtual void setCamera(HOM_ObjNode &camera_node) = 0;
90  virtual void setCamera(const char *camera_path) = 0;
91  virtual void saveViewToCamera(HOM_ObjNode &camera_node) = 0;
92 
93  SWIGOUT(%newobject defaultCamera;)
94  virtual HOM_GeometryViewportCamera *defaultCamera() =0;
95  virtual void setDefaultCamera(HOM_GeometryViewportCamera *cam_settings) =0;
96  virtual void useDefaultCamera() =0;
97 
98  virtual bool isCameraLockedToView() = 0;
99  virtual void lockCameraToView(bool) = 0;
100 
101  virtual bool isViewExportedToCameraContinuously() = 0;
102  virtual void exportViewToCameraContinuously(bool) = 0;
103 
104  virtual bool isActive2D() = 0;
105  virtual bool isActive3D() = 0;
106 
107  virtual bool usesConstructionPlane() = 0;
108 
109  SWIGOUT(%newobject queryNodeAtPixel;)
110  virtual HOM_Node *queryNodeAtPixel(int x, int y, bool pick_templates=false) = 0;
111  SWIGOUT(%newobject queryPrimAtPixel;)
112  virtual HOM_Prim *queryPrimAtPixel(HOM_Node *node, int x, int y) = 0;
113 
114  virtual std::pair<int, int> _queryPrimOnDrawables(
115  const std::vector<HOM_Drawable *> &drawables,
116  int x, int y,
117  bool enable_occlusion) = 0;
118 
119  virtual std::vector<std::pair<int, HOM_ElemPtr<HOM_Selection> > >
120  _queryComponentsOnDrawables(
121  const std::vector<HOM_Drawable *> &drawables,
122  HOM_Vector2 &start, HOM_Vector2 *end_inclusive = nullptr,
123  bool enable_occlusion = false,
124  bool contained = false) = 0;
125 
126  SWIGOUT(%newobject queryInspectedGeometry;)
127  virtual HOM_Geometry *queryInspectedGeometry() = 0;
128  SWIGOUT(%newobject queryInspectedPrim;)
129  virtual HOM_Prim *queryInspectedPrim() = 0;
130 
131  virtual std::pair<HOM_ElemPtr<HOM_Vector3>, HOM_ElemPtr<HOM_Vector3> >
132  mapToWorld(double x, double y) = 0;
133 
134  virtual HOM_Vector2 *mapToScreen(const HOM_Vector3 &pos) = 0;
135 
136  virtual std::pair<int, int> mapFromMouseChop(double x, double y) = 0;
137 
139  queryWorldPositionAndNormal(int x, int y,
140  const HOM_EnumValue selection_restriction =
141  HOM_snapSelectionMode::SnapToAll)=0;
142 
143  virtual std::vector<int> size() = 0;
144  virtual std::vector<int> geometry() = 0;
145 
146  SWIGOUT(%ignore addOpaqueEventCallback;)
147  virtual void addOpaqueEventCallback(void *callback) = 0;
148  SWIGOUT(%ignore removeOpaqueEventCallback;)
149  virtual void removeOpaqueEventCallback(void *callback) = 0;
150  SWIGOUT(%ignore opaqueEventCallbacks;)
151  virtual std::vector<void *> opaqueEventCallbacks() = 0;
152  SWIGOUT(%ignore clearOpaqueEventCallbacks;)
153  virtual void clearOpaqueEventCallbacks() = 0;
154 
155 #ifdef SWIG
156 // expose the handling of the viewport callbacks to HOM
157 %extend
158 {
159  void addEventCallback(InterpreterObject callback)
160  {
161  self->addOpaqueEventCallback(callback);
162  }
163 
164  void removeEventCallback(InterpreterObject callback)
165  {
166  self->removeOpaqueEventCallback(callback);
167  }
168 
169  void clearEventCallbacks()
170  {
171  self->clearOpaqueEventCallbacks();
172  }
173 
174  std::vector<InterpreterObject> eventCallbacks()
175  {
176  std::vector<void *> opaque_callbacks(self->opaqueEventCallbacks());
177 
178  std::vector<InterpreterObject> callbacks;
179  for (int i = 0; i< opaque_callbacks.size(); ++i)
180  callbacks.push_back((InterpreterObject)opaque_callbacks[i]);
181  return callbacks;
182  }
183 }
184 #endif
185 
186 };
187 
188 #endif
#define HOM_DESTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1291
GLuint start
Definition: glcorearb.h:475
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:352
GLint y
Definition: glcorearb.h:103
std::tuple< Types...> UT_Tuple
Definition: UT_Tuple.h:53
#define HOM_API
Definition: HOM_API.h:13
void ignore(T const &) VULKAN_HPP_NOEXCEPT
Definition: vulkan.hpp:6508
#define HOM_CONSTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:1290
GLuint const GLchar * name
Definition: glcorearb.h:786
GLint GLenum GLint x
Definition: glcorearb.h:409
GLsizeiptr size
Definition: glcorearb.h:664
OIIO_UTIL_API bool rename(string_view from, string_view to, std::string &err)
HOM_GeometryViewport(const HOM_GeometryViewport &)
type
Definition: core.h:1059