/usr/share/doc/python-elements/dynamic/elements.html is in python-elements 0.13+svn20090823.230+dfsg-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 | <html>
<head>
<title>elements reference index</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<link type="text/css" rel="stylesheet" href="index.css" />
<script type="text/javascript" src="js.js"></script>
</head>
<body>
<table width="100%" cellspacing="0" cellpadding="0" border="0" style="border: 3px solid black;">
<tr>
<td valign="center" width="230" bgcolor="#ffffff" align="center" style="padding: 6px;">
<img src="logo_small.png"><br>
elements documentation (r105)
</td>
<td valign="center" bgcolor="#6aee28" align="center" style="border-left: 3px solid black; padding: 6px;">
<a href="ref.html">Reference Index</a> || <a href="index.html">Help Contents</a> || <a href="manual.html">Manual</a><br>
<br>
<a href="elements.html">elements</a> || <a href="add.html">elements.add</a> || <a href="callbacks.html">elements.callbacks</a> || <a href="box2d/classb2_world.htm" target="_blank">elements.world</a> || <a href="box2d/hierarchy.htm" target="_blank">Box2D</a>
</td>
</tr>
</table>
<br><br>
<a name="elements"></a>
<big><b>elements</big></b><br>
<ul>
<i>elements main class</i><br>
<ul>
<li><a href="elements.html#elements.__init__">elements.__init__</a> - <font size="-1">constructor of the elements class</font></li>
<li><a href="elements.html#elements.draw">elements.draw</a> - <font size="-1">draw the scene with a specified method</font></li>
<li><a href="elements.html#elements.reset_color">elements.reset_color</a> - <font size="-1">new objects will be added with random colors</font></li>
<li><a href="elements.html#elements.set_color">elements.set_color</a> - <font size="-1">new objects will be added with specified color</font></li>
<li><a href="elements.html#elements.set_drawingMethod">elements.set_drawingMethod</a> - <font size="-1">set a drawing method (pygame, ...)</font></li>
<li><a href="elements.html#elements.set_inputAxisOrigin">elements.set_inputAxisOrigin</a> - <font size="-1">configure the input coordinate system</font></li>
<li><a href="elements.html#elements.set_inputUnit">elements.set_inputUnit</a> - <font size="-1">configure input unit system (pixels or meters)</font></li>
<li><a href="elements.html#elements.set_screenSize">elements.set_screenSize</a> - <font size="-1">set current screen size</font></li>
<li><a href="elements.html#elements.update">elements.update</a> - <font size="-1">update the physics space</font></li>
</ul>
<br>The class which handles all interaction with the box2d engine.<br>
<br>
As a convenience, most of the top-level variables in elements have been placed inside a module named 'elements.locals'. This is meant to be used with 'from elements.locals import *', in addition to 'import elements'.
<br>
<br>
[[comment elements]]
<br>
<br>
<a name="elements.__init__"></a>
<big><b>elements.__init__</b></big>
<ul><i>constructor of the elements class</i><br>
<tt>elements.__init__(screen_size, gravity=(0.0, -9.0), ppm=100.0)): return Elements()</tt><br>
<br>
Parameters: <i>screen_size .. (w, h)</i> is the screen size in pixels, <i>gravity .. (x, y)</i> in m/s^2 [float] and <i>ppm</i> .. pixels per meter [int]<br>
<br>
This function is called on a <i>world = Elements()</i><br>
<br>
[[comment elements.__init__]]
</ul>
<br><br>
<a name="elements.draw"></a>
<big><b>elements.draw</b></big>
<ul><i>draw the scene with a specified method</i><br>
<tt>elements.draw(surface): return None</tt><br>
<br>
If a drawing method is specified, this function passes the objects to the module in pixels.<br>
<br>
Parameters: surface ... can be used for whatever the method needs for drawing
<br>
<br>
[[comment elements.draw]]
</ul>
<br><br>
<a name="elements.reset_color"></a>
<big><b>elements.reset_color</b></big>
<ul><i>new objects will be added with random colors</i><br>
<tt>elements.reset_color(): return None</tt><br>
<br>
All objects from now on will be drawn in random colors
<br>
<br>
[[comment elements.reset_color]]
</ul>
<br><br>
<a name="elements.set_color"></a>
<big><b>elements.set_color</b></big>
<ul><i>new objects will be added with specified color</i><br>
<tt>elements.set_color(clr): return None</tt><br>
<br>
<i>clr</i> can either be a hex color '#123123' or a rgb color ((0), (0), (0))
<br>
<br>
[[comment elements.set_color]]
</ul>
<br><br>
<a name="elements.set_drawingMethod"></a>
<big><b>elements.set_drawingMethod</b></big>
<ul><i>set a drawing method (pygame, ...)</i><br>
<tt>elements.set_drawingMethod(m): return True / False</tt><br>
<br>
Returns True if method is found, False if not.<br>
<br>
The parameter m can be for now only 'pygame'.
<br>
<br>
[[comment elements.set_drawingMethod]]
</ul>
<br><br>
<a name="elements.set_inputAxisOrigin"></a>
<big><b>elements.set_inputAxisOrigin</b></big>
<ul><i>configure the input coordinate system</i><br>
<tt>elements.set_inputAxisOrigin(left=True, top=False): return None</tt><br>
<br>
Change the origin of the input coordinate system axis<br>
<br>
Parameters:<br>
left ... True or False -- x = 0 is at the left?<br>
top .... True or False -- y = 0 is at the top?
<br>
<br>
[[comment elements.set_inputAxisOrigin]]
</ul>
<br><br>
<a name="elements.set_inputUnit"></a>
<big><b>elements.set_inputUnit</b></big>
<ul><i>configure input unit system (pixels or meters)</i><br>
<tt>elements.set_inputUnit(input): return None</tt><br>
<br>
The parameter input can be INPUT_PIXELS (1) or INPUT_METERS (0)
<br>
<br>
[[comment elements.set_inputUnit]]
</ul>
<br><br>
<a name="elements.set_screenSize"></a>
<big><b>elements.set_screenSize</b></big>
<ul><i>set current screen size</i><br>
<tt>elements.set_screenSize(m): return None</tt><br>
<br>
The parameter size is ((width), (height)) in pixels
<br>
<br>
[[comment elements.set_screenSize]]
</ul>
<br><br>
<a name="elements.update"></a>
<big><b>elements.update</b></big>
<ul><i>Update the physics, if not paused (self.run_physics)</i><br>
<tt>elements.update(fps=50.0, iterations=10): return None</tt><br>
<br>
The optional parameter <i>fps</i> specifies the frames per seconds the engine is supposoed to run,
<i>iteration</i> is the number of substeps per step (for smoother simulations)
<br>
<br>
[[comment elements.update]]
</ul>
<br><br>
</ul>
</body>
</body>
|