classScene.html 148 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: Scene Class Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. <div id="navrow2" class="tabs2">
  39. <ul class="tablist">
  40. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  41. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  42. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  43. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  44. </ul>
  45. </div>
  46. </div><!-- top -->
  47. <div class="header">
  48. <div class="summary">
  49. <a href="#pub-methods">Public Member Functions</a> &#124;
  50. <a href="classScene-members.html">List of all members</a> </div>
  51. <div class="headertitle">
  52. <div class="title">Scene Class Reference</div> </div>
  53. </div><!--header-->
  54. <div class="contents">
  55. <p>Inherits <a class="el" href="classBehaviorComponent.html">BehaviorComponent</a>.</p>
  56. <table class="memberdecls">
  57. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  58. Public Member Functions</h2></td></tr>
  59. <tr class="memitem:a2ec5354069ae94a8058dc611ced5e84a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a2ec5354069ae94a8058dc611ced5e84a">add</a> (sceneObject)</td></tr>
  60. <tr class="separator:a2ec5354069ae94a8058dc611ced5e84a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61. <tr class="memitem:a7bd0bd2419edad6f4f6c7dc874d1e42e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a7bd0bd2419edad6f4f6c7dc874d1e42e">addAssetPreload</a> (assetId)</td></tr>
  62. <tr class="separator:a7bd0bd2419edad6f4f6c7dc874d1e42e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:a516e00b5071522b23f5d9770c0d58692"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a516e00b5071522b23f5d9770c0d58692">clear</a> ([deleteObjects])</td></tr>
  64. <tr class="separator:a516e00b5071522b23f5d9770c0d58692"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:a27451117148f13f460752a861c17e700"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a27451117148f13f460752a861c17e700">clearAssetPreloads</a> ()</td></tr>
  66. <tr class="separator:a27451117148f13f460752a861c17e700"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:acf189a511641274f991aee549e12af5b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#acf189a511641274f991aee549e12af5b">create</a> (type)</td></tr>
  68. <tr class="separator:acf189a511641274f991aee549e12af5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69. <tr class="memitem:a3e471b063ed053d3f178c5185ff13332"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a3e471b063ed053d3f178c5185ff13332">createDistanceJoint</a> (sceneObjectA, sceneObjectB,[localAnchorA X/Y],[localAnchorB X/Y],[distance],[frequency],[dampingRatio],[collideConnected])</td></tr>
  70. <tr class="separator:a3e471b063ed053d3f178c5185ff13332"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71. <tr class="memitem:a0c64ea1e52a0663a1f0907d61f3251db"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a0c64ea1e52a0663a1f0907d61f3251db">createFrictionJoint</a> (sceneObjectA, sceneObjectB,[localAnchorA X/Y],[localAnchorB X/Y],[maxForce],[maxTorque],[collideConnected])</td></tr>
  72. <tr class="separator:a0c64ea1e52a0663a1f0907d61f3251db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a156ec65a52be3ecbd3ac43efbe113b06"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a156ec65a52be3ecbd3ac43efbe113b06">createMotorJoint</a> (sceneObjectA, sceneObjectB,[linearOffset X/Y],[angularOffset],[maxForce],[maxTorque],[correctionFactor],[collideConnected])</td></tr>
  74. <tr class="separator:a156ec65a52be3ecbd3ac43efbe113b06"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a35f90ed55a88b1936930dfcd43cf66d0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a35f90ed55a88b1936930dfcd43cf66d0">createPrismaticJoint</a> (sceneObjectA, sceneObjectB, localAnchorA X/Y, localAnchorB X/Y, worldAxis X/Y,[collideConnected])</td></tr>
  76. <tr class="separator:a35f90ed55a88b1936930dfcd43cf66d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a314726df47a8318c25fe049a4d45ddf7"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a314726df47a8318c25fe049a4d45ddf7">createPulleyJoint</a> (sceneObjectA, sceneObjectB, localAnchorA X/Y, localAnchorB X/Y, worldGroundAnchorA X/Y, worldGroundAnchorB X/Y, ratio,[lengthA],[lengthB],[collideConnected])</td></tr>
  78. <tr class="separator:a314726df47a8318c25fe049a4d45ddf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a0b95769bbf08a7b400cabc10e3b9c387"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a0b95769bbf08a7b400cabc10e3b9c387">createRevoluteJoint</a> (sceneObjectA, sceneObjectB,[localAnchorA X/Y],[localAnchorB X/Y],[collideConnected])</td></tr>
  80. <tr class="separator:a0b95769bbf08a7b400cabc10e3b9c387"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a62fa910a2d0358046b407602f3fc9a40"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a62fa910a2d0358046b407602f3fc9a40">createRopeJoint</a> (sceneObjectA, sceneObjectB,[localAnchorA X/Y],[localAnchorB X/Y],[maxLength],[collideConnected])</td></tr>
  82. <tr class="separator:a62fa910a2d0358046b407602f3fc9a40"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ad2ec21387d99b11e2641a658b8c9a013"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#ad2ec21387d99b11e2641a658b8c9a013">createTargetJoint</a> (sceneObject, worldTarget X/Y, maxForce,[useCenterOfMass?],[frequency],[dampingRatio],[collideConnected])</td></tr>
  84. <tr class="separator:ad2ec21387d99b11e2641a658b8c9a013"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a30d321b32b80411f3e23224678f5a367"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a30d321b32b80411f3e23224678f5a367">createWeldJoint</a> (sceneObjectA, sceneObjectB,[localAnchorA X/Y],[localAnchorB X/Y],[frequency],[dampingRatio],[collideConnected])</td></tr>
  86. <tr class="separator:a30d321b32b80411f3e23224678f5a367"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:af9232f386b49a623e7e6d4e80d36c13e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#af9232f386b49a623e7e6d4e80d36c13e">createWheelJoint</a> (sceneObjectA, sceneObjectB, localAnchorA X/Y, localAnchorB X/Y, worldAxis X/Y,[collideConnected])</td></tr>
  88. <tr class="separator:af9232f386b49a623e7e6d4e80d36c13e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a71631fcf2c69ce4a8b53157885e3e712"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a71631fcf2c69ce4a8b53157885e3e712">deleteJoint</a> (int jointId)</td></tr>
  90. <tr class="separator:a71631fcf2c69ce4a8b53157885e3e712"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a35346d81b63943cbf07452f0fba39e1e"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a35346d81b63943cbf07452f0fba39e1e">getAssetPreload</a> (index)</td></tr>
  92. <tr class="separator:a35346d81b63943cbf07452f0fba39e1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a9b374ea743fc5a29947ddb46af2d59b3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a9b374ea743fc5a29947ddb46af2d59b3">getAssetPreloadCount</a> ()</td></tr>
  94. <tr class="separator:a9b374ea743fc5a29947ddb46af2d59b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:ad416a24ceea44b5666539ea779ba2a68"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#ad416a24ceea44b5666539ea779ba2a68">getBatchingEnabled</a> ()</td></tr>
  96. <tr class="separator:ad416a24ceea44b5666539ea779ba2a68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a55631853fae5aed33db986befee573b2"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a55631853fae5aed33db986befee573b2">getControllers</a> ()</td></tr>
  98. <tr class="separator:a55631853fae5aed33db986befee573b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:ae452b1c7e00c383f2916c4a530fab737"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#ae452b1c7e00c383f2916c4a530fab737">getCount</a> ()</td></tr>
  100. <tr class="separator:ae452b1c7e00c383f2916c4a530fab737"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:af7743442dfe3d22ba5d3c8e6631e2ba8"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#af7743442dfe3d22ba5d3c8e6631e2ba8">getDebugOn</a> ()</td></tr>
  102. <tr class="separator:af7743442dfe3d22ba5d3c8e6631e2ba8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a52aff12c0b08562b2539772a9a982f5f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a52aff12c0b08562b2539772a9a982f5f">getDebugSceneObject</a> ()</td></tr>
  104. <tr class="separator:a52aff12c0b08562b2539772a9a982f5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:af4591a5fd925abe6698f1c132d60487c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#af4591a5fd925abe6698f1c132d60487c">getDistanceJointDampingRatio</a> (jointId)</td></tr>
  106. <tr class="separator:af4591a5fd925abe6698f1c132d60487c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:a9b26b952cb40f4525e50e18f8ea65658"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a9b26b952cb40f4525e50e18f8ea65658">getDistanceJointFrequency</a> (jointId)</td></tr>
  108. <tr class="separator:a9b26b952cb40f4525e50e18f8ea65658"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a32ab592e72afad2a91bf9ae1ceba572b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a32ab592e72afad2a91bf9ae1ceba572b">getDistanceJointLength</a> (jointId)</td></tr>
  110. <tr class="separator:a32ab592e72afad2a91bf9ae1ceba572b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:aa526495b6acf0aece355e13766631c74"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#aa526495b6acf0aece355e13766631c74">getFPS</a> ()</td></tr>
  112. <tr class="separator:aa526495b6acf0aece355e13766631c74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a134a0d63775c91ff4a3ab9fa8ac7438a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a134a0d63775c91ff4a3ab9fa8ac7438a">getFrameCount</a> ()</td></tr>
  114. <tr class="separator:a134a0d63775c91ff4a3ab9fa8ac7438a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a016c7605303b0492d0d435c54bad646a"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a016c7605303b0492d0d435c54bad646a">getFrictionJointMaxForce</a> (jointId)</td></tr>
  116. <tr class="separator:a016c7605303b0492d0d435c54bad646a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a0dee48da97c5c43c7b242d320074414f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a0dee48da97c5c43c7b242d320074414f">getFrictionJointMaxTorque</a> (jointId)</td></tr>
  118. <tr class="separator:a0dee48da97c5c43c7b242d320074414f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a8ce0520fea56d4ba654cb83fcdf1b96a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a8ce0520fea56d4ba654cb83fcdf1b96a">getGlobalSceneCount</a> ()</td></tr>
  120. <tr class="separator:a8ce0520fea56d4ba654cb83fcdf1b96a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a3bfee4d1a4591ca0fcfefcf0b2eb55a4"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a3bfee4d1a4591ca0fcfefcf0b2eb55a4">getGravity</a> ()</td></tr>
  122. <tr class="separator:a3bfee4d1a4591ca0fcfefcf0b2eb55a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:a94c403f395bab006f3a507b9e59346cb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a94c403f395bab006f3a507b9e59346cb">getJointCount</a> ()</td></tr>
  124. <tr class="separator:a94c403f395bab006f3a507b9e59346cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:abcd38248cad9ea920731f9ff49da9d16"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#abcd38248cad9ea920731f9ff49da9d16">getJointType</a> (int jointId)</td></tr>
  126. <tr class="separator:abcd38248cad9ea920731f9ff49da9d16"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:abd5784d71f027d5282a014fd7c627d8b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#abd5784d71f027d5282a014fd7c627d8b">getLayerSortMode</a> (layer)</td></tr>
  128. <tr class="separator:abd5784d71f027d5282a014fd7c627d8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:ae57aa415418c6c3f7edf21e47529b101"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#ae57aa415418c6c3f7edf21e47529b101">getMaxFPS</a> ()</td></tr>
  130. <tr class="separator:ae57aa415418c6c3f7edf21e47529b101"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ae078b55824b77c765c340a609a1b18cb"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#ae078b55824b77c765c340a609a1b18cb">getMinFPS</a> ()</td></tr>
  132. <tr class="separator:ae078b55824b77c765c340a609a1b18cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:acd57f0fe5f9e3aa7d19579071d0b7c2c"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#acd57f0fe5f9e3aa7d19579071d0b7c2c">getMotorJointAngularOffset</a> (jointId)</td></tr>
  134. <tr class="separator:acd57f0fe5f9e3aa7d19579071d0b7c2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:adafb561180a2bd06c3029290d92196e4"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#adafb561180a2bd06c3029290d92196e4">getMotorJointLinearOffset</a> (jointId)</td></tr>
  136. <tr class="separator:adafb561180a2bd06c3029290d92196e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a118a47ec5e86ad594bf4f0dd63b52ec7"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a118a47ec5e86ad594bf4f0dd63b52ec7">getMotorJointMaxForce</a> (jointId)</td></tr>
  138. <tr class="separator:a118a47ec5e86ad594bf4f0dd63b52ec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:aceb9522ef6b821f74623bd57033c125f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#aceb9522ef6b821f74623bd57033c125f">getMotorJointMaxTorque</a> (jointId)</td></tr>
  140. <tr class="separator:aceb9522ef6b821f74623bd57033c125f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a74b2500e21a2559cbc4aecf677f13ee8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a74b2500e21a2559cbc4aecf677f13ee8">getObject</a> (sceneObjectIndex)</td></tr>
  142. <tr class="separator:a74b2500e21a2559cbc4aecf677f13ee8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a0e39e4dffaa1f21051374083ecdb174c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a0e39e4dffaa1f21051374083ecdb174c">getPositionIterations</a> ()</td></tr>
  144. <tr class="separator:a0e39e4dffaa1f21051374083ecdb174c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:ad8ec3c7c6dae4948585073d208c87f02"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#ad8ec3c7c6dae4948585073d208c87f02">getPrismaticJointLimit</a> (jointId)</td></tr>
  146. <tr class="separator:ad8ec3c7c6dae4948585073d208c87f02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a8f1b0a6ba5632121f59061b8f808c2bc"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a8f1b0a6ba5632121f59061b8f808c2bc">getPrismaticJointMotor</a> (jointId)</td></tr>
  148. <tr class="separator:a8f1b0a6ba5632121f59061b8f808c2bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:abbc8cd64ee70d21821d2732e8029233b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#abbc8cd64ee70d21821d2732e8029233b">getRevoluteJointAngle</a> (jointId)</td></tr>
  150. <tr class="separator:abbc8cd64ee70d21821d2732e8029233b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a5197c2653efcbb86156544902423ad31"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a5197c2653efcbb86156544902423ad31">getRevoluteJointLimit</a> (jointId)</td></tr>
  152. <tr class="separator:a5197c2653efcbb86156544902423ad31"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a01efd74641d4ba017857443a6b03bf0d"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a01efd74641d4ba017857443a6b03bf0d">getRevoluteJointMotor</a> (jointId)</td></tr>
  154. <tr class="separator:a01efd74641d4ba017857443a6b03bf0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a5fb9ac87851e3bc85ced2682d4723741"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a5fb9ac87851e3bc85ced2682d4723741">getRevoluteJointSpeed</a> (jointId)</td></tr>
  156. <tr class="separator:a5fb9ac87851e3bc85ced2682d4723741"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a5807a2ccbe0f8d25212853bbc40fbb7b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a5807a2ccbe0f8d25212853bbc40fbb7b">getRopeJointMaxLength</a> (jointId)</td></tr>
  158. <tr class="separator:a5807a2ccbe0f8d25212853bbc40fbb7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a6a9bdc129cf71a9d3f9513af63dcb444"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a6a9bdc129cf71a9d3f9513af63dcb444">getSceneObjectList</a> ()</td></tr>
  160. <tr class="separator:a6a9bdc129cf71a9d3f9513af63dcb444"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:a6003c8b51796ecb4a038bbb8243e750e"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a6003c8b51796ecb4a038bbb8243e750e">getScenePause</a> ()</td></tr>
  162. <tr class="separator:a6003c8b51796ecb4a038bbb8243e750e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:aa1ddf9eb34f0eb75e3f3ecb74cef8906"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#aa1ddf9eb34f0eb75e3f3ecb74cef8906">getSceneTime</a> ()</td></tr>
  164. <tr class="separator:aa1ddf9eb34f0eb75e3f3ecb74cef8906"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a36ff8cc35a2347a77971bb127670e5be"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a36ff8cc35a2347a77971bb127670e5be">getTargetJointDampingRatio</a> (jointId)</td></tr>
  166. <tr class="separator:a36ff8cc35a2347a77971bb127670e5be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:a8c7d2fd7eee75777833d488556051a68"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a8c7d2fd7eee75777833d488556051a68">getTargetJointFrequency</a> (jointId)</td></tr>
  168. <tr class="separator:a8c7d2fd7eee75777833d488556051a68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  169. <tr class="memitem:a770cef4b06835f7096d362053733fd6f"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a770cef4b06835f7096d362053733fd6f">getTargetJointTarget</a> (jointId)</td></tr>
  170. <tr class="separator:a770cef4b06835f7096d362053733fd6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:a67d48f6bd47dcbe3ae00541d00aed40c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a67d48f6bd47dcbe3ae00541d00aed40c">getVelocityIterations</a> ()</td></tr>
  172. <tr class="separator:a67d48f6bd47dcbe3ae00541d00aed40c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="memitem:adb6452c02f0485018d91751d40440a37"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#adb6452c02f0485018d91751d40440a37">getWeldJointDampingRatio</a> (jointId)</td></tr>
  174. <tr class="separator:adb6452c02f0485018d91751d40440a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. <tr class="memitem:a9aca95a8eabdd472b9666002ba59f683"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a9aca95a8eabdd472b9666002ba59f683">getWeldJointFrequency</a> (jointId)</td></tr>
  176. <tr class="separator:a9aca95a8eabdd472b9666002ba59f683"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:aba086b3eb60192e17c37a86f0edd9b19"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#aba086b3eb60192e17c37a86f0edd9b19">getWheelJointDampingRatio</a> (jointId)</td></tr>
  178. <tr class="separator:aba086b3eb60192e17c37a86f0edd9b19"><td class="memSeparator" colspan="2">&#160;</td></tr>
  179. <tr class="memitem:a2a689c472ee1a87865d1599a9607b1d8"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a2a689c472ee1a87865d1599a9607b1d8">getWheelJointFrequency</a> (jointId)</td></tr>
  180. <tr class="separator:a2a689c472ee1a87865d1599a9607b1d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a3e7e062826d405182cbf9e3e2ef79ba8"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a3e7e062826d405182cbf9e3e2ef79ba8">getWheelJointMotor</a> (jointId)</td></tr>
  182. <tr class="separator:a3e7e062826d405182cbf9e3e2ef79ba8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:a9192095b4b9e12a3e569568dca519d20"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a9192095b4b9e12a3e569568dca519d20">isJoint</a> (int jointId)</td></tr>
  184. <tr class="separator:a9192095b4b9e12a3e569568dca519d20"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="memitem:a8d3ee1c7548c12282ec9cacec8842bea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a8d3ee1c7548c12282ec9cacec8842bea">mergeScene</a> (scene)</td></tr>
  186. <tr class="separator:a8d3ee1c7548c12282ec9cacec8842bea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a9c9ca45ceaac1e936708b12700d38dc8"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a9c9ca45ceaac1e936708b12700d38dc8">pickArea</a> (startx/y, endx/y,[sceneGroupMask],[sceneLayerMask],[pickMode])</td></tr>
  188. <tr class="separator:a9c9ca45ceaac1e936708b12700d38dc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:a4bc9db69310bdd5401973cdaa89b7e96"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a4bc9db69310bdd5401973cdaa89b7e96">pickCircle</a> (x/y, radius,[sceneGroupMask],[sceneLayerMask],[pickMode])</td></tr>
  190. <tr class="separator:a4bc9db69310bdd5401973cdaa89b7e96"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. <tr class="memitem:a384e6f02b902273dae9394f9e39e5f06"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a384e6f02b902273dae9394f9e39e5f06">pickPoint</a> (x/y,[sceneGroupMask],[sceneLayerMask],[pickMode])</td></tr>
  192. <tr class="separator:a384e6f02b902273dae9394f9e39e5f06"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:ae89cd197a4a6cf10ee00968c2cde1214"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#ae89cd197a4a6cf10ee00968c2cde1214">pickRay</a> (startx/y, endx/y,[sceneGroupMask],[sceneLayerMask],[pickMode])</td></tr>
  194. <tr class="separator:ae89cd197a4a6cf10ee00968c2cde1214"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="memitem:ade381f73f43e3e9b19fbd9ae7fd605e0"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#ade381f73f43e3e9b19fbd9ae7fd605e0">pickRayCollision</a> (startx/y, endx/y,[sceneGroupMask],[sceneLayerMask])</td></tr>
  196. <tr class="separator:ade381f73f43e3e9b19fbd9ae7fd605e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  197. <tr class="memitem:a0d3fbbe5baf15d42867874fd9fd29775"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a0d3fbbe5baf15d42867874fd9fd29775">remove</a> (sceneObject)</td></tr>
  198. <tr class="separator:a0d3fbbe5baf15d42867874fd9fd29775"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <tr class="memitem:aba6d201b1086678015dbc81180ce2828"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#aba6d201b1086678015dbc81180ce2828">removeAssetPreload</a> (assetId)</td></tr>
  200. <tr class="separator:aba6d201b1086678015dbc81180ce2828"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="memitem:a1336006ef13d6ad7ad4754d07d241b3a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a1336006ef13d6ad7ad4754d07d241b3a">resetDebugStats</a> ()</td></tr>
  202. <tr class="separator:a1336006ef13d6ad7ad4754d07d241b3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  203. <tr class="memitem:a7d74530a31755ff6a86ea69349a3eacc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a7d74530a31755ff6a86ea69349a3eacc">setBatchingEnabled</a> (bool enabled)</td></tr>
  204. <tr class="separator:a7d74530a31755ff6a86ea69349a3eacc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. <tr class="memitem:a16f05fd89378a5f7149e46dfd9a759d9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a16f05fd89378a5f7149e46dfd9a759d9">setDebugOff</a> (debugOptions)</td></tr>
  206. <tr class="separator:a16f05fd89378a5f7149e46dfd9a759d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  207. <tr class="memitem:aefa942fdbfda9d4e37139eb36d34789b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#aefa942fdbfda9d4e37139eb36d34789b">setDebugOn</a> (debugOptions)</td></tr>
  208. <tr class="separator:aefa942fdbfda9d4e37139eb36d34789b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  209. <tr class="memitem:a086818fd3866e5eb971fd390c7e7eb0e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a086818fd3866e5eb971fd390c7e7eb0e">setDebugSceneObject</a> (sceneObject)</td></tr>
  210. <tr class="separator:a086818fd3866e5eb971fd390c7e7eb0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  211. <tr class="memitem:a992c1b3c3dfc46371920db78efc54658"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a992c1b3c3dfc46371920db78efc54658">setDistanceJointDampingRatio</a> (jointId, dampingRatio)</td></tr>
  212. <tr class="separator:a992c1b3c3dfc46371920db78efc54658"><td class="memSeparator" colspan="2">&#160;</td></tr>
  213. <tr class="memitem:a2d8107cc04edc88ea6bf81c593f25edd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a2d8107cc04edc88ea6bf81c593f25edd">setDistanceJointFrequency</a> (jointId, frequency)</td></tr>
  214. <tr class="separator:a2d8107cc04edc88ea6bf81c593f25edd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  215. <tr class="memitem:af5134c22884624a61c6d6834bffcde77"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#af5134c22884624a61c6d6834bffcde77">setDistanceJointLength</a> (jointId, length)</td></tr>
  216. <tr class="separator:af5134c22884624a61c6d6834bffcde77"><td class="memSeparator" colspan="2">&#160;</td></tr>
  217. <tr class="memitem:a877ded105f3cce92354a13c2fc05798e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a877ded105f3cce92354a13c2fc05798e">setFrictionJointMaxForce</a> (jointId, maxForce)</td></tr>
  218. <tr class="separator:a877ded105f3cce92354a13c2fc05798e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  219. <tr class="memitem:a6d2366746dd1cea71b96055148cf2a31"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a6d2366746dd1cea71b96055148cf2a31">setFrictionJointMaxTorque</a> (jointId, maxTorque)</td></tr>
  220. <tr class="separator:a6d2366746dd1cea71b96055148cf2a31"><td class="memSeparator" colspan="2">&#160;</td></tr>
  221. <tr class="memitem:a3b48045fe7e6dc73eccd6188dea48746"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a3b48045fe7e6dc73eccd6188dea48746">setGravity</a> (forceX/forceY)</td></tr>
  222. <tr class="separator:a3b48045fe7e6dc73eccd6188dea48746"><td class="memSeparator" colspan="2">&#160;</td></tr>
  223. <tr class="memitem:a7237f10a6dc12d1acce4784bb9a08b17"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a7237f10a6dc12d1acce4784bb9a08b17">setIsEditorScene</a> ()</td></tr>
  224. <tr class="separator:a7237f10a6dc12d1acce4784bb9a08b17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  225. <tr class="memitem:ad6afa52bbea778a6a0f81139af2ebd4b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#ad6afa52bbea778a6a0f81139af2ebd4b">setLayerSortMode</a> (layer, sortMode)</td></tr>
  226. <tr class="separator:ad6afa52bbea778a6a0f81139af2ebd4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  227. <tr class="memitem:a9d7a5a7d5c4bb22202fde5d577609249"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a9d7a5a7d5c4bb22202fde5d577609249">setMotorJointAngularOffset</a> (jointId, angularOffset)</td></tr>
  228. <tr class="separator:a9d7a5a7d5c4bb22202fde5d577609249"><td class="memSeparator" colspan="2">&#160;</td></tr>
  229. <tr class="memitem:a09b062dd0d196285f743cdfd69cd2257"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a09b062dd0d196285f743cdfd69cd2257">setMotorJointLinearOffset</a> (jointId, linearOffset X/Y)</td></tr>
  230. <tr class="separator:a09b062dd0d196285f743cdfd69cd2257"><td class="memSeparator" colspan="2">&#160;</td></tr>
  231. <tr class="memitem:a3347d79e622d1a521c0653bf7c446b54"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a3347d79e622d1a521c0653bf7c446b54">setMotorJointMaxForce</a> (jointId, maxForce)</td></tr>
  232. <tr class="separator:a3347d79e622d1a521c0653bf7c446b54"><td class="memSeparator" colspan="2">&#160;</td></tr>
  233. <tr class="memitem:a1d6e0b81c6dbca9dd54da6c205cfbcf6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a1d6e0b81c6dbca9dd54da6c205cfbcf6">setMotorJointMaxTorque</a> (jointId, maxTorque)</td></tr>
  234. <tr class="separator:a1d6e0b81c6dbca9dd54da6c205cfbcf6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  235. <tr class="memitem:aa0db357087ea53514903069dd819e11c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#aa0db357087ea53514903069dd819e11c">setPositionIterations</a> (int iterations)</td></tr>
  236. <tr class="separator:aa0db357087ea53514903069dd819e11c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  237. <tr class="memitem:a94981849e0d732e0d052fea5e62993e2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a94981849e0d732e0d052fea5e62993e2">setPrismaticJointLimit</a> (jointId, enableLimit,[lowerTranslation],[upperTranslation])</td></tr>
  238. <tr class="separator:a94981849e0d732e0d052fea5e62993e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  239. <tr class="memitem:ae8bf404f377c9b889f0c87f9b9d62308"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#ae8bf404f377c9b889f0c87f9b9d62308">setPrismaticJointMotor</a> (jointId, enableMotor,[motorSpeed],[maxMotorForce])</td></tr>
  240. <tr class="separator:ae8bf404f377c9b889f0c87f9b9d62308"><td class="memSeparator" colspan="2">&#160;</td></tr>
  241. <tr class="memitem:a2a1f64b37af64f2dbb0f84d340bc65c9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a2a1f64b37af64f2dbb0f84d340bc65c9">setRevoluteJointLimit</a> (jointId, enableLimit,[lowerAngle],[upperAngle])</td></tr>
  242. <tr class="separator:a2a1f64b37af64f2dbb0f84d340bc65c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  243. <tr class="memitem:ac2b09af1c3660bc2cbdb75cd0d9f6ba1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#ac2b09af1c3660bc2cbdb75cd0d9f6ba1">setRevoluteJointMotor</a> (jointId, enableMotor,[motorSpeed],[maxMotorTorque])</td></tr>
  244. <tr class="separator:ac2b09af1c3660bc2cbdb75cd0d9f6ba1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  245. <tr class="memitem:a43653956ac81333290f8433084178eec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a43653956ac81333290f8433084178eec">setRopeJointMaxLength</a> (jointId, maxLength)</td></tr>
  246. <tr class="separator:a43653956ac81333290f8433084178eec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  247. <tr class="memitem:ab0c9962ab39eca113ca39ee3ad436e62"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#ab0c9962ab39eca113ca39ee3ad436e62">setScenePause</a> (status)</td></tr>
  248. <tr class="separator:ab0c9962ab39eca113ca39ee3ad436e62"><td class="memSeparator" colspan="2">&#160;</td></tr>
  249. <tr class="memitem:a372cb58985e2ad0cdb7f6eb02c382d53"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a372cb58985e2ad0cdb7f6eb02c382d53">setTargetJointDampingRatio</a> (jointId, dampingRatio)</td></tr>
  250. <tr class="separator:a372cb58985e2ad0cdb7f6eb02c382d53"><td class="memSeparator" colspan="2">&#160;</td></tr>
  251. <tr class="memitem:a721201aba052c42592b7068e73d9c92f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a721201aba052c42592b7068e73d9c92f">setTargetJointFrequency</a> (jointId, frequency)</td></tr>
  252. <tr class="separator:a721201aba052c42592b7068e73d9c92f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  253. <tr class="memitem:a4826e4c5fe1a3fcc838d99b65b862f97"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a4826e4c5fe1a3fcc838d99b65b862f97">setTargetJointTarget</a> (jointId, worldTarget X/Y)</td></tr>
  254. <tr class="separator:a4826e4c5fe1a3fcc838d99b65b862f97"><td class="memSeparator" colspan="2">&#160;</td></tr>
  255. <tr class="memitem:aac7a9c43e5a69de84a17e3ac6b692d2f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#aac7a9c43e5a69de84a17e3ac6b692d2f">setVelocityIterations</a> (int iterations)</td></tr>
  256. <tr class="separator:aac7a9c43e5a69de84a17e3ac6b692d2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  257. <tr class="memitem:a073a64dc1793fcbf8414b6dd47a137b0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a073a64dc1793fcbf8414b6dd47a137b0">setWeldJointDampingRatio</a> (jointId, dampingRatio)</td></tr>
  258. <tr class="separator:a073a64dc1793fcbf8414b6dd47a137b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  259. <tr class="memitem:a87bfdf31f5b370895f00418d7fdd144e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a87bfdf31f5b370895f00418d7fdd144e">setWeldJointFrequency</a> (jointId, frequency)</td></tr>
  260. <tr class="separator:a87bfdf31f5b370895f00418d7fdd144e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  261. <tr class="memitem:a386b7517ea74fc2b1579d1fe06e13f04"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a386b7517ea74fc2b1579d1fe06e13f04">setWheelJointDampingRatio</a> (jointId, dampingRatio)</td></tr>
  262. <tr class="separator:a386b7517ea74fc2b1579d1fe06e13f04"><td class="memSeparator" colspan="2">&#160;</td></tr>
  263. <tr class="memitem:aafe8a0a747f85fdcc517e187e5f3cea0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#aafe8a0a747f85fdcc517e187e5f3cea0">setWheelJointFrequency</a> (jointId, frequency)</td></tr>
  264. <tr class="separator:aafe8a0a747f85fdcc517e187e5f3cea0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  265. <tr class="memitem:a6de30c3a37273fa2e5826d9863304ec7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classScene.html#a6de30c3a37273fa2e5826d9863304ec7">setWheelJointMotor</a> (jointId, enableMotor,[motorSpeed],[maxMotorTorque])</td></tr>
  266. <tr class="separator:a6de30c3a37273fa2e5826d9863304ec7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  267. <tr class="inherit_header pub_methods_classBehaviorComponent"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classBehaviorComponent')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classBehaviorComponent.html">BehaviorComponent</a></td></tr>
  268. <tr class="memitem:a191700f13d3e43312e84217f6b69f9ee inherit pub_methods_classBehaviorComponent"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a191700f13d3e43312e84217f6b69f9ee">addBehavior</a> (<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi)</td></tr>
  269. <tr class="separator:a191700f13d3e43312e84217f6b69f9ee inherit pub_methods_classBehaviorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  270. <tr class="memitem:a75cf9aca6491d3442a30255e50929c07 inherit pub_methods_classBehaviorComponent"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a75cf9aca6491d3442a30255e50929c07">clearBehaviors</a> ()</td></tr>
  271. <tr class="separator:a75cf9aca6491d3442a30255e50929c07 inherit pub_methods_classBehaviorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  272. <tr class="memitem:a24eff746b90533b916b2b3aa0f27d8f3 inherit pub_methods_classBehaviorComponent"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a24eff746b90533b916b2b3aa0f27d8f3">connect</a> (outputBehavior, inputBehavior, outputName, inputName)</td></tr>
  273. <tr class="separator:a24eff746b90533b916b2b3aa0f27d8f3 inherit pub_methods_classBehaviorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  274. <tr class="memitem:a5021752e2f48900d3a7cb3ffdab1f7a9 inherit pub_methods_classBehaviorComponent"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a5021752e2f48900d3a7cb3ffdab1f7a9">disconnect</a> (outputBehavior, inputBehavior, outputName, inputName)</td></tr>
  275. <tr class="separator:a5021752e2f48900d3a7cb3ffdab1f7a9 inherit pub_methods_classBehaviorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  276. <tr class="memitem:a7d996d1d925e53a122b1f3cf57f5abce inherit pub_methods_classBehaviorComponent"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a7d996d1d925e53a122b1f3cf57f5abce">getBehavior</a> (string BehaviorTemplateName)</td></tr>
  277. <tr class="separator:a7d996d1d925e53a122b1f3cf57f5abce inherit pub_methods_classBehaviorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  278. <tr class="memitem:aed9520e4500354682950371b062d974d inherit pub_methods_classBehaviorComponent"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#aed9520e4500354682950371b062d974d">getBehaviorByIndex</a> (int index)</td></tr>
  279. <tr class="separator:aed9520e4500354682950371b062d974d inherit pub_methods_classBehaviorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  280. <tr class="memitem:a88ee692a8690fd9de215f7ece20623b5 inherit pub_methods_classBehaviorComponent"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a88ee692a8690fd9de215f7ece20623b5">getBehaviorConnection</a> (outputBehavior, outputName, connectionIndex)</td></tr>
  281. <tr class="separator:a88ee692a8690fd9de215f7ece20623b5 inherit pub_methods_classBehaviorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  282. <tr class="memitem:ad50805919d99adf0f65c6b94bd9e5dfd inherit pub_methods_classBehaviorComponent"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#ad50805919d99adf0f65c6b94bd9e5dfd">getBehaviorConnectionCount</a> (outputBehavior, outputName)</td></tr>
  283. <tr class="separator:ad50805919d99adf0f65c6b94bd9e5dfd inherit pub_methods_classBehaviorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  284. <tr class="memitem:ab6dc6b3eb09a1d6f8f4c8ec9a4108d17 inherit pub_methods_classBehaviorComponent"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#ab6dc6b3eb09a1d6f8f4c8ec9a4108d17">getBehaviorCount</a> ()</td></tr>
  285. <tr class="separator:ab6dc6b3eb09a1d6f8f4c8ec9a4108d17 inherit pub_methods_classBehaviorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  286. <tr class="memitem:ae81bec76a6acbc925694c5a050198609 inherit pub_methods_classBehaviorComponent"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#ae81bec76a6acbc925694c5a050198609">raise</a> (outputBehavior, outputName,[deltaTime])</td></tr>
  287. <tr class="separator:ae81bec76a6acbc925694c5a050198609 inherit pub_methods_classBehaviorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  288. <tr class="memitem:a5f71e751ee5ab7b8ea61e31a77983f4b inherit pub_methods_classBehaviorComponent"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a5f71e751ee5ab7b8ea61e31a77983f4b">removeBehavior</a> (<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> bi,[bool deleteBehavior=true])</td></tr>
  289. <tr class="separator:a5f71e751ee5ab7b8ea61e31a77983f4b inherit pub_methods_classBehaviorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  290. <tr class="memitem:a753fb3072cd4e96d997755452bc13071 inherit pub_methods_classBehaviorComponent"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBehaviorComponent.html#a753fb3072cd4e96d997755452bc13071">reOrder</a> (<a class="el" href="classBehaviorInstance.html">BehaviorInstance</a> inst,[int desiredIndex=0])</td></tr>
  291. <tr class="separator:a753fb3072cd4e96d997755452bc13071 inherit pub_methods_classBehaviorComponent"><td class="memSeparator" colspan="2">&#160;</td></tr>
  292. </table>
  293. <h2 class="groupheader">Member Function Documentation</h2>
  294. <a class="anchor" id="a2ec5354069ae94a8058dc611ced5e84a"></a>
  295. <div class="memitem">
  296. <div class="memproto">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname">void add </td>
  300. <td>(</td>
  301. <td class="paramtype">sceneObject&#160;</td>
  302. <td class="paramname"></td><td>)</td>
  303. <td></td>
  304. </tr>
  305. </table>
  306. </div><div class="memdoc">
  307. <p>Add the <a class="el" href="classSceneObject.html">SceneObject</a> to the scene. </p>
  308. <dl class="params"><dt>Parameters</dt><dd>
  309. <table class="params">
  310. <tr><td class="paramname">sceneObject</td><td>The <a class="el" href="classSceneObject.html">SceneObject</a> to add to the scene. </td></tr>
  311. </table>
  312. </dd>
  313. </dl>
  314. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  315. </div>
  316. </div>
  317. <a class="anchor" id="a7bd0bd2419edad6f4f6c7dc874d1e42e"></a>
  318. <div class="memitem">
  319. <div class="memproto">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname">void addAssetPreload </td>
  323. <td>(</td>
  324. <td class="paramtype">assetId&#160;</td>
  325. <td class="paramname"></td><td>)</td>
  326. <td></td>
  327. </tr>
  328. </table>
  329. </div><div class="memdoc">
  330. <p>Adds the asset Id so that it is preloaded when the scene is loaded. The asset loaded immediately by this operation. Duplicate assets are ignored. </p>
  331. <dl class="params"><dt>Parameters</dt><dd>
  332. <table class="params">
  333. <tr><td class="paramname">assetId</td><td>The asset Id to be added. </td></tr>
  334. </table>
  335. </dd>
  336. </dl>
  337. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  338. </div>
  339. </div>
  340. <a class="anchor" id="a516e00b5071522b23f5d9770c0d58692"></a>
  341. <div class="memitem">
  342. <div class="memproto">
  343. <table class="memname">
  344. <tr>
  345. <td class="memname">void clear </td>
  346. <td>(</td>
  347. <td class="paramname"></td><td>)</td>
  348. <td></td>
  349. </tr>
  350. </table>
  351. </div><div class="memdoc">
  352. <p>Clear the scene of all scene objects. </p>
  353. <dl class="params"><dt>Parameters</dt><dd>
  354. <table class="params">
  355. <tr><td class="paramname">deleteObjects</td><td>A boolean flag that sets whether to delete the objects as well as remove them from the scene (default is true). </td></tr>
  356. </table>
  357. </dd>
  358. </dl>
  359. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  360. </div>
  361. </div>
  362. <a class="anchor" id="a27451117148f13f460752a861c17e700"></a>
  363. <div class="memitem">
  364. <div class="memproto">
  365. <table class="memname">
  366. <tr>
  367. <td class="memname">void clearAssetPreloads </td>
  368. <td>(</td>
  369. <td class="paramname"></td><td>)</td>
  370. <td></td>
  371. </tr>
  372. </table>
  373. </div><div class="memdoc">
  374. <p>Clears all assets added as a preload. </p>
  375. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  376. </div>
  377. </div>
  378. <a class="anchor" id="acf189a511641274f991aee549e12af5b"></a>
  379. <div class="memitem">
  380. <div class="memproto">
  381. <table class="memname">
  382. <tr>
  383. <td class="memname">string create </td>
  384. <td>(</td>
  385. <td class="paramtype">type&#160;</td>
  386. <td class="paramname"></td><td>)</td>
  387. <td></td>
  388. </tr>
  389. </table>
  390. </div><div class="memdoc">
  391. <p>Creates the specified scene-object derived type and adds it to the scene. </p>
  392. <dl class="section return"><dt>Returns</dt><dd>The scene-object or NULL if not created. </dd></dl>
  393. </div>
  394. </div>
  395. <a class="anchor" id="a3e471b063ed053d3f178c5185ff13332"></a>
  396. <div class="memitem">
  397. <div class="memproto">
  398. <table class="memname">
  399. <tr>
  400. <td class="memname">int createDistanceJoint </td>
  401. <td>(</td>
  402. <td class="paramtype">sceneObjectA&#160;</td>
  403. <td class="paramname">, </td>
  404. </tr>
  405. <tr>
  406. <td class="paramkey"></td>
  407. <td></td>
  408. <td class="paramtype">sceneObjectB&#160;</td>
  409. <td class="paramname">&#160;</td>
  410. </tr>
  411. <tr>
  412. <td></td>
  413. <td>)</td>
  414. <td></td><td></td>
  415. </tr>
  416. </table>
  417. </div><div class="memdoc">
  418. <p>Creates a distance joint. </p>
  419. <dl class="params"><dt>Parameters</dt><dd>
  420. <table class="params">
  421. <tr><td class="paramname">sceneObjectA</td><td>The first scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  422. <tr><td class="paramname">sceneObjectB</td><td>The second scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  423. <tr><td class="paramname">localAnchorA</td><td>The local point of the first scene object where the joint connects. </td></tr>
  424. <tr><td class="paramname">localAnchorB</td><td>The local point of the second scene object where the joint connects. </td></tr>
  425. <tr><td class="paramname">distance</td><td>The distance the joint should maintain between scene objects. The default is the distance currently between the scene objects. </td></tr>
  426. <tr><td class="paramname">frequency</td><td>The mass-spring-damper frequency in Hertz. A value of 0 disables softness (default). </td></tr>
  427. <tr><td class="paramname">dampingRatio</td><td>The damping ratio. 0 = no damping (default), 1 = critical damping. </td></tr>
  428. <tr><td class="paramname">collideConnected</td><td>Whether the scene objects can collide with each other while connected with this joint. </td></tr>
  429. </table>
  430. </dd>
  431. </dl>
  432. <dl class="section return"><dt>Returns</dt><dd>The joint Id (-1 if error). </dd></dl>
  433. </div>
  434. </div>
  435. <a class="anchor" id="a0c64ea1e52a0663a1f0907d61f3251db"></a>
  436. <div class="memitem">
  437. <div class="memproto">
  438. <table class="memname">
  439. <tr>
  440. <td class="memname">int createFrictionJoint </td>
  441. <td>(</td>
  442. <td class="paramtype">sceneObjectA&#160;</td>
  443. <td class="paramname">, </td>
  444. </tr>
  445. <tr>
  446. <td class="paramkey"></td>
  447. <td></td>
  448. <td class="paramtype">sceneObjectB&#160;</td>
  449. <td class="paramname">&#160;</td>
  450. </tr>
  451. <tr>
  452. <td></td>
  453. <td>)</td>
  454. <td></td><td></td>
  455. </tr>
  456. </table>
  457. </div><div class="memdoc">
  458. <p>Creates a friction joint. </p>
  459. <dl class="params"><dt>Parameters</dt><dd>
  460. <table class="params">
  461. <tr><td class="paramname">sceneObjectA</td><td>The first scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  462. <tr><td class="paramname">sceneObjectB</td><td>The second scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  463. <tr><td class="paramname">localAnchorA</td><td>The local point of the first scene object where the joint connects. </td></tr>
  464. <tr><td class="paramname">localAnchorB</td><td>The local point of the second scene object where the joint connects. </td></tr>
  465. <tr><td class="paramname">maxForce</td><td>The maximum friction force (N). </td></tr>
  466. <tr><td class="paramname">maxTorque</td><td>The maximum torque force (N-m). </td></tr>
  467. <tr><td class="paramname">collideConnected</td><td>Whether the scene objects can collide with each other while connected with this joint. </td></tr>
  468. </table>
  469. </dd>
  470. </dl>
  471. <dl class="section return"><dt>Returns</dt><dd>The joint Id (-1 if error). </dd></dl>
  472. </div>
  473. </div>
  474. <a class="anchor" id="a156ec65a52be3ecbd3ac43efbe113b06"></a>
  475. <div class="memitem">
  476. <div class="memproto">
  477. <table class="memname">
  478. <tr>
  479. <td class="memname">int createMotorJoint </td>
  480. <td>(</td>
  481. <td class="paramtype">sceneObjectA&#160;</td>
  482. <td class="paramname">, </td>
  483. </tr>
  484. <tr>
  485. <td class="paramkey"></td>
  486. <td></td>
  487. <td class="paramtype">sceneObjectB&#160;</td>
  488. <td class="paramname">&#160;</td>
  489. </tr>
  490. <tr>
  491. <td></td>
  492. <td>)</td>
  493. <td></td><td></td>
  494. </tr>
  495. </table>
  496. </div><div class="memdoc">
  497. <p>Creates a motor joint. </p>
  498. <dl class="params"><dt>Parameters</dt><dd>
  499. <table class="params">
  500. <tr><td class="paramname">sceneObjectA</td><td>The first scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  501. <tr><td class="paramname">sceneObjectB</td><td>The second scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  502. <tr><td class="paramname">linearOffsetX/Y</td><td>The linear offset in sceneObjectA space. </td></tr>
  503. <tr><td class="paramname">angularOffset</td><td>The angularOffset between the bodies. </td></tr>
  504. <tr><td class="paramname">maxForce</td><td>The maximum friction force (N). </td></tr>
  505. <tr><td class="paramname">maxTorque</td><td>The maximum torque force (N-m). </td></tr>
  506. <tr><td class="paramname">correctionFactor</td><td>The correction factor (tolerance). </td></tr>
  507. <tr><td class="paramname">collideConnected</td><td>Whether the scene objects can collide with each other while connected with this joint. </td></tr>
  508. </table>
  509. </dd>
  510. </dl>
  511. <dl class="section return"><dt>Returns</dt><dd>The joint Id (-1 if error). </dd></dl>
  512. </div>
  513. </div>
  514. <a class="anchor" id="a35f90ed55a88b1936930dfcd43cf66d0"></a>
  515. <div class="memitem">
  516. <div class="memproto">
  517. <table class="memname">
  518. <tr>
  519. <td class="memname">int createPrismaticJoint </td>
  520. <td>(</td>
  521. <td class="paramtype">sceneObjectA&#160;</td>
  522. <td class="paramname">, </td>
  523. </tr>
  524. <tr>
  525. <td class="paramkey"></td>
  526. <td></td>
  527. <td class="paramtype">sceneObjectB&#160;</td>
  528. <td class="paramname">, </td>
  529. </tr>
  530. <tr>
  531. <td class="paramkey"></td>
  532. <td></td>
  533. <td class="paramtype">localAnchorA X/&#160;</td>
  534. <td class="paramname"><em>Y</em>, </td>
  535. </tr>
  536. <tr>
  537. <td class="paramkey"></td>
  538. <td></td>
  539. <td class="paramtype">localAnchorB X/&#160;</td>
  540. <td class="paramname"><em>Y</em>, </td>
  541. </tr>
  542. <tr>
  543. <td class="paramkey"></td>
  544. <td></td>
  545. <td class="paramtype">worldAxis X/&#160;</td>
  546. <td class="paramname"><em>Y</em>&#160;</td>
  547. </tr>
  548. <tr>
  549. <td></td>
  550. <td>)</td>
  551. <td></td><td></td>
  552. </tr>
  553. </table>
  554. </div><div class="memdoc">
  555. <p>Creates a prismatic joint. </p>
  556. <dl class="params"><dt>Parameters</dt><dd>
  557. <table class="params">
  558. <tr><td class="paramname">sceneObjectA</td><td>The first scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  559. <tr><td class="paramname">sceneObjectB</td><td>The second scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  560. <tr><td class="paramname">localAnchorA</td><td>The local point of the first scene object where the joint connects. </td></tr>
  561. <tr><td class="paramname">localAnchorB</td><td>The local point of the second scene object where the joint connects. </td></tr>
  562. <tr><td class="paramname">worldAxis</td><td>The world axis defining the translational degree of freedom. </td></tr>
  563. <tr><td class="paramname">collideConnected</td><td>Whether the scene objects can collide with each other while connected with this joint. </td></tr>
  564. </table>
  565. </dd>
  566. </dl>
  567. <dl class="section return"><dt>Returns</dt><dd>The joint Id (-1 if error). </dd></dl>
  568. </div>
  569. </div>
  570. <a class="anchor" id="a314726df47a8318c25fe049a4d45ddf7"></a>
  571. <div class="memitem">
  572. <div class="memproto">
  573. <table class="memname">
  574. <tr>
  575. <td class="memname">int createPulleyJoint </td>
  576. <td>(</td>
  577. <td class="paramtype">sceneObjectA&#160;</td>
  578. <td class="paramname">, </td>
  579. </tr>
  580. <tr>
  581. <td class="paramkey"></td>
  582. <td></td>
  583. <td class="paramtype">sceneObjectB&#160;</td>
  584. <td class="paramname">, </td>
  585. </tr>
  586. <tr>
  587. <td class="paramkey"></td>
  588. <td></td>
  589. <td class="paramtype">localAnchorA X/&#160;</td>
  590. <td class="paramname"><em>Y</em>, </td>
  591. </tr>
  592. <tr>
  593. <td class="paramkey"></td>
  594. <td></td>
  595. <td class="paramtype">localAnchorB X/&#160;</td>
  596. <td class="paramname"><em>Y</em>, </td>
  597. </tr>
  598. <tr>
  599. <td class="paramkey"></td>
  600. <td></td>
  601. <td class="paramtype">worldGroundAnchorA X/&#160;</td>
  602. <td class="paramname"><em>Y</em>, </td>
  603. </tr>
  604. <tr>
  605. <td class="paramkey"></td>
  606. <td></td>
  607. <td class="paramtype">worldGroundAnchorB X/&#160;</td>
  608. <td class="paramname"><em>Y</em>, </td>
  609. </tr>
  610. <tr>
  611. <td class="paramkey"></td>
  612. <td></td>
  613. <td class="paramtype">ratio&#160;</td>
  614. <td class="paramname">&#160;</td>
  615. </tr>
  616. <tr>
  617. <td></td>
  618. <td>)</td>
  619. <td></td><td></td>
  620. </tr>
  621. </table>
  622. </div><div class="memdoc">
  623. <p>Creates a prismatic joint. </p>
  624. <dl class="params"><dt>Parameters</dt><dd>
  625. <table class="params">
  626. <tr><td class="paramname">sceneObjectA</td><td>The first scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  627. <tr><td class="paramname">sceneObjectB</td><td>The second scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  628. <tr><td class="paramname">localAnchorA</td><td>The local point of the first scene object where the joint connects. </td></tr>
  629. <tr><td class="paramname">localAnchorB</td><td>The local point of the second scene object where the joint connects. </td></tr>
  630. <tr><td class="paramname">worldGroundAnchorA</td><td>The world point of the first ground anchor. This point never moves. </td></tr>
  631. <tr><td class="paramname">worldGroundAnchorB</td><td>The world point of the second ground anchor. This point never moves. </td></tr>
  632. <tr><td class="paramname">ratio</td><td>The pulley ratio used to simulate a block-and-tackle pulley. </td></tr>
  633. <tr><td class="paramname">lengthA</td><td>The reference pulley length for the segment attached to scene object A. Defaults to the distance between the first scene object and the first ground anchor. </td></tr>
  634. <tr><td class="paramname">lengthB</td><td>The reference pulley length for the segment attached to scene object B. Defaults to the distance between the second scene object and the second ground anchor. </td></tr>
  635. <tr><td class="paramname">collideConnected</td><td>Whether the scene objects can collide with each other while connected with this joint. </td></tr>
  636. </table>
  637. </dd>
  638. </dl>
  639. <dl class="section return"><dt>Returns</dt><dd>The joint Id (-1 if error). </dd></dl>
  640. </div>
  641. </div>
  642. <a class="anchor" id="a0b95769bbf08a7b400cabc10e3b9c387"></a>
  643. <div class="memitem">
  644. <div class="memproto">
  645. <table class="memname">
  646. <tr>
  647. <td class="memname">int createRevoluteJoint </td>
  648. <td>(</td>
  649. <td class="paramtype">sceneObjectA&#160;</td>
  650. <td class="paramname">, </td>
  651. </tr>
  652. <tr>
  653. <td class="paramkey"></td>
  654. <td></td>
  655. <td class="paramtype">sceneObjectB&#160;</td>
  656. <td class="paramname">&#160;</td>
  657. </tr>
  658. <tr>
  659. <td></td>
  660. <td>)</td>
  661. <td></td><td></td>
  662. </tr>
  663. </table>
  664. </div><div class="memdoc">
  665. <p>Creates a revolute joint. </p>
  666. <dl class="params"><dt>Parameters</dt><dd>
  667. <table class="params">
  668. <tr><td class="paramname">sceneObjectA</td><td>The first scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  669. <tr><td class="paramname">sceneObjectB</td><td>The second scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  670. <tr><td class="paramname">localAnchorA</td><td>The local point of the first scene object where the joint connects. </td></tr>
  671. <tr><td class="paramname">localAnchorB</td><td>The local point of the second scene object where the joint connects. </td></tr>
  672. <tr><td class="paramname">collideConnected</td><td>Whether the scene objects can collide with each other while connected with this joint. </td></tr>
  673. </table>
  674. </dd>
  675. </dl>
  676. <dl class="section return"><dt>Returns</dt><dd>The joint Id (-1 if error). </dd></dl>
  677. </div>
  678. </div>
  679. <a class="anchor" id="a62fa910a2d0358046b407602f3fc9a40"></a>
  680. <div class="memitem">
  681. <div class="memproto">
  682. <table class="memname">
  683. <tr>
  684. <td class="memname">int createRopeJoint </td>
  685. <td>(</td>
  686. <td class="paramtype">sceneObjectA&#160;</td>
  687. <td class="paramname">, </td>
  688. </tr>
  689. <tr>
  690. <td class="paramkey"></td>
  691. <td></td>
  692. <td class="paramtype">sceneObjectB&#160;</td>
  693. <td class="paramname">&#160;</td>
  694. </tr>
  695. <tr>
  696. <td></td>
  697. <td>)</td>
  698. <td></td><td></td>
  699. </tr>
  700. </table>
  701. </div><div class="memdoc">
  702. <p>Creates a rope joint. </p>
  703. <dl class="params"><dt>Parameters</dt><dd>
  704. <table class="params">
  705. <tr><td class="paramname">sceneObjectA</td><td>The first scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  706. <tr><td class="paramname">sceneObjectB</td><td>The second scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  707. <tr><td class="paramname">localAnchorA</td><td>The local point of the first scene object where the joint connects. </td></tr>
  708. <tr><td class="paramname">localAnchorB</td><td>The local point of the second scene object where the joint connects. </td></tr>
  709. <tr><td class="paramname">maxLength</td><td>The maximum rigid length of the rope. </td></tr>
  710. <tr><td class="paramname">collideConnected</td><td>Whether the scene objects can collide with each other while connected with this joint. </td></tr>
  711. </table>
  712. </dd>
  713. </dl>
  714. <dl class="section return"><dt>Returns</dt><dd>The joint Id (-1 if error). </dd></dl>
  715. </div>
  716. </div>
  717. <a class="anchor" id="ad2ec21387d99b11e2641a658b8c9a013"></a>
  718. <div class="memitem">
  719. <div class="memproto">
  720. <table class="memname">
  721. <tr>
  722. <td class="memname">int createTargetJoint </td>
  723. <td>(</td>
  724. <td class="paramtype">sceneObject&#160;</td>
  725. <td class="paramname">, </td>
  726. </tr>
  727. <tr>
  728. <td class="paramkey"></td>
  729. <td></td>
  730. <td class="paramtype">worldTarget X/&#160;</td>
  731. <td class="paramname"><em>Y</em>, </td>
  732. </tr>
  733. <tr>
  734. <td class="paramkey"></td>
  735. <td></td>
  736. <td class="paramtype">maxForce&#160;</td>
  737. <td class="paramname">&#160;</td>
  738. </tr>
  739. <tr>
  740. <td></td>
  741. <td>)</td>
  742. <td></td><td></td>
  743. </tr>
  744. </table>
  745. </div><div class="memdoc">
  746. <p>Creates a target joint. </p>
  747. <dl class="params"><dt>Parameters</dt><dd>
  748. <table class="params">
  749. <tr><td class="paramname">sceneObject</td><td>The scene object to connect to the joint. </td></tr>
  750. <tr><td class="paramname">worldTarget</td><td>The world point target to move the scene object to. </td></tr>
  751. <tr><td class="paramname">maxForce</td><td>The maximum force the joint should use to position the scene object at the target. </td></tr>
  752. <tr><td class="paramname">useCenterOfMass</td><td>Whether to use the center of mass as the point which the joint is attached or not. Defaults to false. </td></tr>
  753. <tr><td class="paramname">frequency</td><td>The mass-spring-damper frequency in Hertz. A value of 0 disables softness (default=0.7). </td></tr>
  754. <tr><td class="paramname">dampingRatio</td><td>The damping ratio. 0 = no damping (default), 1 = critical damping. </td></tr>
  755. <tr><td class="paramname">collideConnected</td><td>Whether the scene objects can collide with each other while connected with this joint. </td></tr>
  756. </table>
  757. </dd>
  758. </dl>
  759. <dl class="section return"><dt>Returns</dt><dd>The joint Id (-1 if error). </dd></dl>
  760. </div>
  761. </div>
  762. <a class="anchor" id="a30d321b32b80411f3e23224678f5a367"></a>
  763. <div class="memitem">
  764. <div class="memproto">
  765. <table class="memname">
  766. <tr>
  767. <td class="memname">int createWeldJoint </td>
  768. <td>(</td>
  769. <td class="paramtype">sceneObjectA&#160;</td>
  770. <td class="paramname">, </td>
  771. </tr>
  772. <tr>
  773. <td class="paramkey"></td>
  774. <td></td>
  775. <td class="paramtype">sceneObjectB&#160;</td>
  776. <td class="paramname">&#160;</td>
  777. </tr>
  778. <tr>
  779. <td></td>
  780. <td>)</td>
  781. <td></td><td></td>
  782. </tr>
  783. </table>
  784. </div><div class="memdoc">
  785. <p>Creates a weld joint. </p>
  786. <dl class="params"><dt>Parameters</dt><dd>
  787. <table class="params">
  788. <tr><td class="paramname">sceneObjectA</td><td>The first scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  789. <tr><td class="paramname">sceneObjectB</td><td>The second scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  790. <tr><td class="paramname">localAnchorA</td><td>The local point of the first scene object where the joint connects. </td></tr>
  791. <tr><td class="paramname">localAnchorB</td><td>The local point of the second scene object where the joint connects. </td></tr>
  792. <tr><td class="paramname">frequency</td><td>The mass-spring-damper frequency in Hertz. A value of 0 disables softness (default). </td></tr>
  793. <tr><td class="paramname">dampingRatio</td><td>The damping ratio. 0 = no damping (default), 1 = critical damping. </td></tr>
  794. <tr><td class="paramname">collideConnected</td><td>Whether the scene objects can collide with each other while connected with this joint. </td></tr>
  795. </table>
  796. </dd>
  797. </dl>
  798. <dl class="section return"><dt>Returns</dt><dd>The joint Id (-1 if error). </dd></dl>
  799. </div>
  800. </div>
  801. <a class="anchor" id="af9232f386b49a623e7e6d4e80d36c13e"></a>
  802. <div class="memitem">
  803. <div class="memproto">
  804. <table class="memname">
  805. <tr>
  806. <td class="memname">int createWheelJoint </td>
  807. <td>(</td>
  808. <td class="paramtype">sceneObjectA&#160;</td>
  809. <td class="paramname">, </td>
  810. </tr>
  811. <tr>
  812. <td class="paramkey"></td>
  813. <td></td>
  814. <td class="paramtype">sceneObjectB&#160;</td>
  815. <td class="paramname">, </td>
  816. </tr>
  817. <tr>
  818. <td class="paramkey"></td>
  819. <td></td>
  820. <td class="paramtype">localAnchorA X/&#160;</td>
  821. <td class="paramname"><em>Y</em>, </td>
  822. </tr>
  823. <tr>
  824. <td class="paramkey"></td>
  825. <td></td>
  826. <td class="paramtype">localAnchorB X/&#160;</td>
  827. <td class="paramname"><em>Y</em>, </td>
  828. </tr>
  829. <tr>
  830. <td class="paramkey"></td>
  831. <td></td>
  832. <td class="paramtype">worldAxis X/&#160;</td>
  833. <td class="paramname"><em>Y</em>&#160;</td>
  834. </tr>
  835. <tr>
  836. <td></td>
  837. <td>)</td>
  838. <td></td><td></td>
  839. </tr>
  840. </table>
  841. </div><div class="memdoc">
  842. <p>Creates a wheel joint. </p>
  843. <dl class="params"><dt>Parameters</dt><dd>
  844. <table class="params">
  845. <tr><td class="paramname">sceneObjectA</td><td>The first scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  846. <tr><td class="paramname">sceneObjectB</td><td>The second scene object to connect to the joint. Use an empty string to indicate the <a class="el" href="classScene.html">Scene</a> ground body. </td></tr>
  847. <tr><td class="paramname">localAnchorA</td><td>The local point of the first scene object where the joint connects. </td></tr>
  848. <tr><td class="paramname">localAnchorB</td><td>The local point of the second scene object where the joint connects. </td></tr>
  849. <tr><td class="paramname">worldAxis</td><td>The world axis of the wheel suspension spring. </td></tr>
  850. <tr><td class="paramname">collideConnected</td><td>Whether the scene objects can collide with each other while connected with this joint. </td></tr>
  851. </table>
  852. </dd>
  853. </dl>
  854. <dl class="section return"><dt>Returns</dt><dd>The joint Id (-1 if error). </dd></dl>
  855. </div>
  856. </div>
  857. <a class="anchor" id="a71631fcf2c69ce4a8b53157885e3e712"></a>
  858. <div class="memitem">
  859. <div class="memproto">
  860. <table class="memname">
  861. <tr>
  862. <td class="memname">bool deleteJoint </td>
  863. <td>(</td>
  864. <td class="paramtype">int&#160;</td>
  865. <td class="paramname"><em>jointId</em></td><td>)</td>
  866. <td></td>
  867. </tr>
  868. </table>
  869. </div><div class="memdoc">
  870. <p>Deletes the specified joint Id. </p>
  871. <dl class="params"><dt>Parameters</dt><dd>
  872. <table class="params">
  873. <tr><td class="paramname">jointId</td><td>The Id of the joint. </td></tr>
  874. </table>
  875. </dd>
  876. </dl>
  877. <dl class="section return"><dt>Returns</dt><dd>Whether the joint was successfully deleted or not. </dd></dl>
  878. </div>
  879. </div>
  880. <a class="anchor" id="a35346d81b63943cbf07452f0fba39e1e"></a>
  881. <div class="memitem">
  882. <div class="memproto">
  883. <table class="memname">
  884. <tr>
  885. <td class="memname">string getAssetPreload </td>
  886. <td>(</td>
  887. <td class="paramtype">index&#160;</td>
  888. <td class="paramname"></td><td>)</td>
  889. <td></td>
  890. </tr>
  891. </table>
  892. </div><div class="memdoc">
  893. <p>Gets the asset to be preloaded at the specified index. </p>
  894. <dl class="params"><dt>Parameters</dt><dd>
  895. <table class="params">
  896. <tr><td class="paramname">index</td><td>The index of the preloaded asset. </td></tr>
  897. </table>
  898. </dd>
  899. </dl>
  900. <dl class="section return"><dt>Returns</dt><dd>The asset to be preloaded at the specified index. </dd></dl>
  901. </div>
  902. </div>
  903. <a class="anchor" id="a9b374ea743fc5a29947ddb46af2d59b3"></a>
  904. <div class="memitem">
  905. <div class="memproto">
  906. <table class="memname">
  907. <tr>
  908. <td class="memname">int getAssetPreloadCount </td>
  909. <td>(</td>
  910. <td class="paramname"></td><td>)</td>
  911. <td></td>
  912. </tr>
  913. </table>
  914. </div><div class="memdoc">
  915. <p>Gets the number of assets set to preload for this scene. </p>
  916. <dl class="section return"><dt>Returns</dt><dd>The number of assets set to preload for this scene. </dd></dl>
  917. </div>
  918. </div>
  919. <a class="anchor" id="ad416a24ceea44b5666539ea779ba2a68"></a>
  920. <div class="memitem">
  921. <div class="memproto">
  922. <table class="memname">
  923. <tr>
  924. <td class="memname">bool getBatchingEnabled </td>
  925. <td>(</td>
  926. <td class="paramname"></td><td>)</td>
  927. <td></td>
  928. </tr>
  929. </table>
  930. </div><div class="memdoc">
  931. <p>Gets whether render batching is enabled or not. return Whether render batching is enabled or not. </p>
  932. </div>
  933. </div>
  934. <a class="anchor" id="a55631853fae5aed33db986befee573b2"></a>
  935. <div class="memitem">
  936. <div class="memproto">
  937. <table class="memname">
  938. <tr>
  939. <td class="memname">string getControllers </td>
  940. <td>(</td>
  941. <td class="paramname"></td><td>)</td>
  942. <td></td>
  943. </tr>
  944. </table>
  945. </div><div class="memdoc">
  946. <p>Gets the <a class="el" href="classScene.html">Scene</a> Controllers. </p>
  947. <dl class="section return"><dt>Returns</dt><dd>Gets the scene controllers. </dd></dl>
  948. </div>
  949. </div>
  950. <a class="anchor" id="ae452b1c7e00c383f2916c4a530fab737"></a>
  951. <div class="memitem">
  952. <div class="memproto">
  953. <table class="memname">
  954. <tr>
  955. <td class="memname">int getCount </td>
  956. <td>(</td>
  957. <td class="paramname"></td><td>)</td>
  958. <td></td>
  959. </tr>
  960. </table>
  961. </div><div class="memdoc">
  962. <p>Gets the count of scene objects in the scnee. </p>
  963. <dl class="section return"><dt>Returns</dt><dd>Returns the number of scene objects in current scene as an integer. </dd></dl>
  964. </div>
  965. </div>
  966. <a class="anchor" id="af7743442dfe3d22ba5d3c8e6631e2ba8"></a>
  967. <div class="memitem">
  968. <div class="memproto">
  969. <table class="memname">
  970. <tr>
  971. <td class="memname">string getDebugOn </td>
  972. <td>(</td>
  973. <td class="paramname"></td><td>)</td>
  974. <td></td>
  975. </tr>
  976. </table>
  977. </div><div class="memdoc">
  978. <p>Gets the state of the debug modes. </p>
  979. <dl class="section return"><dt>Returns</dt><dd>Returns a space separated list of debug modes that are active. </dd></dl>
  980. </div>
  981. </div>
  982. <a class="anchor" id="a52aff12c0b08562b2539772a9a982f5f"></a>
  983. <div class="memitem">
  984. <div class="memproto">
  985. <table class="memname">
  986. <tr>
  987. <td class="memname">int getDebugSceneObject </td>
  988. <td>(</td>
  989. <td class="paramname"></td><td>)</td>
  990. <td></td>
  991. </tr>
  992. </table>
  993. </div><div class="memdoc">
  994. <p>( Gets the scene object being monitored in the debug metrics. </p>
  995. <dl class="section return"><dt>Returns</dt><dd>The scene object being monitored in the debug metrics (zero if none being monitored). </dd></dl>
  996. </div>
  997. </div>
  998. <a class="anchor" id="af4591a5fd925abe6698f1c132d60487c"></a>
  999. <div class="memitem">
  1000. <div class="memproto">
  1001. <table class="memname">
  1002. <tr>
  1003. <td class="memname">float getDistanceJointDampingRatio </td>
  1004. <td>(</td>
  1005. <td class="paramtype">jointId&#160;</td>
  1006. <td class="paramname"></td><td>)</td>
  1007. <td></td>
  1008. </tr>
  1009. </table>
  1010. </div><div class="memdoc">
  1011. <p>Gets the damping ratio. </p>
  1012. <dl class="params"><dt>Parameters</dt><dd>
  1013. <table class="params">
  1014. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1015. </table>
  1016. </dd>
  1017. </dl>
  1018. <dl class="section return"><dt>Returns</dt><dd>Returns the damping ratio (-1 indicates error). </dd></dl>
  1019. </div>
  1020. </div>
  1021. <a class="anchor" id="a9b26b952cb40f4525e50e18f8ea65658"></a>
  1022. <div class="memitem">
  1023. <div class="memproto">
  1024. <table class="memname">
  1025. <tr>
  1026. <td class="memname">float getDistanceJointFrequency </td>
  1027. <td>(</td>
  1028. <td class="paramtype">jointId&#160;</td>
  1029. <td class="paramname"></td><td>)</td>
  1030. <td></td>
  1031. </tr>
  1032. </table>
  1033. </div><div class="memdoc">
  1034. <p>Gets the mass-spring-damper frequency in Hertz. </p>
  1035. <dl class="params"><dt>Parameters</dt><dd>
  1036. <table class="params">
  1037. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1038. </table>
  1039. </dd>
  1040. </dl>
  1041. <dl class="section return"><dt>Returns</dt><dd>Returns the mass-spring-damper frequency in Hertz (-1 indicates error). </dd></dl>
  1042. </div>
  1043. </div>
  1044. <a class="anchor" id="a32ab592e72afad2a91bf9ae1ceba572b"></a>
  1045. <div class="memitem">
  1046. <div class="memproto">
  1047. <table class="memname">
  1048. <tr>
  1049. <td class="memname">float getDistanceJointLength </td>
  1050. <td>(</td>
  1051. <td class="paramtype">jointId&#160;</td>
  1052. <td class="paramname"></td><td>)</td>
  1053. <td></td>
  1054. </tr>
  1055. </table>
  1056. </div><div class="memdoc">
  1057. <p>Gets the distance the joint should maintain between scene objects. </p>
  1058. <dl class="params"><dt>Parameters</dt><dd>
  1059. <table class="params">
  1060. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1061. </table>
  1062. </dd>
  1063. </dl>
  1064. <dl class="section return"><dt>Returns</dt><dd>Returns the distance the joint should maintain between scene objects (-1 indicates error). </dd></dl>
  1065. </div>
  1066. </div>
  1067. <a class="anchor" id="aa526495b6acf0aece355e13766631c74"></a>
  1068. <div class="memitem">
  1069. <div class="memproto">
  1070. <table class="memname">
  1071. <tr>
  1072. <td class="memname">float getFPS </td>
  1073. <td>(</td>
  1074. <td class="paramname"></td><td>)</td>
  1075. <td></td>
  1076. </tr>
  1077. </table>
  1078. </div><div class="memdoc">
  1079. <p>Gets the current average frames-per-second. </p>
  1080. <dl class="section return"><dt>Returns</dt><dd>The current average frames-per-second. </dd></dl>
  1081. </div>
  1082. </div>
  1083. <a class="anchor" id="a134a0d63775c91ff4a3ab9fa8ac7438a"></a>
  1084. <div class="memitem">
  1085. <div class="memproto">
  1086. <table class="memname">
  1087. <tr>
  1088. <td class="memname">int getFrameCount </td>
  1089. <td>(</td>
  1090. <td class="paramname"></td><td>)</td>
  1091. <td></td>
  1092. </tr>
  1093. </table>
  1094. </div><div class="memdoc">
  1095. <p>Gets the current rendered frame count. </p>
  1096. <dl class="section return"><dt>Returns</dt><dd>The current rendered frame count. </dd></dl>
  1097. </div>
  1098. </div>
  1099. <a class="anchor" id="a016c7605303b0492d0d435c54bad646a"></a>
  1100. <div class="memitem">
  1101. <div class="memproto">
  1102. <table class="memname">
  1103. <tr>
  1104. <td class="memname">float getFrictionJointMaxForce </td>
  1105. <td>(</td>
  1106. <td class="paramtype">jointId&#160;</td>
  1107. <td class="paramname"></td><td>)</td>
  1108. <td></td>
  1109. </tr>
  1110. </table>
  1111. </div><div class="memdoc">
  1112. <p>Sets the maximum friction force. </p>
  1113. <dl class="params"><dt>Parameters</dt><dd>
  1114. <table class="params">
  1115. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1116. </table>
  1117. </dd>
  1118. </dl>
  1119. <dl class="section return"><dt>Returns</dt><dd>Returns the maximum friction force (-1 indicates error). </dd></dl>
  1120. </div>
  1121. </div>
  1122. <a class="anchor" id="a0dee48da97c5c43c7b242d320074414f"></a>
  1123. <div class="memitem">
  1124. <div class="memproto">
  1125. <table class="memname">
  1126. <tr>
  1127. <td class="memname">float getFrictionJointMaxTorque </td>
  1128. <td>(</td>
  1129. <td class="paramtype">jointId&#160;</td>
  1130. <td class="paramname"></td><td>)</td>
  1131. <td></td>
  1132. </tr>
  1133. </table>
  1134. </div><div class="memdoc">
  1135. <p>Gets the maximum torque force. </p>
  1136. <dl class="params"><dt>Parameters</dt><dd>
  1137. <table class="params">
  1138. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1139. </table>
  1140. </dd>
  1141. </dl>
  1142. <dl class="section return"><dt>Returns</dt><dd>Returns the maximum torque force (-1 indicates error). </dd></dl>
  1143. </div>
  1144. </div>
  1145. <a class="anchor" id="a8ce0520fea56d4ba654cb83fcdf1b96a"></a>
  1146. <div class="memitem">
  1147. <div class="memproto">
  1148. <table class="memname">
  1149. <tr>
  1150. <td class="memname">int getGlobalSceneCount </td>
  1151. <td>(</td>
  1152. <td class="paramname"></td><td>)</td>
  1153. <td></td>
  1154. </tr>
  1155. </table>
  1156. </div><div class="memdoc">
  1157. <p>Gets the system-wide scene count. </p>
  1158. <dl class="section return"><dt>Returns</dt><dd>The system-wide scene count. </dd></dl>
  1159. </div>
  1160. </div>
  1161. <a class="anchor" id="a3bfee4d1a4591ca0fcfefcf0b2eb55a4"></a>
  1162. <div class="memitem">
  1163. <div class="memproto">
  1164. <table class="memname">
  1165. <tr>
  1166. <td class="memname">string getGravity </td>
  1167. <td>(</td>
  1168. <td class="paramname"></td><td>)</td>
  1169. <td></td>
  1170. </tr>
  1171. </table>
  1172. </div><div class="memdoc">
  1173. <p>Gets the gravity force applied to all objects in the scene. </p>
  1174. <dl class="section return"><dt>Returns</dt><dd>The gravity force applied to all objects in the scene. </dd></dl>
  1175. </div>
  1176. </div>
  1177. <a class="anchor" id="a94c403f395bab006f3a507b9e59346cb"></a>
  1178. <div class="memitem">
  1179. <div class="memproto">
  1180. <table class="memname">
  1181. <tr>
  1182. <td class="memname">int getJointCount </td>
  1183. <td>(</td>
  1184. <td class="paramname"></td><td>)</td>
  1185. <td></td>
  1186. </tr>
  1187. </table>
  1188. </div><div class="memdoc">
  1189. <p>Gets the joint count. </p>
  1190. <dl class="section return"><dt>Returns</dt><dd>Returns no value </dd></dl>
  1191. </div>
  1192. </div>
  1193. <a class="anchor" id="abcd38248cad9ea920731f9ff49da9d16"></a>
  1194. <div class="memitem">
  1195. <div class="memproto">
  1196. <table class="memname">
  1197. <tr>
  1198. <td class="memname">string getJointType </td>
  1199. <td>(</td>
  1200. <td class="paramtype">int&#160;</td>
  1201. <td class="paramname"><em>jointId</em></td><td>)</td>
  1202. <td></td>
  1203. </tr>
  1204. </table>
  1205. </div><div class="memdoc">
  1206. <p>Gets the joint type of the specified joint Id. </p>
  1207. <dl class="params"><dt>Parameters</dt><dd>
  1208. <table class="params">
  1209. <tr><td class="paramname">jointId</td><td>The Id of the joint. </td></tr>
  1210. </table>
  1211. </dd>
  1212. </dl>
  1213. <dl class="section return"><dt>Returns</dt><dd>The type of joint of the specified joint Id. </dd></dl>
  1214. </div>
  1215. </div>
  1216. <a class="anchor" id="abd5784d71f027d5282a014fd7c627d8b"></a>
  1217. <div class="memitem">
  1218. <div class="memproto">
  1219. <table class="memname">
  1220. <tr>
  1221. <td class="memname">string getLayerSortMode </td>
  1222. <td>(</td>
  1223. <td class="paramtype">layer&#160;</td>
  1224. <td class="paramname"></td><td>)</td>
  1225. <td></td>
  1226. </tr>
  1227. </table>
  1228. </div><div class="memdoc">
  1229. <p>Gets the render sort mode for the specified layer. </p>
  1230. <dl class="params"><dt>Parameters</dt><dd>
  1231. <table class="params">
  1232. <tr><td class="paramname">layer</td><td>The layer to retrieve. </td></tr>
  1233. </table>
  1234. </dd>
  1235. </dl>
  1236. <dl class="section return"><dt>Returns</dt><dd>The render sort mode for the specified layer. </dd></dl>
  1237. </div>
  1238. </div>
  1239. <a class="anchor" id="ae57aa415418c6c3f7edf21e47529b101"></a>
  1240. <div class="memitem">
  1241. <div class="memproto">
  1242. <table class="memname">
  1243. <tr>
  1244. <td class="memname">float getMaxFPS </td>
  1245. <td>(</td>
  1246. <td class="paramname"></td><td>)</td>
  1247. <td></td>
  1248. </tr>
  1249. </table>
  1250. </div><div class="memdoc">
  1251. <p>Gets the maximum average frames-per-second. </p>
  1252. <dl class="section return"><dt>Returns</dt><dd>The average frames-per-second. </dd></dl>
  1253. </div>
  1254. </div>
  1255. <a class="anchor" id="ae078b55824b77c765c340a609a1b18cb"></a>
  1256. <div class="memitem">
  1257. <div class="memproto">
  1258. <table class="memname">
  1259. <tr>
  1260. <td class="memname">float getMinFPS </td>
  1261. <td>(</td>
  1262. <td class="paramname"></td><td>)</td>
  1263. <td></td>
  1264. </tr>
  1265. </table>
  1266. </div><div class="memdoc">
  1267. <p>Gets the minimum average frames-per-second. </p>
  1268. <dl class="section return"><dt>Returns</dt><dd>The minimum Faverage frames-per-second. </dd></dl>
  1269. </div>
  1270. </div>
  1271. <a class="anchor" id="acd57f0fe5f9e3aa7d19579071d0b7c2c"></a>
  1272. <div class="memitem">
  1273. <div class="memproto">
  1274. <table class="memname">
  1275. <tr>
  1276. <td class="memname">float getMotorJointAngularOffset </td>
  1277. <td>(</td>
  1278. <td class="paramtype">jointId&#160;</td>
  1279. <td class="paramname"></td><td>)</td>
  1280. <td></td>
  1281. </tr>
  1282. </table>
  1283. </div><div class="memdoc">
  1284. <p>Gets angularOffset between the bodies. </p>
  1285. <dl class="params"><dt>Parameters</dt><dd>
  1286. <table class="params">
  1287. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1288. </table>
  1289. </dd>
  1290. </dl>
  1291. <dl class="section return"><dt>Returns</dt><dd>Returns the angularOffset between the bodies (-1 indicates error). </dd></dl>
  1292. </div>
  1293. </div>
  1294. <a class="anchor" id="adafb561180a2bd06c3029290d92196e4"></a>
  1295. <div class="memitem">
  1296. <div class="memproto">
  1297. <table class="memname">
  1298. <tr>
  1299. <td class="memname">string getMotorJointLinearOffset </td>
  1300. <td>(</td>
  1301. <td class="paramtype">jointId&#160;</td>
  1302. <td class="paramname"></td><td>)</td>
  1303. <td></td>
  1304. </tr>
  1305. </table>
  1306. </div><div class="memdoc">
  1307. <p>Gets the linear offset in sceneObjectA space. </p>
  1308. <dl class="params"><dt>Parameters</dt><dd>
  1309. <table class="params">
  1310. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1311. </table>
  1312. </dd>
  1313. </dl>
  1314. <dl class="section return"><dt>Returns</dt><dd>Returns the linear offset in sceneObjectA space (always 0,0 if error). </dd></dl>
  1315. </div>
  1316. </div>
  1317. <a class="anchor" id="a118a47ec5e86ad594bf4f0dd63b52ec7"></a>
  1318. <div class="memitem">
  1319. <div class="memproto">
  1320. <table class="memname">
  1321. <tr>
  1322. <td class="memname">float getMotorJointMaxForce </td>
  1323. <td>(</td>
  1324. <td class="paramtype">jointId&#160;</td>
  1325. <td class="paramname"></td><td>)</td>
  1326. <td></td>
  1327. </tr>
  1328. </table>
  1329. </div><div class="memdoc">
  1330. <p>Sets the maximum motor force. </p>
  1331. <dl class="params"><dt>Parameters</dt><dd>
  1332. <table class="params">
  1333. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1334. </table>
  1335. </dd>
  1336. </dl>
  1337. <dl class="section return"><dt>Returns</dt><dd>Returns the maximum motor force (-1 indicates error). </dd></dl>
  1338. </div>
  1339. </div>
  1340. <a class="anchor" id="aceb9522ef6b821f74623bd57033c125f"></a>
  1341. <div class="memitem">
  1342. <div class="memproto">
  1343. <table class="memname">
  1344. <tr>
  1345. <td class="memname">float getMotorJointMaxTorque </td>
  1346. <td>(</td>
  1347. <td class="paramtype">jointId&#160;</td>
  1348. <td class="paramname"></td><td>)</td>
  1349. <td></td>
  1350. </tr>
  1351. </table>
  1352. </div><div class="memdoc">
  1353. <p>Gets the maximum motor torque force. </p>
  1354. <dl class="params"><dt>Parameters</dt><dd>
  1355. <table class="params">
  1356. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1357. </table>
  1358. </dd>
  1359. </dl>
  1360. <dl class="section return"><dt>Returns</dt><dd>Returns the maximum motor torque force (-1 indicates error). </dd></dl>
  1361. </div>
  1362. </div>
  1363. <a class="anchor" id="a74b2500e21a2559cbc4aecf677f13ee8"></a>
  1364. <div class="memitem">
  1365. <div class="memproto">
  1366. <table class="memname">
  1367. <tr>
  1368. <td class="memname">int getObject </td>
  1369. <td>(</td>
  1370. <td class="paramtype">sceneObjectIndex&#160;</td>
  1371. <td class="paramname"></td><td>)</td>
  1372. <td></td>
  1373. </tr>
  1374. </table>
  1375. </div><div class="memdoc">
  1376. <p>Gets the scene object at the selected index. </p>
  1377. <dl class="params"><dt>Parameters</dt><dd>
  1378. <table class="params">
  1379. <tr><td class="paramname">sceneObjectIndex</td><td>The index of the desired object </td></tr>
  1380. </table>
  1381. </dd>
  1382. </dl>
  1383. <dl class="section return"><dt>Returns</dt><dd>The scene object at the specified index. </dd></dl>
  1384. </div>
  1385. </div>
  1386. <a class="anchor" id="a0e39e4dffaa1f21051374083ecdb174c"></a>
  1387. <div class="memitem">
  1388. <div class="memproto">
  1389. <table class="memname">
  1390. <tr>
  1391. <td class="memname">int getPositionIterations </td>
  1392. <td>(</td>
  1393. <td class="paramname"></td><td>)</td>
  1394. <td></td>
  1395. </tr>
  1396. </table>
  1397. </div><div class="memdoc">
  1398. <p>Gets the number of position iterations the physics solver uses. (</p>
  1399. <dl class="section return"><dt>Returns</dt><dd>The number of position iterations the physics solver uses. </dd></dl>
  1400. </div>
  1401. </div>
  1402. <a class="anchor" id="ad8ec3c7c6dae4948585073d208c87f02"></a>
  1403. <div class="memitem">
  1404. <div class="memproto">
  1405. <table class="memname">
  1406. <tr>
  1407. <td class="memname">string getPrismaticJointLimit </td>
  1408. <td>(</td>
  1409. <td class="paramtype">jointId&#160;</td>
  1410. <td class="paramname"></td><td>)</td>
  1411. <td></td>
  1412. </tr>
  1413. </table>
  1414. </div><div class="memdoc">
  1415. <p>Gets whether the joint has translational limits or not and the limits themselves. </p>
  1416. <dl class="section return"><dt>Returns</dt><dd>Returns whether the joint has translational limits or not and the limits themselves (empty string indicates error). </dd></dl>
  1417. </div>
  1418. </div>
  1419. <a class="anchor" id="a8f1b0a6ba5632121f59061b8f808c2bc"></a>
  1420. <div class="memitem">
  1421. <div class="memproto">
  1422. <table class="memname">
  1423. <tr>
  1424. <td class="memname">string getPrismaticJointMotor </td>
  1425. <td>(</td>
  1426. <td class="paramtype">jointId&#160;</td>
  1427. <td class="paramname"></td><td>)</td>
  1428. <td></td>
  1429. </tr>
  1430. </table>
  1431. </div><div class="memdoc">
  1432. <p>Gets whether the joint has a motor or not and the motor settings. </p>
  1433. <dl class="section return"><dt>Returns</dt><dd>Returns whether the joint has a motor or not and the motor settings (empty string indicates error). </dd></dl>
  1434. </div>
  1435. </div>
  1436. <a class="anchor" id="abbc8cd64ee70d21821d2732e8029233b"></a>
  1437. <div class="memitem">
  1438. <div class="memproto">
  1439. <table class="memname">
  1440. <tr>
  1441. <td class="memname">float getRevoluteJointAngle </td>
  1442. <td>(</td>
  1443. <td class="paramtype">jointId&#160;</td>
  1444. <td class="paramname"></td><td>)</td>
  1445. <td></td>
  1446. </tr>
  1447. </table>
  1448. </div><div class="memdoc">
  1449. <p>Gets the current angle of a revolute joint. </p>
  1450. <dl class="params"><dt>Parameters</dt><dd>
  1451. <table class="params">
  1452. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1453. </table>
  1454. </dd>
  1455. </dl>
  1456. <dl class="section return"><dt>Returns</dt><dd>Returns the joint angle. </dd></dl>
  1457. </div>
  1458. </div>
  1459. <a class="anchor" id="a5197c2653efcbb86156544902423ad31"></a>
  1460. <div class="memitem">
  1461. <div class="memproto">
  1462. <table class="memname">
  1463. <tr>
  1464. <td class="memname">string getRevoluteJointLimit </td>
  1465. <td>(</td>
  1466. <td class="paramtype">jointId&#160;</td>
  1467. <td class="paramname"></td><td>)</td>
  1468. <td></td>
  1469. </tr>
  1470. </table>
  1471. </div><div class="memdoc">
  1472. <p>Gets whether the joint has angular limits or not and the limits themselves. </p>
  1473. <dl class="params"><dt>Parameters</dt><dd>
  1474. <table class="params">
  1475. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1476. </table>
  1477. </dd>
  1478. </dl>
  1479. <dl class="section return"><dt>Returns</dt><dd>Returns whether the joint has angular limits or not and the limits themselves (empty string indicates error). </dd></dl>
  1480. </div>
  1481. </div>
  1482. <a class="anchor" id="a01efd74641d4ba017857443a6b03bf0d"></a>
  1483. <div class="memitem">
  1484. <div class="memproto">
  1485. <table class="memname">
  1486. <tr>
  1487. <td class="memname">string getRevoluteJointMotor </td>
  1488. <td>(</td>
  1489. <td class="paramtype">jointId&#160;</td>
  1490. <td class="paramname"></td><td>)</td>
  1491. <td></td>
  1492. </tr>
  1493. </table>
  1494. </div><div class="memdoc">
  1495. <p>Gets whether the joint has a motor or not and the motor settings. </p>
  1496. <dl class="params"><dt>Parameters</dt><dd>
  1497. <table class="params">
  1498. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1499. </table>
  1500. </dd>
  1501. </dl>
  1502. <dl class="section return"><dt>Returns</dt><dd>Returns whether the joint has a motor or not and the motor settings (empty string indicates error). </dd></dl>
  1503. </div>
  1504. </div>
  1505. <a class="anchor" id="a5fb9ac87851e3bc85ced2682d4723741"></a>
  1506. <div class="memitem">
  1507. <div class="memproto">
  1508. <table class="memname">
  1509. <tr>
  1510. <td class="memname">float getRevoluteJointSpeed </td>
  1511. <td>(</td>
  1512. <td class="paramtype">jointId&#160;</td>
  1513. <td class="paramname"></td><td>)</td>
  1514. <td></td>
  1515. </tr>
  1516. </table>
  1517. </div><div class="memdoc">
  1518. <p>Gets the current speed of a revolute joint. </p>
  1519. <dl class="params"><dt>Parameters</dt><dd>
  1520. <table class="params">
  1521. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1522. </table>
  1523. </dd>
  1524. </dl>
  1525. <dl class="section return"><dt>Returns</dt><dd>Returns the joint speed as Angular Velocity </dd></dl>
  1526. </div>
  1527. </div>
  1528. <a class="anchor" id="a5807a2ccbe0f8d25212853bbc40fbb7b"></a>
  1529. <div class="memitem">
  1530. <div class="memproto">
  1531. <table class="memname">
  1532. <tr>
  1533. <td class="memname">float getRopeJointMaxLength </td>
  1534. <td>(</td>
  1535. <td class="paramtype">jointId&#160;</td>
  1536. <td class="paramname"></td><td>)</td>
  1537. <td></td>
  1538. </tr>
  1539. </table>
  1540. </div><div class="memdoc">
  1541. <p>Gets the maximum rigid length of the rope. </p>
  1542. <dl class="params"><dt>Parameters</dt><dd>
  1543. <table class="params">
  1544. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1545. </table>
  1546. </dd>
  1547. </dl>
  1548. <dl class="section return"><dt>Returns</dt><dd>Returns the maximum rigid length of the rope (-1 indicates error). </dd></dl>
  1549. </div>
  1550. </div>
  1551. <a class="anchor" id="a6a9bdc129cf71a9d3f9513af63dcb444"></a>
  1552. <div class="memitem">
  1553. <div class="memproto">
  1554. <table class="memname">
  1555. <tr>
  1556. <td class="memname">string getSceneObjectList </td>
  1557. <td>(</td>
  1558. <td class="paramname"></td><td>)</td>
  1559. <td></td>
  1560. </tr>
  1561. </table>
  1562. </div><div class="memdoc">
  1563. <p>Gets the <a class="el" href="classScene.html">Scene</a> Object-List. </p>
  1564. <dl class="section return"><dt>Returns</dt><dd>Returns a string with a list of object IDs </dd></dl>
  1565. </div>
  1566. </div>
  1567. <a class="anchor" id="a6003c8b51796ecb4a038bbb8243e750e"></a>
  1568. <div class="memitem">
  1569. <div class="memproto">
  1570. <table class="memname">
  1571. <tr>
  1572. <td class="memname">bool getScenePause </td>
  1573. <td>(</td>
  1574. <td class="paramname"></td><td>)</td>
  1575. <td></td>
  1576. </tr>
  1577. </table>
  1578. </div><div class="memdoc">
  1579. <p>Gets scene pause status. </p>
  1580. <dl class="section return"><dt>Returns</dt><dd>Returns a boolean value. True if pause status, false otherwise. </dd></dl>
  1581. </div>
  1582. </div>
  1583. <a class="anchor" id="aa1ddf9eb34f0eb75e3f3ecb74cef8906"></a>
  1584. <div class="memitem">
  1585. <div class="memproto">
  1586. <table class="memname">
  1587. <tr>
  1588. <td class="memname">float getSceneTime </td>
  1589. <td>(</td>
  1590. <td class="paramname"></td><td>)</td>
  1591. <td></td>
  1592. </tr>
  1593. </table>
  1594. </div><div class="memdoc">
  1595. <p>Gets the <a class="el" href="classScene.html">Scene</a> Time. </p>
  1596. <dl class="section return"><dt>Returns</dt><dd>Returns the time as a floating point number </dd></dl>
  1597. </div>
  1598. </div>
  1599. <a class="anchor" id="a36ff8cc35a2347a77971bb127670e5be"></a>
  1600. <div class="memitem">
  1601. <div class="memproto">
  1602. <table class="memname">
  1603. <tr>
  1604. <td class="memname">float getTargetJointDampingRatio </td>
  1605. <td>(</td>
  1606. <td class="paramtype">jointId&#160;</td>
  1607. <td class="paramname"></td><td>)</td>
  1608. <td></td>
  1609. </tr>
  1610. </table>
  1611. </div><div class="memdoc">
  1612. <p>Sets the damping ratio. </p>
  1613. <dl class="params"><dt>Parameters</dt><dd>
  1614. <table class="params">
  1615. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1616. </table>
  1617. </dd>
  1618. </dl>
  1619. <dl class="section return"><dt>Returns</dt><dd>Returns the damping ratio (-1 indicates error). </dd></dl>
  1620. </div>
  1621. </div>
  1622. <a class="anchor" id="a8c7d2fd7eee75777833d488556051a68"></a>
  1623. <div class="memitem">
  1624. <div class="memproto">
  1625. <table class="memname">
  1626. <tr>
  1627. <td class="memname">float getTargetJointFrequency </td>
  1628. <td>(</td>
  1629. <td class="paramtype">jointId&#160;</td>
  1630. <td class="paramname"></td><td>)</td>
  1631. <td></td>
  1632. </tr>
  1633. </table>
  1634. </div><div class="memdoc">
  1635. <p>Gets the mass-spring-damper frequency in Hertz. </p>
  1636. <dl class="params"><dt>Parameters</dt><dd>
  1637. <table class="params">
  1638. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1639. </table>
  1640. </dd>
  1641. </dl>
  1642. <dl class="section return"><dt>Returns</dt><dd>Returns the mass-spring-damper frequency in Hertz (-1 indicates error). </dd></dl>
  1643. </div>
  1644. </div>
  1645. <a class="anchor" id="a770cef4b06835f7096d362053733fd6f"></a>
  1646. <div class="memitem">
  1647. <div class="memproto">
  1648. <table class="memname">
  1649. <tr>
  1650. <td class="memname">string getTargetJointTarget </td>
  1651. <td>(</td>
  1652. <td class="paramtype">jointId&#160;</td>
  1653. <td class="paramname"></td><td>)</td>
  1654. <td></td>
  1655. </tr>
  1656. </table>
  1657. </div><div class="memdoc">
  1658. <p>Gets the target world point for the scene object. </p>
  1659. <dl class="params"><dt>Parameters</dt><dd>
  1660. <table class="params">
  1661. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1662. </table>
  1663. </dd>
  1664. </dl>
  1665. <dl class="section return"><dt>Returns</dt><dd>Returns the target world point for the scene object (always 0,0 if error). </dd></dl>
  1666. </div>
  1667. </div>
  1668. <a class="anchor" id="a67d48f6bd47dcbe3ae00541d00aed40c"></a>
  1669. <div class="memitem">
  1670. <div class="memproto">
  1671. <table class="memname">
  1672. <tr>
  1673. <td class="memname">int getVelocityIterations </td>
  1674. <td>(</td>
  1675. <td class="paramname"></td><td>)</td>
  1676. <td></td>
  1677. </tr>
  1678. </table>
  1679. </div><div class="memdoc">
  1680. <p>Gets the number of velocity iterations the physics solver uses. (</p>
  1681. <dl class="section return"><dt>Returns</dt><dd>The number of velocity iterations the physics solver uses. </dd></dl>
  1682. </div>
  1683. </div>
  1684. <a class="anchor" id="adb6452c02f0485018d91751d40440a37"></a>
  1685. <div class="memitem">
  1686. <div class="memproto">
  1687. <table class="memname">
  1688. <tr>
  1689. <td class="memname">float getWeldJointDampingRatio </td>
  1690. <td>(</td>
  1691. <td class="paramtype">jointId&#160;</td>
  1692. <td class="paramname"></td><td>)</td>
  1693. <td></td>
  1694. </tr>
  1695. </table>
  1696. </div><div class="memdoc">
  1697. <p>Gets the damping ratio. </p>
  1698. <dl class="params"><dt>Parameters</dt><dd>
  1699. <table class="params">
  1700. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1701. </table>
  1702. </dd>
  1703. </dl>
  1704. <dl class="section return"><dt>Returns</dt><dd>Returns the damping ratio (-1 indicates error). </dd></dl>
  1705. </div>
  1706. </div>
  1707. <a class="anchor" id="a9aca95a8eabdd472b9666002ba59f683"></a>
  1708. <div class="memitem">
  1709. <div class="memproto">
  1710. <table class="memname">
  1711. <tr>
  1712. <td class="memname">float getWeldJointFrequency </td>
  1713. <td>(</td>
  1714. <td class="paramtype">jointId&#160;</td>
  1715. <td class="paramname"></td><td>)</td>
  1716. <td></td>
  1717. </tr>
  1718. </table>
  1719. </div><div class="memdoc">
  1720. <p>Gets the mass-spring-damper frequency in Hertz. </p>
  1721. <dl class="params"><dt>Parameters</dt><dd>
  1722. <table class="params">
  1723. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1724. </table>
  1725. </dd>
  1726. </dl>
  1727. <dl class="section return"><dt>Returns</dt><dd>Returns the mass-spring-damper frequency in Hertz (-1 indicates error). </dd></dl>
  1728. </div>
  1729. </div>
  1730. <a class="anchor" id="aba086b3eb60192e17c37a86f0edd9b19"></a>
  1731. <div class="memitem">
  1732. <div class="memproto">
  1733. <table class="memname">
  1734. <tr>
  1735. <td class="memname">float getWheelJointDampingRatio </td>
  1736. <td>(</td>
  1737. <td class="paramtype">jointId&#160;</td>
  1738. <td class="paramname"></td><td>)</td>
  1739. <td></td>
  1740. </tr>
  1741. </table>
  1742. </div><div class="memdoc">
  1743. <p>Gets the damping ratio. </p>
  1744. <dl class="params"><dt>Parameters</dt><dd>
  1745. <table class="params">
  1746. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1747. </table>
  1748. </dd>
  1749. </dl>
  1750. <dl class="section return"><dt>Returns</dt><dd>Returns the damping ratio (-1 indicates error). </dd></dl>
  1751. </div>
  1752. </div>
  1753. <a class="anchor" id="a2a689c472ee1a87865d1599a9607b1d8"></a>
  1754. <div class="memitem">
  1755. <div class="memproto">
  1756. <table class="memname">
  1757. <tr>
  1758. <td class="memname">float getWheelJointFrequency </td>
  1759. <td>(</td>
  1760. <td class="paramtype">jointId&#160;</td>
  1761. <td class="paramname"></td><td>)</td>
  1762. <td></td>
  1763. </tr>
  1764. </table>
  1765. </div><div class="memdoc">
  1766. <p>Gets the mass-spring-damper frequency in Hertz. </p>
  1767. <dl class="params"><dt>Parameters</dt><dd>
  1768. <table class="params">
  1769. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1770. </table>
  1771. </dd>
  1772. </dl>
  1773. <dl class="section return"><dt>Returns</dt><dd>Returns the mass-spring-damper frequency in Hertz (-1 indicates error). </dd></dl>
  1774. </div>
  1775. </div>
  1776. <a class="anchor" id="a3e7e062826d405182cbf9e3e2ef79ba8"></a>
  1777. <div class="memitem">
  1778. <div class="memproto">
  1779. <table class="memname">
  1780. <tr>
  1781. <td class="memname">string getWheelJointMotor </td>
  1782. <td>(</td>
  1783. <td class="paramtype">jointId&#160;</td>
  1784. <td class="paramname"></td><td>)</td>
  1785. <td></td>
  1786. </tr>
  1787. </table>
  1788. </div><div class="memdoc">
  1789. <p>Gets whether the joint has a motor or not and the motor settings. </p>
  1790. <dl class="params"><dt>Parameters</dt><dd>
  1791. <table class="params">
  1792. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  1793. </table>
  1794. </dd>
  1795. </dl>
  1796. <dl class="section return"><dt>Returns</dt><dd>Returns whether the joint has a motor or not and the motor settings (empty string indicates error). </dd></dl>
  1797. </div>
  1798. </div>
  1799. <a class="anchor" id="a9192095b4b9e12a3e569568dca519d20"></a>
  1800. <div class="memitem">
  1801. <div class="memproto">
  1802. <table class="memname">
  1803. <tr>
  1804. <td class="memname">bool isJoint </td>
  1805. <td>(</td>
  1806. <td class="paramtype">int&#160;</td>
  1807. <td class="paramname"><em>jointId</em></td><td>)</td>
  1808. <td></td>
  1809. </tr>
  1810. </table>
  1811. </div><div class="memdoc">
  1812. <p>Gets whether the joint Id is valid or not. </p>
  1813. <dl class="params"><dt>Parameters</dt><dd>
  1814. <table class="params">
  1815. <tr><td class="paramname">jointId</td><td>The Id of the joint. </td></tr>
  1816. </table>
  1817. </dd>
  1818. </dl>
  1819. <dl class="section return"><dt>Returns</dt><dd>whether the joint Id is valid or not. </dd></dl>
  1820. </div>
  1821. </div>
  1822. <a class="anchor" id="a8d3ee1c7548c12282ec9cacec8842bea"></a>
  1823. <div class="memitem">
  1824. <div class="memproto">
  1825. <table class="memname">
  1826. <tr>
  1827. <td class="memname">void mergeScene </td>
  1828. <td>(</td>
  1829. <td class="paramtype">scene&#160;</td>
  1830. <td class="paramname"></td><td>)</td>
  1831. <td></td>
  1832. </tr>
  1833. </table>
  1834. </div><div class="memdoc">
  1835. <p>Merges the specified scene into this scene by cloning the scenes contents. </p>
  1836. </div>
  1837. </div>
  1838. <a class="anchor" id="a9c9ca45ceaac1e936708b12700d38dc8"></a>
  1839. <div class="memitem">
  1840. <div class="memproto">
  1841. <table class="memname">
  1842. <tr>
  1843. <td class="memname">string pickArea </td>
  1844. <td>(</td>
  1845. <td class="paramtype">startx/&#160;</td>
  1846. <td class="paramname"><em>y</em>, </td>
  1847. </tr>
  1848. <tr>
  1849. <td class="paramkey"></td>
  1850. <td></td>
  1851. <td class="paramtype">endx/&#160;</td>
  1852. <td class="paramname"><em>y</em>&#160;</td>
  1853. </tr>
  1854. <tr>
  1855. <td></td>
  1856. <td>)</td>
  1857. <td></td><td></td>
  1858. </tr>
  1859. </table>
  1860. </div><div class="memdoc">
  1861. <p>Picks objects intersecting the specified area with optional group/layer masks. </p>
  1862. <dl class="params"><dt>Parameters</dt><dd>
  1863. <table class="params">
  1864. <tr><td class="paramname">startx/y</td><td>The coordinates of the start point as either ( y\ or (x,y) </td></tr>
  1865. <tr><td class="paramname">endx/y</td><td>The coordinates of the end point as either ( y\ or (x,y) </td></tr>
  1866. <tr><td class="paramname">sceneGroupMask</td><td>Optional scene group mask. (-1) or empty string selects all groups. </td></tr>
  1867. <tr><td class="paramname">sceneLayerMask</td><td>Optional scene layer mask. (-1) or empty string selects all layers. </td></tr>
  1868. <tr><td class="paramname">pickMode</td><td>Optional mode 'any', 'aabb', 'oobb' or 'collision' (default is 'oobb'). </td></tr>
  1869. </table>
  1870. </dd>
  1871. </dl>
  1872. <dl class="section return"><dt>Returns</dt><dd>Returns list of object IDs. </dd></dl>
  1873. </div>
  1874. </div>
  1875. <a class="anchor" id="a4bc9db69310bdd5401973cdaa89b7e96"></a>
  1876. <div class="memitem">
  1877. <div class="memproto">
  1878. <table class="memname">
  1879. <tr>
  1880. <td class="memname">string pickCircle </td>
  1881. <td>(</td>
  1882. <td class="paramtype">x/&#160;</td>
  1883. <td class="paramname"><em>y</em>, </td>
  1884. </tr>
  1885. <tr>
  1886. <td class="paramkey"></td>
  1887. <td></td>
  1888. <td class="paramtype">radius&#160;</td>
  1889. <td class="paramname">&#160;</td>
  1890. </tr>
  1891. <tr>
  1892. <td></td>
  1893. <td>)</td>
  1894. <td></td><td></td>
  1895. </tr>
  1896. </table>
  1897. </div><div class="memdoc">
  1898. <p>Picks objects intersecting the specified circle with optional group/layer masks. </p>
  1899. <dl class="params"><dt>Parameters</dt><dd>
  1900. <table class="params">
  1901. <tr><td class="paramname">x/y</td><td>The coordinate of the point as either ( y\ or (x,y) </td></tr>
  1902. <tr><td class="paramname">radius</td><td>The radius of the circle. </td></tr>
  1903. <tr><td class="paramname">sceneGroupMask</td><td>Optional scene group mask. (-1) or empty string selects all groups. </td></tr>
  1904. <tr><td class="paramname">sceneLayerMask</td><td>Optional scene layer mask. (-1) or empty string selects all layers. </td></tr>
  1905. <tr><td class="paramname">pickMode</td><td>Optional mode 'any', 'aabb', 'oobb' or 'collision' (default is 'ooabb'). </td></tr>
  1906. </table>
  1907. </dd>
  1908. </dl>
  1909. <dl class="section return"><dt>Returns</dt><dd>Returns list of object IDs. </dd></dl>
  1910. </div>
  1911. </div>
  1912. <a class="anchor" id="a384e6f02b902273dae9394f9e39e5f06"></a>
  1913. <div class="memitem">
  1914. <div class="memproto">
  1915. <table class="memname">
  1916. <tr>
  1917. <td class="memname">string pickPoint </td>
  1918. <td>(</td>
  1919. <td class="paramtype">x/&#160;</td>
  1920. <td class="paramname"><em>y</em></td><td>)</td>
  1921. <td></td>
  1922. </tr>
  1923. </table>
  1924. </div><div class="memdoc">
  1925. <p>Picks objects intersecting the specified point with optional group/layer masks. </p>
  1926. <dl class="params"><dt>Parameters</dt><dd>
  1927. <table class="params">
  1928. <tr><td class="paramname">x/y</td><td>The coordinate of the point as either ( y\ or (x,y) </td></tr>
  1929. <tr><td class="paramname">sceneGroupMask</td><td>Optional scene group mask. (-1) or empty string selects all groups. </td></tr>
  1930. <tr><td class="paramname">sceneLayerMask</td><td>Optional scene layer mask. (-1) or empty string selects all layers. </td></tr>
  1931. <tr><td class="paramname">pickMode</td><td>Optional mode 'any', 'aabb', 'oobb' or 'collision' (default is 'ooabb'). </td></tr>
  1932. </table>
  1933. </dd>
  1934. </dl>
  1935. <dl class="section return"><dt>Returns</dt><dd>Returns list of object IDs. </dd></dl>
  1936. </div>
  1937. </div>
  1938. <a class="anchor" id="ae89cd197a4a6cf10ee00968c2cde1214"></a>
  1939. <div class="memitem">
  1940. <div class="memproto">
  1941. <table class="memname">
  1942. <tr>
  1943. <td class="memname">string pickRay </td>
  1944. <td>(</td>
  1945. <td class="paramtype">startx/&#160;</td>
  1946. <td class="paramname"><em>y</em>, </td>
  1947. </tr>
  1948. <tr>
  1949. <td class="paramkey"></td>
  1950. <td></td>
  1951. <td class="paramtype">endx/&#160;</td>
  1952. <td class="paramname"><em>y</em>&#160;</td>
  1953. </tr>
  1954. <tr>
  1955. <td></td>
  1956. <td>)</td>
  1957. <td></td><td></td>
  1958. </tr>
  1959. </table>
  1960. </div><div class="memdoc">
  1961. <p>Picks objects intersecting the specified ray with optional group/layer masks. </p>
  1962. <dl class="params"><dt>Parameters</dt><dd>
  1963. <table class="params">
  1964. <tr><td class="paramname">startx/y</td><td>The coordinates of the start point as either ( y\ or (x,y) </td></tr>
  1965. <tr><td class="paramname">endx/y</td><td>The coordinates of the end point as either ( y\ or (x,y) </td></tr>
  1966. <tr><td class="paramname">sceneGroupMask</td><td>Optional scene group mask. (-1) or empty string selects all groups. </td></tr>
  1967. <tr><td class="paramname">sceneLayerMask</td><td>Optional scene layer mask. (-1) or empty string selects all layers. </td></tr>
  1968. <tr><td class="paramname">pickMode</td><td>Optional mode 'any', 'aabb', 'oobb' or 'collision' (default is 'oobb'). </td></tr>
  1969. </table>
  1970. </dd>
  1971. </dl>
  1972. <dl class="section return"><dt>Returns</dt><dd>Returns list of object IDs. </dd></dl>
  1973. </div>
  1974. </div>
  1975. <a class="anchor" id="ade381f73f43e3e9b19fbd9ae7fd605e0"></a>
  1976. <div class="memitem">
  1977. <div class="memproto">
  1978. <table class="memname">
  1979. <tr>
  1980. <td class="memname">string pickRayCollision </td>
  1981. <td>(</td>
  1982. <td class="paramtype">startx/&#160;</td>
  1983. <td class="paramname"><em>y</em>, </td>
  1984. </tr>
  1985. <tr>
  1986. <td class="paramkey"></td>
  1987. <td></td>
  1988. <td class="paramtype">endx/&#160;</td>
  1989. <td class="paramname"><em>y</em>&#160;</td>
  1990. </tr>
  1991. <tr>
  1992. <td></td>
  1993. <td>)</td>
  1994. <td></td><td></td>
  1995. </tr>
  1996. </table>
  1997. </div><div class="memdoc">
  1998. <p>Picks objects with collision shapes intersecting the specified ray with optional group/layer masks. Unlike other pick methods, this returns the complete detail for each object encountered, returning the collision point, normal and fraction of the ray intersection. </p>
  1999. <dl class="params"><dt>Parameters</dt><dd>
  2000. <table class="params">
  2001. <tr><td class="paramname">startx/y</td><td>The coordinates of the start point as either ( y\ or (x,y) </td></tr>
  2002. <tr><td class="paramname">endx/y</td><td>The coordinates of the end point as either ( y\ or (x,y) </td></tr>
  2003. <tr><td class="paramname">sceneGroupMask</td><td>Optional scene group mask. (-1) or empty string selects all groups. </td></tr>
  2004. <tr><td class="paramname">sceneLayerMask</td><td>Optional scene layer mask. (-1) or empty string selects all layers. </td></tr>
  2005. </table>
  2006. </dd>
  2007. </dl>
  2008. <dl class="section return"><dt>Returns</dt><dd>Returns a list of objects in blocks of detail items where each block represents a single object and its collision detail in the format: &lt;ObjectId pointx="" pointy="" normalx="" normaly="" rayfraction="" shapeindex&gt;=""&gt; &lt;ObjectId pointx="" pointy="" normalx="" normaly="" rayfraction="" shapeindex&gt;=""&gt; &lt;ObjectId pointx="" pointy="" normalx="" normaly="" rayfraction="" shapeindex&gt;=""&gt; etc. </dd></dl>
  2009. </div>
  2010. </div>
  2011. <a class="anchor" id="a0d3fbbe5baf15d42867874fd9fd29775"></a>
  2012. <div class="memitem">
  2013. <div class="memproto">
  2014. <table class="memname">
  2015. <tr>
  2016. <td class="memname">void remove </td>
  2017. <td>(</td>
  2018. <td class="paramtype">sceneObject&#160;</td>
  2019. <td class="paramname"></td><td>)</td>
  2020. <td></td>
  2021. </tr>
  2022. </table>
  2023. </div><div class="memdoc">
  2024. <p>Remove the <a class="el" href="classSceneObject.html">SceneObject</a> from the scene. </p>
  2025. <dl class="params"><dt>Parameters</dt><dd>
  2026. <table class="params">
  2027. <tr><td class="paramname">sceneObject</td><td>The <a class="el" href="classSceneObject.html">SceneObject</a> to remove from the scene. </td></tr>
  2028. </table>
  2029. </dd>
  2030. </dl>
  2031. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  2032. </div>
  2033. </div>
  2034. <a class="anchor" id="aba6d201b1086678015dbc81180ce2828"></a>
  2035. <div class="memitem">
  2036. <div class="memproto">
  2037. <table class="memname">
  2038. <tr>
  2039. <td class="memname">void removeAssetPreload </td>
  2040. <td>(</td>
  2041. <td class="paramtype">assetId&#160;</td>
  2042. <td class="paramname"></td><td>)</td>
  2043. <td></td>
  2044. </tr>
  2045. </table>
  2046. </div><div class="memdoc">
  2047. <p>Removes the asset Id from being preloaded when the scene is loaded. The asset may be unloaded immediately by this operation if it has no other references. </p>
  2048. <dl class="params"><dt>Parameters</dt><dd>
  2049. <table class="params">
  2050. <tr><td class="paramname">assetId</td><td>The asset Id to be removed. </td></tr>
  2051. </table>
  2052. </dd>
  2053. </dl>
  2054. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  2055. </div>
  2056. </div>
  2057. <a class="anchor" id="a1336006ef13d6ad7ad4754d07d241b3a"></a>
  2058. <div class="memitem">
  2059. <div class="memproto">
  2060. <table class="memname">
  2061. <tr>
  2062. <td class="memname">void resetDebugStats </td>
  2063. <td>(</td>
  2064. <td class="paramname"></td><td>)</td>
  2065. <td></td>
  2066. </tr>
  2067. </table>
  2068. </div><div class="memdoc">
  2069. <p>Resets the debug statistics. </p>
  2070. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  2071. </div>
  2072. </div>
  2073. <a class="anchor" id="a7d74530a31755ff6a86ea69349a3eacc"></a>
  2074. <div class="memitem">
  2075. <div class="memproto">
  2076. <table class="memname">
  2077. <tr>
  2078. <td class="memname">void setBatchingEnabled </td>
  2079. <td>(</td>
  2080. <td class="paramtype">bool&#160;</td>
  2081. <td class="paramname"><em>enabled</em></td><td>)</td>
  2082. <td></td>
  2083. </tr>
  2084. </table>
  2085. </div><div class="memdoc">
  2086. <p>Sets whether render batching is enabled or not. </p>
  2087. <dl class="params"><dt>Parameters</dt><dd>
  2088. <table class="params">
  2089. <tr><td class="paramname">enabled</td><td>Whether render batching is enabled or not. return No return value. </td></tr>
  2090. </table>
  2091. </dd>
  2092. </dl>
  2093. </div>
  2094. </div>
  2095. <a class="anchor" id="a16f05fd89378a5f7149e46dfd9a759d9"></a>
  2096. <div class="memitem">
  2097. <div class="memproto">
  2098. <table class="memname">
  2099. <tr>
  2100. <td class="memname">void setDebugOff </td>
  2101. <td>(</td>
  2102. <td class="paramtype">debugOptions&#160;</td>
  2103. <td class="paramname"></td><td>)</td>
  2104. <td></td>
  2105. </tr>
  2106. </table>
  2107. </div><div class="memdoc">
  2108. <p>Sets Debug options(s) off. </p>
  2109. <dl class="params"><dt>Parameters</dt><dd>
  2110. <table class="params">
  2111. <tr><td class="paramname">debugOptions</td><td>Either a list of debug modes to turn off (comma-separated) or a string (space-separated) </td></tr>
  2112. </table>
  2113. </dd>
  2114. </dl>
  2115. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  2116. </div>
  2117. </div>
  2118. <a class="anchor" id="aefa942fdbfda9d4e37139eb36d34789b"></a>
  2119. <div class="memitem">
  2120. <div class="memproto">
  2121. <table class="memname">
  2122. <tr>
  2123. <td class="memname">void setDebugOn </td>
  2124. <td>(</td>
  2125. <td class="paramtype">debugOptions&#160;</td>
  2126. <td class="paramname"></td><td>)</td>
  2127. <td></td>
  2128. </tr>
  2129. </table>
  2130. </div><div class="memdoc">
  2131. <p>Sets Debug option(s) on. </p>
  2132. <dl class="params"><dt>Parameters</dt><dd>
  2133. <table class="params">
  2134. <tr><td class="paramname">debugOptions</td><td>Either a list of debug modes (comma-separated), or a string with the modes (space-separated) </td></tr>
  2135. </table>
  2136. </dd>
  2137. </dl>
  2138. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  2139. </div>
  2140. </div>
  2141. <a class="anchor" id="a086818fd3866e5eb971fd390c7e7eb0e"></a>
  2142. <div class="memitem">
  2143. <div class="memproto">
  2144. <table class="memname">
  2145. <tr>
  2146. <td class="memname">void setDebugSceneObject </td>
  2147. <td>(</td>
  2148. <td class="paramtype">sceneObject&#160;</td>
  2149. <td class="paramname"></td><td>)</td>
  2150. <td></td>
  2151. </tr>
  2152. </table>
  2153. </div><div class="memdoc">
  2154. <p>Sets the scene object to monitor in the debug metrics. </p>
  2155. <dl class="params"><dt>Parameters</dt><dd>
  2156. <table class="params">
  2157. <tr><td class="paramname"><a class="el" href="classSceneObject.html">SceneObject</a></td><td>The scene object to monitor in the debug metrics. </td></tr>
  2158. </table>
  2159. </dd>
  2160. </dl>
  2161. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  2162. </div>
  2163. </div>
  2164. <a class="anchor" id="a992c1b3c3dfc46371920db78efc54658"></a>
  2165. <div class="memitem">
  2166. <div class="memproto">
  2167. <table class="memname">
  2168. <tr>
  2169. <td class="memname">void setDistanceJointDampingRatio </td>
  2170. <td>(</td>
  2171. <td class="paramtype">jointId&#160;</td>
  2172. <td class="paramname">, </td>
  2173. </tr>
  2174. <tr>
  2175. <td class="paramkey"></td>
  2176. <td></td>
  2177. <td class="paramtype">dampingRatio&#160;</td>
  2178. <td class="paramname">&#160;</td>
  2179. </tr>
  2180. <tr>
  2181. <td></td>
  2182. <td>)</td>
  2183. <td></td><td></td>
  2184. </tr>
  2185. </table>
  2186. </div><div class="memdoc">
  2187. <p>Sets the damping ratio. </p>
  2188. <dl class="params"><dt>Parameters</dt><dd>
  2189. <table class="params">
  2190. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2191. <tr><td class="paramname">dampingRatio</td><td>The damping ratio. 0 = no damping, 1 = critical damping. </td></tr>
  2192. </table>
  2193. </dd>
  2194. </dl>
  2195. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2196. </div>
  2197. </div>
  2198. <a class="anchor" id="a2d8107cc04edc88ea6bf81c593f25edd"></a>
  2199. <div class="memitem">
  2200. <div class="memproto">
  2201. <table class="memname">
  2202. <tr>
  2203. <td class="memname">void setDistanceJointFrequency </td>
  2204. <td>(</td>
  2205. <td class="paramtype">jointId&#160;</td>
  2206. <td class="paramname">, </td>
  2207. </tr>
  2208. <tr>
  2209. <td class="paramkey"></td>
  2210. <td></td>
  2211. <td class="paramtype">frequency&#160;</td>
  2212. <td class="paramname">&#160;</td>
  2213. </tr>
  2214. <tr>
  2215. <td></td>
  2216. <td>)</td>
  2217. <td></td><td></td>
  2218. </tr>
  2219. </table>
  2220. </div><div class="memdoc">
  2221. <p>Sets the mass-spring-damper frequency in Hertz. </p>
  2222. <dl class="params"><dt>Parameters</dt><dd>
  2223. <table class="params">
  2224. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2225. <tr><td class="paramname">frequency</td><td>The mass-spring-damper frequency in Hertz. A value of 0 disables softness. </td></tr>
  2226. </table>
  2227. </dd>
  2228. </dl>
  2229. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2230. </div>
  2231. </div>
  2232. <a class="anchor" id="af5134c22884624a61c6d6834bffcde77"></a>
  2233. <div class="memitem">
  2234. <div class="memproto">
  2235. <table class="memname">
  2236. <tr>
  2237. <td class="memname">void setDistanceJointLength </td>
  2238. <td>(</td>
  2239. <td class="paramtype">jointId&#160;</td>
  2240. <td class="paramname">, </td>
  2241. </tr>
  2242. <tr>
  2243. <td class="paramkey"></td>
  2244. <td></td>
  2245. <td class="paramtype">length&#160;</td>
  2246. <td class="paramname">&#160;</td>
  2247. </tr>
  2248. <tr>
  2249. <td></td>
  2250. <td>)</td>
  2251. <td></td><td></td>
  2252. </tr>
  2253. </table>
  2254. </div><div class="memdoc">
  2255. <p>Sets the distance the joint should maintain between scene objects. </p>
  2256. <dl class="params"><dt>Parameters</dt><dd>
  2257. <table class="params">
  2258. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2259. <tr><td class="paramname">length</td><td>The length the joint should maintain between scene objects. </td></tr>
  2260. </table>
  2261. </dd>
  2262. </dl>
  2263. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2264. </div>
  2265. </div>
  2266. <a class="anchor" id="a877ded105f3cce92354a13c2fc05798e"></a>
  2267. <div class="memitem">
  2268. <div class="memproto">
  2269. <table class="memname">
  2270. <tr>
  2271. <td class="memname">void setFrictionJointMaxForce </td>
  2272. <td>(</td>
  2273. <td class="paramtype">jointId&#160;</td>
  2274. <td class="paramname">, </td>
  2275. </tr>
  2276. <tr>
  2277. <td class="paramkey"></td>
  2278. <td></td>
  2279. <td class="paramtype">maxForce&#160;</td>
  2280. <td class="paramname">&#160;</td>
  2281. </tr>
  2282. <tr>
  2283. <td></td>
  2284. <td>)</td>
  2285. <td></td><td></td>
  2286. </tr>
  2287. </table>
  2288. </div><div class="memdoc">
  2289. <p>Sets the maximum friction force. </p>
  2290. <dl class="params"><dt>Parameters</dt><dd>
  2291. <table class="params">
  2292. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2293. <tr><td class="paramname">maxForce</td><td>The maximum friction force (N). </td></tr>
  2294. </table>
  2295. </dd>
  2296. </dl>
  2297. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2298. </div>
  2299. </div>
  2300. <a class="anchor" id="a6d2366746dd1cea71b96055148cf2a31"></a>
  2301. <div class="memitem">
  2302. <div class="memproto">
  2303. <table class="memname">
  2304. <tr>
  2305. <td class="memname">void setFrictionJointMaxTorque </td>
  2306. <td>(</td>
  2307. <td class="paramtype">jointId&#160;</td>
  2308. <td class="paramname">, </td>
  2309. </tr>
  2310. <tr>
  2311. <td class="paramkey"></td>
  2312. <td></td>
  2313. <td class="paramtype">maxTorque&#160;</td>
  2314. <td class="paramname">&#160;</td>
  2315. </tr>
  2316. <tr>
  2317. <td></td>
  2318. <td>)</td>
  2319. <td></td><td></td>
  2320. </tr>
  2321. </table>
  2322. </div><div class="memdoc">
  2323. <p>Sets the maximum torque force. </p>
  2324. <dl class="params"><dt>Parameters</dt><dd>
  2325. <table class="params">
  2326. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2327. <tr><td class="paramname">maxTorque</td><td>The maximum torque force (N). </td></tr>
  2328. </table>
  2329. </dd>
  2330. </dl>
  2331. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2332. </div>
  2333. </div>
  2334. <a class="anchor" id="a3b48045fe7e6dc73eccd6188dea48746"></a>
  2335. <div class="memitem">
  2336. <div class="memproto">
  2337. <table class="memname">
  2338. <tr>
  2339. <td class="memname">void setGravity </td>
  2340. <td>(</td>
  2341. <td class="paramtype">forceX/&#160;</td>
  2342. <td class="paramname"><em>forceY</em></td><td>)</td>
  2343. <td></td>
  2344. </tr>
  2345. </table>
  2346. </div><div class="memdoc">
  2347. <p>The gravity force to apply to all objects in the scene. </p>
  2348. <dl class="params"><dt>Parameters</dt><dd>
  2349. <table class="params">
  2350. <tr><td class="paramname">forceX/forceY</td><td>The direction and magnitude of the force in each direction. Formatted as either ( forceY\ or (forceX, forceY) </td></tr>
  2351. </table>
  2352. </dd>
  2353. </dl>
  2354. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  2355. </div>
  2356. </div>
  2357. <a class="anchor" id="a7237f10a6dc12d1acce4784bb9a08b17"></a>
  2358. <div class="memitem">
  2359. <div class="memproto">
  2360. <table class="memname">
  2361. <tr>
  2362. <td class="memname">void setIsEditorScene </td>
  2363. <td>(</td>
  2364. <td class="paramname"></td><td>)</td>
  2365. <td></td>
  2366. </tr>
  2367. </table>
  2368. </div><div class="memdoc">
  2369. <p>Sets whether this is an editor scene. </p>
  2370. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  2371. </div>
  2372. </div>
  2373. <a class="anchor" id="ad6afa52bbea778a6a0f81139af2ebd4b"></a>
  2374. <div class="memitem">
  2375. <div class="memproto">
  2376. <table class="memname">
  2377. <tr>
  2378. <td class="memname">void setLayerSortMode </td>
  2379. <td>(</td>
  2380. <td class="paramtype">layer&#160;</td>
  2381. <td class="paramname">, </td>
  2382. </tr>
  2383. <tr>
  2384. <td class="paramkey"></td>
  2385. <td></td>
  2386. <td class="paramtype">sortMode&#160;</td>
  2387. <td class="paramname">&#160;</td>
  2388. </tr>
  2389. <tr>
  2390. <td></td>
  2391. <td>)</td>
  2392. <td></td><td></td>
  2393. </tr>
  2394. </table>
  2395. </div><div class="memdoc">
  2396. <p>Sets the layer to use the specified render sort mode. </p>
  2397. <dl class="params"><dt>Parameters</dt><dd>
  2398. <table class="params">
  2399. <tr><td class="paramname">layer</td><td>The layer to modify. </td></tr>
  2400. <tr><td class="paramname">sortMode</td><td>The sort mode to use on the specified layer. </td></tr>
  2401. </table>
  2402. </dd>
  2403. </dl>
  2404. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  2405. </div>
  2406. </div>
  2407. <a class="anchor" id="a9d7a5a7d5c4bb22202fde5d577609249"></a>
  2408. <div class="memitem">
  2409. <div class="memproto">
  2410. <table class="memname">
  2411. <tr>
  2412. <td class="memname">void setMotorJointAngularOffset </td>
  2413. <td>(</td>
  2414. <td class="paramtype">jointId&#160;</td>
  2415. <td class="paramname">, </td>
  2416. </tr>
  2417. <tr>
  2418. <td class="paramkey"></td>
  2419. <td></td>
  2420. <td class="paramtype">angularOffset&#160;</td>
  2421. <td class="paramname">&#160;</td>
  2422. </tr>
  2423. <tr>
  2424. <td></td>
  2425. <td>)</td>
  2426. <td></td><td></td>
  2427. </tr>
  2428. </table>
  2429. </div><div class="memdoc">
  2430. <p>Sets the angularOffset between the bodies. </p>
  2431. <dl class="params"><dt>Parameters</dt><dd>
  2432. <table class="params">
  2433. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2434. <tr><td class="paramname">angularOffset</td><td>The angularOffset between the bodies. </td></tr>
  2435. </table>
  2436. </dd>
  2437. </dl>
  2438. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2439. </div>
  2440. </div>
  2441. <a class="anchor" id="a09b062dd0d196285f743cdfd69cd2257"></a>
  2442. <div class="memitem">
  2443. <div class="memproto">
  2444. <table class="memname">
  2445. <tr>
  2446. <td class="memname">void setMotorJointLinearOffset </td>
  2447. <td>(</td>
  2448. <td class="paramtype">jointId&#160;</td>
  2449. <td class="paramname">, </td>
  2450. </tr>
  2451. <tr>
  2452. <td class="paramkey"></td>
  2453. <td></td>
  2454. <td class="paramtype">linearOffset X/&#160;</td>
  2455. <td class="paramname"><em>Y</em>&#160;</td>
  2456. </tr>
  2457. <tr>
  2458. <td></td>
  2459. <td>)</td>
  2460. <td></td><td></td>
  2461. </tr>
  2462. </table>
  2463. </div><div class="memdoc">
  2464. <p>Sets the linear offset in sceneObjectA space. </p>
  2465. <dl class="params"><dt>Parameters</dt><dd>
  2466. <table class="params">
  2467. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2468. <tr><td class="paramname">linearOffsetX/Y</td><td>The linear offset in sceneObjectA space. </td></tr>
  2469. </table>
  2470. </dd>
  2471. </dl>
  2472. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2473. </div>
  2474. </div>
  2475. <a class="anchor" id="a3347d79e622d1a521c0653bf7c446b54"></a>
  2476. <div class="memitem">
  2477. <div class="memproto">
  2478. <table class="memname">
  2479. <tr>
  2480. <td class="memname">void setMotorJointMaxForce </td>
  2481. <td>(</td>
  2482. <td class="paramtype">jointId&#160;</td>
  2483. <td class="paramname">, </td>
  2484. </tr>
  2485. <tr>
  2486. <td class="paramkey"></td>
  2487. <td></td>
  2488. <td class="paramtype">maxForce&#160;</td>
  2489. <td class="paramname">&#160;</td>
  2490. </tr>
  2491. <tr>
  2492. <td></td>
  2493. <td>)</td>
  2494. <td></td><td></td>
  2495. </tr>
  2496. </table>
  2497. </div><div class="memdoc">
  2498. <p>Sets the maximum motor force. </p>
  2499. <dl class="params"><dt>Parameters</dt><dd>
  2500. <table class="params">
  2501. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2502. <tr><td class="paramname">maxForce</td><td>The maximum motor force (N). </td></tr>
  2503. </table>
  2504. </dd>
  2505. </dl>
  2506. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2507. </div>
  2508. </div>
  2509. <a class="anchor" id="a1d6e0b81c6dbca9dd54da6c205cfbcf6"></a>
  2510. <div class="memitem">
  2511. <div class="memproto">
  2512. <table class="memname">
  2513. <tr>
  2514. <td class="memname">void setMotorJointMaxTorque </td>
  2515. <td>(</td>
  2516. <td class="paramtype">jointId&#160;</td>
  2517. <td class="paramname">, </td>
  2518. </tr>
  2519. <tr>
  2520. <td class="paramkey"></td>
  2521. <td></td>
  2522. <td class="paramtype">maxTorque&#160;</td>
  2523. <td class="paramname">&#160;</td>
  2524. </tr>
  2525. <tr>
  2526. <td></td>
  2527. <td>)</td>
  2528. <td></td><td></td>
  2529. </tr>
  2530. </table>
  2531. </div><div class="memdoc">
  2532. <p>Sets the maximum motor torque force. </p>
  2533. <dl class="params"><dt>Parameters</dt><dd>
  2534. <table class="params">
  2535. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2536. <tr><td class="paramname">maxTorque</td><td>The maximum motor torque force (N). </td></tr>
  2537. </table>
  2538. </dd>
  2539. </dl>
  2540. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2541. </div>
  2542. </div>
  2543. <a class="anchor" id="aa0db357087ea53514903069dd819e11c"></a>
  2544. <div class="memitem">
  2545. <div class="memproto">
  2546. <table class="memname">
  2547. <tr>
  2548. <td class="memname">void setPositionIterations </td>
  2549. <td>(</td>
  2550. <td class="paramtype">int&#160;</td>
  2551. <td class="paramname"><em>iterations</em></td><td>)</td>
  2552. <td></td>
  2553. </tr>
  2554. </table>
  2555. </div><div class="memdoc">
  2556. <p>Sets the number of position iterations the physics solver uses. </p>
  2557. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  2558. </div>
  2559. </div>
  2560. <a class="anchor" id="a94981849e0d732e0d052fea5e62993e2"></a>
  2561. <div class="memitem">
  2562. <div class="memproto">
  2563. <table class="memname">
  2564. <tr>
  2565. <td class="memname">void setPrismaticJointLimit </td>
  2566. <td>(</td>
  2567. <td class="paramtype">jointId&#160;</td>
  2568. <td class="paramname">, </td>
  2569. </tr>
  2570. <tr>
  2571. <td class="paramkey"></td>
  2572. <td></td>
  2573. <td class="paramtype">enableLimit&#160;</td>
  2574. <td class="paramname">&#160;</td>
  2575. </tr>
  2576. <tr>
  2577. <td></td>
  2578. <td>)</td>
  2579. <td></td><td></td>
  2580. </tr>
  2581. </table>
  2582. </div><div class="memdoc">
  2583. <p>Sets whether the joint has translational limits or not and the limits themselves. </p>
  2584. <dl class="params"><dt>Parameters</dt><dd>
  2585. <table class="params">
  2586. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2587. <tr><td class="paramname">enableLimit</td><td>Whether the joint has angular limits or not. </td></tr>
  2588. <tr><td class="paramname">lowerTranslation</td><td>The lower translation limit. </td></tr>
  2589. <tr><td class="paramname">upperTranslation</td><td>The upper translation limit. </td></tr>
  2590. </table>
  2591. </dd>
  2592. </dl>
  2593. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2594. </div>
  2595. </div>
  2596. <a class="anchor" id="ae8bf404f377c9b889f0c87f9b9d62308"></a>
  2597. <div class="memitem">
  2598. <div class="memproto">
  2599. <table class="memname">
  2600. <tr>
  2601. <td class="memname">void setPrismaticJointMotor </td>
  2602. <td>(</td>
  2603. <td class="paramtype">jointId&#160;</td>
  2604. <td class="paramname">, </td>
  2605. </tr>
  2606. <tr>
  2607. <td class="paramkey"></td>
  2608. <td></td>
  2609. <td class="paramtype">enableMotor&#160;</td>
  2610. <td class="paramname">&#160;</td>
  2611. </tr>
  2612. <tr>
  2613. <td></td>
  2614. <td>)</td>
  2615. <td></td><td></td>
  2616. </tr>
  2617. </table>
  2618. </div><div class="memdoc">
  2619. <p>Sets whether the joint has a motor or not and the motor settings. </p>
  2620. <dl class="params"><dt>Parameters</dt><dd>
  2621. <table class="params">
  2622. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2623. <tr><td class="paramname">enableMotor</td><td>Whether the joint has a motor or not. </td></tr>
  2624. <tr><td class="paramname">motorSpeed</td><td>The motor speed (degrees per/sec). </td></tr>
  2625. <tr><td class="paramname">maxMotorForce</td><td>The maximum motor force used to achieve the specified motor speed (N-m). </td></tr>
  2626. </table>
  2627. </dd>
  2628. </dl>
  2629. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2630. </div>
  2631. </div>
  2632. <a class="anchor" id="a2a1f64b37af64f2dbb0f84d340bc65c9"></a>
  2633. <div class="memitem">
  2634. <div class="memproto">
  2635. <table class="memname">
  2636. <tr>
  2637. <td class="memname">void setRevoluteJointLimit </td>
  2638. <td>(</td>
  2639. <td class="paramtype">jointId&#160;</td>
  2640. <td class="paramname">, </td>
  2641. </tr>
  2642. <tr>
  2643. <td class="paramkey"></td>
  2644. <td></td>
  2645. <td class="paramtype">enableLimit&#160;</td>
  2646. <td class="paramname">&#160;</td>
  2647. </tr>
  2648. <tr>
  2649. <td></td>
  2650. <td>)</td>
  2651. <td></td><td></td>
  2652. </tr>
  2653. </table>
  2654. </div><div class="memdoc">
  2655. <p>Sets whether the joint has angular limits or not and the limits themselves. </p>
  2656. <dl class="params"><dt>Parameters</dt><dd>
  2657. <table class="params">
  2658. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2659. <tr><td class="paramname">enableLimit</td><td>Whether the joint has angular limits or not. </td></tr>
  2660. <tr><td class="paramname">lowerAngle</td><td>The lower angle of the angular limit. </td></tr>
  2661. <tr><td class="paramname">upperAngle</td><td>The upper angle of the angular limit. </td></tr>
  2662. </table>
  2663. </dd>
  2664. </dl>
  2665. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2666. </div>
  2667. </div>
  2668. <a class="anchor" id="ac2b09af1c3660bc2cbdb75cd0d9f6ba1"></a>
  2669. <div class="memitem">
  2670. <div class="memproto">
  2671. <table class="memname">
  2672. <tr>
  2673. <td class="memname">void setRevoluteJointMotor </td>
  2674. <td>(</td>
  2675. <td class="paramtype">jointId&#160;</td>
  2676. <td class="paramname">, </td>
  2677. </tr>
  2678. <tr>
  2679. <td class="paramkey"></td>
  2680. <td></td>
  2681. <td class="paramtype">enableMotor&#160;</td>
  2682. <td class="paramname">&#160;</td>
  2683. </tr>
  2684. <tr>
  2685. <td></td>
  2686. <td>)</td>
  2687. <td></td><td></td>
  2688. </tr>
  2689. </table>
  2690. </div><div class="memdoc">
  2691. <p>Sets whether the joint has a motor or not and the motor settings. </p>
  2692. <dl class="params"><dt>Parameters</dt><dd>
  2693. <table class="params">
  2694. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2695. <tr><td class="paramname">enableMotor</td><td>Whether the joint has a motor or not. </td></tr>
  2696. <tr><td class="paramname">motorSpeed</td><td>The motor speed (degrees per/sec). </td></tr>
  2697. <tr><td class="paramname">maxMotorTorque</td><td>The maximum motor torque used to achieve the specified motor speed (N-m). </td></tr>
  2698. </table>
  2699. </dd>
  2700. </dl>
  2701. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2702. </div>
  2703. </div>
  2704. <a class="anchor" id="a43653956ac81333290f8433084178eec"></a>
  2705. <div class="memitem">
  2706. <div class="memproto">
  2707. <table class="memname">
  2708. <tr>
  2709. <td class="memname">void setRopeJointMaxLength </td>
  2710. <td>(</td>
  2711. <td class="paramtype">jointId&#160;</td>
  2712. <td class="paramname">, </td>
  2713. </tr>
  2714. <tr>
  2715. <td class="paramkey"></td>
  2716. <td></td>
  2717. <td class="paramtype">maxLength&#160;</td>
  2718. <td class="paramname">&#160;</td>
  2719. </tr>
  2720. <tr>
  2721. <td></td>
  2722. <td>)</td>
  2723. <td></td><td></td>
  2724. </tr>
  2725. </table>
  2726. </div><div class="memdoc">
  2727. <p>Sets the maximum rigid length of the rope. </p>
  2728. <dl class="params"><dt>Parameters</dt><dd>
  2729. <table class="params">
  2730. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2731. <tr><td class="paramname">maxLength</td><td>The maximum rigid length of the rope. </td></tr>
  2732. </table>
  2733. </dd>
  2734. </dl>
  2735. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2736. </div>
  2737. </div>
  2738. <a class="anchor" id="ab0c9962ab39eca113ca39ee3ad436e62"></a>
  2739. <div class="memitem">
  2740. <div class="memproto">
  2741. <table class="memname">
  2742. <tr>
  2743. <td class="memname">void setScenePause </td>
  2744. <td>(</td>
  2745. <td class="paramtype">status&#160;</td>
  2746. <td class="paramname"></td><td>)</td>
  2747. <td></td>
  2748. </tr>
  2749. </table>
  2750. </div><div class="memdoc">
  2751. <p>Sets scene pause status. </p>
  2752. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  2753. </div>
  2754. </div>
  2755. <a class="anchor" id="a372cb58985e2ad0cdb7f6eb02c382d53"></a>
  2756. <div class="memitem">
  2757. <div class="memproto">
  2758. <table class="memname">
  2759. <tr>
  2760. <td class="memname">void setTargetJointDampingRatio </td>
  2761. <td>(</td>
  2762. <td class="paramtype">jointId&#160;</td>
  2763. <td class="paramname">, </td>
  2764. </tr>
  2765. <tr>
  2766. <td class="paramkey"></td>
  2767. <td></td>
  2768. <td class="paramtype">dampingRatio&#160;</td>
  2769. <td class="paramname">&#160;</td>
  2770. </tr>
  2771. <tr>
  2772. <td></td>
  2773. <td>)</td>
  2774. <td></td><td></td>
  2775. </tr>
  2776. </table>
  2777. </div><div class="memdoc">
  2778. <p>Sets the damping ratio. </p>
  2779. <dl class="params"><dt>Parameters</dt><dd>
  2780. <table class="params">
  2781. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2782. <tr><td class="paramname">dampingRatio</td><td>The damping ratio. 0 = no damping, 1 = critical damping. </td></tr>
  2783. </table>
  2784. </dd>
  2785. </dl>
  2786. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2787. </div>
  2788. </div>
  2789. <a class="anchor" id="a721201aba052c42592b7068e73d9c92f"></a>
  2790. <div class="memitem">
  2791. <div class="memproto">
  2792. <table class="memname">
  2793. <tr>
  2794. <td class="memname">void setTargetJointFrequency </td>
  2795. <td>(</td>
  2796. <td class="paramtype">jointId&#160;</td>
  2797. <td class="paramname">, </td>
  2798. </tr>
  2799. <tr>
  2800. <td class="paramkey"></td>
  2801. <td></td>
  2802. <td class="paramtype">frequency&#160;</td>
  2803. <td class="paramname">&#160;</td>
  2804. </tr>
  2805. <tr>
  2806. <td></td>
  2807. <td>)</td>
  2808. <td></td><td></td>
  2809. </tr>
  2810. </table>
  2811. </div><div class="memdoc">
  2812. <p>Sets the mass-spring-damper frequency in Hertz. </p>
  2813. <dl class="params"><dt>Parameters</dt><dd>
  2814. <table class="params">
  2815. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2816. <tr><td class="paramname">frequency</td><td>The mass-spring-damper frequency in Hertz. A value of 0 disables softness. </td></tr>
  2817. </table>
  2818. </dd>
  2819. </dl>
  2820. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2821. </div>
  2822. </div>
  2823. <a class="anchor" id="a4826e4c5fe1a3fcc838d99b65b862f97"></a>
  2824. <div class="memitem">
  2825. <div class="memproto">
  2826. <table class="memname">
  2827. <tr>
  2828. <td class="memname">void setTargetJointTarget </td>
  2829. <td>(</td>
  2830. <td class="paramtype">jointId&#160;</td>
  2831. <td class="paramname">, </td>
  2832. </tr>
  2833. <tr>
  2834. <td class="paramkey"></td>
  2835. <td></td>
  2836. <td class="paramtype">worldTarget X/&#160;</td>
  2837. <td class="paramname"><em>Y</em>&#160;</td>
  2838. </tr>
  2839. <tr>
  2840. <td></td>
  2841. <td>)</td>
  2842. <td></td><td></td>
  2843. </tr>
  2844. </table>
  2845. </div><div class="memdoc">
  2846. <p>Sets the target world point for the scene object. </p>
  2847. <dl class="params"><dt>Parameters</dt><dd>
  2848. <table class="params">
  2849. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2850. <tr><td class="paramname">worldTarget</td><td>The target world point to move the scene object to. </td></tr>
  2851. </table>
  2852. </dd>
  2853. </dl>
  2854. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2855. </div>
  2856. </div>
  2857. <a class="anchor" id="aac7a9c43e5a69de84a17e3ac6b692d2f"></a>
  2858. <div class="memitem">
  2859. <div class="memproto">
  2860. <table class="memname">
  2861. <tr>
  2862. <td class="memname">void setVelocityIterations </td>
  2863. <td>(</td>
  2864. <td class="paramtype">int&#160;</td>
  2865. <td class="paramname"><em>iterations</em></td><td>)</td>
  2866. <td></td>
  2867. </tr>
  2868. </table>
  2869. </div><div class="memdoc">
  2870. <p>Sets the number of velocity iterations the physics solver uses. </p>
  2871. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  2872. </div>
  2873. </div>
  2874. <a class="anchor" id="a073a64dc1793fcbf8414b6dd47a137b0"></a>
  2875. <div class="memitem">
  2876. <div class="memproto">
  2877. <table class="memname">
  2878. <tr>
  2879. <td class="memname">void setWeldJointDampingRatio </td>
  2880. <td>(</td>
  2881. <td class="paramtype">jointId&#160;</td>
  2882. <td class="paramname">, </td>
  2883. </tr>
  2884. <tr>
  2885. <td class="paramkey"></td>
  2886. <td></td>
  2887. <td class="paramtype">dampingRatio&#160;</td>
  2888. <td class="paramname">&#160;</td>
  2889. </tr>
  2890. <tr>
  2891. <td></td>
  2892. <td>)</td>
  2893. <td></td><td></td>
  2894. </tr>
  2895. </table>
  2896. </div><div class="memdoc">
  2897. <p>Sets the damping ratio. </p>
  2898. <dl class="params"><dt>Parameters</dt><dd>
  2899. <table class="params">
  2900. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2901. <tr><td class="paramname">dampingRatio</td><td>The damping ratio. 0 = no damping, 1 = critical damping. </td></tr>
  2902. </table>
  2903. </dd>
  2904. </dl>
  2905. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2906. </div>
  2907. </div>
  2908. <a class="anchor" id="a87bfdf31f5b370895f00418d7fdd144e"></a>
  2909. <div class="memitem">
  2910. <div class="memproto">
  2911. <table class="memname">
  2912. <tr>
  2913. <td class="memname">void setWeldJointFrequency </td>
  2914. <td>(</td>
  2915. <td class="paramtype">jointId&#160;</td>
  2916. <td class="paramname">, </td>
  2917. </tr>
  2918. <tr>
  2919. <td class="paramkey"></td>
  2920. <td></td>
  2921. <td class="paramtype">frequency&#160;</td>
  2922. <td class="paramname">&#160;</td>
  2923. </tr>
  2924. <tr>
  2925. <td></td>
  2926. <td>)</td>
  2927. <td></td><td></td>
  2928. </tr>
  2929. </table>
  2930. </div><div class="memdoc">
  2931. <p>Sets the mass-spring-damper frequency in Hertz. </p>
  2932. <dl class="params"><dt>Parameters</dt><dd>
  2933. <table class="params">
  2934. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2935. <tr><td class="paramname">frequency</td><td>The mass-spring-damper frequency in Hertz. A value of 0 disables softness. </td></tr>
  2936. </table>
  2937. </dd>
  2938. </dl>
  2939. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2940. </div>
  2941. </div>
  2942. <a class="anchor" id="a386b7517ea74fc2b1579d1fe06e13f04"></a>
  2943. <div class="memitem">
  2944. <div class="memproto">
  2945. <table class="memname">
  2946. <tr>
  2947. <td class="memname">void setWheelJointDampingRatio </td>
  2948. <td>(</td>
  2949. <td class="paramtype">jointId&#160;</td>
  2950. <td class="paramname">, </td>
  2951. </tr>
  2952. <tr>
  2953. <td class="paramkey"></td>
  2954. <td></td>
  2955. <td class="paramtype">dampingRatio&#160;</td>
  2956. <td class="paramname">&#160;</td>
  2957. </tr>
  2958. <tr>
  2959. <td></td>
  2960. <td>)</td>
  2961. <td></td><td></td>
  2962. </tr>
  2963. </table>
  2964. </div><div class="memdoc">
  2965. <p>Sets the damping ratio. </p>
  2966. <dl class="params"><dt>Parameters</dt><dd>
  2967. <table class="params">
  2968. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  2969. <tr><td class="paramname">dampingRatio</td><td>The damping ratio. 0 = no damping, 1 = critical damping. </td></tr>
  2970. </table>
  2971. </dd>
  2972. </dl>
  2973. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  2974. </div>
  2975. </div>
  2976. <a class="anchor" id="aafe8a0a747f85fdcc517e187e5f3cea0"></a>
  2977. <div class="memitem">
  2978. <div class="memproto">
  2979. <table class="memname">
  2980. <tr>
  2981. <td class="memname">void setWheelJointFrequency </td>
  2982. <td>(</td>
  2983. <td class="paramtype">jointId&#160;</td>
  2984. <td class="paramname">, </td>
  2985. </tr>
  2986. <tr>
  2987. <td class="paramkey"></td>
  2988. <td></td>
  2989. <td class="paramtype">frequency&#160;</td>
  2990. <td class="paramname">&#160;</td>
  2991. </tr>
  2992. <tr>
  2993. <td></td>
  2994. <td>)</td>
  2995. <td></td><td></td>
  2996. </tr>
  2997. </table>
  2998. </div><div class="memdoc">
  2999. <p>Sets the mass-spring-damper frequency in Hertz. </p>
  3000. <dl class="params"><dt>Parameters</dt><dd>
  3001. <table class="params">
  3002. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  3003. <tr><td class="paramname">frequency</td><td>The mass-spring-damper frequency in Hertz. A value of 0 disables softness. </td></tr>
  3004. </table>
  3005. </dd>
  3006. </dl>
  3007. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  3008. </div>
  3009. </div>
  3010. <a class="anchor" id="a6de30c3a37273fa2e5826d9863304ec7"></a>
  3011. <div class="memitem">
  3012. <div class="memproto">
  3013. <table class="memname">
  3014. <tr>
  3015. <td class="memname">void setWheelJointMotor </td>
  3016. <td>(</td>
  3017. <td class="paramtype">jointId&#160;</td>
  3018. <td class="paramname">, </td>
  3019. </tr>
  3020. <tr>
  3021. <td class="paramkey"></td>
  3022. <td></td>
  3023. <td class="paramtype">enableMotor&#160;</td>
  3024. <td class="paramname">&#160;</td>
  3025. </tr>
  3026. <tr>
  3027. <td></td>
  3028. <td>)</td>
  3029. <td></td><td></td>
  3030. </tr>
  3031. </table>
  3032. </div><div class="memdoc">
  3033. <p>Sets whether the joint has a motor or not and the motor settings. </p>
  3034. <dl class="params"><dt>Parameters</dt><dd>
  3035. <table class="params">
  3036. <tr><td class="paramname">jointId</td><td>The Id of the joint to use. </td></tr>
  3037. <tr><td class="paramname">enableMotor</td><td>Whether the joint has a motor or not. </td></tr>
  3038. <tr><td class="paramname">motorSpeed</td><td>The motor speed (degrees per/sec). </td></tr>
  3039. <tr><td class="paramname">maxMotorTorque</td><td>The maximum motor torque used to achieve the specified motor speed (N-m). </td></tr>
  3040. </table>
  3041. </dd>
  3042. </dl>
  3043. <dl class="section return"><dt>Returns</dt><dd>Returns no value. </dd></dl>
  3044. </div>
  3045. </div>
  3046. </div><!-- contents -->
  3047. <!-- start footer part -->
  3048. <hr class="footer"/><address class="footer"><small>
  3049. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  3050. <img class="footer" src="doxygen.png" alt="doxygen"/>
  3051. </a> 1.8.3.1
  3052. </small></address>
  3053. </body>
  3054. </html>