-
Notifications
You must be signed in to change notification settings - Fork 1
/
PI_HelloWorld1.py
163 lines (136 loc) · 5.7 KB
/
PI_HelloWorld1.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
"""
HellWorld.py
Ported to Python by Sandy Barbour - 28/04/2005
Ported to XPPython3 by Peter Buckner - 26-Jul-2020
This plugin implements the canonical first program. In this case, we will
create a window that has the text hello-world in it. As an added bonus
the text will change to 'This is a plugin' while the mouse is held down
in the window.
This plugin demonstrates creating a window and writing mouse and drawing
callbacks for that window.
"""
from XPPython3 import xp
class PythonInterface:
"""
XPluginStart
Our start routine registers our window and does any other initialization we
must do.
"""
def XPluginStart(self):
"""
First we must fill in the passed in buffers to describe our
plugin to the plugin-system."""
self.Name = "HelloWorld1 v1.0"
self.Sig = "helloWorld1.demos.xppython3"
self.Desc = "A test plugin for the Python Interface."
self.Clicked = False
"""
Now we create a window. We pass in a rectangle in left, top,
right, bottom screen coordinates. We pass in three callbacks."""
self.WindowId = xp.createWindowEx(50, 600, 300, 400, 1,
self.DrawWindowCallback,
self.MouseClickCallback,
self.KeyCallback,
self.CursorCallback,
self.MouseWheelCallback,
0,
xp.WindowDecorationRoundRectangle,
xp.WindowLayerFloatingWindows,
None)
return self.Name, self.Sig, self.Desc
"""
XPluginStop
Our cleanup routine deallocates our window.
Thing you create, register in "Start" should be destroyed, unregistered in "Stop"
"""
def XPluginStop(self):
xp.destroyWindow(self.WindowId)
"""
XPluginEnable.
We don't do any enable-specific initialization, but we must return 1 to indicate
that we may be enabled at this time.
"""
def XPluginEnable(self):
return 1
"""
XPluginDisable
We do not need to do anything when we are disabled, but we must provide the handler.
Similar to Start/Stop, things you create / register in Enable should be
destroyed / unregistered in Disable
"""
def XPluginDisable(self):
pass
"""
XPluginReceiveMessage
We don't have to do anything in our receive message handler, but we must provide one.
"""
def XPluginReceiveMessage(self, inFromWho, inMessage, inParam):
pass
"""
MyDrawingWindowCallback
This callback does the work of drawing our window once per sim cycle each time
it is needed. It dynamically changes the text depending on the saved mouse
status. Note that we don't have to tell X-Plane to redraw us when our text
changes; we are redrawn by the sim continuously.
"""
def DrawWindowCallback(self, inWindowID, inRefcon):
# First we get the location of the window passed in to us.
(left, top, right, bottom) = xp.getWindowGeometry(inWindowID)
"""
We now use an XPLMGraphics routine to draw a translucent dark
rectangle that is our window's shape.
"""
xp.drawTranslucentDarkBox(left, top, right, bottom)
color = 1.0, 1.0, 1.0
if self.Clicked:
Desc = "I'm a plugin 1"
else:
Desc = "Hello World 1"
"""
Finally we draw the text into the window, also using XPLMGraphics
routines. The NULL indicates no word wrapping.
"""
xp.drawString(color, left + 5, top - 20, Desc, 0, xp.Font_Basic)
"""
MyHandleKeyCallback
Our key handling callback does nothing in this plugin. This is ok;
we simply don't use keyboard input.
"""
def KeyCallback(self, inWindowID, inKey, inFlags, inVirtualKey, inRefcon, losingFocus):
pass
"""
MyHandleMouseClickCallback
Our mouse click callback toggles the status of our mouse variable
as the mouse is clicked. We then update our text on the next sim
cycle.
"""
def MouseClickCallback(self, inWindowID, x, y, inMouse, inRefcon):
"""
If we get a down or up, toggle our status click. We will
never get a down without an up if we accept the down.
"""
if inMouse in (xp.MouseDown, xp.MouseUp):
self.Clicked = not self.Clicked
"""
Returning 1 tells X-Plane that we 'accepted' the click; otherwise
it would be passed to the next window behind us. If we accept
the click we get mouse moved and mouse up callbacks, if we don't
we do not get any more callbacks. It is worth noting that we
will receive mouse moved and mouse up even if the mouse is dragged
out of our window's box as long as the click started in our window's
box.
"""
return 1
def CursorCallback(self, inWindowID, x, y, inRefcon):
"""
Cursor Callback, you must return XPLMCursorStatus to indicate how to
display the cursor.
"""
return xp.CursorDefault
def MouseWheelCallback(self, inWindowID, x, y, wheel, clicks, inRefcon):
"""
return 1 to consume the mouse wheel movement, 0 to pass them to lower window.
(If you window appears opaque to the user, you should consume the mouse wheel
scolling, even if it does nothing.)
"""
return 1