TI-Nspire(TM) Lua Scripting API Reference Guide - Texas Instruments

156 Pages·2012·0.49 MB·English

by  Texas Instruments Incorporated

Lua Scripting API Reference Guide
This reference guide applies to TI-NspireTM software version 3.2. To obtain the latest
version of the documentation, go to education.ti.com/nspire/scripting.
Important Information
Except as otherwise expressly stated in the License that accompanies a program, Texas
Instruments makes no warranty, either express or implied, including but not limited to any
implied warranties of merchantability and fitness for a particular purpose, regarding any
programs or book materials and makes such materials available solely on an ”as-is” basis.
In no event shall Texas Instruments be liable to anyone for special, collateral, incidental,
or consequential damages in connection with or arising out of the purchase or use of these
materials, and the sole and exclusive liability of Texas Instruments, regardless of the form
of action, shall not exceed the amount set forth in the license for the program. Moreover,
Texas Instruments shall not be liable for any claim of any kind whatsoever against the use
of these materials by any other party.
(cid:13)c 2011 - 2012 Texas Instruments Incorporated
The TI-NspireTM software uses Lua as scripting environment. For copyright and license
information, see http://www.lua.org/license.html.
The TI-NspireTM software uses Chipmunk Physics as simulation environment. For license
information, see http://chipmunk-physics.net/release/ChipmunkLatest-Docs/.
Microsoft(cid:13)R Windows(cid:13)R, and Mac(cid:13)R OS X(cid:13)R are trademarks of their respective own-
ers.
i
Contents
1 Standard Libraries 1
1.1 Basic Library Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.1.1 Coroutine Sub-Library . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2 Module Library. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.3 String Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.4 Table Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.5 Math Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.6 Unimplemented Libraries and Functions . . . . . . . . . . . . . . . . . . . . 3
2 2D Editor 4
2.1 newRichText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.2 createChemBox. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3 createMathBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.4 getExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.5 getExpressionSelection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.6 getText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.7 hasFocus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.8 isVisible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.9 move . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.10 registerFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.11 resize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.12 setBorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.13 setBorderColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.14 setColorable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.15 setDisable2DinRT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.16 setExpression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.17 setFocus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.18 setFontSize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.19 setMainFont . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.20 setReadOnly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
ii
2.21 setSelectable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.22 setSizeChangeListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.23 setText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.24 setTextChangeListener . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.25 setTextColor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.26 setVisible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.27 setWordWrapWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
3 Class Library 16
3.1 class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
4 Clipboard Library 17
4.1 addText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
4.2 getText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
5 Cursor Library 18
5.1 set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
5.2 hide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
5.3 show . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6 Document Library 20
6.1 markChanged . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
7 Event Handling 21
7.1 activate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
7.2 arrowDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
7.3 arrowKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
7.4 arrowLeft . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
7.5 arrowRight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
7.6 arrowUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
7.7 charIn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
7.8 backspaceKey. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
7.9 backtabKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
7.10 clearKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
7.11 construction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
7.12 contextMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
7.13 copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
7.14 create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
7.15 createMathBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
7.16 cut . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
7.17 deactivate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
7.18 deleteKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
iii
7.19 destroy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
7.20 enterKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
7.21 escapeKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
7.22 getFocus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
7.23 getSymbolList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
7.24 grabDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
7.25 grabUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
7.26 help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
7.27 loseFocus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
7.28 mouseDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
7.29 mouseMove . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
7.30 mouseUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
7.31 paint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
7.32 paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
7.33 resize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
7.34 restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
7.35 returnKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
7.36 rightMouseDown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
7.37 rightMouseUp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
7.38 save . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
7.39 tabKey . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
7.40 timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
7.41 varChange . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
8 Graphics Library 35
8.1 clipRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
8.2 drawArc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
8.3 drawImage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
8.4 drawLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
8.5 drawPolyLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8.6 drawRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8.7 drawString . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8.8 fillArc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
8.9 fillPolygon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
8.10 fillRect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
8.11 getStringHeight . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
8.12 getStringWidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
8.13 setColorRGB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
8.14 setFont . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
8.15 setPen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
iv
9 Image Library 41
9.1 new . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
9.2 copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
9.3 height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
9.4 rotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
9.5 width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10 Locale Library 44
10.1 name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
11 Math Library Extension 45
11.1 eval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
11.2 evalStr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
11.3 getEvalSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
11.4 setEvalSettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
12 Physics Library 51
12.1 Miscellaneous routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
12.1.1 INFINITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
12.1.2 momentForBox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
12.1.3 momentForCircle . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
12.1.4 momentForPoly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
12.1.5 momentForSegment . . . . . . . . . . . . . . . . . . . . . . . . . . 53
12.2 Vectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
12.2.1 Vect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
12.2.2 add. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
12.2.3 clamp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
12.2.4 cross . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
12.2.5 dist. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
12.2.6 distsq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
12.2.7 dot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
12.2.8 eql . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
12.2.9 length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
12.2.10 lengthsq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
12.2.11 lerp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
12.2.12 lerpconst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
12.2.13 mult . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
12.2.14 near . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
12.2.15 neg . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
12.2.16 normalize . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
12.2.17 normalizeSafe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
v
12.2.18 perp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
12.2.19 project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
12.2.20 rotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
12.2.21 rperp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
12.2.22 setx . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
12.2.23 sety . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
12.2.24 slerp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
12.2.25 slerpconst . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
12.2.26 sub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
12.2.27 toangle. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
12.2.28 unrotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
12.2.29 x . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
12.2.30 y . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
12.3 Bounding Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
12.3.1 BB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
12.3.2 b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
12.3.3 clampVect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
12.3.4 containsBB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
12.3.5 containsVect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
12.3.6 expand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
12.3.7 intersects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
12.3.8 l . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
12.3.9 merge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
12.3.10 setb . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
12.3.11 r . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
12.3.12 setl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
12.3.13 setr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
12.3.14 sett. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
12.3.15 t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
12.3.16 wrapVect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
12.4 Bodies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
12.4.1 Body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
12.4.2 activate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
12.4.3 angle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
12.4.4 angVel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
12.4.5 applyForce . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
12.4.6 applyImpulse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
12.4.7 data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
12.4.8 force . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
12.4.9 isRogue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
12.4.10 isSleeping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
vi
12.4.11 local2World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
12.4.12 kineticEnergy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
12.4.13 mass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
12.4.14 moment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
12.4.15 pos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
12.4.16 resetForces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
12.4.17 rot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
12.4.18 setAngle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
12.4.19 setAngVel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
12.4.20 setData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
12.4.21 setForce . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
12.4.22 setMass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
12.4.23 setMoment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
12.4.24 setPos . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
12.4.25 setPositionFunc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
12.4.26 setTorque . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
12.4.27 setVel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
12.4.28 setVelocityFunc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
12.4.29 setVLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
12.4.30 setWLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
12.4.31 sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
12.4.32 sleepWithGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
12.4.33 torque . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
12.4.34 updatePosition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
12.4.35 updateVelocity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
12.4.36 vel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
12.4.37 vLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
12.4.38 wLimit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
12.4.39 world2Local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
12.5 Shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
12.5.1 BB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
12.5.2 body . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
12.5.3 collisionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
12.5.4 data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
12.5.5 friction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
12.5.6 group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
12.5.7 layers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
12.5.8 rawBB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
12.5.9 restitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
12.5.10 sensor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
12.5.11 setCollisionType . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
vii
12.5.12 setData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
12.5.13 setFriction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
12.5.14 setGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
12.5.15 setLayers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
12.5.16 setRestitution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
12.5.17 setSensor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
12.5.18 setSurfaceV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
12.5.19 surfaceV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
12.6 Circle Shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
12.6.1 CircleShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
12.6.2 offset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
12.6.3 radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
12.7 Polygon Shapes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
12.7.1 PolyShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
12.7.2 numVerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
12.7.3 points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
12.7.4 vert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
12.8 Segment Shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
12.8.1 SegmentShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
12.8.2 a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
12.8.3 b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
12.8.4 normal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
12.8.5 radius . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
12.9 Spaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
12.9.1 Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
12.9.2 addBody . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
12.9.3 addConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
12.9.4 addCollisionHandler . . . . . . . . . . . . . . . . . . . . . . . . . . 98
12.9.5 addPostStepCallback . . . . . . . . . . . . . . . . . . . . . . . . . . 99
12.9.6 addShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
12.9.7 addStaticShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
12.9.8 damping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
12.9.9 data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
12.9.10 elasticIterations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
12.9.11 gravity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
12.9.12 idleSpeedThreshold . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
12.9.13 iterations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
12.9.14 rehashShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
12.9.15 rehashStatic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
12.9.16 removeBody . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
12.9.17 removeConstraint . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
viii
12.9.18 removeShape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
12.9.19 removeStaticShape . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
12.9.20 resizeActiveHash . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
12.9.21 resizeStaticHash . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
12.9.22 setDamping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
12.9.23 setData . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
12.9.24 setElasticIterations . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
12.9.25 setGravity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
12.9.26 setIdleSpeedThreshold . . . . . . . . . . . . . . . . . . . . . . . . . 107
12.9.27 setIterations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
12.9.28 setSleepTimeThreshold. . . . . . . . . . . . . . . . . . . . . . . . . 108
12.9.29 sleepTimeThreshold . . . . . . . . . . . . . . . . . . . . . . . . . . 108
12.9.30 step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
12.10Constraints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
12.10.1 Damped Rotary Spring . . . . . . . . . . . . . . . . . . . . . . . . 109
12.10.2 Damped Spring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
12.10.3 Gear Joint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
12.10.4 Groove Joint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
12.10.5 Pin Joint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
12.10.6 Pivot Joint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
12.10.7 Ratchet Joint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
12.10.8 Rotary Limit Joint . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
12.10.9 Simple Motor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
12.10.10 Slide Joints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
12.11Arbiters and Collision Pairs . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
12.11.1 #. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
12.11.2 a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
12.11.3 b . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
12.11.4 bodies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
12.11.5 depth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
12.11.6 elasticity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
12.11.7 friction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
12.11.8 impulse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
12.11.9 isFirstContact . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
12.11.10 normal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
12.11.11 point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
12.11.12 setElasticity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
12.11.13 setFriction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
12.11.14 shapes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
12.11.15 totalImpulse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
12.11.16 totalImpulseWithFriction . . . . . . . . . . . . . . . . . . . . . . . 121
ix