HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
HOM_Desktop.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_Desktop_h__
10 #define __HOM_Desktop_h__
11 
12 #include "HOM_API.h"
13 #include "HOM_Defines.h"
14 #include "HOM_Errors.h"
15 #include "HOM_Module.h"
16 #include "HOM_EnumValue.h"
17 #include <string>
18 #include <vector>
19 
20 class HOM_ShelfDock;
21 class HOM_Pane;
22 class HOM_PaneTab;
23 class HOM_FloatingPanel;
24 
25 SWIGOUT(%rename(Desktop) HOM_Desktop;)
26 
28 {
29 public:
31  { HOM_CONSTRUCT_OBJECT(this) }
33  { HOM_CONSTRUCT_OBJECT(this) }
34  virtual ~HOM_Desktop()
35  { HOM_DESTRUCT_OBJECT(this) }
36 
37  virtual std::string __repr__() = 0;
38 
39  virtual std::vector<HOM_ElemPtr<HOM_Pane> > panes() = 0;
40 
41  virtual std::vector<HOM_ElemPtr<HOM_PaneTab> > paneTabs() = 0;
42 
43  virtual std::vector<HOM_ElemPtr<HOM_PaneTab> > currentPaneTabs() = 0;
44 
45  virtual std::vector<HOM_ElemPtr<HOM_PaneTab> > floatingPaneTabs() = 0;
46 
47  SWIGOUT(%newobject paneTabOfType;)
48  virtual HOM_PaneTab *paneTabOfType(HOM_EnumValue &type, int index=0) = 0;
49 
50  SWIGOUT(%newobject findPaneTab;)
51  virtual HOM_PaneTab *findPaneTab(const char *name) = 0;
52 
53  SWIGOUT(%newobject createFloatingPaneTab;)
54  SWIGOUT(%kwargs createFloatingPaneTab;)
55  virtual HOM_PaneTab *createFloatingPaneTab(
56  HOM_EnumValue &pane_tab_type,
57  const std::vector<int> &position = std::vector<int>(),
58  const std::vector<int> &size = std::vector<int>(),
59  const char *python_panel_interface=nullptr) = 0;
60 
61  // This method is deprecated:
62  SWIGOUT(%newobject createFloatingPane;)
64  HOM_EnumValue &pane_tab_type,
65  const std::vector<int> &position = std::vector<int>(),
66  const std::vector<int> &size = std::vector<int>())
67  { return createFloatingPaneTab(pane_tab_type, position, size); }
68 
69  virtual std::vector<HOM_ElemPtr<HOM_FloatingPanel> > floatingPanels() = 0;
70 
71  SWIGOUT(%newobject createFloatingPanel;)
72  SWIGOUT(%kwargs createFloatingPanel;)
73  virtual HOM_FloatingPanel *createFloatingPanel(HOM_EnumValue &pane_tab_type,
74  const std::vector<int> &position = std::vector<int>(),
75  const std::vector<int> &size = std::vector<int>(),
76  const char *python_panel_interface=nullptr) = 0;
77 
78  SWIGOUT(%newobject paneUnderCursor;)
79  virtual HOM_Pane *paneUnderCursor() = 0;
80  SWIGOUT(%newobject paneTabUnderCursor;)
81  virtual HOM_PaneTab *paneTabUnderCursor() = 0;
82 
83 
84  virtual std::string name() = 0;
85 
86  SWIGOUT(%newobject shelfDock;)
87  virtual HOM_ShelfDock *shelfDock() = 0;
88 
89  SWIGOUT(%newobject displaySideHelp;)
90  virtual HOM_PaneTab *displaySideHelp(bool show = true) = 0;
91  virtual void displayHelp(HOM_NodeType &node_type) = 0;
92  virtual void displayHelpPath(const char *help_path) = 0;
93  virtual void displayHelpPyPanel(const char *interface_name) = 0;
94 
95  virtual void setAsCurrent() = 0;
96 };
97 
98 #endif
#define HOM_DESTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:973
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
#define SWIGOUT(x)
Definition: HOM_Defines.h:24
GLsizeiptr size
Definition: glcorearb.h:663
virtual ~HOM_Desktop()
Definition: HOM_Desktop.h:34
#define HOM_API
Definition: HOM_API.h:13
#define HOM_CONSTRUCT_OBJECT(pointer)
Definition: HOM_Module.h:972
virtual HOM_PaneTab * paneTabOfType(HOM_EnumValue &type, int index=0)=0
GLuint const GLchar * name
Definition: glcorearb.h:785
virtual HOM_Vector2 * position()=0
virtual HOM_PaneTab * findPaneTab(const char *name)=0
virtual std::string __repr__()=0
GLuint index
Definition: glcorearb.h:785
virtual std::vector< HOM_ElemPtr< HOM_Pane > > panes()=0
GLint GLint GLsizei GLint GLenum GLenum type
Definition: glcorearb.h:107
HOM_Desktop(const HOM_Desktop &)
Definition: HOM_Desktop.h:32
HOM_PaneTab * createFloatingPane(HOM_EnumValue &pane_tab_type, const std::vector< int > &position=std::vector< int >(), const std::vector< int > &size=std::vector< int >())
Definition: HOM_Desktop.h:63
virtual std::vector< HOM_ElemPtr< HOM_PaneTab > > paneTabs()=0