C++ SDK Reference  12.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
diguyPluginKeyboardEvent.h
Go to the documentation of this file.
1 
2 /*
3  * Copyright (C) 1992-2013 Boston Dynamics
4  * ALL RIGHTS RESERVED.
5  *
6  * These coded instructions, statements, and computer programs
7  * contain unpublished proprietary information of Boston Dynamics
8  * and are protected by Copyright Laws of the United States.
9  * They may not be used, duplicated, or disclosed in any form, in
10  * whole or in part, without the prior written consent from Boston
11  * Dynamics.
12  *
13  * RESTRICTED RIGHTS LEGEND
14  * Use, duplication, or disclosure by the government is subject
15  * to restrictions as set forth in FAR 52.227.19(c)(2) or
16  * subparagraph (c)(1)(ii) of the Rights in Technical Data and
17  * Computer Software clause at DFARS 252.227-7013 and/or in
18  * similar or successor clauses in the FAR, or the DOD or NASA
19  * FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the
20  * Commercial Computer Software--Restricted Rights at 48 CFR
21  * 52.227-19, as applicable. Unpublished-rights reserved under
22  * the Copyright Laws of the United States.
23  * Contractor/Manufacturer is:
24  * Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.
25  */
26 
27 
28 /*********************************************************************
29  **
30  *t diguyPluginKeyboardEvent
31  **
32  ** Objects of this type are passed into the plugin keyboard
33  ** functions key_press() and key_release().
34  */
35 
36 #ifndef __diguyPluginKeyboardEvent_H
37 #define __diguyPluginKeyboardEvent_H
38 
39 
40 #include <declspec_diguy.h>
41 
42 class diguyView;
43 
44 
45 /****************************************************************************/
46 class BDI_DECLSPEC_diguy diguyPluginKeyboardEvent
47 {
48 
49 public:
50 
51  /*l
52  *b Description:
53  **
54  ** This function returns the view in which the keyboard event
55  ** took place.
56  **
57  *b Returns:
58  **
59  ** object of type diguyView
60  **
61  *b Callable From:
62  **
63  *- - C++
64  */
65  diguyView* get_view();
66 
67  /*l
68  *b Description:
69  **
70  ** This function returns the key that was pressed of released.
71  **
72  *b Returns:
73  **
74  ** code of key
75  **
76  *b Callable From:
77  **
78  *- - C++
79  */
80  int get_key();
81 
82  /*l
83  *b Description:
84  **
85  ** This function returns the screen x coordinate at which the
86  ** keyboard event took place.
87  **
88  *b Returns:
89  **
90  ** screen x coordinate
91  **
92  *b Callable From:
93  **
94  *- - C++
95  */
96  int get_x();
97 
98  /*l
99  *b Description:
100  **
101  ** This function returns the screen y coordinate at which the
102  ** keyboard event took place.
103  **
104  *b Returns:
105  **
106  ** screen y coordinate
107  **
108  *b Callable From:
109  **
110  *- - C++
111  */
112  int get_y();
113 
118 #ifdef CPLUSPLUS_ONLY
119 
120  diguyPluginKeyboardEvent(diguyView* view,
121  int x,
122  int y,
123  int key);
124  ~diguyPluginKeyboardEvent();
125 
126 private:
127 
128  diguyView* m_view;
129  int m_x;
130  int m_y;
131  int m_key;
132 
133  friend class bdiScenarioPlugin;
134  friend class bdiScenarioEditor;
135 
136 #endif
137 
138 };
139 
140 
141 #endif /* __diguyPluginKeyboardEvent_H */
142 
143 
144 /*
145  * Copyright (C) 1992-2013 Boston Dynamics
146  * ALL RIGHTS RESERVED.
147  *
148  * These coded instructions, statements, and computer programs
149  * contain unpublished proprietary information of Boston Dynamics
150  * and are protected by Copyright Laws of the United States.
151  * They may not be used, duplicated, or disclosed in any form, in
152  * whole or in part, without the prior written consent from Boston
153  * Dynamics.
154  *
155  * RESTRICTED RIGHTS LEGEND
156  * Use, duplication, or disclosure by the government is subject
157  * to restrictions as set forth in FAR 52.227.19(c)(2) or
158  * subparagraph (c)(1)(ii) of the Rights in Technical Data and
159  * Computer Software clause at DFARS 252.227-7013 and/or in
160  * similar or successor clauses in the FAR, or the DOD or NASA
161  * FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the
162  * Commercial Computer Software--Restricted Rights at 48 CFR
163  * 52.227-19, as applicable. Unpublished-rights reserved under
164  * the Copyright Laws of the United States.
165  * Contractor/Manufacturer is:
166  * Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.
167  */
168