MITSUBISHIELECTRICRESEARCHLABORATORIES http://www.merl.com The ANSI C (Internal) Spline Version 3.0 Application Program Interface R.Waters,D.Anderson,A.Greysukh,W.Lambert,H.Kozuka,B.Perlman,V.Phan,D. Schwenke,S.Shipman,E.Suits,W.Yerazunis TR97-11 December1997 Abstract Thisdocumentdescribesthe(Internal)SplineVersion3.0ApplicationProgramInterface(API) as exported to ANSI C. It documents each publicly available object class and function. In ad- dition, itdescribesthefacilitiesavailabletothosethatwishtomodifythesystemcore. Thisis a machine generated document created from a database of information. It exists in both paper andHTMLform. OtherdocumentsdescribetheAPIexportedtootherprogramminglanguage environments. Thisworkmaynotbecopiedorreproducedinwholeorinpartforanycommercialpurpose. Permissiontocopyinwholeorinpart withoutpaymentoffeeisgrantedfornonprofiteducationalandresearchpurposesprovidedthatallsuchwholeorpartialcopiesinclude thefollowing: anoticethatsuchcopyingisbypermissionofMitsubishiElectricResearchLaboratories,Inc.;anacknowledgmentof theauthorsandindividualcontributionstothework; andallapplicableportionsofthecopyrightnotice. Copying, reproduction, or republishingforanyotherpurposeshallrequirealicensewithpaymentoffeetoMitsubishiElectricResearchLaboratories,Inc. All rightsreserved. Copyright(cid:13)c MitsubishiElectricResearchLaboratories,Inc.,1997 201Broadway,Cambridge,Massachusetts02139 MERLCoverPageSide2 MERL { A MITSUBISHI ELECTRIC RESEARCH LABORATORY http://www.merl.com The ANSI C (Internal) Spline Version 3.0 Application Program Interface R. Waters, D. Anderson, A. Greysukh, W. Lambert, H. Kozuka, B. Perlman, V. Phan, D. Schwenke, S. Shipman, E. Suits, and W. Yerazunis TR-97-11 December, 1997 Abstract This document describes the (Internal) Spline Version 3.0 Application Program Interface (API) as exported to ANSI C. It documents each publicly available object class and function. In addition, it describes the facilities available to those that wish to modify the system core. This is a machine generated document created from a database of informa- tion. It exists in both paper and HTML form. Other documents describe the API exported to other programming language environments. This work maynotbe copiedor reproducedin whole or inpart for anycommercialpurpose. Permission to copyin whole or in partwithout paymentof fee is grantedfor nonpro(cid:12)teducational andresearch purposes provided that all such whole or partial copies include the following: a notice that such copying is by per- mission of Mitsubishi Electric Information Technology Center America; an acknowledgment of the authors and individual contributions to the work; and all applicable portions of the copyright notice. Copying, reproduction,orrepublishingforanyotherpurposeshallrequirealicensewithpaymentoffeetoMitsubishi Electric InformationTechnology CenterAmerica. All rights reserved. Copyright (cid:13)c Mitsubishi Electric Information Technology Center America,1997 201 Broadway, Cambridge, Massachusetts 02139 ii CONTENTS Contents 3. spVisual 36 3.1 spVisualInit . . . . . . . . . . . . . 37 1. Introduction 1 3.2 spVisualFinish . . . . . . . . . . . . 37 1.1 Reading This Document . . . . . . 2 1.2 System Overview . . . . . . . . . . 3 4. spAudio 38 1.2.1 Scalability. . . . . . . . . . . . . . 4 4.1 spAudioInit . . . . . . . . . . . . . 38 1.2.2 Application Processes . . . . . . . 6 4.2 spAudioFinish . . . . . . . . . . . . 38 1.2.3 The API . . . . . . . . . . . . . . 7 1.2.4 Rendering . . . . . . . . . . . . . . 8 5. spWM 39 1.2.5 Supporting Simulations . . . . . . 9 5.1 Me . . . . . . . . . . . . . . . . . . 40 1.2.6 ISTP . . . . . . . . . . . . . . . . 10 5.2 MainOwner . . . . . . . . . . . . . 40 1.2.7 User Servers . . . . . . . . . . . . 11 5.3 SystemOwner . . . . . . . . . . . . 40 1.3 Atomic Data . . . . . . . . . . . . . 11 5.4 Error . . . . . . . . . . . . . . . . . 41 1.4 Pointer Data . . . . . . . . . . . . . 12 5.5 LastError . . . . . . . . . . . . . . . 41 1.5 Shared Objects . . . . . . . . . . . 13 5.6 Interval . . . . . . . . . . . . . . . . 42 1.5.1 Accessors . . . . . . . . . . . . . . 13 5.7 DesiredInterval . . . . . . . . . . . 42 1.5.2 Referring To . . . . . . . . . . . . 16 5.8 Week . . . . . . . . . . . . . . . . . 43 1.5.3 Removal . . . . . . . . . . . . . . . 17 5.9 Msec . . . . . . . . . . . . . . . . . 43 1.5.4 Communication Patterns . . . . . 18 5.10 Window . . . . . . . . . . . . . . . 44 1.5.5 Descriptions . . . . . . . . . . . . 19 5.11 DNSName . . . . . . . . . . . . . . 44 1.5.6 In-Order Description Processing . 19 5.12 Port . . . . . . . . . . . . . . . . . . 44 1.6 De(cid:12)ning Shared Classes . . . . . . . 20 5.13 MsgRejectionQueue . . . . . . . . . 45 1.6.1 Example . . . . . . . . . . . . . . 21 5.14 spWMNew . . . . . . . . . . . . . . 46 1.6.2 Shared Classes . . . . . . . . . . . 21 5.15 spWMRemove . . . . . . . . . . . . 46 1.6.3 Variables and Access Methods . . 21 5.16 spWMUpdate . . . . . . . . . . . . 46 1.6.4 Shared Variable Types . . . . . . . 23 5.17 spWMGenerateOwner. . . . . . . . 48 1.6.5 Methods In Shared Classes . . . . 23 5.18 spWMReportError . . . . . . . . . 49 1.6.6 Interfaces . . . . . . . . . . . . . . 24 5.19 spWMRegister . . . . . . . . . . . . 49 1.6.7 Variables Available In C . . . . . . 27 5.20 spWMDeregister . . . . . . . . . . . 50 1.6.8 Scalar C Types . . . . . . . . . . . 28 6. spFn 50 1.6.9 Pointer C Types . . . . . . . . . . 29 6.1 spFn Predicates . . . . . . . . . . . 51 1.6.10 Static Final Variables . . . . . . . 30 6.2 Old Values of Shared Variables . . . 52 1.6.11 Methods Available In C . . . . . . 30 1.7 Acknowledgments . . . . . . . . . . 31 7. spMask 54 7.1 Constants . . . . . . . . . . . . . . 55 2. spApp 32 2.1 Application Templates . . . . . . . 32 8. spTransform 56 2.2 Interaction With Rendering . . . . 33 8.1 Constants . . . . . . . . . . . . . . 59 2.3 User I/O . . . . . . . . . . . . . . . 34 8.2 spTransformCopy . . . . . . . . . . 59 2.4 Multi-Threaded Applications . . . . 35 8.3 spTransformFromIdent . . . . . . . 60 2.5 spAppChooseServer . . . . . . . . . 35 8.4 spTransformGetTranslation. . . . . 60 2.6 spAppInit . . . . . . . . . . . . . . 35 8.5 spTransformSetTranslation . . . . . 60 2.7 spAppBody . . . . . . . . . . . . . 36 8.6 spTransformGetRotation . . . . . . 60 2.8 spAppFinish . . . . . . . . . . . . . 36 8.7 spTransformSetRotation . . . . . . 61 8.8 spTransformGetScale . . . . . . . . 61 CONTENTS iii 8.9 spTransformSetScale . . . . . . . . 61 12. spMatrix 76 8.10 spTransformGetScaleOrientation . . 61 12.1 spMatrixCopy . . . . . . . . . . . . 77 8.11 spTransformSetScaleOrientation . . 61 12.2 spMatrixFromIdent . . . . . . . . . 77 8.12 spTransformGetCenter . . . . . . . 62 12.3 spMatrixGetTranslation . . . . . . 77 8.13 spTransformSetCenter . . . . . . . 62 12.4 spMatrixSetTranslation . . . . . . . 78 12.5 spMatrixFromTransform . . . . . . 78 9. spVector 62 12.6 spMatrixToTransform . . . . . . . . 78 9.1 Constants . . . . . . . . . . . . . . 64 12.7 spMatrixInverse . . . . . . . . . . . 78 9.2 spVectorCopy . . . . . . . . . . . . 64 12.8 spMatrixMult . . . . . . . . . . . . 79 9.3 spVectorSetFromScalar . . . . . . . 64 12.9 spMatrixMultVector . . . . . . . . . 79 9.4 spVectorEquals . . . . . . . . . . . 65 9.5 spVectorEqualsDelta . . . . . . . . 65 13. spPath 80 9.6 spVectorAdd . . . . . . . . . . . . . 65 13.1 spPathNew . . . . . . . . . . . . . . 80 9.7 spVectorSubtract . . . . . . . . . . 65 13.2 spPathFree . . . . . . . . . . . . . . 80 9.8 spVectorMultiplyByScalar . . . . . 65 13.3 spPathAppendTransform . . . . . . 81 9.9 spVectorDivideByScalar . . . . . . 66 13.4 spPathGetTransform . . . . . . . . 81 9.10 spVectorCrossProduct. . . . . . . . 66 13.5 spPathCopy . . . . . . . . . . . . . 81 9.11 spVectorDotProduct . . . . . . . . 66 13.6 spPathSave . . . . . . . . . . . . . . 81 9.12 spVectorComposeScales . . . . . . . 66 13.7 spPathLoad . . . . . . . . . . . . . 82 9.13 spVectorLength . . . . . . . . . . . 66 13.8 spPathChangeStartPoint . . . . . . 82 9.14 spVectorNormalize . . . . . . . . . 67 13.9 spPathThin . . . . . . . . . . . . . 82 10. spRotation 67 14. spFormat 83 10.1 Rotation Ambiguity . . . . . . . . . 68 14.1 Constants . . . . . . . . . . . . . . 83 10.2 Constants . . . . . . . . . . . . . . 70 14.2 spFormatDurationFromLength . . . 84 10.3 spRotationCopy . . . . . . . . . . . 71 14.3 spFormatLengthFromDuration . . . 84 10.4 spRotationFromIdent . . . . . . . . 71 10.5 spRotationGetAxis . . . . . . . . . 71 15. sp 85 10.6 spRotationSetAxis . . . . . . . . . . 71 15.1 C . . . . . . . . . . . . . . . . . . . 86 10.7 spRotationGetAngle . . . . . . . . . 71 15.2 DEGREES . . . . . . . . . . . . . . 86 10.8 spRotationSetAngle . . . . . . . . . 72 15.3 LocalPtr . . . . . . . . . . . . . . . 87 10.9 spRotationToQuat . . . . . . . . . . 72 15.4 NextPtr . . . . . . . . . . . . . . . 87 10.10 spRotationFromQuat . . . . . . . . 72 15.5 Marker . . . . . . . . . . . . . . . . 88 10.11 spRotationToAngles . . . . . . . . . 72 15.6 DescriptionLength . . . . . . . . . . 88 10.12 spRotationFromAngles . . . . . . . 73 15.7 Counter . . . . . . . . . . . . . . . 89 10.13 spRotationMult . . . . . . . . . . . 73 15.8 Name . . . . . . . . . . . . . . . . . 89 10.14 spRotationLookAt . . . . . . . . . . 73 15.9 Class . . . . . . . . . . . . . . . . . 91 15.10 Owner . . . . . . . . . . . . . . . . 91 11. spQuaternion 74 15.11 Locale . . . . . . . . . . . . . . . . 92 11.1 spQuaternionCopy. . . . . . . . . . 74 15.12 SharedBits . . . . . . . . . . . . . . 93 11.2 spQuaternionFromIdent . . . . . . . 75 15.13 Parent . . . . . . . . . . . . . . . . 93 11.3 spQuaternionMult . . . . . . . . . . 75 15.14 IsRemoved . . . . . . . . . . . . . . 94 15.15 ForceReliable . . . . . . . . . . . . 95 15.16 InhibitReliable . . . . . . . . . . . . 95 15.17 LocalBits . . . . . . . . . . . . . . . 96 MERL-TR-97-11 December, 1997 iv CONTENTS 15.18 IsNew . . . . . . . . . . . . . . . . . 96 17. spDisplaying 114 15.19 AppData . . . . . . . . . . . . . . . 97 17.1 VisualDe(cid:12)nition . . . . . . . . . . . 115 15.20 MessageNeeded . . . . . . . . . . . 97 17.2 InRadius . . . . . . . . . . . . . . . 115 15.21 Change . . . . . . . . . . . . . . . . 98 17.3 OutRadius . . . . . . . . . . . . . . 116 15.22 OldPtr . . . . . . . . . . . . . . . . 99 17.4 GraphicsNode . . . . . . . . . . . . 116 15.23 JavaPtr . . . . . . . . . . . . . . . . 99 15.24 Referrers . . . . . . . . . . . . . . . 99 18. spLinking 117 15.25 Alerters . . . . . . . . . . . . . . . . 100 18.1 URL . . . . . . . . . . . . . . . . . 119 15.26 Msgs . . . . . . . . . . . . . . . . . 100 18.2 Checksum . . . . . . . . . . . . . . 120 15.27 LastUpdateTime. . . . . . . . . . . 101 18.3 FileName . . . . . . . . . . . . . . . 120 15.28 spNew . . . . . . . . . . . . . . . . 101 18.4 Data . . . . . . . . . . . . . . . . . 121 15.29 spInitialization . . . . . . . . . . . . 102 18.5 spLinkingNew . . . . . . . . . . . . 121 15.30 spRemove . . . . . . . . . . . . . . 102 18.6 spLinkingURLAltered . . . . . . . . 122 15.31 spExamineChildren . . . . . . . . . 103 18.7 spLinkingReadData . . . . . . . . . 122 15.32 spExamineDescendants . . . . . . . 103 19. spMultilinking 123 15.33 spTopmost . . . . . . . . . . . . . . 103 19.1 Multipart . . . . . . . . . . . . . . . 124 15.34 spPrint . . . . . . . . . . . . . . . . 104 19.2 IndexName . . . . . . . . . . . . . . 125 15.35 spLocallyOwned . . . . . . . . . . . 104 19.3 spMultilinkingNew . . . . . . . . . 125 15.36 spSetParent . . . . . . . . . . . . . 104 19.4 spMultilinkingSelect. . . . . . . . . 126 16. spPositioning 105 20. spBeaconing 126 16.1 Transform . . . . . . . . . . . . . . 106 20.1 Using Beacons . . . . . . . . . . . . 127 16.2 Matrix . . . . . . . . . . . . . . . . 106 20.2 Tag . . . . . . . . . . . . . . . . . . 128 16.3 MatrixOK . . . . . . . . . . . . . . 107 20.3 Suppress . . . . . . . . . . . . . . . 129 16.4 MatrixInverse . . . . . . . . . . . . 107 16.5 MatrixInverseOK . . . . . . . . . . 107 21. spObserving 130 16.6 spPositioningMatrix . . . . . . . . . 108 21.1 Audio . . . . . . . . . . . . . . . . . 131 16.7 spPositioningMatrixInverse . . . . . 108 21.2 IgnoreNearby . . . . . . . . . . . . 131 16.8 spPositioningLocalize . . . . . . . . 108 16.9 spPositioningRelativeMatrix . . . . 109 22. spVisualParameters 132 16.10 spPositioningRelativeVector . . . . 110 22.1 FarClip . . . . . . . . . . . . . . . . 132 16.11 spPositioningDistance . . . . . . . . 110 22.2 NearClip . . . . . . . . . . . . . . . 133 16.12 spPositioningLookAt . . . . . . . . 110 22.3 Field . . . . . . . . . . . . . . . . . 133 16.13 spPositioningGoThru . . . . . . . . 111 22.4 Interval . . . . . . . . . . . . . . . . 134 16.14 spPositioningStopAt. . . . . . . . . 111 16.15 spPositioningStop . . . . . . . . . . 112 23. spAudioParameters 134 16.16 spPositioningFollowPath . . . . . . 112 23.1 Focus . . . . . . . . . . . . . . . . . 135 16.17 spPositioningMotionTimeLeft . . . 113 23.2 Live . . . . . . . . . . . . . . . . . . 135 16.18 spPositioningGetMotionQueue . . . 113 23.3 Format . . . . . . . . . . . . . . . . 136 16.19 spPositioningFlushMotionQueue . . 113 16.20 spPositioningSetTransform . . . . . 114 24. spVisualDe(cid:12)nition 136 16.21 spPositioningInitialization . . . . . 114 24.1 spVisualDe(cid:12)nitionNew . . . . . . . 138 24.2 spVisualDe(cid:12)nitionReadData . . . . 138 24.3 spVisualDe(cid:12)nitionSelect . . . . . . 138 MERL-TR-97-11 December, 1997 CONTENTS v 25. spSound 139 29.15 SendViaTCP . . . . . . . . . . . . . 162 25.1 Duration . . . . . . . . . . . . . . . 141 29.16 NumVariables . . . . . . . . . . . . 163 25.2 spSoundNew . . . . . . . . . . . . . 141 29.17 MethodTable . . . . . . . . . . . . . 163 25.3 spSoundPlay . . . . . . . . . . . . . 141 29.18 spClassNewObj . . . . . . . . . . . 163 25.4 spSoundSelect . . . . . . . . . . . . 142 29.19 spClassNewLink . . . . . . . . . . . 164 25.5 spSoundReadData . . . . . . . . . . 142 29.20 spClassNew . . . . . . . . . . . . . 164 29.21 spClassEq . . . . . . . . . . . . . . 164 26. spLocale 142 29.22 spClassLeq . . . . . . . . . . . . . . 165 26.1 How Locales Work . . . . . . . . . 143 29.23 spClassExamine . . . . . . . . . . . 165 26.2 Boundary. . . . . . . . . . . . . . . 146 29.24 spClassMonitor . . . . . . . . . . . 165 26.3 NumNeighbors . . . . . . . . . . . . 146 29.25 spClassReadData . . . . . . . . . . 166 26.4 spLocaleNew . . . . . . . . . . . . . 146 26.5 spLocaleChoose . . . . . . . . . . . 147 30. spThing 166 26.6 spLocaleExportMatrix . . . . . . . 147 26.7 spLocaleReadData . . . . . . . . . . 148 31. spRoot 167 27. spBoundary 148 32. spAvatar 167 27.1 Volume . . . . . . . . . . . . . . . . 149 32.1 IsBot . . . . . . . . . . . . . . . . . 168 27.2 spBoundaryNew . . . . . . . . . . . 149 33. spAudioSource 169 27.3 spBoundaryBelow . . . . . . . . . . 149 33.1 Duration . . . . . . . . . . . . . . . 170 27.4 spBoundaryAbove . . . . . . . . . . 150 33.2 ExternalFormat . . . . . . . . . . . 170 27.5 spBoundaryInside . . . . . . . . . . 150 33.3 spAudioSourceSetup . . . . . . . . 171 27.6 spBoundaryReadData . . . . . . . . 151 33.4 spAudioSourceWrite. . . . . . . . . 172 28. spTerrain 151 33.5 spAudioSourceRead . . . . . . . . . 172 28.1 spTerrainNew . . . . . . . . . . . . 153 34. spBeacon 173 28.2 spTerrainBelow . . . . . . . . . . . 153 34.1 spBeaconNew . . . . . . . . . . . . 173 28.3 spTerrainAbove . . . . . . . . . . . 154 28.4 spTerrainInside . . . . . . . . . . . 154 35. spPositionedBeacon 174 28.5 spTerrainReadData . . . . . . . . . 154 36. spSpeaking 174 29. spClass 154 36.1 spSpeakingNew . . . . . . . . . . . 175 29.1 ClassName . . . . . . . . . . . . . . 156 29.2 LoadData . . . . . . . . . . . . . . 157 37. spHearing 175 29.3 ReadDataFn . . . . . . . . . . . . . 157 37.1 spHearingNew . . . . . . . . . . . . 176 29.4 SelectFn . . . . . . . . . . . . . . . 158 29.5 Superclasses . . . . . . . . . . . . . 158 38. spSeeing 176 29.6 NumSuperclasses . . . . . . . . . . 159 38.1 spSeeingNew . . . . . . . . . . . . . 177 29.7 Size . . . . . . . . . . . . . . . . . . 159 29.8 Level . . . . . . . . . . . . . . . . . 160 39. spSimulationObserver 177 29.9 LocalO(cid:11)set . . . . . . . . . . . . . . 160 40. spVisualObserver 178 29.10 SharedO(cid:11)set . . . . . . . . . . . . . 160 29.11 SharedBitNum . . . . . . . . . . . . 161 41. spAudioObserver 178 29.12 LocalBitNum . . . . . . . . . . . . 161 41.1 spAudioObserverInitialization . . . 179 29.13 TimeStampO(cid:11)sets . . . . . . . . . . 162 29.14 SendViaLocale . . . . . . . . . . . . 162 MERL-TR-97-11 December, 1997. vi CONTENTS 42. spIntervalCallback 180 48.4 spDoSoundPlayFunction . . . . . . 207 42.1 Details of Callback processing . . . 180 42.2 Interval . . . . . . . . . . . . . . . . 182 49. spMover 207 42.3 F . . . . . . . . . . . . . . . . . . . 183 49.1 X . . . . . . . . . . . . . . . . . . . 208 42.4 FState . . . . . . . . . . . . . . . . 183 49.2 T . . . . . . . . . . . . . . . . . . . 208 42.5 NextTriggerTime . . . . . . . . . . 184 49.3 Queue . . . . . . . . . . . . . . . . 208 42.6 IntNext . . . . . . . . . . . . . . . . 184 49.4 spMoverFunction . . . . . . . . . . 208 42.7 IntPrev . . . . . . . . . . . . . . . . 185 A. Java Declaration File 209 42.8 spIntervalCallbackNew . . . . . . . 185 B. Quick Function Reference 223 43. spAlerter 185 43.1 Details of alerter processing . . . . 187 43.2 P . . . . . . . . . . . . . . . . . . . 189 43.3 PState . . . . . . . . . . . . . . . . 190 43.4 Mask . . . . . . . . . . . . . . . . . 190 43.5 ChgNext . . . . . . . . . . . . . . . 191 43.6 ChgPrev . . . . . . . . . . . . . . . 191 43.7 spAlerterNew . . . . . . . . . . . . 191 43.8 spAlerterInitialization . . . . . . . . 192 44. spBeaconMonitor 192 44.1 Pattern . . . . . . . . . . . . . . . . 193 44.2 spBeaconMonitorNew . . . . . . . . 194 45. spBeaconGoto 195 45.1 Object . . . . . . . . . . . . . . . . 196 45.2 spBeaconGotoNew . . . . . . . . . 196 46. spAction 197 46.1 Details of Action Processing . . . . 198 46.2 spActionFunction . . . . . . . . . . 198 47. spOwnershipRequest 200 47.1 Ownership Transfer . . . . . . . . . 200 47.2 F . . . . . . . . . . . . . . . . . . . 203 47.3 FState . . . . . . . . . . . . . . . . 203 47.4 Timeout . . . . . . . . . . . . . . . 203 47.5 TimeAlive . . . . . . . . . . . . . . 204 47.6 spOwnershipRequestNew . . . . . . 204 47.7 spOwnershipRequestFunction . . . 205 47.8 spOwnershipRequestGrant . . . . . 205 48. spDoSoundPlay 205 48.1 Sound. . . . . . . . . . . . . . . . . 206 48.2 Loop . . . . . . . . . . . . . . . . . 206 48.3 Gain . . . . . . . . . . . . . . . . . 207 MERL-TR-97-11 December, 1997 Waters, Anderson, et al. 1 1 Introduction Thisdocument describes the (Internal) SplineVersion 3.0 ApplicationProgram Interface (API) asexportedto ANSIC.It documents each publiclyavailableobject classandfunction. Inaddition, it describes the facilities available to those that wish to modify the system core. This is a machine generated document created from a database of information. It exists in both paper and HTML form. Other documents describe the API exported to other programming language environments. The following lists the classes described in this document. If a class is part of the external API, then its name is printed in bold. If a class is fundamental in the sense that if could not have been written by an application programmer, then its name is underlined. Note that many of the classes are not fundamental. These classes are included for convenience, but do not require special support from the system core. It is expected that application writers will write many more classes like them. The API includes the following generic and particular applications: spApp - A standard application (Section 2). spVisual - Visual renderer (Section 3). spAudio - Audio renderer (Section 4). The API includes the following ordinary data structures: spWM - A world model (Section 5). spFn - Operation that can be mapped (Section 6). spMask - World model view mask (Section 7). spTransform - Position, axis, angle, scale speci(cid:12)cation (Section 8). spVector - 3-element vector (Section 9). spRotation - Rotation speci(cid:12)ed using axis and angle (Section 10). spQuaternion - A quaternion (Section 11). spMatrix - 4x4 transformation matrix (Section 12). spPath - Stored motion path (Section 13). spFormat - Sound data format (Section 14). The API includes the following abstract classes that are multiply inherited: sp - Speci(cid:12)es minimal sharable object (Section 15). spPositioning - Speci(cid:12)es position and orientation (Section 16). spDisplaying - Speci(cid:12)es visual appearance and extent (Section 17). spLinking - Speci(cid:12)es link to large slowly-changing data (Section 18). spMultilinking - Link to index (Section 19). spBeaconing - Speci(cid:12)es content-addressable object (Section 20). spObserving - Speci(cid:12)es point of view (Section 21). spVisualParameters - Speci(cid:12)es visual rendering parameters (Section 22). spAudioParameters - Speci(cid:12)es audio rendering parameters (Section 23). 2 (Internal) Spline Version 3.0 API The API includes the following shared object classes: spVisualDe(cid:12)nition - Link to graphic model (Section 24). spSound - Link to stored sound (Section 25). spLocale - Link to separate coordinate system (Section 26). spBoundary - Link to bounding box (Section 27). spTerrain - Link to e(cid:14)cient 3D boundary description (Section 28). spClass - Link to description of a shared class (Section 29). spThing - Thing in the virtual world (Section 30). spRoot - Root of recognized whole (Section 31). spAvatar - Whole representing user or agent (Section 32). spAudioSource - Source of sound. (Section 33). spBeacon - Minimal Content-addressable object (Section 34). spPositionedBeacon - Beacon specifying a position (Section 35). spSpeaking - Connects to user’s speech (Section 36). spHearing - Connects to user’s ears (Section 37). spSeeing - Connects to user’s eyes (Section 38). spSimulationObserver - Observer of basic data (Section 39). spVisualObserver - Observer of visual data (Section 40). spAudioObserver - Observer of sound data (Section 41). spIntervalCallback - Interval callback (Section 42). spAlerter - Event detector (Section 43). spBeaconMonitor - Inspect beacons (Section 44). spBeaconGoto - Puts spThing beside beacon (Section 45). spAction - Speci(cid:12)es program triggered by system core (Section 46). spOwnershipRequest - Requests getting ownership (Section 47). spDoSoundPlay - Plays sound data (Section 48). spMover - Supports smooth motion (Section 49). 1.1 Reading This Document This document is a reference manual rather than a tutorial. In general, each topic is only discussed once and therefore any order of reading the sections in this document will not be quite right, because every section can be best understood only after having read many other sections. The document is organized around the various classes enumerated above. At the top level, there is a section for each class. Within these sections, there are subsections corresponding to each instance variable and function. There are two ways to look things up in this document. By using the table of contents, you can look instance variables and functions up by the name of the class the are in. The functions can be looked up alphabetically by using the quick reference index at the end of this document (Appendix B). There are several quite di(cid:11)erent kinds of classes listed above: application templates, passive data structures, abstract classes that embody the key capabilities of the system and are multiply inherited, and shared objects that are the basis of communication between processes. The application templates (e.g., spApp) show how simple applications can be written. MERL-TR-97-11 December, 1997