LuaScriptAPI.dox 156 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694
  1. namespace Urho3D
  2. {
  3. /**
  4. \page LuaScriptAPI Lua Scripting API
  5. \section LuaScriptAPI_Classes Classes
  6. ### Audio : Object
  7. Methods:
  8. - bool SetMode(int bufferLengthMSec, int mixRate, bool stereo, bool interpolation = true)
  9. - bool Play()
  10. - void Stop()
  11. - void SetMasterGain(SoundType type, float gain)
  12. - void SetListener(SoundListener* listener)
  13. - void StopSound(Sound* sound)
  14. - unsigned GetSampleSize() const
  15. - int GetMixRate() const
  16. - bool GetInterpolation() const
  17. - bool IsStereo() const
  18. - bool IsPlaying() const
  19. - bool IsInitialized() const
  20. - float GetMasterGain(SoundType type) const
  21. - SoundListener* GetListener() const
  22. - const PODVector<SoundSource*>& GetSoundSources() const
  23. - void AddSoundSource(SoundSource* soundSource)
  24. - void RemoveSoundSource(SoundSource* soundSource)
  25. - float GetSoundSourceMasterGain(SoundType type) const
  26. - void MixOutput(void *dest, unsigned samples)
  27. Properties:
  28. - unsigned sampleSize (readonly)
  29. - int mixRate (readonly)
  30. - bool interpolation (readonly)
  31. - bool stereo (readonly)
  32. - bool playing (readonly)
  33. - bool initialized (readonly)
  34. - SoundListener* listener
  35. ### Sound : Resource
  36. Methods:
  37. - Sound()
  38. - ~Sound()
  39. - bool LoadRaw(Deserializer& source)
  40. - bool LoadWav(Deserializer& source)
  41. - bool LoadOggVorbis(Deserializer& source)
  42. - bool LoadRaw(const String fileName)
  43. - bool LoadWav(const String fileName)
  44. - bool LoadOggVorbis(const String fileName)
  45. - void SetSize(unsigned dataSize)
  46. - void SetData(const void* data, unsigned dataSize)
  47. - void SetFormat(unsigned frequency, bool sixteenBit, bool stereo)
  48. - void SetLooped(bool enable)
  49. - void SetLoop(unsigned repeatOffset, unsigned endOffset)
  50. - void FixInterpolation()
  51. - float GetLength() const
  52. - unsigned GetDataSize() const
  53. - unsigned GetSampleSize() const
  54. - float GetFrequency()
  55. - unsigned GetIntFrequency()
  56. - bool IsLooped() const
  57. - bool IsSixteenBit() const
  58. - bool IsStereo() const
  59. - bool IsCompressed() const
  60. Properties:
  61. - float length (readonly)
  62. - unsigned dataSize (readonly)
  63. - unsigned sampleSize (readonly)
  64. - float frequency (readonly)
  65. - int intFrequency (readonly)
  66. - bool looped
  67. - bool sixteenBit (readonly)
  68. - bool stereo (readonly)
  69. - bool compressed (readonly)
  70. ### SoundListener : Component
  71. Methods:
  72. ### SoundSource : Component
  73. Methods:
  74. - void Play(Sound* sound)
  75. - void Play(Sound* sound, float frequency)
  76. - void Play(Sound* sound, float frequency, float gain)
  77. - void Play(Sound* sound, float frequency, float gain, float panning)
  78. - void Stop()
  79. - void SetSoundType(SoundType type)
  80. - void SetFrequency(float frequency)
  81. - void SetGain(float gain)
  82. - void SetAttenuation(float attenuation)
  83. - void SetPanning(float panning)
  84. - void SetAutoRemove(bool enable)
  85. - Sound* GetSound() const
  86. - SoundType GetSoundType() const
  87. - float GetTimePosition() const
  88. - float GetFrequency() const
  89. - float GetGain() const
  90. - float GetAttenuation() const
  91. - float GetPanning() const
  92. - bool GetAutoRemove() const
  93. - bool IsPlaying() const
  94. - void PlayLockless(Sound* sound)
  95. - void StopLockless()
  96. Properties:
  97. - Sound* sound (readonly)
  98. - SoundType soundType
  99. - float timePosition (readonly)
  100. - float frequency
  101. - float gain
  102. - float attenuation
  103. - float panning
  104. - bool autoRemove
  105. - bool playing (readonly)
  106. ### SoundSource3D : SoundSource
  107. Methods:
  108. - void SetDistanceAttenuation(float nearDistance, float farDistance, float rolloffFactor)
  109. - void SetAngleAttenuation(float innerAngle, float outerAngle)
  110. - void SetNearDistance(float distance)
  111. - void SetFarDistance(float distance)
  112. - void SetInnerAngle(float angle)
  113. - void SetOuterAngle(float angle)
  114. - void SetRolloffFactor(float factor)
  115. - void CalculateAttenuation()
  116. - float GetNearDistance() const
  117. - float GetFarDistance() const
  118. - float GetInnerAngle() const
  119. - float GetOuterAngle() const
  120. - float RollAngleoffFactor() const
  121. Properties:
  122. - float nearDistance
  123. - float farDistance
  124. - float innerAngle
  125. - float outerAngle
  126. - float rolloffFactor
  127. ### Context
  128. Methods:
  129. - Object* GetEventSender() const
  130. - EventHandler* GetEventHandler() const
  131. - const String GetTypeName(ShortStringHash objectType) const
  132. ### Object : RefCounted
  133. Methods:
  134. - ShortStringHash GetType() const
  135. - ShortStringHash GetBaseType() const
  136. - const String GetTypeName() const
  137. - const String GetCategory() const
  138. - void SendEvent(const String eventName, VariantMap* eventData = 0)
  139. Properties:
  140. - ShortStringHash type (readonly)
  141. - ShortStringHash baseType (readonly)
  142. - const String typeName (readonly)
  143. - const String category (readonly)
  144. ### ResourceRef
  145. Methods:
  146. - ResourceRef()
  147. - ResourceRef(ShortStringHash type)
  148. - ResourceRef(ShortStringHash type, String name)
  149. - ResourceRef(const ResourceRef& rhs)
  150. Properties:
  151. - ShortStringHash type
  152. - String name
  153. - bool operator == (const ResourceRef& rhs) const
  154. ### ResourceRefList
  155. Methods:
  156. - ResourceRefList()
  157. - ResourceRefList(ShortStringHash type)
  158. Properties:
  159. - ShortStringHash type
  160. - bool operator == (const ResourceRefList& rhs) const
  161. ### Variant
  162. Methods:
  163. - Variant()
  164. - Variant(int value)
  165. - Variant(unsigned value)
  166. - Variant(const StringHash& value)
  167. - Variant(const ShortStringHash& value)
  168. - Variant(bool value)
  169. - Variant(float value)
  170. - Variant(const Vector2& value)
  171. - Variant(const Vector3& value)
  172. - Variant(const Vector4& value)
  173. - Variant(const Quaternion& value)
  174. - Variant(const Color& value)
  175. - Variant(const String value)
  176. - Variant(const char* value)
  177. - Variant(const ResourceRef& value)
  178. - Variant(const ResourceRefList& value)
  179. - Variant(const IntRect& value)
  180. - Variant(const IntVector2& value)
  181. - Variant(const String type, const String value)
  182. - Variant(VariantType type, const String value)
  183. - Variant(VariantType type, const char* value)
  184. - Variant(const Variant& value)
  185. - ~Variant()
  186. - void Clear()
  187. - bool operator == (const Variant& rhs) const
  188. - bool operator == (int rhs) const
  189. - bool operator == (unsigned rhs) const
  190. - bool operator == (bool rhs) const
  191. - bool operator == (float rhs) const
  192. - bool operator == (const Vector2& rhs)
  193. - bool operator == (const Vector3& rhs) const
  194. - bool operator == (const Vector4& rhs) const
  195. - bool operator == (const Quaternion& rhs) const
  196. - bool operator == (const Color& rhs) const
  197. - bool operator == (const String rhs) const
  198. - bool operator == (const ResourceRef& rhs) const
  199. - bool operator == (const ResourceRefList& rhs) const
  200. - bool operator == (const IntRect& rhs) const
  201. - bool operator == (const IntVector2& rhs) const
  202. - bool operator == (const StringHash& rhs) const
  203. - bool operator == (const ShortStringHash& rhs) const
  204. - void SetInt(int value)
  205. - void SetUint(unsigned value)
  206. - void SetStringHash(const StringHash& value)
  207. - void SetShortStringHash(const ShortStringHash& value)
  208. - void SetBool(bool value)
  209. - void SetFloat(float value)
  210. - void SetVector2(const Vector2& value)
  211. - void SetVector3(const Vector3& value)
  212. - void SetVector4(const Vector4& value)
  213. - void SetQuaternion(const Quaternion& value)
  214. - void SetColor(const Color& value)
  215. - void SetString(const String value)
  216. - void SetBuffer(const VectorBuffer& value)
  217. - void SetResourceRef(const ResourceRef& value)
  218. - void SetResourceRefList(const ResourceRefList& value)
  219. - void SetIntRect(const IntRect& value)
  220. - void SetIntVector2(const IntVector2& value)
  221. - int GetInt() const
  222. - int GetUInt() const
  223. - StringHash GetStringHash()
  224. - ShortStringHash GetShortStringHash()
  225. - bool GetBool() const
  226. - float GetFloat() const
  227. - const Vector2& GetVector2() const
  228. - const Vector3& GetVector3() const
  229. - const Vector4& GetVector4() const
  230. - const Quaternion& GetQuaternion() const
  231. - const Color& GetColor() const
  232. - const String GetString() const
  233. - VectorBuffer GetBuffer() const
  234. - const ResourceRef& GetResourceRef() const
  235. - const ResourceRefList& GetResourceRefList() const
  236. - const IntRect& GetIntRect() const
  237. - const IntVector2& GetIntVector2() const
  238. - VariantType GetType() const
  239. - String GetTypeName() const
  240. - String ToString() const
  241. - bool IsZero() const
  242. - bool IsEmpty() const
  243. Properties:
  244. - VariantType type (readonly)
  245. - String typeName (readonly)
  246. - bool zero (readonly)
  247. - bool empty (readonly)
  248. ### VariantMap
  249. Methods:
  250. - VariantMap()
  251. - ~VariantMap()
  252. - void SetInt(const String key, int value)
  253. - void SetUInt(const String key, unsigned value)
  254. - void SetStringHash(const String key, const StringHash& value)
  255. - void SetShortStringHash(const String key, const ShortStringHash& value)
  256. - void SetBool(const String key, bool value)
  257. - void SetFloat(const String key, float value)
  258. - void SetVector2(const String key, const Vector2 value)
  259. - void SetVector3(const String key, const Vector3 value)
  260. - void SetVector4(const String key, const Vector4 value)
  261. - void SetQuaternion(const String key, const Quaternion value)
  262. - void SetColor(const String key, const Color value)
  263. - void SetString(const String key, const String value)
  264. - void SetBuffer(const String key, const VectorBuffer& value)
  265. - void SetResourceRef(const String key, const ResourceRef value)
  266. - void SetResourceRefList(const String key, const ResourceRefList value)
  267. - void SetIntRect(const String key, const IntRect value)
  268. - void SetIntVector2(const String key, const IntVector2 value)
  269. - void SetPtr(const String key, void* value)
  270. - int GetInt(const String key)
  271. - int GetUInt(const String key)
  272. - StringHash GetStringHash(const String key)
  273. - ShortStringHash GetShortStringHash(const String key)
  274. - bool GetBool(const String key)
  275. - float GetFloat(const String key)
  276. - const Vector2& GetVector2(const String key)
  277. - const Vector3& GetVector3(const String key)
  278. - const Vector4& GetVector4(const String key)
  279. - const Quaternion& GetQuaternion(const String key)
  280. - const Color& GetColor(const String key)
  281. - const String GetString(const String key)
  282. - VectorBuffer GetBuffer(const String key)
  283. - const ResourceRef& GetResourceRef(const String key)
  284. - const ResourceRefList& GetResourceRefList(const String key)
  285. - const IntRect& GetIntRect(const String key)
  286. - const IntVector2& GetIntVector2(const String key)
  287. - const void* GetPtr(const String type, const String key)
  288. ### Time : Object
  289. Methods:
  290. - unsigned GetFrameNumber() const
  291. - float GetTimeStep() const
  292. - unsigned GetTimerPeriod() const
  293. - float GetElapsedTime()
  294. - static unsigned GetSystemTime()
  295. - static String GetTimeStamp()
  296. - static void Sleep(unsigned mSec)
  297. Properties:
  298. - unsigned frameNumber (readonly)
  299. - float timeStep (readonly)
  300. - unsigned timerPeriod (readonly)
  301. - float elapsedTime (readonly)
  302. ### Console : Object
  303. Methods:
  304. - void SetDefaultStyle(XMLFile* style)
  305. - void SetVisible(bool enable)
  306. - void Toggle()
  307. - void SetNumRows(unsigned rows)
  308. - void SetNumHistoryRows(unsigned rows)
  309. - void UpdateElements()
  310. - XMLFile* GetDefaultStyle() const
  311. - BorderImage* GetBackground() const
  312. - LineEdit* GetLineEdit() const
  313. - bool IsVisible() const
  314. - unsigned GetNumRows() const
  315. - unsigned GetNumHistoryRows() const
  316. - unsigned GetHistoryPosition() const
  317. - const String GetHistoryRow(unsigned index) const
  318. Properties:
  319. - XMLFile* defaultStyle
  320. - BorderImage* background (readonly)
  321. - LineEdit* lineEdit (readonly)
  322. - bool visible
  323. - unsigned numRows
  324. - unsigned numHistoryRows
  325. - unsigned historyPosition (readonly)
  326. ### DebugHud : Object
  327. Methods:
  328. - void SetDefaultStyle(XMLFile* style)
  329. - void SetMode(unsigned mode)
  330. - void SetProfilerMaxDepth(unsigned depth)
  331. - void SetProfilerInterval(float interval)
  332. - void SetUseRendererStats(bool enable)
  333. - void Toggle(unsigned mode)
  334. - void ToggleAll()
  335. - XMLFile* GetDefaultStyle() const
  336. - Text* GetStatsText() const
  337. - Text* GetModeText() const
  338. - Text* GetProfilerText() const
  339. - unsigned GetMode() const
  340. - unsigned GetProfilerMaxDepth() const
  341. - float GetProfilerInterval() const
  342. - bool GetUseRendererStats() const
  343. - void SetAppStats(const String label, const Variant stats)
  344. - void SetAppStats(const String label, const String stats)
  345. - bool ResetAppStats(const String label)
  346. - void ClearAppStats()
  347. Properties:
  348. - XMLFile* defaultStyle
  349. - Text* statsText (readonly)
  350. - Text* modeText (readonly)
  351. - Text* profilerText (readonly)
  352. - unsigned mode
  353. - unsigned profilerMaxDepth
  354. - float profilerInterval
  355. - bool useRendererStats
  356. ### Engine : Object
  357. Methods:
  358. - void RunFrame()
  359. - Console* CreateConsole()
  360. - DebugHud* CreateDebugHud()
  361. - void SetMinFps(int fps)
  362. - void SetMaxFps(int fps)
  363. - void SetMaxInactiveFps(int fps)
  364. - void SetTimeStepSmoothing(int frames)
  365. - void SetPauseMinimized(bool enable)
  366. - void SetAutoExit(bool enable)
  367. - void Exit()
  368. - void DumpProfiler()
  369. - void DumpResources()
  370. - void DumpMemory()
  371. - int GetMinFps() const
  372. - int GetMaxFps() const
  373. - int GetMaxInactiveFps() const
  374. - int GetTimeStepSmoothing() const
  375. - bool GetPauseMinimized() const
  376. - bool GetAutoExit() const
  377. - bool IsInitialized() const
  378. - bool IsExiting() const
  379. - bool IsHeadless() const
  380. Properties:
  381. - int minFps
  382. - int maxFps
  383. - int maxInactiveFps
  384. - int timeStepSmoothing
  385. - bool pauseMinimized
  386. - bool autoExit
  387. - bool initialized (readonly)
  388. - bool exiting (readonly)
  389. - bool headless (readonly)
  390. ### Drawable : Component
  391. Methods:
  392. - void SetDrawDistance(float distance)
  393. - void SetShadowDistance(float distance)
  394. - void SetLodBias(float bias)
  395. - void SetViewMask(unsigned mask)
  396. - void SetLightMask(unsigned mask)
  397. - void SetShadowMask(unsigned mask)
  398. - void SetZoneMask(unsigned mask)
  399. - void SetMaxLights(unsigned num)
  400. - void SetCastShadows(bool enable)
  401. - void SetOccluder(bool enable)
  402. - void SetOccludee(bool enable)
  403. - void MarkForUpdate()
  404. - const BoundingBox& GetBoundingBox() const
  405. - const BoundingBox& GetWorldBoundingBox()
  406. - unsigned char GetDrawableFlags() const
  407. - float GetDrawDistance() const
  408. - float GetShadowDistance() const
  409. - float GetLodBias() const
  410. - unsigned GetViewMask() const
  411. - unsigned GetLightMask() const
  412. - unsigned GetShadowMask() const
  413. - unsigned GetZoneMask() const
  414. - unsigned GetMaxLights() const
  415. - bool GetCastShadows() const
  416. - bool IsOccluder() const
  417. - bool IsOccludee() const
  418. - void SetZone(Zone* zone, bool temporary = false)
  419. - void SetSortValue(float value)
  420. - void SetMinMaxZ(float minZ, float maxZ)
  421. - void MarkInView(const FrameInfo& frame, bool mainView = true)
  422. - void ClearLights()
  423. - void AddLight(Light* light)
  424. - void AddVertexLight(Light* light)
  425. - void LimitLights()
  426. - void LimitVertexLights()
  427. - void SetBasePass(unsigned batchIndex)
  428. - Octant* GetOctant() const
  429. - Zone* GetZone() const
  430. - Zone* GetLastZone() const
  431. - bool IsZoneDirty() const
  432. - float GetDistance() const
  433. - float GetLodDistance() const
  434. - float GetSortValue() const
  435. - bool IsInView(unsigned frameNumber) const
  436. - bool IsInView(const FrameInfo& frame, bool mainView = true) const
  437. - bool HasBasePass(unsigned batchIndex) const
  438. - Light* GetFirstLight() const
  439. - float GetMinZ() const
  440. - float GetMaxZ() const
  441. Properties:
  442. - BoundingBox& worldBoundingBox (readonly)
  443. - unsigned char drawableFlags (readonly)
  444. - float drawDistance
  445. - float shadowDistance
  446. - float lodBias
  447. - unsigned viewMask
  448. - unsigned lightMask
  449. - unsigned shadowMask
  450. - unsigned zoneMask
  451. - unsigned maxLights
  452. - bool castShadows
  453. - bool occluder
  454. - bool occludee
  455. - Octant* octant (readonly)
  456. - Zone* zone
  457. - Zone* lastZone (readonly)
  458. - bool zoneDirty (readonly)
  459. - float distance (readonly)
  460. - float lodDistance (readonly)
  461. - float sortValue
  462. - Light* firstLight (readonly)
  463. - float minZ (readonly)
  464. - float maxZ (readonly)
  465. ### AnimatedModel : StaticModel
  466. Methods:
  467. - void SetModel(Model* model)
  468. - AnimationState* AddAnimationState(Animation* animation)
  469. - void RemoveAnimationState(Animation* animation)
  470. - void RemoveAnimationState(const String animationName)
  471. - void RemoveAnimationState(StringHash animationNameHash)
  472. - void RemoveAnimationState(AnimationState* state)
  473. - void RemoveAnimationState(unsigned index)
  474. - void RemoveAllAnimationStates()
  475. - void SetAnimationLodBias(float bias)
  476. - void SetUpdateInvisible(bool enable)
  477. - void SetMorphWeight(unsigned index, float weight)
  478. - void SetMorphWeight(const String name, float weight)
  479. - void SetMorphWeight(StringHash nameHash, float weight)
  480. - void ResetMorphWeights()
  481. - Skeleton& GetSkeleton()
  482. - unsigned GetNumAnimationStates() const
  483. - AnimationState* GetAnimationState(Animation* animation) const
  484. - AnimationState* GetAnimationState(const String animationName) const
  485. - AnimationState* GetAnimationState(const StringHash animationNameHash) const
  486. - AnimationState* GetAnimationState(unsigned index) const
  487. - float GetAnimationLodBias() const
  488. - bool GetUpdateInvisible() const
  489. - unsigned GetNumMorphs() const
  490. - float GetMorphWeight(unsigned index) const
  491. - float GetMorphWeight(const String name) const
  492. - float GetMorphWeight(StringHash nameHash) const
  493. - bool IsMaster() const
  494. Properties:
  495. - Model* model
  496. - Skeleton& skeleton (readonly)
  497. - unsigned numAnimationStates (readonly)
  498. - float animationLodBias
  499. - bool updateInvisible
  500. - unsigned numMorphs (readonly)
  501. - bool master (readonly)
  502. ### AnimationKeyFrame
  503. Methods:
  504. Properties:
  505. - float time
  506. - Vector3 position
  507. - Quaternion rotation
  508. - Vector3 scale
  509. ### Animation : Resource
  510. Methods:
  511. - const String GetAnimationName() const
  512. - StringHash GetAnimationNameHash() const
  513. - float GetLength() const
  514. - unsigned GetNumTracks() const
  515. - const AnimationTrack* GetTrack(unsigned index) const
  516. - const AnimationTrack* GetTrack(const String name) const
  517. - const AnimationTrack* GetTrack(StringHash nameHash) const
  518. - unsigned GetNumTriggers() const
  519. Properties:
  520. - String animationName (readonly)
  521. - StringHash animationNameHash (readonly)
  522. - float length (readonly)
  523. - unsigned numTracks (readonly)
  524. - unsigned numTriggers (readonly)
  525. ### AnimationControl
  526. Methods:
  527. - AnimationControl()
  528. Properties:
  529. - StringHash hash_
  530. - float speed_
  531. - float targetWeight_
  532. - float fadeTime_
  533. - float autoFadeTime_
  534. - float setTimeTtl_
  535. - float setWeightTtl_
  536. - unsigned short setTime_
  537. - unsigned char setWeight_
  538. - unsigned char setTimeRev_
  539. - unsigned char setWeightRev_
  540. ### AnimationController : Component
  541. Methods:
  542. - bool Play(const String name, unsigned char layer, bool looped, float fadeInTime = 0.0f)
  543. - bool PlayExclusive(const String name, unsigned char layer, bool looped, float fadeTime = 0.0f)
  544. - bool Stop(const String name, float fadeOutTime = 0.0f)
  545. - void StopLayer(unsigned char layer, float fadeOutTime = 0.0f)
  546. - void StopAll(float fadeTime = 0.0f)
  547. - bool Fade(const String name, float targetWeight, float fadeTime)
  548. - bool FadeOthers(const String name, float targetWeight, float fadeTime)
  549. - bool SetLayer(const String name, unsigned char layer)
  550. - bool SetStartBone(const String name, const String startBoneName)
  551. - bool SetTime(const String name, float time)
  552. - bool SetWeight(const String name, float weight)
  553. - bool SetLooped(const String name, bool enable)
  554. - bool SetSpeed(const String name, float speed)
  555. - bool SetAutoFade(const String name, float fadeOutTime)
  556. - bool IsPlaying(const String name) const
  557. - bool IsFadingIn(const String name) const
  558. - bool IsFadingOut(const String name) const
  559. - unsigned char GetLayer(const String name) const
  560. - Bone* GetStartBone(const String name) const
  561. - const String GetStartBoneName(const String name) const
  562. - float GetTime(const String name) const
  563. - float GetWeight(const String name) const
  564. - bool IsLooped(const String name) const
  565. - float GetLength(const String name) const
  566. - float GetSpeed(const String name) const
  567. - float GetFadeTarget(const String name) const
  568. - float GetFadeTime(const String name) const
  569. - float GetAutoFade(const String name) const
  570. - AnimationState* GetAnimationState(const String name) const
  571. - AnimationState* GetAnimationState(StringHash nameHash) const
  572. ### AnimationState
  573. Methods:
  574. - AnimationState(AnimatedModel* model, Animation* animation)
  575. - AnimationState(Node* node, Animation* animation)
  576. - ~AnimationState()
  577. - void SetStartBone(Bone* bone)
  578. - void SetLooped(bool looped)
  579. - void SetWeight(float weight)
  580. - void SetTime(float time)
  581. - void SetBoneWeight(unsigned index, float weight, bool recursive = false)
  582. - void SetBoneWeight(const String name, float weight, bool recursive = false)
  583. - void SetBoneWeight(StringHash nameHash, float weight, bool recursive = false)
  584. - void AddWeight(float delta)
  585. - void AddTime(float delta)
  586. - void SetLayer(unsigned char layer)
  587. - Animation* GetAnimation() const
  588. - Bone* GetStartBone() const
  589. - float GetBoneWeight(unsigned index) const
  590. - float GetBoneWeight(const String name) const
  591. - float GetBoneWeight(StringHash nameHash) const
  592. - unsigned GetTrackIndex(const String name) const
  593. - unsigned GetTrackIndex(StringHash nameHash) const
  594. - bool IsEnabled() const
  595. - bool IsLooped() const
  596. - float GetWeight() const
  597. - float GetTime() const
  598. - float GetLength() const
  599. - unsigned char GetLayer() const
  600. Properties:
  601. - Animation* animation (readonly)
  602. - Bone* startBone
  603. - bool enabled (readonly)
  604. - bool looped
  605. - float weight
  606. - float time
  607. - float length (readonly)
  608. - unsigned char layer
  609. ### Billboard
  610. Methods:
  611. Properties:
  612. - Vector3 position
  613. - Vector2 size
  614. - Rect uv
  615. - Color color
  616. - float rotation
  617. - bool enabled
  618. - float sortDistance
  619. ### BillboardSet : Drawable
  620. Methods:
  621. - void SetMaterial(Material* material)
  622. - void SetNumBillboards(unsigned num)
  623. - void SetRelative(bool enable)
  624. - void SetScaled(bool enable)
  625. - void SetSorted(bool enable)
  626. - void SetFaceCamera(bool enable)
  627. - void SetAnimationLodBias(float bias)
  628. - void Commit()
  629. - Material* GetMaterial() const
  630. - unsigned GetNumBillboards() const
  631. - Billboard* GetBillboard(unsigned index)
  632. - bool IsRelative() const
  633. - bool IsScaled() const
  634. - bool IsSorted() const
  635. - bool GetFaceCamera() const
  636. - float GetAnimationLodBias() const
  637. Properties:
  638. - Material* material
  639. - unsigned numBillboards
  640. - bool relative
  641. - bool scaled
  642. - bool sorted
  643. - bool faceCamera
  644. - float animationLodBias
  645. ### Camera : Component
  646. Methods:
  647. - void SetNearClip(float nearClip)
  648. - void SetFarClip(float farClip)
  649. - void SetFov(float fov)
  650. - void SetOrthoSize(float orthoSize)
  651. - void SetOrthoSize(const Vector2& orthoSize)
  652. - void SetAspectRatio(float aspectRatio)
  653. - void SetFillMode(FillMode mode)
  654. - void SetZoom(float zoom)
  655. - void SetLodBias(float bias)
  656. - void SetViewMask(unsigned mask)
  657. - void SetViewOverrideFlags(unsigned flags)
  658. - void SetOrthographic(bool enable)
  659. - void SetAutoAspectRatio(bool enable)
  660. - void SetProjectionOffset(const Vector2& offset)
  661. - void SetUseReflection(bool enable)
  662. - void SetReflectionPlane(const Plane& reflectionPlane)
  663. - void SetUseClipping(bool enable)
  664. - void SetClipPlane(const Plane& clipPlane)
  665. - float GetFarClip() const
  666. - float GetNearClip() const
  667. - float GetFov() const
  668. - float GetOrthoSize() const
  669. - float GetAspectRatio() const
  670. - float GetZoom() const
  671. - float GetLodBias() const
  672. - unsigned GetViewMask() const
  673. - unsigned GetViewOverrideFlags() const
  674. - FillMode GetFillMode() const
  675. - bool IsOrthographic() const
  676. - bool GetAutoAspectRatio() const
  677. - const Frustum& GetFrustum() const
  678. - const Matrix4& GetProjection() const
  679. - const Matrix3x4& GetView() const
  680. - void GetFrustumSize(Vector3& near, Vector3& far) const
  681. - float GetHalfViewSize() const
  682. - Frustum GetSplitFrustum(float nearClip, float farClip) const
  683. - Frustum GetViewSpaceFrustum() const
  684. - Frustum GetViewSpaceSplitFrustum(float nearClip, float farClip) const
  685. - Ray GetScreenRay(float x, float y) const
  686. - Vector2 WorldToScreenPoint(const Vector3& worldPos) const
  687. - Vector3 ScreenToWorldPoint(const Vector3& screenPos) const
  688. - const Vector2& GetProjectionOffset() const
  689. - bool GetUseReflection() const
  690. - const Plane& GetReflectionPlane() const
  691. - bool GetUseClipping() const
  692. - const Plane& GetClipPlane() const
  693. - float GetDistance(const Vector3& worldPos) const
  694. - float GetDistanceSquared(const Vector3& worldPos) const
  695. - float GetLodDistance(float distance, float scale, float bias) const
  696. - bool IsProjectionValid() const
  697. - Matrix3x4 GetEffectiveWorldTransform() const
  698. Properties:
  699. - float farClip
  700. - float nearClip
  701. - float fov
  702. - float orthoSize
  703. - float aspectRatio
  704. - float zoom
  705. - float lodBias
  706. - unsigned viewMask
  707. - unsigned viewOverrideFlags
  708. - FillMode fillMode
  709. - bool orthographic
  710. - bool autoAspectRatio
  711. - Frustum& frustum (readonly)
  712. - Matrix4& projection (readonly)
  713. - Matrix3x4& view (readonly)
  714. - float halfViewSize (readonly)
  715. - Frustum viewSpaceFrustum (readonly)
  716. - Vector2& projectionOffset
  717. - bool useReflection
  718. - Plane& reflectionPlane
  719. - bool useClipping
  720. - Plane& clipPlane
  721. - bool projectionValid (readonly)
  722. - Matrix3x4 effectiveWorldTransform (readonly)
  723. ### DebugRenderer : Component
  724. Methods:
  725. - void SetView(Camera* camera)
  726. - void AddLine(const Vector3& start, const Vector3& end, const Color& color, bool depthTest = true)
  727. - void AddLine(const Vector3& start, const Vector3& end, unsigned color, bool depthTest = true)
  728. - void AddNode(Node* node, float scale = 1.0f, bool depthTest = true)
  729. - void AddBoundingBox(const BoundingBox& box, const Color& color, bool depthTest = true)
  730. - void AddBoundingBox(const BoundingBox& box, const Matrix3x4& transform, const Color& color, bool depthTest = true)
  731. - void AddFrustum(const Frustum& frustum, const Color& color, bool depthTest = true)
  732. - void AddPolyhedron(const Polyhedron& poly, const Color& color, bool depthTest = true)
  733. - void AddSphere(const Sphere& sphere, const Color& color, bool depthTest = true)
  734. - void AddSkeleton(const Skeleton& skeleton, const Color& color, bool depthTest = true)
  735. - void AddTriangleMesh(const void* vertexData, unsigned vertexSize, const void* indexData, unsigned indexSize, unsigned indexStart, unsigned indexCount, const Matrix3x4& transform, const Color& color, bool depthTest = true)
  736. - void Render()
  737. - const Matrix3x4& GetView() const
  738. - const Matrix4& GetProjection() const
  739. - const Frustum& GetFrustum() const
  740. - bool IsInside(const BoundingBox& box) const
  741. Properties:
  742. - Matrix3x4& view (readonly)
  743. - Matrix4& projection (readonly)
  744. - Frustum& frustum (readonly)
  745. ### DecalSet : Drawable
  746. Methods:
  747. - void SetMaterial(Material* material)
  748. - void SetMaxVertices(unsigned num)
  749. - void SetMaxIndices(unsigned num)
  750. - bool AddDecal(Drawable* target, const Vector3& worldPosition, const Quaternion& worldRotation, float size, float aspectRatio, float depth, const Vector2& topLeftUV, const Vector2& bottomRightUV, float timeToLive = 0.0f, float normalCutoff = 0.1f, unsigned subGeometry = M_MAX_UNSIGNED)
  751. - void RemoveDecals(unsigned num)
  752. - void RemoveAllDecals()
  753. - Material* GetMaterial() const
  754. - unsigned GetNumDecals() const
  755. - unsigned GetNumVertices() const
  756. - unsigned GetNumIndices() const
  757. - unsigned GetMaxVertices() const
  758. - unsigned GetMaxIndices() const
  759. Properties:
  760. - Material* material
  761. - unsigned numDecals (readonly)
  762. - unsigned numVertices (readonly)
  763. - unsigned numIndices (readonly)
  764. - unsigned maxVertices
  765. - unsigned maxIndices
  766. ### Graphics : Object
  767. Methods:
  768. - void SetWindowTitle(const String windowTitle)
  769. - void SetWindowIcon(Image* windowIcon)
  770. - void SetWindowPosition(const IntVector2& position)
  771. - void SetWindowPosition(int x, int y)
  772. - bool SetMode(int width, int height, bool fullscreen, bool borderless, bool resizable, bool vsync, bool tripleBuffer, int multiSample)
  773. - bool SetMode(int width, int height)
  774. - void SetSRGB(bool enable)
  775. - void SetFlushGPU(bool enable)
  776. - bool ToggleFullscreen()
  777. - void Maximize()
  778. - void Minimize()
  779. - void Close()
  780. - bool TakeScreenShot(Image& destImage)
  781. - bool IsInitialized() const
  782. - void* GetExternalWindow() const
  783. - const String GetWindowTitle() const
  784. - IntVector2 GetWindowPosition() const
  785. - int GetWidth() const
  786. - int GetHeight() const
  787. - int GetMultiSample() const
  788. - bool GetFullscreen() const
  789. - bool GetResizable() const
  790. - bool GetBorderless() const
  791. - bool GetVSync() const
  792. - bool GetTripleBuffer() const
  793. - bool GetSRGB() const
  794. - bool GetFlushGPU() const
  795. - bool IsDeviceLost() const
  796. - unsigned GetNumPrimitives() const
  797. - unsigned GetNumBatches() const
  798. - unsigned GetDummyColorFormat() const
  799. - unsigned GetShadowMapFormat() const
  800. - unsigned GetHiresShadowMapFormat() const
  801. - bool GetSM3Support() const
  802. - bool GetInstancingSupport() const
  803. - bool GetLightPrepassSupport() const
  804. - bool GetDeferredSupport() const
  805. - bool GetHardwareShadowSupport() const
  806. - bool GetStreamOffsetSupport() const
  807. - bool GetSRGBSupport() const
  808. - bool GetSRGBWriteSupport() const
  809. - IntVector2 GetDesktopResolution() const
  810. - static unsigned GetRGBFormat()
  811. Properties:
  812. - bool initialized (readonly)
  813. - String windowTitle
  814. - IntVector2 windowPosition
  815. - int width (readonly)
  816. - int height (readonly)
  817. - int multiSample (readonly)
  818. - bool fullscreen (readonly)
  819. - bool resizable (readonly)
  820. - bool borderless (readonly)
  821. - bool vSync (readonly)
  822. - bool tripleBuffer (readonly)
  823. - bool sRGB
  824. - bool flushGPU
  825. - bool deviceLost (readonly)
  826. - unsigned numPrimitives (readonly)
  827. - unsigned numBatches (readonly)
  828. - unsigned dummyColorFormat (readonly)
  829. - unsigned shadowMapFormat (readonly)
  830. - unsigned hiresShadowMapFormat (readonly)
  831. - bool sM3Support (readonly)
  832. - bool instancingSupport (readonly)
  833. - bool lightPrepassSupport (readonly)
  834. - bool deferredSupport (readonly)
  835. - bool hardwareShadowSupport (readonly)
  836. - bool streamOffsetSupport (readonly)
  837. - bool sRGBSupport (readonly)
  838. - bool sRGBWriteSupport (readonly)
  839. - IntVector2 desktopResolution (readonly)
  840. ### BiasParameters
  841. Methods:
  842. - BiasParameters()
  843. - BiasParameters(float constantBias, float slopeScaledBias)
  844. ### CascadeParameters
  845. Methods:
  846. - CascadeParameters()
  847. - CascadeParameters(float split1, float split2, float split3, float split4, float fadeStart, float biasAutoAdjust = 1.0f)
  848. ### FocusParameters
  849. Methods:
  850. - FocusParameters()
  851. - FocusParameters(bool focus, bool nonUniform, bool autoSize, float quantize, float minView)
  852. ### Light : Drawable
  853. Methods:
  854. - void SetLightType(LightType type)
  855. - void SetPerVertex(bool enable)
  856. - void SetColor(const Color& color)
  857. - void SetSpecularIntensity(float intensity)
  858. - void SetRange(float range)
  859. - void SetFov(float fov)
  860. - void SetAspectRatio(float aspectRatio)
  861. - void SetFadeDistance(float distance)
  862. - void SetShadowFadeDistance(float distance)
  863. - void SetShadowBias(const BiasParameters& parameters)
  864. - void SetShadowCascade(const CascadeParameters& parameters)
  865. - void SetShadowFocus(const FocusParameters& parameters)
  866. - void SetShadowIntensity(float intensity)
  867. - void SetShadowResolution(float resolution)
  868. - void SetShadowNearFarRatio(float nearFarRatio)
  869. - void SetRampTexture(Texture* texture)
  870. - void SetShapeTexture(Texture* texture)
  871. - LightType GetLightType() const
  872. - bool GetPerVertex() const
  873. - const Color& GetColor() const
  874. - float GetSpecularIntensity() const
  875. - float GetRange() const
  876. - float GetFov() const
  877. - float GetAspectRatio() const
  878. - float GetFadeDistance() const
  879. - float GetShadowFadeDistance() const
  880. - const BiasParameters& GetShadowBias() const
  881. - const CascadeParameters& GetShadowCascade() const
  882. - const FocusParameters& GetShadowFocus() const
  883. - float GetShadowIntensity() const
  884. - float GetShadowResolution() const
  885. - float GetShadowNearFarRatio() const
  886. - Texture* GetRampTexture() const
  887. - Texture* GetShapeTexture() const
  888. - Frustum GetFrustum() const
  889. Properties:
  890. - LightType lightType
  891. - bool perVertex
  892. - Color& color
  893. - float specularIntensity
  894. - float range
  895. - float fov
  896. - float aspectRatio
  897. - float fadeDistance
  898. - float shadowFadeDistance
  899. - BiasParameters& shadowBias
  900. - CascadeParameters& shadowCascade
  901. - FocusParameters& shadowFocus
  902. - float shadowIntensity
  903. - float shadowResolution
  904. - float shadowNearFarRatio
  905. - Texture* rampTexture
  906. - Texture* shapeTexture
  907. - Frustum frustum (readonly)
  908. ### Material : Resource
  909. Methods:
  910. - Material()
  911. - ~Material()
  912. - void SetNumTechniques(unsigned num)
  913. - void SetTechnique(unsigned index, Technique* tech, unsigned qualityLevel = 0, float lodDistance = 0.0f)
  914. - void SetShaderParameter(const String name, const Variant& value)
  915. - void SetTexture(TextureUnit unit, Texture* texture)
  916. - void SetUVTransform(const Vector2& offset, float rotation, const Vector2& repeat)
  917. - void SetUVTransform(const Vector2& offset, float rotation, float repeat)
  918. - void SetCullMode(CullMode mode)
  919. - void SetShadowCullMode(CullMode mode)
  920. - void SetDepthBias(const BiasParameters& parameters)
  921. - void RemoveShaderParameter(const String name)
  922. - void ReleaseShaders()
  923. - void SortTechniques()
  924. - void MarkForAuxView(unsigned frameNumber)
  925. - unsigned GetNumTechniques() const
  926. - Technique* GetTechnique(unsigned index) const
  927. - Pass* GetPass(unsigned index, StringHash passType) const
  928. - Pass* GetPass(unsigned index, const String passType) const
  929. - Texture* GetTexture(TextureUnit unit) const
  930. - CullMode GetCullMode() const
  931. - CullMode GetShadowCullMode() const
  932. - const BiasParameters& GetDepthBias() const
  933. - unsigned GetAuxViewFrameNumber() const
  934. - bool GetOcclusion() const
  935. - bool GetSpecular() const
  936. Properties:
  937. - CullMode cullMode (readonly)
  938. - CullMode shadowCullMode (readonly)
  939. - unsigned auxViewFrameNumber (readonly)
  940. - bool occlusion (readonly)
  941. - bool specular (readonly)
  942. ### Model : Resource
  943. Methods:
  944. - const BoundingBox& GetBoundingBox() const
  945. - Skeleton& GetSkeleton()
  946. - unsigned GetNumGeometries() const
  947. - unsigned GetNumGeometryLodLevels(unsigned index) const
  948. - Geometry* GetGeometry(unsigned index, unsigned lodLevel) const
  949. - unsigned GetNumMorphs() const
  950. - const ModelMorph* GetMorph(unsigned index) const
  951. - const ModelMorph* GetMorph(const String name) const
  952. - const ModelMorph* GetMorph(StringHash nameHash) const
  953. - unsigned GetMorphRangeStart(unsigned bufferIndex) const
  954. - unsigned GetMorphRangeCount(unsigned bufferIndex) const
  955. Properties:
  956. - BoundingBox& boundingBox (readonly)
  957. - Skeleton skeleton (readonly)
  958. - unsigned numGeometries (readonly)
  959. - unsigned numMorphs (readonly)
  960. ### Octree : Component
  961. Methods:
  962. - void SetSize(const BoundingBox& box, unsigned numLevels)
  963. - void Update(const FrameInfo& frame)
  964. - void AddManualDrawable(Drawable* drawable)
  965. - void RemoveManualDrawable(Drawable* drawable)
  966. - const PODVector<OctreeQueryResult>& GetDrawables(const Vector3& point, unsigned char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  967. - const PODVector<OctreeQueryResult>& GetDrawables(const BoundingBox& box, unsigned char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  968. - const PODVector<OctreeQueryResult>& GetDrawables(const Frustum& frustum, unsigned char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  969. - const PODVector<OctreeQueryResult>& GetDrawables(const Sphere& sphere, unsigned char drawableFlags = DRAWABLE_ANY, unsigned viewMask = DEFAULT_VIEWMASK) const
  970. - const PODVector<RayQueryResult>& Raycast(const Ray& ray, RayQueryLevel level, float maxDistance, unsigned char drawableFlags) const
  971. - RayQueryResult RaycastSingle(const Ray& ray, RayQueryLevel level, float maxDistance, unsigned char drawableFlags) const
  972. - unsigned GetNumLevels() const
  973. - void QueueUpdate(Drawable* drawable)
  974. - void DrawDebugGeometry(bool depthTest)
  975. Properties:
  976. - unsigned numLevels (readonly)
  977. ### OctreeQueryResult
  978. Methods:
  979. - OctreeQueryResult()
  980. Properties:
  981. - Drawable* drawable
  982. - Node* node
  983. ### RayQueryResult
  984. Methods:
  985. - RayQueryResult()
  986. Properties:
  987. - Vector3 position
  988. - Vector3 normal
  989. - float distance
  990. - Drawable* drawable
  991. - Node* node
  992. - unsigned subObject
  993. ### ColorFrame
  994. Methods:
  995. - ColorFrame()
  996. - ColorFrame(const Color& color)
  997. - ColorFrame(const Color& color, float time)
  998. - Color Interpolate(const ColorFrame& next, float time)
  999. Properties:
  1000. - Color color
  1001. - float time
  1002. ### TextureFrame
  1003. Methods:
  1004. - TextureFrame()
  1005. Properties:
  1006. - Rect uv
  1007. - float time
  1008. ### ParticleEmitter : BillboardSet
  1009. Methods:
  1010. - bool Load(XMLFile* file)
  1011. - bool Save(XMLFile* file)
  1012. - void SetNumParticles(unsigned num)
  1013. - void SetEmissionRate(float rate)
  1014. - void SetMinEmissionRate(float rate)
  1015. - void SetMaxEmissionRate(float rate)
  1016. - void SetEmitterType(EmitterType type)
  1017. - void SetEmitterSize(const Vector3& size)
  1018. - void SetActiveTime(float time)
  1019. - void SetInactiveTime(float time)
  1020. - void SetEmitting(bool enable, bool resetPeriod = false)
  1021. - void SetUpdateInvisible(bool enable)
  1022. - void SetTimeToLive(float time)
  1023. - void SetMinTimeToLive(float time)
  1024. - void SetMaxTimeToLive(float time)
  1025. - void SetParticleSize(const Vector2& size)
  1026. - void SetMinParticleSize(const Vector2& size)
  1027. - void SetMaxParticleSize(const Vector2& size)
  1028. - void SetMinDirection(const Vector3& direction)
  1029. - void SetMaxDirection(const Vector3& direction)
  1030. - void SetVelocity(float velocity)
  1031. - void SetMinVelocity(float velocity)
  1032. - void SetMaxVelocity(float velocity)
  1033. - void SetRotation(float rotation)
  1034. - void SetMinRotation(float rotation)
  1035. - void SetMaxRotation(float rotation)
  1036. - void SetRotationSpeed(float speed)
  1037. - void SetMinRotationSpeed(float speed)
  1038. - void SetMaxRotationSpeed(float speed)
  1039. - void SetConstantForce(const Vector3& force)
  1040. - void SetDampingForce(float force)
  1041. - void SetSizeAdd(float sizeAdd)
  1042. - void SetSizeMul(float sizeMul)
  1043. - void SetColor(const Color& color)
  1044. - void SetNumColors(unsigned num)
  1045. - void SetNumTextureFrames(unsigned num)
  1046. - unsigned GetNumParticles() const
  1047. - bool IsEmitting() const
  1048. - bool GetUpdateInvisible() const
  1049. - float GetMinEmissionRate() const
  1050. - float GetMaxEmissionRate() const
  1051. - EmitterType GetEmitterType() const
  1052. - const Vector3& GetEmitterSize() const
  1053. - float GetActiveTime() const
  1054. - float GetInactiveTime() const
  1055. - float GetMinTimeToLive() const
  1056. - float GetMaxTimeToLive() const
  1057. - const Vector2& GetMinParticleSize() const
  1058. - const Vector2& GetMaxParticleSize() const
  1059. - const Vector3& GetMinDirection() const
  1060. - const Vector3& GetMaxDirection() const
  1061. - float GetMinVelocity() const
  1062. - float GetMaxVelocity() const
  1063. - float GetMinRotation() const
  1064. - float GetMaxRotation() const
  1065. - float GetMinRotationSpeed() const
  1066. - float GetMaxRotationSpeed() const
  1067. - const Vector3& GetConstantForce() const
  1068. - float GetDampingForce() const
  1069. - float GetSizeAdd() const
  1070. - float GetSizeMul() const
  1071. - unsigned GetNumColors() const
  1072. - ColorFrame* GetColor(unsigned index)
  1073. - unsigned GetNumTextureFrames() const
  1074. - TextureFrame* GetTextureFrame(unsigned index)
  1075. Properties:
  1076. - unsigned numParticles
  1077. - bool emitting
  1078. - bool updateInvisible
  1079. - float minEmissionRate
  1080. - float maxEmissionRate
  1081. - EmitterType emitterType
  1082. - Vector3& emitterSize
  1083. - float activeTime
  1084. - float inactiveTime
  1085. - float minTimeToLive
  1086. - float maxTimeToLive
  1087. - Vector2& minParticleSize
  1088. - Vector2& maxParticleSize
  1089. - Vector3& minDirection
  1090. - Vector3& maxDirection
  1091. - float minVelocity
  1092. - float maxVelocity
  1093. - float minRotation
  1094. - float maxRotation
  1095. - float minRotationSpeed
  1096. - float maxRotationSpeed
  1097. - Vector3& constantForce
  1098. - float dampingForce
  1099. - float sizeAdd
  1100. - float sizeMul
  1101. - unsigned numColors
  1102. - unsigned numTextureFrames
  1103. ### Renderer
  1104. Methods:
  1105. - void SetNumViewports(unsigned num)
  1106. - void SetViewport(unsigned index, Viewport* viewport)
  1107. - void SetDefaultRenderPath(RenderPath* renderPath)
  1108. - void SetDefaultRenderPath(XMLFile* file)
  1109. - void SetHDRRendering(bool enable)
  1110. - void SetSpecularLighting(bool enable)
  1111. - void SetTextureAnisotropy(int level)
  1112. - void SetTextureFilterMode(TextureFilterMode mode)
  1113. - void SetTextureQuality(int quality)
  1114. - void SetMaterialQuality(int quality)
  1115. - void SetDrawShadows(bool enable)
  1116. - void SetShadowMapSize(int size)
  1117. - void SetShadowQuality(int quality)
  1118. - void SetReuseShadowMaps(bool enable)
  1119. - void SetMaxShadowMaps(int shadowMaps)
  1120. - void SetMaxShadowCascades(int cascades)
  1121. - void SetDynamicInstancing(bool enable)
  1122. - void SetMinInstances(int instances)
  1123. - void SetMaxInstanceTriangles(int triangles)
  1124. - void SetMaxSortedInstances(int instances)
  1125. - void SetMaxOccluderTriangles(int triangles)
  1126. - void SetOcclusionBufferSize(int size)
  1127. - void SetOccluderSizeThreshold(float screenSize)
  1128. - void ReloadShaders()
  1129. - unsigned GetNumViewports() const
  1130. - Viewport* GetViewport(unsigned index) const
  1131. - RenderPath* GetDefaultRenderPath() const
  1132. - bool GetHDRRendering() const
  1133. - bool GetSpecularLighting() const
  1134. - bool GetDrawShadows() const
  1135. - int GetTextureAnisotropy() const
  1136. - TextureFilterMode GetTextureFilterMode() const
  1137. - int GetTextureQuality() const
  1138. - int GetMaterialQuality() const
  1139. - int GetShadowMapSize() const
  1140. - int GetShadowQuality() const
  1141. - bool GetReuseShadowMaps() const
  1142. - int GetMaxShadowMaps() const
  1143. - int GetMaxShadowCascades() const
  1144. - bool GetDynamicInstancing() const
  1145. - int GetMinInstances() const
  1146. - int GetMaxInstanceTriangles() const
  1147. - int GetMaxSortedInstances() const
  1148. - int GetMaxOccluderTriangles() const
  1149. - int GetOcclusionBufferSize() const
  1150. - float GetOccluderSizeThreshold() const
  1151. - unsigned GetNumViews() const
  1152. - unsigned GetNumPrimitives() const
  1153. - unsigned GetNumBatches() const
  1154. - unsigned GetNumGeometries(bool allViews = false) const
  1155. - unsigned GetNumLights(bool allViews = false) const
  1156. - unsigned GetNumShadowMaps(bool allViews = false) const
  1157. - unsigned GetNumOccluders(bool allViews = false) const
  1158. - Zone* GetDefaultZone() const
  1159. - Light* GetQuadDirLight() const
  1160. - Material* GetDefaultMaterial() const
  1161. - Texture2D* GetDefaultLightRamp() const
  1162. - Texture2D* GetDefaultLightSpot() const
  1163. - TextureCube* GetFaceSelectCubeMap() const
  1164. - TextureCube* GetIndirectionCubeMap() const
  1165. - VertexBuffer* GetInstancingBuffer() const
  1166. - ShaderVariation* GetVertexShader(const String name, bool checkExists = false) const
  1167. - ShaderVariation* GetPixelShader(const String name, bool checkExists = false) const
  1168. - ShaderVariation* GetStencilVS() const
  1169. - ShaderVariation* GetStencilPS() const
  1170. - const FrameInfo& GetFrameInfo()
  1171. - void DrawDebugGeometry(bool depthTest)
  1172. Properties:
  1173. - unsigned numViewports
  1174. - RenderPath* defaultRenderPath
  1175. - bool HDRRendering
  1176. - bool specularLighting
  1177. - bool drawShadows
  1178. - int textureAnisotropy
  1179. - TextureFilterMode textureFilterMode
  1180. - int textureQuality
  1181. - int materialQuality
  1182. - int shadowMapSize
  1183. - int shadowQuality
  1184. - bool reuseShadowMaps
  1185. - int maxShadowMaps
  1186. - int maxShadowCascades
  1187. - bool dynamicInstancing
  1188. - int minInstances
  1189. - int maxInstanceTriangles
  1190. - int maxSortedInstances
  1191. - int maxOccluderTriangles
  1192. - int occlusionBufferSize
  1193. - float occluderSizeThreshold
  1194. - unsigned numViews (readonly)
  1195. - unsigned numPrimitives (readonly)
  1196. - unsigned numBatches (readonly)
  1197. - Zone* defaultZone (readonly)
  1198. - Light* quadDirLight (readonly)
  1199. - Material* defaultMaterial (readonly)
  1200. - Texture2D* defaultLightRamp (readonly)
  1201. - Texture2D* defaultLightSpot (readonly)
  1202. - TextureCube* faceSelectCubeMap (readonly)
  1203. - TextureCube* indirectionCubeMap (readonly)
  1204. - VertexBuffer* instancingBuffer (readonly)
  1205. - ShaderVariation* stencilVS (readonly)
  1206. - ShaderVariation* stencilPS (readonly)
  1207. ### RenderPath
  1208. Methods:
  1209. - RenderPath* Clone()
  1210. - bool Load(XMLFile* file)
  1211. - bool Append(XMLFile* file)
  1212. - void SetEnabled(const String tag, bool active)
  1213. - void ToggleEnabled(const String tag)
  1214. - void SetRenderTarget(unsigned index, const RenderTargetInfo& info)
  1215. - void AddRenderTarget(const RenderTargetInfo& info)
  1216. - void RemoveRenderTarget(unsigned index)
  1217. - void RemoveRenderTarget(const String name)
  1218. - void RemoveRenderTargets(const String tag)
  1219. - void SetCommand(unsigned index, const RenderPathCommand& command)
  1220. - void AddCommand(const RenderPathCommand& command)
  1221. - void InsertCommand(unsigned index, const RenderPathCommand& command)
  1222. - void RemoveCommand(unsigned index)
  1223. - void RemoveCommands(const String tag)
  1224. - void SetShaderParameter(const String name, const Variant& value)
  1225. - unsigned GetNumRenderTargets() const
  1226. - unsigned GetNumCommands() const
  1227. - const Variant& GetShaderParameter(const String name) const
  1228. ### RenderSurface
  1229. Methods:
  1230. - RenderSurface(Texture* parentTexture)
  1231. - ~RenderSurface()
  1232. - void SetNumViewports(unsigned num)
  1233. - void SetViewport(unsigned index, Viewport* viewport)
  1234. - void SetUpdateMode(RenderSurfaceUpdateMode mode)
  1235. - void SetLinkedRenderTarget(RenderSurface* renderTarget)
  1236. - void SetLinkedDepthStencil(RenderSurface* depthStencil)
  1237. - void QueueUpdate()
  1238. - void Release()
  1239. - Texture* GetParentTexture() const
  1240. - int GetWidth() const
  1241. - int GetHeight() const
  1242. - TextureUsage GetUsage() const
  1243. - unsigned GetNumViewports() const
  1244. - Viewport* GetViewport(unsigned index) const
  1245. - RenderSurfaceUpdateMode GetUpdateMode() const
  1246. - RenderSurface* GetLinkedRenderTarget() const
  1247. - RenderSurface* GetLinkedDepthStencil() const
  1248. Properties:
  1249. - Texture* parentTexture (readonly)
  1250. - int width (readonly)
  1251. - int height (readonly)
  1252. - TextureUsage usage (readonly)
  1253. - unsigned numViewports
  1254. - RenderSurfaceUpdateMode updateMode
  1255. - RenderSurface* linkedRenderTarget
  1256. - RenderSurface* linkedDepthStencil
  1257. ### Bone
  1258. Methods:
  1259. - Bone()
  1260. Properties:
  1261. - String name
  1262. - StringHash nameHash
  1263. - unsigned parentIndex
  1264. - Vector3 initialPosition
  1265. - Quaternion initialRotation
  1266. - Vector3 initialScale
  1267. - Matrix3x4 offsetMatrix
  1268. - bool animated
  1269. - unsigned char collisionMask
  1270. - float radius
  1271. - BoundingBox boundingBox
  1272. - Node* node
  1273. ### Skeleton
  1274. Methods:
  1275. - unsigned GetNumBones() const
  1276. - Bone* GetRootBone()
  1277. - Bone* GetBone(const String name)
  1278. - Bone* GetBone(unsigned index)
  1279. Properties:
  1280. - unsigned numBones (readonly)
  1281. - Bone* rootBone (readonly)
  1282. ### Skybox : StaticModel
  1283. Methods:
  1284. ### StaticModelGeometryData
  1285. Methods:
  1286. Properties:
  1287. - Vector3 center
  1288. - unsigned lodLevel
  1289. ### StaticModel : Drawable
  1290. Methods:
  1291. - void SetModel(Model* model)
  1292. - void SetMaterial(Material* material)
  1293. - bool SetMaterial(unsigned index, Material* material)
  1294. - void SetOcclusionLodLevel(unsigned level)
  1295. - void ApplyMaterialList(const String fileName = String::EMPTY)
  1296. - Model* GetModel() const
  1297. - unsigned GetNumGeometries() const
  1298. - Material* GetMaterial(unsigned index = 0) const
  1299. - unsigned GetOcclusionLodLevel() const
  1300. - bool IsInside(const Vector3& point) const
  1301. - bool IsInsideLocal(const Vector3& point) const
  1302. Properties:
  1303. - Model* model
  1304. - Material* material
  1305. - BoundingBox& boundingBox (readonly)
  1306. - unsigned numGeometries (readonly)
  1307. - unsigned occlusionLodLevel
  1308. ### StaticModelGroup : StaticModel
  1309. Methods:
  1310. - void AddInstanceNode(Node* node)
  1311. - void RemoveInstanceNode(Node* node)
  1312. - void RemoveAllInstanceNodes()
  1313. - unsigned GetNumInstanceNodes() const
  1314. - Node* GetInstanceNode(unsigned index) const
  1315. Properties:
  1316. - unsigned numInstanceNodes (readonly)
  1317. ### Pass : RefCounted
  1318. Methods:
  1319. ### Technique : Resource
  1320. Methods:
  1321. - bool HasPass(const String type) const
  1322. - Pass* GetPass(const String type) const
  1323. - bool IsSM3() const
  1324. Properties:
  1325. - bool SM3 (readonly)
  1326. ### Terrain : Component
  1327. Methods:
  1328. - void SetPatchSize(int size)
  1329. - void SetSpacing(const Vector3& spacing)
  1330. - void SetSmoothing(bool enable)
  1331. - bool SetHeightMap(Image* image)
  1332. - void SetMaterial(Material* material)
  1333. - void SetDrawDistance(float distance)
  1334. - void SetShadowDistance(float distance)
  1335. - void SetLodBias(float bias)
  1336. - void SetViewMask(unsigned mask)
  1337. - void SetLightMask(unsigned mask)
  1338. - void SetShadowMask(unsigned mask)
  1339. - void SetZoneMask(unsigned mask)
  1340. - void SetMaxLights(unsigned num)
  1341. - void SetCastShadows(bool enable)
  1342. - void SetOccluder(bool enable)
  1343. - void SetOccludee(bool enable)
  1344. - int GetPatchSize() const
  1345. - const Vector3& GetSpacing() const
  1346. - const IntVector2& GetNumVertices() const
  1347. - const IntVector2& GetNumPatches() const
  1348. - bool GetSmoothing() const
  1349. - Image* GetHeightMap() const
  1350. - Material* GetMaterial() const
  1351. - TerrainPatch* GetPatch(unsigned index) const
  1352. - TerrainPatch* GetPatch(int x, int z) const
  1353. - float GetHeight(const Vector3& worldPosition) const
  1354. - Vector3 GetNormal(const Vector3& worldPosition) const
  1355. - SharedArrayPtr<float> GetHeightData() const
  1356. - float GetDrawDistance() const
  1357. - float GetShadowDistance() const
  1358. - float GetLodBias() const
  1359. - unsigned GetViewMask() const
  1360. - unsigned GetLightMask() const
  1361. - unsigned GetShadowMask() const
  1362. - unsigned GetZoneMask() const
  1363. - unsigned GetMaxLights() const
  1364. - bool IsVisible() const
  1365. - bool GetCastShadows() const
  1366. - bool IsOccluder() const
  1367. - bool IsOccludee() const
  1368. Properties:
  1369. - int patchSize
  1370. - Vector3& spacing
  1371. - IntVector2& numVertices (readonly)
  1372. - IntVector2& numPatches (readonly)
  1373. - bool smoothing
  1374. - Image* heightMap
  1375. - Material* material
  1376. - float drawDistance
  1377. - float shadowDistance
  1378. - float lodBias
  1379. - unsigned viewMask
  1380. - unsigned lightMask
  1381. - unsigned shadowMask
  1382. - unsigned zoneMask
  1383. - unsigned maxLights
  1384. - bool visible (readonly)
  1385. - bool castShadows
  1386. - bool occluder
  1387. - bool occludee
  1388. ### TerrainPatch : Drawable
  1389. Methods:
  1390. - void SetOwner(Terrain* terrain)
  1391. - void SetNeighbors(TerrainPatch* north, TerrainPatch* south, TerrainPatch* west, TerrainPatch* east)
  1392. - void SetMaterial(Material* material)
  1393. - void SetBoundingBox(const BoundingBox& box)
  1394. - void SetCoordinates(const IntVector2& coordinates)
  1395. - void SetOcclusionOffset(float offset)
  1396. - void ResetLod()
  1397. - Geometry* GetGeometry() const
  1398. - Geometry* GetMaxLodGeometry() const
  1399. - Geometry* GetMinLodGeometry() const
  1400. - VertexBuffer* GetVertexBuffer() const
  1401. - Terrain* GetOwner() const
  1402. - TerrainPatch* GetNorthPatch() const
  1403. - TerrainPatch* GetSouthPatch() const
  1404. - TerrainPatch* GetWestPatch() const
  1405. - TerrainPatch* GetEastPatch() const
  1406. - const IntVector2& GetCoordinates() const
  1407. - unsigned GetLodLevel() const
  1408. - float GetOcclusionOffset() const
  1409. Properties:
  1410. - Geometry* geometry (readonly)
  1411. - Geometry* maxLodGeometry (readonly)
  1412. - Geometry* minLodGeometry (readonly)
  1413. - VertexBuffer* vertexBuffer (readonly)
  1414. - Terrain* owner
  1415. - TerrainPatch* northPatch (readonly)
  1416. - TerrainPatch* southPatch (readonly)
  1417. - TerrainPatch* westPatch (readonly)
  1418. - TerrainPatch* eastPatch (readonly)
  1419. - BoundingBox& boundingBox
  1420. - IntVector2& coordinates
  1421. - unsigned lodLevel (readonly)
  1422. - float occlusionOffset
  1423. ### Texture : Resource
  1424. Methods:
  1425. - void SetNumLevels(unsigned levels)
  1426. - void SetFilterMode(TextureFilterMode filter)
  1427. - void SetAddressMode(TextureCoordinate coord, TextureAddressMode address)
  1428. - void SetBorderColor(const Color& color)
  1429. - void SetSRGB(bool enable)
  1430. - void SetBackupTexture(Texture* texture)
  1431. - void SetMipsToSkip(int quality, int mips)
  1432. - unsigned GetFormat() const
  1433. - bool IsCompressed() const
  1434. - unsigned GetLevels() const
  1435. - int GetWidth() const
  1436. - int GetHeight() const
  1437. - TextureFilterMode GetFilterMode() const
  1438. - TextureAddressMode GetAddressMode(TextureCoordinate coord) const
  1439. - const Color& GetBorderColor() const
  1440. - bool GetSRGB() const
  1441. - Texture* GetBackupTexture() const
  1442. - int GetMipsToSkip(int quality) const
  1443. - int GetLevelWidth(unsigned level) const
  1444. - int GetLevelHeight(unsigned level) const
  1445. - TextureUsage GetUsage() const
  1446. - unsigned GetDataSize(int width, int height) const
  1447. - unsigned GetRowDataSize(int width) const
  1448. Properties:
  1449. - unsigned format (readonly)
  1450. - bool compressed (readonly)
  1451. - unsigned levels (readonly)
  1452. - int width (readonly)
  1453. - int height (readonly)
  1454. - TextureFilterMode filterMode
  1455. - Color& borderColor
  1456. - bool sRGB
  1457. - Texture* backupTexture
  1458. - TextureUsage usage (readonly)
  1459. ### Texture2D : Texture
  1460. Methods:
  1461. - Texture2D()
  1462. - ~Texture2D()
  1463. - bool SetSize(int width, int height, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  1464. - RenderSurface* GetRenderSurface() const
  1465. Properties:
  1466. - RenderSurface* renderSurface (readonly)
  1467. ### TextureCube : Texture
  1468. Methods:
  1469. - RenderSurface* GetRenderSurface(CubeMapFace face) const
  1470. ### Viewport
  1471. Methods:
  1472. - Viewport()
  1473. - Viewport(Scene* scene, Camera* camera, RenderPath* renderPath = 0)
  1474. - Viewport(Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0)
  1475. - ~Viewport()
  1476. - void SetScene(Scene* scene)
  1477. - void SetCamera(Camera* camera)
  1478. - void SetRect(const IntRect& rect)
  1479. - void SetRenderPath(RenderPath* path)
  1480. - void SetRenderPath(XMLFile* file)
  1481. - Scene* GetScene() const
  1482. - Camera* GetCamera() const
  1483. - const IntRect& GetRect() const
  1484. - RenderPath* GetRenderPath() const
  1485. Properties:
  1486. - Scene* scene
  1487. - Camera* camera
  1488. - IntRect& rect
  1489. - RenderPath* renderPath
  1490. ### Zone : Drawable
  1491. Methods:
  1492. - void SetBoundingBox(const BoundingBox& box)
  1493. - void SetAmbientColor(const Color& color)
  1494. - void SetFogColor(const Color& color)
  1495. - void SetFogStart(float start)
  1496. - void SetFogEnd(float end)
  1497. - void SetPriority(int priority)
  1498. - void SetOverride(bool enable)
  1499. - void SetAmbientGradient(bool enable)
  1500. - const Matrix3x4& GetInverseWorldTransform() const
  1501. - const Color& GetAmbientColor() const
  1502. - const Color& GetAmbientStartColor()
  1503. - const Color& GetAmbientEndColor()
  1504. - const Color& GetFogColor() const
  1505. - float GetFogStart() const
  1506. - float GetFogEnd() const
  1507. - int GetPriority() const
  1508. - bool GetOverride() const
  1509. - bool GetAmbientGradient() const
  1510. - bool IsInside(const Vector3& point) const
  1511. Properties:
  1512. - BoundingBox& boundingBox
  1513. - Matrix3x4& inverseWorldTransform (readonly)
  1514. - Color& ambientColor
  1515. - Color& ambientStartColor (readonly)
  1516. - Color& ambientEndColor (readonly)
  1517. - Color& fogColor
  1518. - float fogStart
  1519. - float fogEnd
  1520. - int priority
  1521. - bool override
  1522. - bool ambientGradient
  1523. ### Deserializer
  1524. Methods:
  1525. - VectorBuffer Read(unsigned size)
  1526. - unsigned Seek(unsigned position)
  1527. - const String GetName() const
  1528. - unsigned GetChecksum()
  1529. - unsigned GetPosition() const
  1530. - unsigned GetSize() const
  1531. - bool IsEof() const
  1532. - int ReadInt()
  1533. - short ReadShort()
  1534. - signed char ReadByte()
  1535. - unsigned ReadUInt()
  1536. - unsigned short ReadUShort()
  1537. - unsigned char ReadUByte()
  1538. - bool ReadBool()
  1539. - float ReadFloat()
  1540. - IntRect ReadIntRect()
  1541. - IntVector2 ReadIntVector2()
  1542. - Rect ReadRect()
  1543. - Vector2 ReadVector2()
  1544. - Vector3 ReadVector3()
  1545. - Vector3 ReadPackedVector3(float maxAbsCoord)
  1546. - Vector4 ReadVector4()
  1547. - Quaternion ReadQuaternion()
  1548. - Quaternion ReadPackedQuaternion()
  1549. - Color ReadColor()
  1550. - BoundingBox ReadBoundingBox()
  1551. - String ReadString()
  1552. - String ReadFileID()
  1553. - StringHash ReadStringHash()
  1554. - ShortStringHash ReadShortStringHash()
  1555. - VectorBuffer ReadBuffer()
  1556. - ResourceRef ReadResourceRef()
  1557. - ResourceRefList ReadResourceRefList()
  1558. - Variant ReadVariant()
  1559. - Variant ReadVariant(VariantType type)
  1560. - VariantVector ReadVariantVector()
  1561. - VariantMap ReadVariantMap()
  1562. - unsigned ReadVLE()
  1563. - unsigned ReadNetID()
  1564. - String ReadLine()
  1565. Properties:
  1566. - String name (readonly)
  1567. - unsigned checksum (readonly)
  1568. - unsigned position (readonly)
  1569. - unsigned size (readonly)
  1570. - bool eof (readonly)
  1571. ### File : Object
  1572. Methods:
  1573. - File()
  1574. - File(const String fileName, FileMode mode = FILE_READ)
  1575. - File(PackageFile* package, const String fileName)
  1576. - ~File()
  1577. - bool Open(const String fileName, FileMode mode = FILE_READ)
  1578. - bool Open(PackageFile* package, const String fileName)
  1579. - void Close()
  1580. - void Flush()
  1581. - void SetName(const String name)
  1582. - FileMode GetMode() const
  1583. - bool IsOpen() const
  1584. - void* GetHandle() const
  1585. - bool IsPackaged() const
  1586. - VectorBuffer Read(unsigned size)
  1587. - unsigned Seek(unsigned position)
  1588. - const String GetName() const
  1589. - unsigned GetChecksum()
  1590. - unsigned GetPosition() const
  1591. - unsigned GetSize() const
  1592. - bool IsEof() const
  1593. - int ReadInt()
  1594. - short ReadShort()
  1595. - signed char ReadByte()
  1596. - unsigned ReadUInt()
  1597. - unsigned short ReadUShort()
  1598. - unsigned char ReadUByte()
  1599. - bool ReadBool()
  1600. - float ReadFloat()
  1601. - IntRect ReadIntRect()
  1602. - IntVector2 ReadIntVector2()
  1603. - Rect ReadRect()
  1604. - Vector2 ReadVector2()
  1605. - Vector3 ReadVector3()
  1606. - Vector3 ReadPackedVector3(float maxAbsCoord)
  1607. - Vector4 ReadVector4()
  1608. - Quaternion ReadQuaternion()
  1609. - Quaternion ReadPackedQuaternion()
  1610. - Color ReadColor()
  1611. - BoundingBox ReadBoundingBox()
  1612. - String ReadString()
  1613. - String ReadFileID()
  1614. - StringHash ReadStringHash()
  1615. - ShortStringHash ReadShortStringHash()
  1616. - VectorBuffer ReadBuffer()
  1617. - ResourceRef ReadResourceRef()
  1618. - ResourceRefList ReadResourceRefList()
  1619. - Variant ReadVariant()
  1620. - Variant ReadVariant(VariantType type)
  1621. - VariantVector ReadVariantVector()
  1622. - VariantMap ReadVariantMap()
  1623. - unsigned ReadVLE()
  1624. - unsigned ReadNetID()
  1625. - String ReadLine()
  1626. - unsigned Write(const VectorBuffer& buffer)
  1627. - bool WriteInt(int value)
  1628. - bool WriteShort(short value)
  1629. - bool WriteByte(signed char value)
  1630. - bool WriteUInt(unsigned value)
  1631. - bool WriteUShort(unsigned short value)
  1632. - bool WriteUByte(unsigned char value)
  1633. - bool WriteBool(bool value)
  1634. - bool WriteFloat(float value)
  1635. - bool WriteIntRect(const IntRect& value)
  1636. - bool WriteIntVector2(const IntVector2& value)
  1637. - bool WriteRect(const Rect& value)
  1638. - bool WriteVector2(const Vector2& value)
  1639. - bool WriteVector3(const Vector3& value)
  1640. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  1641. - bool WriteVector4(const Vector4& value)
  1642. - bool WriteQuaternion(const Quaternion& value)
  1643. - bool WritePackedQuaternion(const Quaternion& value)
  1644. - bool WriteColor(const Color& value)
  1645. - bool WriteBoundingBox(const BoundingBox& value)
  1646. - bool WriteString(const String value)
  1647. - bool WriteFileID(const String value)
  1648. - bool WriteStringHash(const StringHash& value)
  1649. - bool WriteShortStringHash(const ShortStringHash& value)
  1650. - bool WriteBuffer(const VectorBuffer& buffer)
  1651. - bool WriteResourceRef(const ResourceRef& value)
  1652. - bool WriteResourceRefList(const ResourceRefList& value)
  1653. - bool WriteVariant(const Variant& value)
  1654. - bool WriteVariantData(const Variant& value)
  1655. - bool WriteVariantVector(const VariantVector& value)
  1656. - bool WriteVariantMap(const VariantMap& value)
  1657. - bool WriteVLE(unsigned value)
  1658. - bool WriteNetID(unsigned value)
  1659. - bool WriteLine(const String value)
  1660. Properties:
  1661. - FileMode mode (readonly)
  1662. - bool open (readonly)
  1663. - bool packaged (readonly)
  1664. - String name (readonly)
  1665. - unsigned checksum (readonly)
  1666. - unsigned position (readonly)
  1667. - unsigned size (readonly)
  1668. - bool eof (readonly)
  1669. ### FileSystem : Object
  1670. Methods:
  1671. - bool SetCurrentDir(const String pathName)
  1672. - bool CreateDir(const String pathName)
  1673. - int SystemCommand(const String commandLine)
  1674. - int SystemRun(const String fileName, const Vector<String>& arguments)
  1675. - bool SystemOpen(const String fileName, const String mode = String::EMPTY)
  1676. - bool Copy(const String srcFileName, const String destFileName)
  1677. - bool Rename(const String srcFileName, const String destFileName)
  1678. - bool Delete(const String fileName)
  1679. - void RegisterPath(const String pathName)
  1680. - String GetCurrentDir() const
  1681. - bool HasRegisteredPaths() const
  1682. - bool CheckAccess(const String pathName) const
  1683. - unsigned GetLastModifiedTime(const String fileName) const
  1684. - bool FileExists(const String fileName) const
  1685. - bool DirExists(const String pathName) const
  1686. - const Vector<String>& ScanDir(const String pathName, const String filter, unsigned flags, bool recursive) const
  1687. - String GetProgramDir() const
  1688. - String GetUserDocumentsDir() const
  1689. ### FileWatcher : Object
  1690. Methods:
  1691. - bool StartWatching(const String pathName, bool watchSubDirs)
  1692. - void StopWatching()
  1693. - void AddChange(const String fileName)
  1694. - const String GetPath() const
  1695. ### Log : Object
  1696. Methods:
  1697. - void Open(const String fileName)
  1698. - void Close()
  1699. - void SetLevel(int level)
  1700. - void SetTimeStamp(bool enable)
  1701. - void SetQuiet(bool quiet)
  1702. - int GetLevel() const
  1703. - bool GetTimeStamp() const
  1704. - String GetLastMessage() const
  1705. - bool IsQuiet() const
  1706. - static void Write(int level, const String message)
  1707. - static void WriteRaw(const String message, bool error = false)
  1708. Properties:
  1709. - int level
  1710. - bool timeStamp
  1711. - bool quiet
  1712. ### PackageEntry
  1713. Methods:
  1714. Properties:
  1715. - unsigned offset
  1716. - unsigned size
  1717. - unsigned checksum
  1718. ### PackageFile : Object
  1719. Methods:
  1720. - PackageFile()
  1721. - PackageFile(const String fileName, unsigned startOffset = 0)
  1722. - ~PackageFile()
  1723. - bool Open(const String fileName, unsigned startOffset = 0)
  1724. - bool Exists(const String fileName) const
  1725. - const PackageEntry* GetEntry(const String fileName) const
  1726. - const HashMap<String, PackageEntry>& GetEntries() const
  1727. - const String GetName() const
  1728. - StringHash GetNameHash() const
  1729. - unsigned GetNumFiles() const
  1730. - unsigned GetTotalSize() const
  1731. - unsigned GetChecksum() const
  1732. - bool IsCompressed() const
  1733. Properties:
  1734. - String name (readonly)
  1735. - StringHash nameHash (readonly)
  1736. - unsigned numFiles (readonly)
  1737. - unsigned totalSize (readonly)
  1738. - unsigned checksum (readonly)
  1739. - bool compressed (readonly)
  1740. ### Serializer
  1741. Methods:
  1742. - unsigned Write(const VectorBuffer& buffer)
  1743. - bool WriteInt(int value)
  1744. - bool WriteShort(short value)
  1745. - bool WriteByte(signed char value)
  1746. - bool WriteUInt(unsigned value)
  1747. - bool WriteUShort(unsigned short value)
  1748. - bool WriteUByte(unsigned char value)
  1749. - bool WriteBool(bool value)
  1750. - bool WriteFloat(float value)
  1751. - bool WriteIntRect(const IntRect& value)
  1752. - bool WriteIntVector2(const IntVector2& value)
  1753. - bool WriteRect(const Rect& value)
  1754. - bool WriteVector2(const Vector2& value)
  1755. - bool WriteVector3(const Vector3& value)
  1756. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  1757. - bool WriteVector4(const Vector4& value)
  1758. - bool WriteQuaternion(const Quaternion& value)
  1759. - bool WritePackedQuaternion(const Quaternion& value)
  1760. - bool WriteColor(const Color& value)
  1761. - bool WriteBoundingBox(const BoundingBox& value)
  1762. - bool WriteString(const String value)
  1763. - bool WriteFileID(const String value)
  1764. - bool WriteStringHash(const StringHash& value)
  1765. - bool WriteShortStringHash(const ShortStringHash& value)
  1766. - bool WriteBuffer(const VectorBuffer& buffer)
  1767. - bool WriteResourceRef(const ResourceRef& value)
  1768. - bool WriteResourceRefList(const ResourceRefList& value)
  1769. - bool WriteVariant(const Variant& value)
  1770. - bool WriteVariantData(const Variant& value)
  1771. - bool WriteVariantVector(const VariantVector& value)
  1772. - bool WriteVariantMap(const VariantMap& value)
  1773. - bool WriteVLE(unsigned value)
  1774. - bool WriteNetID(unsigned value)
  1775. - bool WriteLine(const String value)
  1776. ### VectorBuffer
  1777. Methods:
  1778. - VectorBuffer()
  1779. - VectorBuffer(Deserializer& source, unsigned size)
  1780. - ~VectorBuffer()
  1781. - void SetData(Deserializer& source, unsigned size)
  1782. - void Clear()
  1783. - void Resize(unsigned size)
  1784. - const void* GetData() const
  1785. - void* GetModifiableData()
  1786. - VectorBuffer Read(unsigned size)
  1787. - unsigned Seek(unsigned position)
  1788. - const String GetName() const
  1789. - unsigned GetChecksum()
  1790. - unsigned GetPosition() const
  1791. - unsigned GetSize() const
  1792. - bool IsEof() const
  1793. - int ReadInt()
  1794. - short ReadShort()
  1795. - signed char ReadByte()
  1796. - unsigned ReadUInt()
  1797. - unsigned short ReadUShort()
  1798. - unsigned char ReadUByte()
  1799. - bool ReadBool()
  1800. - float ReadFloat()
  1801. - IntRect ReadIntRect()
  1802. - IntVector2 ReadIntVector2()
  1803. - Rect ReadRect()
  1804. - Vector2 ReadVector2()
  1805. - Vector3 ReadVector3()
  1806. - Vector3 ReadPackedVector3(float maxAbsCoord)
  1807. - Vector4 ReadVector4()
  1808. - Quaternion ReadQuaternion()
  1809. - Quaternion ReadPackedQuaternion()
  1810. - Color ReadColor()
  1811. - BoundingBox ReadBoundingBox()
  1812. - String ReadString()
  1813. - String ReadFileID()
  1814. - StringHash ReadStringHash()
  1815. - ShortStringHash ReadShortStringHash()
  1816. - VectorBuffer ReadBuffer()
  1817. - ResourceRef ReadResourceRef()
  1818. - ResourceRefList ReadResourceRefList()
  1819. - Variant ReadVariant()
  1820. - Variant ReadVariant(VariantType type)
  1821. - VariantVector ReadVariantVector()
  1822. - VariantMap ReadVariantMap()
  1823. - unsigned ReadVLE()
  1824. - unsigned ReadNetID()
  1825. - String ReadLine()
  1826. - unsigned Write(const VectorBuffer& buffer)
  1827. - bool WriteInt(int value)
  1828. - bool WriteShort(short value)
  1829. - bool WriteByte(signed char value)
  1830. - bool WriteUInt(unsigned value)
  1831. - bool WriteUShort(unsigned short value)
  1832. - bool WriteUByte(unsigned char value)
  1833. - bool WriteBool(bool value)
  1834. - bool WriteFloat(float value)
  1835. - bool WriteIntRect(const IntRect& value)
  1836. - bool WriteIntVector2(const IntVector2& value)
  1837. - bool WriteRect(const Rect& value)
  1838. - bool WriteVector2(const Vector2& value)
  1839. - bool WriteVector3(const Vector3& value)
  1840. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  1841. - bool WriteVector4(const Vector4& value)
  1842. - bool WriteQuaternion(const Quaternion& value)
  1843. - bool WritePackedQuaternion(const Quaternion& value)
  1844. - bool WriteColor(const Color& value)
  1845. - bool WriteBoundingBox(const BoundingBox& value)
  1846. - bool WriteString(const String value)
  1847. - bool WriteFileID(const String value)
  1848. - bool WriteStringHash(const StringHash& value)
  1849. - bool WriteShortStringHash(const ShortStringHash& value)
  1850. - bool WriteBuffer(const VectorBuffer& buffer)
  1851. - bool WriteResourceRef(const ResourceRef& value)
  1852. - bool WriteResourceRefList(const ResourceRefList& value)
  1853. - bool WriteVariant(const Variant& value)
  1854. - bool WriteVariantData(const Variant& value)
  1855. - bool WriteVariantVector(const VariantVector& value)
  1856. - bool WriteVariantMap(const VariantMap& value)
  1857. - bool WriteVLE(unsigned value)
  1858. - bool WriteNetID(unsigned value)
  1859. - bool WriteLine(const String value)
  1860. Properties:
  1861. - String name (readonly)
  1862. - unsigned checksum (readonly)
  1863. - unsigned position (readonly)
  1864. - unsigned size (readonly)
  1865. - bool eof (readonly)
  1866. ### TouchState
  1867. Methods:
  1868. Properties:
  1869. - int touchID
  1870. - IntVector2 position
  1871. - IntVector2 lastPosition
  1872. - IntVector2 delta
  1873. - float pressure
  1874. ### JoystickState
  1875. Methods:
  1876. - unsigned GetNumButtons() const
  1877. - unsigned GetNumAxes() const
  1878. - unsigned GetNumHats() const
  1879. - bool GetButtonDown(unsigned index) const
  1880. - bool GetButtonPress(unsigned index) const
  1881. - float GetAxisPosition(unsigned index) const
  1882. - int GetHatPosition(unsigned index) const
  1883. Properties:
  1884. - unsigned numButtons (readonly)
  1885. - unsigned numAxes (readonly)
  1886. - unsigned numHats (readonly)
  1887. ### Input : Object
  1888. Methods:
  1889. - void SetToggleFullscreen(bool enable)
  1890. - void SetMouseVisible(bool enable)
  1891. - bool OpenJoystick(unsigned index)
  1892. - void CloseJoystick(unsigned index)
  1893. - bool DetectJoysticks()
  1894. - void SetScreenKeyboardVisible(bool enable)
  1895. - bool GetKeyDown(int key) const
  1896. - bool GetKeyPress(int key) const
  1897. - bool GetMouseButtonDown(int button) const
  1898. - bool GetMouseButtonPress(int button) const
  1899. - bool GetQualifierDown(int qualifier) const
  1900. - bool GetQualifierPress(int qualifier) const
  1901. - int GetQualifiers() const
  1902. - IntVector2 GetMousePosition() const
  1903. - const IntVector2& GetMouseMove() const
  1904. - int GetMouseMoveX() const
  1905. - int GetMouseMoveY() const
  1906. - int GetMouseMoveWheel() const
  1907. - unsigned GetNumTouches() const
  1908. - TouchState* GetTouch(unsigned index) const
  1909. - unsigned GetNumJoysticks() const
  1910. - const String GetJoystickName(unsigned index) const
  1911. - JoystickState* GetJoystick(unsigned index)
  1912. - bool GetToggleFullscreen() const
  1913. - bool GetScreenKeyboardSupport() const
  1914. - bool IsScreenKeyboardVisible() const
  1915. - bool IsMouseVisible() const
  1916. - bool HasFocus()
  1917. - bool IsMinimized() const
  1918. Properties:
  1919. - int qualifiers (readonly)
  1920. - IntVector2 mousePosition (readonly)
  1921. - IntVector2& mouseMove (readonly)
  1922. - int mouseMoveX (readonly)
  1923. - int mouseMoveY (readonly)
  1924. - int mouseMoveWheel (readonly)
  1925. - unsigned numTouches (readonly)
  1926. - unsigned numJoysticks (readonly)
  1927. - bool toggleFullscreen (readonly)
  1928. - bool screenKeyboardSupport (readonly)
  1929. - bool screenKeyboardVisible
  1930. - bool mouseVisible
  1931. - bool focus (readonly)
  1932. - bool minimized (readonly)
  1933. ### LuaScriptInstance : Component
  1934. Methods:
  1935. - bool CreateObject(const String scriptObjectType)
  1936. - bool CreateObject(const String scriptFileName, const String scriptObjectType)
  1937. - void SetScriptFileName(const String scriptFileName)
  1938. - void SetScriptObjectType(const String scriptObjectType)
  1939. - void SubscribeToEvent(const String eventName, const String functionName)
  1940. - void UnsubscribeFromEvent(const String eventName)
  1941. - void UnsubscribeFromAllEvents()
  1942. - void SubscribeToEvent(void* sender, const String eventName, const String functionName)
  1943. - void UnsubscribeFromEvent(void* sender, const String eventName)
  1944. - void UnsubscribeFromEvents(void* sender)
  1945. - const String GetScriptFileName() const
  1946. - const String GetScriptObjectType() const
  1947. Properties:
  1948. - const String scriptFileName
  1949. - const String scriptObjectType
  1950. ### BoundingBox
  1951. Methods:
  1952. - BoundingBox()
  1953. - BoundingBox(const BoundingBox& box)
  1954. - BoundingBox(const Rect& rect)
  1955. - BoundingBox(const Vector3& min, const Vector3& max)
  1956. - BoundingBox(float min, float max)
  1957. - BoundingBox(const Frustum& frustum)
  1958. - BoundingBox(const Polyhedron& poly)
  1959. - BoundingBox(const Sphere& sphere)
  1960. - ~BoundingBox()
  1961. - bool operator == (const BoundingBox& rhs) const
  1962. - void Define(const BoundingBox& box)
  1963. - void Define(const Rect& rect)
  1964. - void Define(const Vector3& min, const Vector3& max)
  1965. - void Define(float min, float max)
  1966. - void Define(const Vector3& point)
  1967. - void Define(const Frustum& frustum)
  1968. - void Define(const Polyhedron& poly)
  1969. - void Define(const Sphere& sphere)
  1970. - void Merge(const Vector3& point)
  1971. - void Merge(const BoundingBox& box)
  1972. - void Merge(const Frustum& frustum)
  1973. - void Merge(const Polyhedron& poly)
  1974. - void Merge(const Sphere& sphere)
  1975. - void Clip(const BoundingBox& box)
  1976. - void Transform(const Matrix3& transform)
  1977. - void Transform(const Matrix3x4& transform)
  1978. - void Clear()
  1979. - Vector3 Center() const
  1980. - Vector3 Size() const
  1981. - Vector3 HalfSize() const
  1982. - BoundingBox Transformed(const Matrix3& transform) const
  1983. - BoundingBox Transformed(const Matrix3x4& transform) const
  1984. - Rect Projected(const Matrix4& projection) const
  1985. - Intersection IsInside(const Vector3& point) const
  1986. - Intersection IsInside(const BoundingBox& box) const
  1987. - Intersection IsInsideFast(const BoundingBox& box) const
  1988. - Intersection IsInside(const Sphere& sphere) const
  1989. - Intersection IsInsideFast(const Sphere& sphere) const
  1990. - String ToString() const
  1991. Properties:
  1992. - Vector3 min
  1993. - Vector3 max
  1994. - bool defined
  1995. - Vector3 center (readonly)
  1996. - Vector3 size (readonly)
  1997. - Vector3 halfSize (readonly)
  1998. ### Color
  1999. Methods:
  2000. - Color()
  2001. - Color(const Color& color)
  2002. - Color(const Color& color, float a)
  2003. - Color(float r, float g, float b)
  2004. - Color(float r, float g, float b, float a)
  2005. - ~Color()
  2006. - bool operator == (const Color& rhs) const
  2007. - Color operator * (float rhs) const
  2008. - Color operator + (const Color& rhs)
  2009. - unsigned ToUInt() const
  2010. - Vector3 ToHSL() const
  2011. - Vector3 ToHSV() const
  2012. - void FromHSL(float h, float s, float l, float a)
  2013. - void FromHSV(float h, float s, float v, float a)
  2014. - Vector3 ToVector3() const
  2015. - Vector4 ToVector4() const
  2016. - float SumRGB() const
  2017. - float Average() const
  2018. - float Luma() const
  2019. - float Chroma() const
  2020. - float Hue() const
  2021. - float SaturationHSL() const
  2022. - float SaturationHSV() const
  2023. - float Value() const
  2024. - float Lightness() const
  2025. - float MaxRGB() const
  2026. - float MinRGB() const
  2027. - float Range() const
  2028. - void Clip(bool clipAlpha = false)
  2029. - void Invert(bool invertAlpha = false)
  2030. - Color Lerp(const Color& rhs, float t) const
  2031. - String ToString() const
  2032. Properties:
  2033. - float r
  2034. - float g
  2035. - float b
  2036. - float a
  2037. - static const Color WHITE
  2038. - static const Color GRAY
  2039. - static const Color BLACK
  2040. - static const Color RED
  2041. - static const Color GREEN
  2042. - static const Color BLUE
  2043. - static const Color CYAN
  2044. - static const Color MAGENTA
  2045. - static const Color YELLOW
  2046. - static const Color TRANSPARENT
  2047. ### Frustum
  2048. Methods:
  2049. - Frustum()
  2050. - Frustum(const Frustum& frustum)
  2051. - ~Frustum()
  2052. - void Define(float fov, float aspectRatio, float zoom, float nearZ, float farZ, const Matrix3x4& transform = Matrix3x4::IDENTITY)
  2053. - void Define(const Vector3& near, const Vector3& far, const Matrix3x4& transform = Matrix3x4::IDENTITY)
  2054. - void Define(const BoundingBox& box, const Matrix3x4& transform = Matrix3x4::IDENTITY)
  2055. - void DefineOrtho(float orthoSize, float aspectRatio, float zoom, float nearZ, float farZ, const Matrix3x4& transform = Matrix3x4::IDENTITY)
  2056. - void Transform(const Matrix3& transform)
  2057. - void Transform(const Matrix3x4& transform)
  2058. - Intersection IsInside(const Vector3& point) const
  2059. - Intersection IsInside(const Sphere& sphere) const
  2060. - Intersection IsInsideFast(const Sphere& sphere) const
  2061. - Intersection IsInside(const BoundingBox& box) const
  2062. - Intersection IsInsideFast(const BoundingBox& box) const
  2063. - float Distance(const Vector3& point) const
  2064. - Frustum Transformed(const Matrix3& transform) const
  2065. - Frustum Transformed(const Matrix3x4& transform) const
  2066. - Rect Projected(const Matrix4& transform) const
  2067. - void UpdatePlanes()
  2068. ### Matrix3
  2069. Methods:
  2070. - Matrix3()
  2071. - Matrix3(const Matrix3& matrix)
  2072. Properties:
  2073. - Matrix3(float v00, float v01, float v02,
  2074. - float v10, float v11, float v12,
  2075. - float v20, float v21, float v22)
  2076. - ~Matrix3()
  2077. - bool operator == (const Matrix3& rhs) const
  2078. - Vector3 operator * (const Vector3& rhs) const
  2079. - Matrix3 operator + (const Matrix3& rhs) const
  2080. - Matrix3 operator - (const Matrix3& rhs) const
  2081. - Matrix3 operator * (float rhs) const
  2082. - Matrix3 operator * (const Matrix3& rhs) const
  2083. - void SetScale(const Vector3& scale)
  2084. - void SetScale(float scale)
  2085. - Vector3 Scale() const
  2086. - Matrix3 Transpose() const
  2087. - Matrix3 Scaled(const Vector3& scale) const
  2088. - bool Equals(const Matrix3& rhs) const
  2089. - Matrix3 Inverse() const
  2090. - float m00
  2091. - float m01
  2092. - float m02
  2093. - float m10
  2094. - float m11
  2095. - float m12
  2096. - float m20
  2097. - float m21
  2098. - float m22
  2099. - static const Matrix3 ZERO
  2100. - static const Matrix3 IDENTITY
  2101. ### Matrix3x4
  2102. Methods:
  2103. - Matrix3x4()
  2104. - Matrix3x4(const Matrix3x4& matrix)
  2105. - Matrix3x4(const Matrix3& matrix)
  2106. - Matrix3x4(const Matrix4& matrix)
  2107. Properties:
  2108. - Matrix3x4(float v00, float v01, float v02, float v03,
  2109. - float v10, float v11, float v12, float v13,
  2110. - float v20, float v21, float v22, float v23)
  2111. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, float scale)
  2112. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, const Vector3& scale)
  2113. - bool operator == (const Matrix3x4& rhs) const
  2114. - Vector3 operator * (const Vector3& rhs) const
  2115. - Vector3 operator * (const Vector4& rhs) const
  2116. - Matrix3x4 operator + (const Matrix3x4& rhs) const
  2117. - Matrix3x4 operator - (const Matrix3x4& rhs) const
  2118. - Matrix3x4 operator * (float rhs) const
  2119. - Matrix3x4 operator * (const Matrix3x4& rhs) const
  2120. - Matrix4 operator * (const Matrix4& rhs) const
  2121. - void SetTranslation(const Vector3& translation)
  2122. - void SetRotation(const Matrix3& rotation)
  2123. - void SetScale(const Vector3& scale)
  2124. - void SetScale(float scale)
  2125. - Matrix3 ToMatrix3() const
  2126. - Matrix4 ToMatrix4() const
  2127. - Matrix3 RotationMatrix() const
  2128. - Vector3 Translation() const
  2129. - Quaternion Rotation() const
  2130. - Vector3 Scale() const
  2131. - bool Equals(const Matrix3x4& rhs) const
  2132. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  2133. - Matrix3x4 Inverse() const
  2134. - float m00
  2135. - float m01
  2136. - float m02
  2137. - float m03
  2138. - float m10
  2139. - float m11
  2140. - float m12
  2141. - float m13
  2142. - float m20
  2143. - float m21
  2144. - float m22
  2145. - float m23
  2146. - static const Matrix3x4 ZERO
  2147. - static const Matrix3x4 IDENTITY
  2148. ### Matrix4
  2149. Methods:
  2150. - Matrix4()
  2151. - Matrix4(const Matrix4& matrix)
  2152. - Matrix4(const Matrix3& matrix)
  2153. Properties:
  2154. - Matrix4(float v00, float v01, float v02, float v03,
  2155. - float v10, float v11, float v12, float v13,
  2156. - float v20, float v21, float v22, float v23,
  2157. - float v30, float v31, float v32, float v33)
  2158. - ~Matrix4()
  2159. - bool operator == (const Matrix4& rhs) const
  2160. - Vector3 operator * (const Vector3& rhs) const
  2161. - Vector4 operator * (const Vector4& rhs) const
  2162. - Matrix4 operator + (const Matrix4& rhs) const
  2163. - Matrix4 operator - (const Matrix4& rhs) const
  2164. - Matrix4 operator * (float rhs) const
  2165. - Matrix4 operator * (const Matrix4& rhs) const
  2166. - void SetTranslation(const Vector3& translation)
  2167. - void SetRotation(const Matrix3& rotation)
  2168. - void SetScale(const Vector3& scale)
  2169. - void SetScale(float scale)
  2170. - Matrix3 ToMatrix3() const
  2171. - Matrix3 RotationMatrix() const
  2172. - Vector3 Translation() const
  2173. - Quaternion Rotation() const
  2174. - Vector3 Scale() const
  2175. - Matrix4 Transpose() const
  2176. - bool Equals(const Matrix4& rhs) const
  2177. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  2178. - Matrix4 Inverse() const
  2179. - float m00
  2180. - float m01
  2181. - float m02
  2182. - float m03
  2183. - float m10
  2184. - float m11
  2185. - float m12
  2186. - float m13
  2187. - float m20
  2188. - float m21
  2189. - float m22
  2190. - float m23
  2191. - float m30
  2192. - float m31
  2193. - float m32
  2194. - float m33
  2195. - static const Matrix4 ZERO
  2196. - static const Matrix4 IDENTITY
  2197. ### Plane
  2198. Methods:
  2199. - Plane()
  2200. - Plane(const Plane& plane)
  2201. - Plane(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  2202. - Plane(const Vector3& normal, const Vector3& point)
  2203. - Plane(const Vector4& plane)
  2204. - ~Plane()
  2205. - void Define(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  2206. - void Define(const Vector3& normal, const Vector3& point)
  2207. - void Define(const Vector4& plane)
  2208. - void Transform(const Matrix3& transform)
  2209. - void Transform(const Matrix3x4& transform)
  2210. - void Transform(const Matrix4& transform)
  2211. - float Distance(const Vector3& point) const
  2212. - Vector3 Reflect(const Vector3& direction) const
  2213. - Matrix3x4 ReflectionMatrix() const
  2214. - Plane Transformed(const Matrix3& transform) const
  2215. - Plane Transformed(const Matrix3x4& transform) const
  2216. - Plane Transformed(const Matrix4& transform) const
  2217. - Vector4 ToVector4() const
  2218. Properties:
  2219. - Vector3 normal
  2220. - Vector3 absNormal
  2221. - float d
  2222. - static const Plane UP
  2223. ### Polyhedron
  2224. Methods:
  2225. - Polyhedron()
  2226. - Polyhedron(const Polyhedron& polyhedron)
  2227. - Polyhedron(const BoundingBox& box)
  2228. - Polyhedron(const Frustum& frustum)
  2229. - ~Polyhedron()
  2230. - void Define(const BoundingBox& box)
  2231. - void Define(const Frustum& frustum)
  2232. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  2233. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2, const Vector3& v3)
  2234. - void Clip(const Plane& plane)
  2235. - void Clip(const BoundingBox& box)
  2236. - void Clip(const Frustum& box)
  2237. - void Clear()
  2238. - void Transform(const Matrix3& transform)
  2239. - void Transform(const Matrix3x4& transform)
  2240. - Polyhedron Transformed(const Matrix3& transform) const
  2241. - Polyhedron Transformed(const Matrix3x4& transform) const
  2242. - bool Empty() const
  2243. Properties:
  2244. - bool empty (readonly)
  2245. ### Quaternion
  2246. Methods:
  2247. - Quaternion()
  2248. - Quaternion(const Quaternion& quat)
  2249. - Quaternion(float w, float x, float y, float z)
  2250. - Quaternion(float angle, const Vector3& axis)
  2251. - Quaternion(float x, float y, float z)
  2252. - Quaternion(const Vector3& start, const Vector3& end)
  2253. - Quaternion(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  2254. - Quaternion(const Matrix3& matrix)
  2255. - ~Quaternion()
  2256. - bool operator == (const Quaternion& rhs) const
  2257. - Quaternion operator * (float rhs) const
  2258. - Quaternion operator - () const
  2259. - bool operator == (const Quaternion& rhs) const
  2260. - Quaternion operator * (float rhs) const
  2261. - Quaternion operator - () const
  2262. - Quaternion operator + (const Quaternion& rhs) const
  2263. - Quaternion operator - (const Quaternion& rhs) const
  2264. - Quaternion operator * (const Quaternion& rhs) const
  2265. - Vector3 operator * (const Vector3& rhs) const
  2266. - void FromAngleAxis(float angle, const Vector3& axis)
  2267. - void FromEulerAngles(float x, float y, float z)
  2268. - void FromRotationTo(const Vector3& start, const Vector3& end)
  2269. - void FromAxes(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  2270. - void FromRotationMatrix(const Matrix3& matrix)
  2271. - void FromLookRotation(const Vector3& direction, const Vector3& up)
  2272. - void Normalize()
  2273. - Quaternion Normalized() const
  2274. - Quaternion Inverse() const
  2275. - float LengthSquared() const
  2276. - float DotProduct(const Quaternion& rhs) const
  2277. - bool Equals(const Quaternion& rhs) const
  2278. - Quaternion Conjugate() const
  2279. - Vector3 EulerAngles() const
  2280. - float YawAngle() const
  2281. - float PitchAngle() const
  2282. - float RollAngle() const
  2283. - Matrix3 RotationMatrix() const
  2284. - Quaternion Slerp(Quaternion rhs, float t) const
  2285. - Quaternion Nlerp(Quaternion rhs, float t, bool shortestPath) const
  2286. - String ToString() const
  2287. Properties:
  2288. - float w
  2289. - float x
  2290. - float y
  2291. - float z
  2292. - static const Quaternion IDENTITY
  2293. ### Ray
  2294. Methods:
  2295. - Ray()
  2296. - Ray(const Vector3& origin, const Vector3& direction)
  2297. - Ray(const Ray& ray)
  2298. - ~Ray()
  2299. - bool operator == (const Ray& rhs) const
  2300. - void Define(const Vector3& origin, const Vector3& direction)
  2301. - Vector3 Project(const Vector3& point) const
  2302. - float Distance(const Vector3& point) const
  2303. - Vector3 ClosestPoint(const Ray& ray) const
  2304. - float HitDistance(const Plane& plane) const
  2305. - float HitDistance(const BoundingBox& box) const
  2306. - float HitDistance(const Frustum& frustum, bool solidInside = true) const
  2307. - float HitDistance(const Sphere& sphere) const
  2308. - float HitDistance(const Vector3& v0, const Vector3& v1, const Vector3& v2) const
  2309. - Ray Transformed(const Matrix3x4& transform) const
  2310. Properties:
  2311. - Vector3 origin
  2312. - Vector3 direction
  2313. ### Rect
  2314. Methods:
  2315. - Rect()
  2316. - Rect(const Rect& rect)
  2317. - Rect(const Vector2& min, const Vector2& max)
  2318. - Rect(float left, float top, float right, float bottom)
  2319. - Rect(const Vector4& vector)
  2320. - ~Rect()
  2321. - bool operator == (const Rect& rhs) const
  2322. - void Define(const Rect& rect)
  2323. - void Define(const Vector2& min, const Vector2& max)
  2324. - void Define(const Vector2& point)
  2325. - void Merge(const Vector2& point)
  2326. - void Merge(const Rect& rect)
  2327. - void Clear()
  2328. - void Clip(const Rect& rect)
  2329. - Vector2 Center() const
  2330. - Vector2 Size() const
  2331. - Vector2 HalfSize() const
  2332. - bool Equals(const Rect& rhs) const
  2333. - Intersection IsInside(const Vector2& point) const
  2334. - Vector4 ToVector4() const
  2335. - String ToString() const
  2336. Properties:
  2337. - Vector2 min
  2338. - Vector2 max
  2339. - static const Rect FULL
  2340. - static const Rect POSITIVE
  2341. - static const Rect ZERO
  2342. - Vector2 center (readonly)
  2343. - Vector2 size (readonly)
  2344. - Vector2 halfSize (readonly)
  2345. ### IntRect
  2346. Methods:
  2347. - IntRect()
  2348. - IntRect(int left, int top, int right, int bottom)
  2349. - ~IntRect()
  2350. - bool operator == (const IntRect& rhs) const
  2351. - IntVector2 Size() const
  2352. - int Width() const
  2353. - int Height() const
  2354. - Intersection IsInside(const IntVector2& point) const
  2355. Properties:
  2356. - int left
  2357. - int top
  2358. - int right
  2359. - int bottom
  2360. - static const IntRect ZERO
  2361. - IntVector2 size (readonly)
  2362. - int width (readonly)
  2363. - int height (readonly)
  2364. ### Sphere
  2365. Methods:
  2366. - Sphere()
  2367. - Sphere(const Sphere& sphere)
  2368. - Sphere(const Vector3& center, float radius)
  2369. - Sphere(const BoundingBox& box)
  2370. - Sphere(const Frustum& frustum)
  2371. - Sphere(const Polyhedron& poly)
  2372. - ~Sphere()
  2373. - bool operator == (const Sphere& rhs) const
  2374. - void Define(const Sphere& sphere)
  2375. - void Define(const Vector3& center, float radius)
  2376. - void Define(const BoundingBox& box)
  2377. - void Define(const Frustum& frustum)
  2378. - void Define(const Polyhedron& poly)
  2379. - void Merge(const Vector3& point)
  2380. - void Merge(const BoundingBox& box)
  2381. - void Merge(const Frustum& frustum)
  2382. - void Merge(const Polyhedron& poly)
  2383. - void Merge(const Sphere& sphere)
  2384. - void Clear()
  2385. - Intersection IsInside(const Vector3& point) const
  2386. - Intersection IsInside(const Sphere& sphere) const
  2387. - Intersection IsInsideFast(const Sphere& sphere) const
  2388. - Intersection IsInside(const BoundingBox& box) const
  2389. - Intersection IsInsideFast(const BoundingBox& box) const
  2390. - float Distance(const Vector3& point) const
  2391. Properties:
  2392. - Vector3 center
  2393. - float radius
  2394. - bool defined
  2395. ### StringHash
  2396. Methods:
  2397. - StringHash()
  2398. - StringHash(const StringHash& rhs)
  2399. - StringHash(unsigned value)
  2400. - StringHash(const String str)
  2401. - ~StringHash()
  2402. - StringHash operator + (const StringHash& rhs) const
  2403. - bool operator == (const StringHash& rhs) const
  2404. - bool operator < (const StringHash& rhs) const
  2405. - operator bool () const
  2406. - unsigned Value() const
  2407. - String ToString() const
  2408. - unsigned ToHash() const
  2409. - static unsigned Calculate(const char* str)
  2410. Properties:
  2411. - static const StringHash ZERO
  2412. - unsigned value (readonly)
  2413. ### ShortStringHash
  2414. Methods:
  2415. - ShortStringHash()
  2416. - ShortStringHash(const ShortStringHash& rhs)
  2417. - ShortStringHash(const StringHash& rhs)
  2418. - ShortStringHash(unsigned short value)
  2419. - ShortStringHash(const String str)
  2420. - ~ShortStringHash()
  2421. - ShortStringHash operator + (const ShortStringHash& rhs) const
  2422. - bool operator == (const ShortStringHash& rhs) const
  2423. - bool operator < (const ShortStringHash& rhs) const
  2424. - unsigned short Value() const
  2425. - static unsigned short Calculate(const char* str)
  2426. Properties:
  2427. - static const ShortStringHash ZERO
  2428. - unsigned short value (readonly)
  2429. ### Vector2
  2430. Methods:
  2431. - Vector2()
  2432. - Vector2(const Vector2& vector)
  2433. - Vector2(float x, float y)
  2434. - ~Vector2()
  2435. - bool operator == (const Vector2& rhs) const
  2436. - Vector2 operator + (const Vector2& rhs) const
  2437. - Vector2 operator - () const
  2438. - Vector2 operator - (const Vector2& rhs) const
  2439. - Vector2 operator * (float rhs) const
  2440. - Vector2 operator * (const Vector2& rhs) const
  2441. - Vector2 operator / (float rhs) const
  2442. - Vector2 operator / (const Vector2& rhs) const
  2443. - Vector2 operator / (const Vector2& rhs) const
  2444. - void Normalize()
  2445. - float Length() const
  2446. - float LengthSquared() const
  2447. - float DotProduct(const Vector2& rhs) const
  2448. - float AbsDotProduct(const Vector2& rhs) const
  2449. - Vector2 Abs() const
  2450. - Vector2 Lerp(const Vector2& rhs, float t) const
  2451. - bool Equals(const Vector2& rhs) const
  2452. - Vector2 Normalized() const
  2453. - String ToString() const
  2454. Properties:
  2455. - float x
  2456. - float y
  2457. - static const Vector2 ZERO
  2458. - static const Vector2 LEFT
  2459. - static const Vector2 RIGHT
  2460. - static const Vector2 UP
  2461. - static const Vector2 DOWN
  2462. - static const Vector2 ONE
  2463. ### IntVector2
  2464. Methods:
  2465. - IntVector2()
  2466. - IntVector2(int x, int y)
  2467. - IntVector2(const IntVector2& rhs)
  2468. - ~IntVector2()
  2469. - bool operator == (const IntVector2& rhs) const
  2470. - IntVector2 operator + (const IntVector2& rhs) const
  2471. - IntVector2 operator - () const
  2472. - IntVector2 operator - (const IntVector2& rhs) const
  2473. - IntVector2 operator * (int rhs) const
  2474. - IntVector2 operator / (int rhs) const
  2475. - IntVector2 operator / (int rhs) const
  2476. - String ToString() const
  2477. Properties:
  2478. - int x
  2479. - int y
  2480. - static const IntVector2 ZERO
  2481. ### Vector3
  2482. Methods:
  2483. - Vector3()
  2484. - Vector3(const Vector3& vector)
  2485. - Vector3(const Vector2& vector, float z)
  2486. - Vector3(float x, float y, float z)
  2487. - ~Vector3()
  2488. - bool operator == (const Vector3& rhs) const
  2489. - Vector3 operator + (const Vector3& rhs) const
  2490. - Vector3 operator - () const
  2491. - Vector3 operator - (const Vector3& rhs) const
  2492. - Vector3 operator * (float rhs) const
  2493. - Vector3 operator * (const Vector3& rhs) const
  2494. - Vector3 operator / (float rhs) const
  2495. - Vector3 operator / (const Vector3& rhs) const
  2496. - Vector3 operator / (const Vector3& rhs) const
  2497. - void Normalize()
  2498. - float Length() const
  2499. - float LengthSquared() const
  2500. - float DotProduct(const Vector3& rhs) const
  2501. - float AbsDotProduct(const Vector3& rhs) const
  2502. - Vector3 CrossProduct(const Vector3& rhs) const
  2503. - Vector3 Abs() const
  2504. - Vector3 Lerp(const Vector3& rhs, float t) const
  2505. - bool Equals(const Vector3& rhs) const
  2506. - float Angle(const Vector3& rhs) const
  2507. - Vector3 Normalized() const
  2508. - String ToString() const
  2509. Properties:
  2510. - float x
  2511. - float y
  2512. - float z
  2513. - static const Vector3 ZERO
  2514. - static const Vector3 LEFT
  2515. - static const Vector3 RIGHT
  2516. - static const Vector3 UP
  2517. - static const Vector3 DOWN
  2518. - static const Vector3 FORWARD
  2519. - static const Vector3 BACK
  2520. - static const Vector3 ONE
  2521. ### Vector4
  2522. Methods:
  2523. - Vector4()
  2524. - Vector4(const Vector4& vector)
  2525. - Vector4(const Vector3& vector, float w)
  2526. - Vector4(float x, float y, float z, float w)
  2527. - ~Vector4()
  2528. - bool operator == (const Vector4& rhs) const
  2529. - Vector4 operator + (const Vector4& rhs) const
  2530. - Vector4 operator - () const
  2531. - Vector4 operator - (const Vector4& rhs) const
  2532. - Vector4 operator * (float rhs) const
  2533. - Vector4 operator * (const Vector4& rhs) const
  2534. - Vector4 operator / (float rhs) const
  2535. - Vector4 operator / (const Vector4& rhs) const
  2536. - Vector4 operator / (const Vector4& rhs) const
  2537. - float DotProduct(const Vector4& rhs) const
  2538. - float AbsDotProduct(const Vector4& rhs) const
  2539. - Vector4 Abs() const
  2540. - Vector4 Lerp(const Vector4& rhs, float t) const
  2541. - bool Equals(const Vector4& rhs) const
  2542. - String ToString() const
  2543. Properties:
  2544. - float x
  2545. - float y
  2546. - float z
  2547. - float w
  2548. - static const Vector4 ZERO
  2549. - static const Vector4 ONE
  2550. ### Navigable : Component
  2551. Methods:
  2552. - void SetRecursive(bool enable)
  2553. - bool IsRecursive() const
  2554. Properties:
  2555. - bool recursive
  2556. ### NavigationGeometryInfo
  2557. Methods:
  2558. Properties:
  2559. - Component* component
  2560. - unsigned lodLevel
  2561. - Matrix3x4 transform
  2562. - BoundingBox boundingBox
  2563. ### NavigationMesh : Component
  2564. Methods:
  2565. - void SetTileSize(int size)
  2566. - void SetCellSize(float size)
  2567. - void SetCellHeight(float height)
  2568. - void SetAgentHeight(float height)
  2569. - void SetAgentRadius(float radius)
  2570. - void SetAgentMaxClimb(float maxClimb)
  2571. - void SetAgentMaxSlope(float maxSlope)
  2572. - void SetRegionMinSize(float size)
  2573. - void SetRegionMergeSize(float size)
  2574. - void SetEdgeMaxLength(float length)
  2575. - void SetEdgeMaxError(float error)
  2576. - void SetDetailSampleDistance(float distance)
  2577. - void SetDetailSampleMaxError(float error)
  2578. - void SetPadding(const Vector3& padding)
  2579. - bool Build()
  2580. - bool Build(const BoundingBox& boundingBox)
  2581. - Vector3 FindNearestPoint(const Vector3& point, const Vector3& extents = Vector3::ONE)
  2582. - Vector3 MoveAlongSurface(const Vector3& start, const Vector3& end, const Vector3& extents=Vector3::ONE, int maxVisited=3)
  2583. - const PODVector<Vector3>& FindPath(const Vector3& start, const Vector3& end, const Vector3& extents = Vector3::ONE)
  2584. - Vector3 GetRandomPoint()
  2585. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius, const Vector3& extents = Vector3::ONE)
  2586. - float GetDistanceToWall(const Vector3& point, float radius, const Vector3& extents = Vector3::ONE)
  2587. - Vector3 Raycast(const Vector3& start, const Vector3& end, const Vector3& extents = Vector3::ONE)
  2588. - void DrawDebugGeometry(bool depthTest)
  2589. - int GetTileSize() const
  2590. - float GetCellSize() const
  2591. - float GetCellHeight() const
  2592. - float GetAgentHeight() const
  2593. - float GetAgentRadius() const
  2594. - float GetAgentMaxClimb() const
  2595. - float GetAgentMaxSlope() const
  2596. - float GetRegionMinSize() const
  2597. - float GetRegionMergeSize() const
  2598. - float GetEdgeMaxLength() const
  2599. - float GetEdgeMaxError() const
  2600. - float GetDetailSampleDistance() const
  2601. - float GetDetailSampleMaxError() const
  2602. - const Vector3& GetPadding() const
  2603. - bool IsInitialized() const
  2604. - const BoundingBox& GetBoundingBox() const
  2605. - BoundingBox GetWorldBoundingBox() const
  2606. - IntVector2 GetNumTiles() const
  2607. Properties:
  2608. - int tileSize
  2609. - float cellSize
  2610. - float cellHeight
  2611. - float agentHeight
  2612. - float agentRadius
  2613. - float agentMaxClimb
  2614. - float agentMaxSlope
  2615. - float regionMinSize
  2616. - float regionMergeSize
  2617. - float edgeMaxLength
  2618. - float edgeMaxError
  2619. - float detailSampleDistance
  2620. - float detailSampleMaxError
  2621. - Vector3& padding
  2622. - bool initialized (readonly)
  2623. - BoundingBox& boundingBox (readonly)
  2624. - BoundingBox worldBoundingBox (readonly)
  2625. - IntVector2 numTiles (readonly)
  2626. ### OffMeshConnection : Component
  2627. Methods:
  2628. - void SetEndPoint(Node* node)
  2629. - void SetRadius(float radius)
  2630. - void SetBidirectional(bool enabled)
  2631. - Node* GetEndPoint() const
  2632. - float GetRadius() const
  2633. - bool IsBidirectional() const
  2634. Properties:
  2635. - Node* endPoint
  2636. - float radius
  2637. - bool bidirectional
  2638. ### RemoteEvent
  2639. Methods:
  2640. Properties:
  2641. - unsigned senderID
  2642. - StringHash eventType
  2643. - VariantMap eventData
  2644. - bool inOrder
  2645. ### Connection : Object
  2646. Methods:
  2647. - void SendMessage(int msgID, bool reliable, bool inOrder, const VectorBuffer& msg, unsigned contentID = 0)
  2648. - void SendRemoteEvent(StringHash eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  2649. - void SendRemoteEvent(const String eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  2650. - void SendRemoteEvent(Node* node, StringHash eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  2651. - void SendRemoteEvent(Node* node, const String eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  2652. - void SetScene(Scene* newScene)
  2653. - void SetIdentity(const VariantMap& identity)
  2654. - void SetControls(const Controls& newControls)
  2655. - void SetPosition(const Vector3& position)
  2656. - void SetConnectPending(bool connectPending)
  2657. - void SetLogStatistics(bool enable)
  2658. - void Disconnect(int waitMSec = 0)
  2659. - void SendServerUpdate()
  2660. - void SendClientUpdate()
  2661. - void SendRemoteEvents()
  2662. - void SendPackages()
  2663. - void ProcessPendingLatestData()
  2664. - bool ProcessMessage(int msgID, MemoryBuffer& msg)
  2665. - const VariantMap& GetIdentity() const
  2666. - Scene* GetScene() const
  2667. - const Controls& GetControls() const
  2668. - const Vector3& GetPosition() const
  2669. - bool IsClient() const
  2670. - bool IsConnected() const
  2671. - bool IsConnectPending() const
  2672. - bool IsSceneLoaded() const
  2673. - bool GetLogStatistics() const
  2674. - String GetAddress() const
  2675. - unsigned short GetPort() const
  2676. - String ToString() const
  2677. - unsigned GetNumDownloads() const
  2678. - const String GetDownloadName() const
  2679. - float GetDownloadProgress() const
  2680. Properties:
  2681. - VariantMap& identity
  2682. - Scene* scene
  2683. - Controls& controls
  2684. - Vector3& position
  2685. - bool client (readonly)
  2686. - bool connected (readonly)
  2687. - bool connectPending
  2688. - bool sceneLoaded (readonly)
  2689. - bool logStatistics
  2690. - String address (readonly)
  2691. - unsigned short port (readonly)
  2692. - unsigned numDownloads (readonly)
  2693. - String downloadName (readonly)
  2694. - float downloadProgress (readonly)
  2695. ### Controls
  2696. Methods:
  2697. - Controls()
  2698. - void Reset()
  2699. - void Set(unsigned buttons, bool down = true)
  2700. - bool IsDown(unsigned button) const
  2701. - bool IsPressed(unsigned button, const Controls& previousControls) const
  2702. Properties:
  2703. - unsigned buttons
  2704. - float yaw
  2705. - float pitch
  2706. - VariantMap extraData
  2707. ### HttpRequest : Deserializer
  2708. Methods:
  2709. - const String GetURL() const
  2710. - const String GetVerb() const
  2711. - String GetError() const
  2712. - HttpRequestState GetState() const
  2713. - unsigned GetAvailableSize() const
  2714. - bool IsOpen() const
  2715. Properties:
  2716. - String URL (readonly)
  2717. - String verb (readonly)
  2718. - String error (readonly)
  2719. - HttpRequestState state (readonly)
  2720. - unsigned availableSize (readonly)
  2721. - bool open (readonly)
  2722. ### SharedPtr
  2723. Methods:
  2724. - TOLUA_TEMPLATE_BIND(T, HttpRequest)
  2725. - SharedPtr()
  2726. - ~SharedPtr()
  2727. - bool Null() const
  2728. - bool NotNull() const
  2729. - T* Get() const
  2730. ### Network
  2731. Methods:
  2732. - bool Connect(const String address, unsigned short port, Scene* scene, const VariantMap& identity = Variant::emptyVariantMap)
  2733. - void Disconnect(int waitMSec = 0)
  2734. - bool StartServer(unsigned short port)
  2735. - void StopServer()
  2736. - void BroadcastMessage(int msgID, bool reliable, bool inOrder, const VectorBuffer& msg, unsigned contentID = 0)
  2737. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  2738. - void BroadcastRemoteEvent(const String eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  2739. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  2740. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  2741. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  2742. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  2743. - void SetUpdateFps(int fps)
  2744. - void RegisterRemoteEvent(StringHash eventType)
  2745. - void RegisterRemoteEvent(const String eventType)
  2746. - void UnregisterRemoteEvent(StringHash eventType)
  2747. - void UnregisterRemoteEvent(const String eventType)
  2748. - void UnregisterAllRemoteEvents()
  2749. - void SetPackageCacheDir(const String path)
  2750. - SharedPtr<HttpRequest> MakeHttpRequest(const String url, const String verb = String::EMPTY, const Vector<String>& headers = Vector<String>(), const String postData = String::EMPTY)
  2751. - int GetUpdateFps() const
  2752. - Connection* GetServerConnection() const
  2753. - bool IsServerRunning() const
  2754. - bool CheckRemoteEvent(StringHash eventType) const
  2755. - const String GetPackageCacheDir() const
  2756. Properties:
  2757. - int updateFps
  2758. - Connection* serverConnection (readonly)
  2759. - bool serverRunning (readonly)
  2760. - String packageCacheDir
  2761. ### NetworkPriority : Component
  2762. Methods:
  2763. - void SetBasePriority(float priority)
  2764. - void SetDistanceFactor(float factor)
  2765. - void SetMinPriority(float priority)
  2766. - void SetAlwaysUpdateOwner(bool enable)
  2767. - float GetBasePriority() const
  2768. - float GetDistanceFactor() const
  2769. - float GetMinPriority() const
  2770. - bool GetAlwaysUpdateOwner() const
  2771. - bool CheckUpdate(float distance, float& accumulator)
  2772. Properties:
  2773. - float basePriority
  2774. - float distanceFactor
  2775. - float minPriority
  2776. - bool alwaysUpdateOwner
  2777. ### CollisionShape : Component
  2778. Methods:
  2779. - void SetBox(const Vector3& size, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  2780. - void SetSphere(float diameter, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  2781. - void SetStaticPlane(const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  2782. - void SetCylinder(float diameter, float height, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  2783. - void SetCapsule(float diameter, float height, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  2784. - void SetCone(float diameter, float height, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  2785. - void SetTriangleMesh(Model* model, unsigned lodLevel = 0, const Vector3& scale = Vector3::ONE, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  2786. - void SetConvexHull(Model* model, unsigned lodLevel = 0, const Vector3& scale = Vector3::ONE, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  2787. - void SetTerrain()
  2788. - void SetShapeType(ShapeType type)
  2789. - void SetSize(const Vector3& size)
  2790. - void SetPosition(const Vector3& position)
  2791. - void SetRotation(const Quaternion& rotation)
  2792. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  2793. - void SetMargin(float margin)
  2794. - void SetModel(Model* model)
  2795. - void SetLodLevel(unsigned lodLevel)
  2796. - PhysicsWorld* GetPhysicsWorld() const
  2797. - ShapeType GetShapeType() const
  2798. - const Vector3& GetSize() const
  2799. - const Vector3& GetPosition() const
  2800. - const Quaternion& GetRotation() const
  2801. - float GetMargin() const
  2802. - Model* GetModel() const
  2803. - unsigned GetLodLevel() const
  2804. - BoundingBox GetWorldBoundingBox() const
  2805. Properties:
  2806. - PhysicsWorld* physicsWorld (readonly)
  2807. - ShapeType shapeType
  2808. - Vector3& size
  2809. - Vector3& position
  2810. - Quaternion& rotation
  2811. - float margin
  2812. - Model* model
  2813. - unsigned lodLevel
  2814. - tolua_readonlyBoundingBox worldBoundingBox (readonly)
  2815. - ResourceRef modelAttr
  2816. ### Constraint : Component
  2817. Methods:
  2818. - void SetConstraintType(ConstraintType type)
  2819. - void SetOtherBody(RigidBody* body)
  2820. - void SetPosition(const Vector3& position)
  2821. - void SetRotation(const Quaternion& rotation)
  2822. - void SetAxis(const Vector3& axis)
  2823. - void SetOtherPosition(const Vector3& position)
  2824. - void SetOtherRotation(const Quaternion& rotation)
  2825. - void SetOtherAxis(const Vector3& axis)
  2826. - void SetWorldPosition(const Vector3& position)
  2827. - void SetHighLimit(const Vector2& limit)
  2828. - void SetLowLimit(const Vector2& limit)
  2829. - void SetERP(float erp)
  2830. - void SetCFM(float cfm)
  2831. - void SetDisableCollision(bool disable)
  2832. - PhysicsWorld* GetPhysicsWorld() const
  2833. - ConstraintType GetConstraintType() const
  2834. - RigidBody* GetOwnBody() const
  2835. - RigidBody* GetOtherBody() const
  2836. - const Vector3& GetPosition() const
  2837. - const Quaternion& GetRotation() const
  2838. - const Vector3& GetOtherPosition() const
  2839. - const Quaternion& GetOtherRotation() const
  2840. - Vector3 GetWorldPosition() const
  2841. - const Vector2& GetHighLimit() const
  2842. - const Vector2& GetLowLimit() const
  2843. - float GetERP() const
  2844. - float GetCFM() const
  2845. - bool GetDisableCollision() const
  2846. Properties:
  2847. - PhysicsWorld* physicsWorld (readonly)
  2848. - ConstraintType constraintType
  2849. - RigidBody* ownBody (readonly)
  2850. - RigidBody* otherBody
  2851. - Vector3& position
  2852. - Quaternion& rotation
  2853. - Vector3& otherPosition
  2854. - Quaternion& otherRotation
  2855. - Vector3 worldPosition
  2856. - Vector2& highLimit
  2857. - Vector2& lowLimit
  2858. - float ERP
  2859. - float CFM
  2860. - bool disableCollision
  2861. ### PhysicsRaycastResult
  2862. Methods:
  2863. - PhysicsRaycastResult()
  2864. Properties:
  2865. - Vector3 position
  2866. - Vector3 normal
  2867. - float distance
  2868. - RigidBody* body
  2869. ### PhysicsWorld : Component
  2870. Methods:
  2871. - void Update(float timeStep)
  2872. - void UpdateCollisions()
  2873. - void SetFps(int fps)
  2874. - void SetGravity(Vector3 gravity)
  2875. - void SetNumIterations(int num)
  2876. - void SetInterpolation(bool enable)
  2877. - void SetInternalEdge(bool enable)
  2878. - void SetSplitImpulse(bool enable)
  2879. - void SetMaxNetworkAngularVelocity(float velocity)
  2880. - const PODVector<PhysicsRaycastResult>& Raycast(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  2881. - PhysicsRaycastResult RaycastSingle(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  2882. - PhysicsRaycastResult SphereCast(const Ray& ray, float radius, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  2883. - void DrawDebugGeometry(bool depthTest)
  2884. - void RemoveCachedGeometry(Model* model)
  2885. - Vector3 GetGravity() const
  2886. - int GetNumIterations() const
  2887. - bool GetInterpolation() const
  2888. - bool GetInternalEdge() const
  2889. - bool GetSplitImpulse() const
  2890. - int GetFps() const
  2891. - float GetMaxNetworkAngularVelocity() const
  2892. Properties:
  2893. - Vector3 gravity
  2894. - int numIterations
  2895. - bool interpolation
  2896. - bool internalEdge
  2897. - bool splitImpulse
  2898. - int fps
  2899. - float maxNetworkAngularVelocity
  2900. - bool applyingTransforms
  2901. ### RigidBody : Component
  2902. Methods:
  2903. - void SetMass(float mass)
  2904. - void SetPosition(Vector3 position)
  2905. - void SetRotation(Quaternion rotation)
  2906. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  2907. - void SetLinearVelocity(Vector3 velocity)
  2908. - void SetLinearFactor(Vector3 factor)
  2909. - void SetLinearRestThreshold(float threshold)
  2910. - void SetLinearDamping(float damping)
  2911. - void SetAngularVelocity(Vector3 angularVelocity)
  2912. - void SetAngularFactor(Vector3 factor)
  2913. - void SetAngularRestThreshold(float threshold)
  2914. - void SetAngularDamping(float factor)
  2915. - void SetFriction(float friction)
  2916. - void SetAnisotropicFriction(Vector3 friction)
  2917. - void SetRollingFriction(float friction)
  2918. - void SetRestitution(float restitution)
  2919. - void SetContactProcessingThreshold(float threshold)
  2920. - void SetCcdRadius(float radius)
  2921. - void SetCcdMotionThreshold(float threshold)
  2922. - void SetUseGravity(bool enable)
  2923. - void SetGravityOverride(const Vector3& gravity)
  2924. - void SetKinematic(bool enable)
  2925. - void SetPhantom(bool enable)
  2926. - void SetCollisionLayer(unsigned layer)
  2927. - void SetCollisionMask(unsigned mask)
  2928. - void SetCollisionLayerAndMask(unsigned layer, unsigned mask)
  2929. - void SetCollisionEventMode(CollisionEventMode mode)
  2930. - void ApplyForce(const Vector3& force)
  2931. - void ApplyForce(const Vector3& force, const Vector3& position)
  2932. - void ApplyTorque(const Vector3& torque)
  2933. - void ApplyImpulse(const Vector3& impulse)
  2934. - void ApplyImpulse(const Vector3& impulse, const Vector3& position)
  2935. - void ApplyTorqueImpulse(const Vector3& torque)
  2936. - void ResetForces()
  2937. - void Activate()
  2938. - void ReAddBodyToWorld()
  2939. - PhysicsWorld* GetPhysicsWorld() const
  2940. - float GetMass() const
  2941. - Vector3 GetPosition() const
  2942. - Quaternion GetRotation() const
  2943. - Vector3 GetLinearVelocity() const
  2944. - Vector3 GetLinearFactor() const
  2945. - Vector3 GetVelocityAtPoint(const Vector3& position) const
  2946. - float GetLinearRestThreshold() const
  2947. - float GetLinearDamping() const
  2948. - Vector3 GetAngularVelocity() const
  2949. - Vector3 GetAngularFactor() const
  2950. - float GetAngularRestThreshold() const
  2951. - float GetAngularDamping() const
  2952. - float GetFriction() const
  2953. - Vector3 GetAnisotropicFriction() const
  2954. - float GetRollingFriction() const
  2955. - float GetRestitution() const
  2956. - float GetContactProcessingThreshold() const
  2957. - float GetCcdRadius() const
  2958. - float GetCcdMotionThreshold() const
  2959. - bool GetUseGravity() const
  2960. - const Vector3& GetGravityOverride() const
  2961. - const Vector3& GetCenterOfMass() const
  2962. - bool IsKinematic() const
  2963. - bool IsPhantom() const
  2964. - bool IsActive() const
  2965. - unsigned GetCollisionLayer() const
  2966. - unsigned GetCollisionMask() const
  2967. - CollisionEventMode GetCollisionEventMode() const
  2968. Properties:
  2969. - PhysicsWorld* physicsWorld (readonly)
  2970. - float mass
  2971. - Vector3 position
  2972. - Quaternion rotation
  2973. - Vector3 linearVelocity
  2974. - Vector3 linearFactor
  2975. - float linearRestThreshold
  2976. - float linearDamping
  2977. - Vector3 angularVelocity
  2978. - Vector3 angularFactor
  2979. - float angularRestThreshold
  2980. - float angularDamping
  2981. - float friction
  2982. - Vector3 anisotropicFriction
  2983. - float rollingFriction
  2984. - float restitution
  2985. - float contactProcessingThreshold
  2986. - float ccdRadius
  2987. - float ccdMotionThreshold
  2988. - bool useGravity
  2989. - Vector3& gravityOverride
  2990. - Vector3& centerOfMass (readonly)
  2991. - bool kinematic
  2992. - bool phantom
  2993. - bool active (readonly)
  2994. - unsigned collisionLayer
  2995. - unsigned collisionMask
  2996. - CollisionEventMode collisionEventMode
  2997. ### Resource
  2998. Methods:
  2999. - bool Load(Deserializer& source)
  3000. - bool Save(Serializer& dest) const
  3001. - bool Load(const String fileName)
  3002. - bool Save(const String fileName) const
  3003. - const String GetName() const
  3004. - StringHash GetNameHash() const
  3005. - unsigned GetMemoryUse() const
  3006. Properties:
  3007. - String name (readonly)
  3008. - StringHash nameHash (readonly)
  3009. - unsigned memoryUse (readonly)
  3010. ### Image : Resource
  3011. Methods:
  3012. - Image()
  3013. - ~Image()
  3014. - bool SetSize(int width, int height, unsigned components)
  3015. - bool SetSize(int width, int height, int depth, unsigned components)
  3016. - void SetPixel(int x, int y, const Color& color)
  3017. - void SetPixel(int x, int y, int z, const Color& color)
  3018. - bool LoadColorLUT(Deserializer& source)
  3019. - bool LoadColorLUT(const String fileName)
  3020. - void FlipVertical()
  3021. - bool Resize(int width, int height)
  3022. - void Clear(const Color& color)
  3023. - bool SaveBMP(const String fileName) const
  3024. - bool SavePNG(const String fileName) const
  3025. - bool SaveTGA(const String fileName) const
  3026. - bool SaveJPG(const String fileName, int quality) const
  3027. - Color GetPixel(int x, int y) const
  3028. - Color GetPixel(int x, int y, int z) const
  3029. - Color GetPixelBilinear(float x, float y) const
  3030. - Color GetPixelTrilinear(float x, float y, float z) const
  3031. - int GetWidth() const
  3032. - int GetHeight() const
  3033. - int GetDepth() const
  3034. - unsigned GetComponents() const
  3035. - bool IsCompressed() const
  3036. - CompressedFormat GetCompressedFormat() const
  3037. - unsigned GetNumCompressedLevels() const
  3038. - CompressedLevel GetCompressedLevel(unsigned index) const
  3039. Properties:
  3040. - int width (readonly)
  3041. - int height (readonly)
  3042. - int depth (readonly)
  3043. - unsigned components (readonly)
  3044. - bool compressed (readonly)
  3045. - CompressedFormat compressedFormat (readonly)
  3046. - unsigned numCompressedLevels (readonly)
  3047. ### ResourceCache
  3048. Methods:
  3049. - void ReleaseAllResources(bool force = false)
  3050. - bool ReloadResource(Resource* resource)
  3051. - void SetMemoryBudget(ShortStringHash type, unsigned budget)
  3052. - void SetMemoryBudget(const String type, unsigned budget)
  3053. - void SetAutoReloadResources(bool enable)
  3054. - void SetSearchPackagesFirst(bool value)
  3055. - File* GetFile(const String name)
  3056. - Resource* GetResource(const String type, const String name)
  3057. - bool Exists(const String name) const
  3058. - unsigned GetMemoryBudget(ShortStringHash type) const
  3059. - unsigned GetMemoryUse(ShortStringHash type) const
  3060. - unsigned GetTotalMemoryUse() const
  3061. - String GetResourceFileName(const String name) const
  3062. - bool GetAutoReloadResources() const
  3063. - bool GetSearchPackagesFirst() const
  3064. - String GetPreferredResourceDir(const String path) const
  3065. - String SanitateResourceName(const String name) const
  3066. - String SanitateResourceDirName(const String name) const
  3067. Properties:
  3068. - unsigned totalMemoryUse (readonly)
  3069. - bool autoReloadResources (readonly)
  3070. - bool searchPackagesFirst (readonly)
  3071. ### XMLElement
  3072. Methods:
  3073. - XMLElement CreateChild(const String name)
  3074. - bool RemoveChild(const XMLElement& element)
  3075. - bool RemoveChild(const String name)
  3076. - bool RemoveChildren(const String name = String::EMPTY)
  3077. - bool RemoveAttribute(const String name = String::EMPTY)
  3078. - bool SetValue(const String value)
  3079. - bool SetAttribute(const String name, const String value)
  3080. - bool SetBool(const String name, bool value)
  3081. - bool SetBoundingBox(const BoundingBox& value)
  3082. - bool SetColor(const String name, const Color& value)
  3083. - bool SetFloat(const String name, float value)
  3084. - bool SetUInt(const String name, unsigned value)
  3085. - bool SetInt(const String name, int value)
  3086. - bool SetIntRect(const String name, const IntRect& value)
  3087. - bool SetIntVector2(const String name, const IntVector2& value)
  3088. - bool SetRect(const String name, const Rect& value)
  3089. - bool SetQuaternion(const String name, const Quaternion& value)
  3090. - bool SetString(const String name, const String value)
  3091. - bool SetVariant(const Variant& value)
  3092. - bool SetVariantValue(const Variant& value)
  3093. - bool SetResourceRef(const ResourceRef& value)
  3094. - bool SetResourceRefList(const ResourceRefList& value)
  3095. - bool SetVector2(const String name, const Vector2& value)
  3096. - bool SetVector3(const String name, const Vector3& value)
  3097. - bool SetVector4(const String name, const Vector4& value)
  3098. - bool SetVectorVariant(const String name, const Variant& value)
  3099. - bool IsNull() const
  3100. - bool NotNull() const
  3101. - operator bool () const
  3102. - String GetName() const
  3103. - bool HasChild(const String name) const
  3104. - XMLElement GetChild(const String name = String::EMPTY) const
  3105. - XMLElement GetNext(const String name = String::EMPTY) const
  3106. - XMLElement GetParent() const
  3107. - unsigned GetNumAttributes() const
  3108. - bool HasAttribute(const String name) const
  3109. - bool GetBool(const String name) const
  3110. - BoundingBox GetBoundingBox() const
  3111. - String GetValue() const
  3112. - Color GetColor(const String name) const
  3113. - float GetFloat(const String name) const
  3114. - unsigned GetUInt(const String name) const
  3115. - int GetInt(const String name) const
  3116. - IntRect GetIntRect(const String name) const
  3117. - IntVector2 GetIntVector2(const String name) const
  3118. - Rect GetRect(const String name) const
  3119. - Quaternion GetQuaternion(const String name) const
  3120. - Variant GetVariant() const
  3121. - Variant GetVariantValue(VariantType type) const
  3122. - ResourceRef GetResourceRef() const
  3123. - ResourceRefList GetResourceRefList() const
  3124. - VariantMap GetVariantMap() const
  3125. - Vector2 GetVector2(const String name) const
  3126. - Vector3 GetVector3(const String name) const
  3127. - Vector4 GetVector4(const String name) const
  3128. - Vector4 GetVector(const String name) const
  3129. - XMLFile* GetFile() const
  3130. Properties:
  3131. - static const XMLElement EMPTY
  3132. - bool null (readonly)
  3133. - String name (readonly)
  3134. - String value (readonly)
  3135. - XMLElement parent (readonly)
  3136. - unsigned numAttributes (readonly)
  3137. - XMLFile* file (readonly)
  3138. ### XMLFile : Resource
  3139. Methods:
  3140. - XMLFile()
  3141. - ~XMLFile()
  3142. - XMLElement CreateRoot(const String name = String::EMPTY)
  3143. - XMLElement GetRoot(const String name = String::EMPTY)
  3144. - void Patch(XMLFile* patchFile)
  3145. - void Patch(XMLElement patchElement)
  3146. ### Serializable : Object
  3147. Methods:
  3148. - void SetTemporary(bool enable)
  3149. - bool IsTemporary() const
  3150. Properties:
  3151. - bool temporary
  3152. ### Component : Serializable
  3153. Methods:
  3154. - void SetEnabled(bool enable)
  3155. - void Remove()
  3156. - unsigned GetID() const
  3157. - Node* GetNode() const
  3158. - Scene* GetScene() const
  3159. - bool IsEnabled() const
  3160. - bool IsEnabledEffective() const
  3161. - Component* GetComponent(ShortStringHash type) const
  3162. - Component* GetComponent(const String type) const
  3163. ### Node : Serializable
  3164. Methods:
  3165. - Node()
  3166. - virtual ~Node()
  3167. - bool SaveXML(File* dest) const
  3168. - void SetName(const String name)
  3169. - void SetPosition(const Vector3& position)
  3170. - void SetPositionXYZ(float x, float y, float z)
  3171. - void SetRotation(const Quaternion& rotation)
  3172. - void SetRotationXYZ(float x, float y, float z)
  3173. - void SetDirection(const Vector3& direction)
  3174. - void SetDirectionXYZ(float x, float y, float z)
  3175. - void SetScale(float scale)
  3176. - void SetScale(const Vector3& scale)
  3177. - void SetScaleXYZ(float x, float y, float z)
  3178. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  3179. - void SetTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3180. - void SetTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3181. - void SetWorldPosition(const Vector3& position)
  3182. - void SetWorldPositionXYZ(float x, float y, float z)
  3183. - void SetWorldRotation(const Quaternion& rotation)
  3184. - void SetWorldRotationXYZ(float x, float y, float z)
  3185. - void SetWorldDirection(const Vector3& direction)
  3186. - void SetWorldDirectionXYZ(float x, float y, float z)
  3187. - void SetWorldScale(float scale)
  3188. - void SetWorldScale(const Vector3& scale)
  3189. - void SetWorldScaleXYZ(float x, float y, float z)
  3190. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation)
  3191. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3192. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3193. - void Translate(const Vector3& delta)
  3194. - void TranslateXYZ(float x, float y, float z)
  3195. - void TranslateRelative(const Vector3& delta)
  3196. - void TranslateRelativeXYZ(float x, float y, float z)
  3197. - void Rotate(const Quaternion& delta, bool fixedAxis = false)
  3198. - void RotateXYZ(float x, float y, float z, bool fixedAxis = false)
  3199. - void Pitch(float angle, bool fixedAxis = false)
  3200. - void Yaw(float angle, bool fixedAxis = false)
  3201. - void Roll(float angle, bool fixedAxis = false)
  3202. - void LookAt(const Vector3& target, const Vector3& upAxis = Vector3::UP)
  3203. - void LookAtXYZ(float x, float y, float z, float upX = 0.0f, float upY = 1.0f, float upZ = 0.0f)
  3204. - void Scale(float scale)
  3205. - void Scale(const Vector3& scale)
  3206. - void ScaleXYZ(float x, float y, float z)
  3207. - void SetEnabled(bool enable)
  3208. - void SetEnabled(bool enable, bool recursive)
  3209. - void SetOwner(Connection* owner)
  3210. - void MarkDirty()
  3211. - Node* CreateChild(const String name = String::EMPTY, CreateMode mode = REPLICATED, unsigned id = 0)
  3212. - void AddChild(Node* node)
  3213. - void RemoveChild(Node* node)
  3214. - void RemoveAllChildren()
  3215. - void RemoveChildren(bool removeReplicated, bool removeLocal, bool recursive)
  3216. - void RemoveComponent(Component* component)
  3217. - void RemoveComponent(ShortStringHash type)
  3218. - void RemoveComponent(const String type)
  3219. - void RemoveAllComponents()
  3220. - void RemoveComponents(bool removeReplicated, bool removeLocal)
  3221. - Node* Clone(CreateMode mode = REPLICATED)
  3222. - void Remove()
  3223. - void SetParent(Node* parent)
  3224. - void SetVar(ShortStringHash key, const Variant& value)
  3225. - void AddListener(Component* component)
  3226. - void RemoveListener(Component* component)
  3227. - Component* CreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  3228. - int CreateScriptObject(const String scriptObjectType)
  3229. - int CreateScriptObject(const String fileName, const String scriptObjectType)
  3230. - int GetScriptObject() const
  3231. - int GetScriptObject(const String scriptObjectType) const
  3232. - unsigned GetID() const
  3233. - const String GetName() const
  3234. - StringHash GetNameHash() const
  3235. - Node* GetParent() const
  3236. - Scene* GetScene() const
  3237. - bool IsEnabled() const
  3238. - Connection* GetOwner() const
  3239. - const Vector3& GetPosition() const
  3240. - void GetPositionXYZ(float* x = 0.0f, float* y = 0.0f, float* z = 0.0f) const
  3241. - const Quaternion& GetRotation() const
  3242. - void GetRotationXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3243. - void GetRotationWXYZ(float* *w = 0.0f, float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3244. - Vector3 GetDirection() const
  3245. - void GetDirectionXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3246. - Vector3 GetUp() const
  3247. - void GetUpXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3248. - Vector3 GetRight() const
  3249. - void GetRightXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3250. - const Vector3& GetScale() const
  3251. - void GetScaleXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3252. - Matrix3x4 GetTransform() const
  3253. - Vector3 GetWorldPosition() const
  3254. - void GetWorldPositionXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3255. - Quaternion GetWorldRotation() const
  3256. - void GetWorldRotationXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3257. - void GetWorldRotationWXYZ(float* *w = 0.0f, float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3258. - Vector3 GetWorldDirection() const
  3259. - void GetWorldDirectionXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3260. - Vector3 GetWorldUp() const
  3261. - void GetWorldUpXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3262. - Vector3 GetWorldRight() const
  3263. - void GetWorldRightXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3264. - Vector3 GetWorldScale() const
  3265. - void GetWorldScaleXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3266. - const Matrix3x4& GetWorldTransform() const
  3267. - Vector3 LocalToWorld(const Vector3& position) const
  3268. - Vector3 LocalToWorld(const Vector4& vector) const
  3269. - Vector3 WorldToLocal(const Vector3& position) const
  3270. - Vector3 WorldToLocal(const Vector4& vector) const
  3271. - bool IsDirty() const
  3272. - unsigned GetNumChildren(bool recursive = false) const
  3273. - Node* GetChild(unsigned index) const
  3274. - Node* GetChild(const String name, bool recursive = false) const
  3275. - Node* GetChild(StringHash nameHash, bool recursive = false) const
  3276. - unsigned GetNumComponents() const
  3277. - unsigned GetNumNetworkComponents() const
  3278. - bool HasComponent(ShortStringHash type) const
  3279. - bool HasComponent(const String type) const
  3280. - const Variant& GetVar(ShortStringHash key) const
  3281. - const VariantMap& GetVars() const
  3282. - Component* GetComponent(const String type) const
  3283. - void SetID(unsigned id)
  3284. - void SetScene(Scene* scene)
  3285. - void ResetScene()
  3286. - bool Load(Deserializer& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3287. - bool LoadXML(const XMLElement& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3288. - Node* CreateChild(unsigned id, CreateMode mode)
  3289. - void AddComponent(Component* component, unsigned id, CreateMode mode)
  3290. Properties:
  3291. - unsigned ID
  3292. - String name
  3293. - StringHash nameHash (readonly)
  3294. - Node* parent
  3295. - Scene* scene
  3296. - bool enabled
  3297. - Connection* owner
  3298. - Vector3& position
  3299. - Quaternion& rotation
  3300. - Vector3 direction
  3301. - Vector3 up (readonly)
  3302. - Vector3 right (readonly)
  3303. - Vector3& scale
  3304. - Matrix3x4 transform (readonly)
  3305. - Vector3 worldPosition
  3306. - Quaternion worldRotation
  3307. - Vector3 worldDirection
  3308. - Vector3 worldUp (readonly)
  3309. - Vector3 worldRight (readonly)
  3310. - Vector3 worldScale
  3311. - Matrix3x4& worldTransform (readonly)
  3312. - bool dirty (readonly)
  3313. - unsigned numComponents (readonly)
  3314. - unsigned numNetworkComponents (readonly)
  3315. ### Scene : Node
  3316. Methods:
  3317. - Scene()
  3318. - virtual ~Scene()
  3319. - bool Load(File* source)
  3320. - bool Save(File* dest) const
  3321. - bool Load(const String fileName)
  3322. - bool Save(const String fileName) const
  3323. - bool LoadXML(File* source)
  3324. - bool SaveXML(File* dest) const
  3325. - bool LoadXML(const String fileName)
  3326. - bool SaveXML(const String fileName) const
  3327. - Node* Instantiate(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  3328. - Node* Instantiate(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  3329. - Node* InstantiateXML(File* source, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  3330. - Node* InstantiateXML(const String fileName, const Vector3& position, const Quaternion& rotation, CreateMode mode = REPLICATED)
  3331. - bool LoadAsync(File* file)
  3332. - bool LoadAsyncXML(File* file)
  3333. - void StopAsyncLoading()
  3334. - void Clear(bool clearReplicated = true, bool clearLocal = true)
  3335. - void SetUpdateEnabled(bool enable)
  3336. - void SetTimeScale(float scale)
  3337. - void SetElapsedTime(float time)
  3338. - void SetSmoothingConstant(float constant)
  3339. - void SetSnapThreshold(float threshold)
  3340. - Node* GetNode(unsigned id) const
  3341. - bool IsUpdateEnabled() const
  3342. - bool IsAsyncLoading() const
  3343. - float GetAsyncProgress() const
  3344. - const String GetFileName() const
  3345. - unsigned GetChecksum() const
  3346. - float GetTimeScale() const
  3347. - float GetElapsedTime() const
  3348. - float GetSmoothingConstant() const
  3349. - float GetSnapThreshold() const
  3350. - const String GetVarName(ShortStringHash hash) const
  3351. - void Update(float timeStep)
  3352. - void BeginThreadedUpdate()
  3353. - void EndThreadedUpdate()
  3354. - void DelayedMarkedDirty(Component* component)
  3355. - bool IsThreadedUpdate() const
  3356. - unsigned GetFreeNodeID(CreateMode mode)
  3357. - unsigned GetFreeComponentID(CreateMode mode)
  3358. - void NodeAdded(Node* node)
  3359. - void NodeRemoved(Node* node)
  3360. - void ComponentAdded(Component* component)
  3361. - void ComponentRemoved(Component* component)
  3362. - void SetVarNamesAttr(String value)
  3363. - String GetVarNamesAttr() const
  3364. - void PrepareNetworkUpdate()
  3365. - void CleanupConnection(Connection* connection)
  3366. - void MarkNetworkUpdate(Node* node)
  3367. - void MarkNetworkUpdate(Component* component)
  3368. - void MarkReplicationDirty(Node* node)
  3369. Properties:
  3370. - bool updateEnabled
  3371. - bool asyncLoading (readonly)
  3372. - float asyncProgress (readonly)
  3373. - const String fileName
  3374. - unsigned checksum (readonly)
  3375. - float timeScale
  3376. - float elapsedTime
  3377. - float smoothingConstant
  3378. - float snapThreshold
  3379. - bool threadedUpdate (readonly)
  3380. - String varNamesAttr
  3381. ### Spline : Component
  3382. Methods:
  3383. - void SetInterpolationMode(InterpolationMode interpolationMode)
  3384. - void SetSpeed(float speed)
  3385. - void SetPosition(float factor)
  3386. - InterpolationMode GetInterpolationMode() const
  3387. - float GetSpeed() const
  3388. - Vector3 GetPosition() const
  3389. - void Push(const Vector3& controlPoint)
  3390. - void Pop()
  3391. - Vector3 GetPoint(float factor) const
  3392. - void Move(float timeStep)
  3393. - void Reset()
  3394. - bool IsFinished() const
  3395. Properties:
  3396. - InterpolationMode interpolationMode
  3397. - float speed
  3398. ### UIElement : Serializable
  3399. Methods:
  3400. - UIElement()
  3401. - virtual ~UIElement()
  3402. - virtual const IntVector2& GetScreenPosition() const
  3403. - bool LoadXML(Deserializer& source)
  3404. - bool SaveXML(Serializer& dest) const
  3405. - bool LoadXML(const String fileName)
  3406. - bool SaveXML(const String fileName) const
  3407. - bool FilterAttributes(XMLElement& dest) const
  3408. - void SetName(const String name)
  3409. - void SetPosition(const IntVector2& position)
  3410. - void SetPosition(int x, int y)
  3411. - void SetSize(const IntVector2& size)
  3412. - void SetSize(int width, int height)
  3413. - void SetWidth(int width)
  3414. - void SetHeight(int height)
  3415. - void SetMinSize(const IntVector2& minSize)
  3416. - void SetMinSize(int width, int height)
  3417. - void SetMinWidth(int width)
  3418. - void SetMinHeight(int height)
  3419. - void SetMaxSize(const IntVector2& maxSize)
  3420. - void SetMaxSize(int width, int height)
  3421. - void SetMaxWidth(int width)
  3422. - void SetMaxHeight(int height)
  3423. - void SetFixedSize(const IntVector2& size)
  3424. - void SetFixedSize(int width, int height)
  3425. - void SetFixedWidth(int width)
  3426. - void SetFixedHeight(int height)
  3427. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  3428. - void SetHorizontalAlignment(HorizontalAlignment align)
  3429. - void SetVerticalAlignment(VerticalAlignment align)
  3430. - void SetClipBorder(const IntRect& rect)
  3431. - void SetColor(const Color& color)
  3432. - void SetColor(Corner corner, const Color& color)
  3433. - void SetPriority(int priority)
  3434. - void SetOpacity(float opacity)
  3435. - void SetBringToFront(bool enable)
  3436. - void SetBringToBack(bool enable)
  3437. - void SetClipChildren(bool enable)
  3438. - void SetSortChildren(bool enable)
  3439. - void SetUseDerivedOpacity(bool enable)
  3440. - void SetEnabled(bool enable)
  3441. - void SetEditable(bool enable)
  3442. - void SetFocus(bool enable)
  3443. - void SetSelected(bool enable)
  3444. - void SetVisible(bool enable)
  3445. - void SetFocusMode(FocusMode mode)
  3446. - void SetDragDropMode(unsigned mode)
  3447. - bool SetStyle(const String styleName, XMLFile* file = 0)
  3448. - bool SetStyle(const XMLElement& element)
  3449. - bool SetStyleAuto(XMLFile* file = 0)
  3450. - void SetDefaultStyle(XMLFile* style)
  3451. - void SetLayout(LayoutMode mode, int spacing = 0, const IntRect& border = IntRect::ZERO)
  3452. - void SetLayoutMode(LayoutMode mode)
  3453. - void SetLayoutSpacing(int spacing)
  3454. - void SetLayoutBorder(const IntRect& border)
  3455. - void SetIndent(int indent)
  3456. - void SetIndentSpacing(int indentSpacing)
  3457. - void UpdateLayout()
  3458. - void DisableLayoutUpdate()
  3459. - void EnableLayoutUpdate()
  3460. - void BringToFront()
  3461. - UIElement* CreateChild(const String type, const String name = String::EMPTY, unsigned index = M_MAX_UNSIGNED)
  3462. - void AddChild(UIElement* element)
  3463. - void InsertChild(unsigned index, UIElement* element)
  3464. - void RemoveChild(UIElement* element, unsigned index = 0)
  3465. - void RemoveChildAtIndex(unsigned index)
  3466. - void RemoveAllChildren()
  3467. - void Remove()
  3468. - unsigned FindChild(UIElement* element) const
  3469. - void SetParent(UIElement* parent, unsigned index = M_MAX_UNSIGNED)
  3470. - void SetVar(ShortStringHash key, const Variant& value)
  3471. - void SetInternal(bool enable)
  3472. - void SetTraversalMode(TraversalMode traversalMode)
  3473. - void SetElementEventSender(bool flag)
  3474. - const String GetName() const
  3475. - const IntVector2& GetPosition() const
  3476. - const IntVector2& GetSize() const
  3477. - int GetWidth() const
  3478. - int GetHeight() const
  3479. - const IntVector2& GetMinSize() const
  3480. - int GetMinWidth() const
  3481. - int GetMinHeight() const
  3482. - const IntVector2& GetMaxSize() const
  3483. - int GetMaxWidth() const
  3484. - int GetMaxHeight() const
  3485. - bool IsFixedSize() const
  3486. - bool IsFixedWidth() const
  3487. - bool IsFixedHeight() const
  3488. - const IntVector2& GetChildOffset() const
  3489. - HorizontalAlignment GetHorizontalAlignment() const
  3490. - VerticalAlignment GetVerticalAlignment() const
  3491. - const IntRect& GetClipBorder() const
  3492. - const Color& GetColor(Corner corner) const
  3493. - int GetPriority() const
  3494. - float GetOpacity() const
  3495. - float GetDerivedOpacity() const
  3496. - bool GetBringToFront() const
  3497. - bool GetBringToBack() const
  3498. - bool GetClipChildren() const
  3499. - bool GetSortChildren() const
  3500. - bool GetUseDerivedOpacity() const
  3501. - bool HasFocus() const
  3502. - bool IsEnabled() const
  3503. - bool IsEditable() const
  3504. - bool IsSelected() const
  3505. - bool IsVisible() const
  3506. - bool IsHovering() const
  3507. - bool IsInternal() const
  3508. - bool HasColorGradient() const
  3509. - FocusMode GetFocusMode() const
  3510. - unsigned GetDragDropMode() const
  3511. - const String GetAppliedStyle() const
  3512. - XMLFile* GetDefaultStyle(bool recursiveUp = true) const
  3513. - LayoutMode GetLayoutMode() const
  3514. - int GetLayoutSpacing() const
  3515. - const IntRect& GetLayoutBorder() const
  3516. - unsigned GetNumChildren(bool recursive = false) const
  3517. - UIElement* GetChild(unsigned index) const
  3518. - UIElement* GetChild(const String name, bool recursive = false) const
  3519. - UIElement* GetParent() const
  3520. - UIElement* GetRoot() const
  3521. - const Color& GetDerivedColor() const
  3522. - const Variant& GetVar(ShortStringHash key) const
  3523. - const VariantMap& GetVars() const
  3524. - IntVector2 ScreenToElement(const IntVector2& screenPosition)
  3525. - IntVector2 ElementToScreen(const IntVector2& position)
  3526. - bool IsInside(IntVector2 position, bool isScreen)
  3527. - bool IsInsideCombined(IntVector2 position, bool isScreen)
  3528. - IntRect GetCombinedScreenRect()
  3529. - void SortChildren()
  3530. - int GetLayoutMinSize() const
  3531. - int GetIndent() const
  3532. - int GetIndentSpacing() const
  3533. - int GetIndentWidth() const
  3534. - void SetChildOffset(const IntVector2& offset)
  3535. - void SetHovering(bool enable)
  3536. - const Color& GetColor() const
  3537. - TraversalMode GetTraversalMode() const
  3538. - bool IsElementEventSender() const
  3539. - UIElement* GetElementEventSender() const
  3540. Properties:
  3541. - IntVector2& screenPosition (readonly)
  3542. - String name
  3543. - IntVector2& position
  3544. - IntVector2 size
  3545. - int width
  3546. - int height
  3547. - IntVector2 minSize
  3548. - int minWidth
  3549. - int minHeight
  3550. - IntVector2 maxSize
  3551. - int maxWidth
  3552. - int maxHeight
  3553. - bool fixedSize (readonly)
  3554. - bool fixedWidth (readonly)
  3555. - bool fixedHeight (readonly)
  3556. - IntVector2& childOffset
  3557. - HorizontalAlignment horizontalAlignment
  3558. - VerticalAlignment verticalAlignment
  3559. - IntRect clipBorder
  3560. - Color& colorAttr @ color
  3561. - int priority
  3562. - float opacity
  3563. - float derivedOpacity (readonly)
  3564. - bool bringToFront
  3565. - bool bringToBack
  3566. - bool clipChildren
  3567. - bool sortChildren
  3568. - bool useDerivedOpacity
  3569. - bool focus
  3570. - bool enabled
  3571. - bool editable
  3572. - bool selected
  3573. - bool visible
  3574. - bool hovering
  3575. - bool internal
  3576. - bool colorGradient (readonly)
  3577. - FocusMode focusMode
  3578. - unsigned dragDropMode
  3579. - String style
  3580. - XMLFile* defaultStyle
  3581. - LayoutMode layoutMode
  3582. - int layoutSpacing
  3583. - IntRect& layoutBorder
  3584. - unsigned numChildren (readonly)
  3585. - UIElement* parent
  3586. - UIElement* root (readonly)
  3587. - Color& derivedColor (readonly)
  3588. - IntRect combinedScreenRect (readonly)
  3589. - int layoutMinSize (readonly)
  3590. - int indent
  3591. - int indentSpacing
  3592. - int indentWidth (readonly)
  3593. - TraversalMode traversalMode
  3594. - bool elementEventSender
  3595. ### BorderImage : UIElement
  3596. Methods:
  3597. - BorderImage()
  3598. - virtual ~BorderImage()
  3599. - void SetTexture(Texture* texture)
  3600. - void SetImageRect(const IntRect& rect)
  3601. - void SetFullImageRect()
  3602. - void SetBorder(const IntRect& rect)
  3603. - void SetHoverOffset(const IntVector2& offset)
  3604. - void SetHoverOffset(int x, int y)
  3605. - void SetBlendMode(BlendMode mode)
  3606. - void SetTiled(bool enable)
  3607. - Texture* GetTexture() const
  3608. - const IntRect& GetImageRect() const
  3609. - const IntRect& GetBorder() const
  3610. - const IntVector2& GetHoverOffset() const
  3611. - BlendMode GetBlendMode() const
  3612. - bool IsTiled() const
  3613. Properties:
  3614. - Texture* texture
  3615. - IntRect& imageRect
  3616. - IntRect& border
  3617. - IntVector2& hoverOffset
  3618. - BlendMode blendMode
  3619. - bool tiled
  3620. ### Button : BorderImage
  3621. Methods:
  3622. - Button()
  3623. - virtual ~Button()
  3624. - void SetPressedOffset(const IntVector2& offset)
  3625. - void SetPressedOffset(int x, int y)
  3626. - void SetPressedChildOffset(const IntVector2& offset)
  3627. - void SetPressedChildOffset(int x, int y)
  3628. - void SetRepeat(float delay, float rate)
  3629. - void SetRepeatDelay(float delay)
  3630. - void SetRepeatRate(float rate)
  3631. - const IntVector2& GetPressedOffset() const
  3632. - const IntVector2& GetPressedChildOffset() const
  3633. - float GetRepeatDelay() const
  3634. - float GetRepeatRate() const
  3635. - bool IsPressed() const
  3636. Properties:
  3637. - IntVector2& pressedOffset
  3638. - IntVector2& pressedChildOffset
  3639. - float repeatDelay
  3640. - float repeatRate
  3641. - bool pressed (readonly)
  3642. ### CheckBox : BorderImage
  3643. Methods:
  3644. - CheckBox()
  3645. - virtual ~CheckBox()
  3646. - void SetChecked(bool enable)
  3647. - void SetCheckedOffset(const IntVector2& rect)
  3648. - void SetCheckedOffset(int x, int y)
  3649. - bool IsChecked() const
  3650. - const IntVector2& GetCheckedOffset() const
  3651. Properties:
  3652. - bool checked
  3653. - IntVector2& checkedOffset
  3654. ### Cursor : BorderImage
  3655. Methods:
  3656. - Cursor()
  3657. - virtual ~Cursor()
  3658. - void DefineShape(CursorShape shape, Image* image, const IntRect& imageRect, const IntVector2& hotSpot)
  3659. - void SetShape(CursorShape shape)
  3660. - void SetUseSystemShapes(bool enable)
  3661. - CursorShape GetShape() const
  3662. - bool GetUseSystemShapes() const
  3663. Properties:
  3664. - CursorShape shape
  3665. - bool useSystemShapes
  3666. ### FileSelectorEntry
  3667. Methods:
  3668. Properties:
  3669. - String name
  3670. - bool directory
  3671. ### FileSelector : Object
  3672. Methods:
  3673. - FileSelector()
  3674. - virtual ~FileSelector()
  3675. - void SetDefaultStyle(XMLFile* style)
  3676. - void SetTitle(const String text)
  3677. - void SetButtonTexts(const String okText, const String cancelText)
  3678. - void SetPath(const String path)
  3679. - void SetFileName(const String fileName)
  3680. - void SetFilters(const Vector<String>& filters, unsigned defaultIndex)
  3681. - void SetDirectoryMode(bool enable)
  3682. - void UpdateElements()
  3683. - XMLFile* GetDefaultStyle() const
  3684. - Window* GetWindow() const
  3685. - Text* GetTitleText() const
  3686. - ListView* GetFileList() const
  3687. - LineEdit* GetPathEdit() const
  3688. - LineEdit* GetFileNameEdit() const
  3689. - DropDownList* GetFilterList() const
  3690. - Button* GetOKButton() const
  3691. - Button* GetCancelButton() const
  3692. - Button* GetCloseButton() const
  3693. - const String GetTitle() const
  3694. - const String GetPath() const
  3695. - const String GetFileName() const
  3696. - const String GetFilter() const
  3697. - unsigned GetFilterIndex() const
  3698. - bool GetDirectoryMode() const
  3699. Properties:
  3700. - XMLFile* defaultStyle
  3701. - Window* window (readonly)
  3702. - Text* titleText (readonly)
  3703. - ListView* fileList (readonly)
  3704. - LineEdit* pathEdit (readonly)
  3705. - LineEdit* fileNameEdit (readonly)
  3706. - DropDownList* filterList (readonly)
  3707. - Button* OKButton (readonly)
  3708. - Button* cancelButton (readonly)
  3709. - Button* closeButton (readonly)
  3710. - String title
  3711. - String path
  3712. - String fileName
  3713. - String filter (readonly)
  3714. - unsigned filterIndex (readonly)
  3715. - bool directoryMode
  3716. ### Font : Resource
  3717. Methods:
  3718. ### LineEdit : BorderImage
  3719. Methods:
  3720. - LineEdit()
  3721. - virtual ~LineEdit()
  3722. - void SetText(const String text)
  3723. - void SetCursorPosition(unsigned position)
  3724. - void SetCursorBlinkRate(float rate)
  3725. - void SetMaxLength(unsigned length)
  3726. - void SetEchoCharacter(unsigned c)
  3727. - void SetCursorMovable(bool enable)
  3728. - void SetTextSelectable(bool enable)
  3729. - void SetTextCopyable(bool enable)
  3730. - const String GetText() const
  3731. - unsigned GetCursorPosition() const
  3732. - float GetCursorBlinkRate() const
  3733. - unsigned GetMaxLength() const
  3734. - unsigned GetEchoCharacter() const
  3735. - bool IsCursorMovable() const
  3736. - bool IsTextSelectable() const
  3737. - bool IsTextCopyable() const
  3738. - Text* GetTextElement() const
  3739. - BorderImage* GetCursor() const
  3740. Properties:
  3741. - String text
  3742. - unsigned cursorPosition
  3743. - float cursorBlinkRate
  3744. - unsigned maxLength
  3745. - unsigned echoCharacter
  3746. - bool cursorMovable
  3747. - bool textSelectable
  3748. - bool textCopyable
  3749. - Text* textElement (readonly)
  3750. - BorderImage* cursor (readonly)
  3751. ### Menu : Button
  3752. Methods:
  3753. - Menu()
  3754. - virtual ~Menu()
  3755. - void SetPopup(UIElement* element)
  3756. - void SetPopupOffset(const IntVector2& offset)
  3757. - void SetPopupOffset(int x, int y)
  3758. - void ShowPopup(bool enable)
  3759. - void SetAccelerator(int key, int qualifiers)
  3760. - UIElement* GetPopup() const
  3761. - const IntVector2& GetPopupOffset() const
  3762. - bool GetShowPopup() const
  3763. - int GetAcceleratorKey() const
  3764. - int GetAcceleratorQualifiers() const
  3765. Properties:
  3766. - UIElement* popup
  3767. - IntVector2& popupOffset
  3768. - bool showPopup
  3769. - int acceleratorKey (readonly)
  3770. - int acceleratorQualifiers (readonly)
  3771. ### MessageBox : Object
  3772. Methods:
  3773. - MessageBox(const String messageString = String::EMPTY, const String titleString = String::EMPTY, XMLFile* layoutFile = 0, XMLFile* styleFile = 0)
  3774. - virtual ~MessageBox()
  3775. - void SetTitle(const String text)
  3776. - void SetMessage(const String text)
  3777. - const String GetTitle() const
  3778. - const String GetMessage() const
  3779. - UIElement* GetWindow() const
  3780. Properties:
  3781. - String title
  3782. - String message
  3783. - UIElement* window (readonly)
  3784. ### DropDownList : Menu
  3785. Methods:
  3786. - DropDownList()
  3787. - ~DropDownList()
  3788. - void AddItem(UIElement* item)
  3789. - void InsertItem(unsigned index, UIElement* item)
  3790. - void RemoveItem(UIElement* item)
  3791. - void RemoveItem(unsigned index)
  3792. - void RemoveAllItems()
  3793. - void SetSelection(unsigned index)
  3794. - void SetPlaceholderText(const String text)
  3795. - void SetResizePopup(bool enable)
  3796. - unsigned GetNumItems() const
  3797. - UIElement* GetItem(unsigned index) const
  3798. - const PODVector<UIElement*>& GetItems() const
  3799. - unsigned GetSelection() const
  3800. - UIElement* GetSelectedItem() const
  3801. - ListView* GetListView() const
  3802. - UIElement* GetPlaceholder() const
  3803. - const String GetPlaceholderText() const
  3804. - bool GetResizePopup() const
  3805. Properties:
  3806. - unsigned numItems (readonly)
  3807. - unsigned selection
  3808. - UIElement* selectedItem (readonly)
  3809. - ListView* listView (readonly)
  3810. - UIElement* placeholder (readonly)
  3811. - String placeholderText
  3812. - bool resizePopup
  3813. ### Slider : BorderImage
  3814. Methods:
  3815. - Slider()
  3816. - virtual ~Slider()
  3817. - void SetOrientation(Orientation orientation)
  3818. - void SetRange(float range)
  3819. - void SetValue(float value)
  3820. - void ChangeValue(float delta)
  3821. - void SetRepeatRate(float rate)
  3822. - Orientation GetOrientation() const
  3823. - float GetRange() const
  3824. - float GetValue() const
  3825. - BorderImage* GetKnob() const
  3826. - float GetRepeatRate() const
  3827. Properties:
  3828. - Orientation orientation
  3829. - float range
  3830. - float value
  3831. - BorderImage* knob (readonly)
  3832. - float repeatRate
  3833. ### ScrollBar : UIElement
  3834. Methods:
  3835. - ScrollBar()
  3836. - virtual ~ScrollBar()
  3837. - void SetOrientation(Orientation orientation)
  3838. - void SetRange(float range)
  3839. - void SetValue(float value)
  3840. - void ChangeValue(float delta)
  3841. - void SetScrollStep(float step)
  3842. - void SetStepFactor(float factor)
  3843. - void StepBack()
  3844. - void StepForward()
  3845. - Orientation GetOrientation() const
  3846. - float GetRange() const
  3847. - float GetValue() const
  3848. - float GetScrollStep() const
  3849. - float GetStepFactor() const
  3850. - float GetEffectiveScrollStep() const
  3851. - Button* GetBackButton() const
  3852. - Button* GetForwardButton() const
  3853. - Slider* GetSlider() const
  3854. Properties:
  3855. - Orientation orientation
  3856. - float range
  3857. - float value
  3858. - float scrollStep
  3859. - float stepFactor
  3860. - float effectiveScrollStep (readonly)
  3861. - Button* backButton (readonly)
  3862. - Button* forwardButton (readonly)
  3863. - Slider* slider (readonly)
  3864. ### ScrollView : UIElement
  3865. Methods:
  3866. - ScrollView()
  3867. - virtual ~ScrollView()
  3868. - void SetContentElement(UIElement* element)
  3869. - void SetViewPosition(const IntVector2& position)
  3870. - void SetViewPosition(int x, int y)
  3871. - void SetScrollBarsVisible(bool horizontal, bool vertical)
  3872. - void SetScrollBarsAutoVisible(bool enable)
  3873. - void SetScrollStep(float step)
  3874. - void SetPageStep(float step)
  3875. - const IntVector2& GetViewPosition() const
  3876. - UIElement* GetContentElement() const
  3877. - ScrollBar* GetHorizontalScrollBar() const
  3878. - ScrollBar* GetVerticalScrollBar() const
  3879. - BorderImage* GetScrollPanel() const
  3880. - bool GetScrollBarsAutoVisible() const
  3881. - float GetScrollStep() const
  3882. - float GetPageStep() const
  3883. Properties:
  3884. - IntVector2& viewPosition
  3885. - UIElement* contentElement
  3886. - ScrollBar* horizontalScrollBar (readonly)
  3887. - ScrollBar* verticalScrollBar (readonly)
  3888. - BorderImage* scrollPanel (readonly)
  3889. - bool scrollBarsAutoVisible
  3890. - float scrollStep
  3891. - float pageStep
  3892. ### ListView : ScrollView
  3893. Methods:
  3894. - ListView()
  3895. - virtual ~ListView()
  3896. - void AddItem(UIElement* item)
  3897. - void InsertItem(unsigned index, UIElement* item, UIElement* parentItem = 0)
  3898. - void RemoveItem(UIElement* item, unsigned index = 0)
  3899. - void RemoveItem(unsigned index)
  3900. - void RemoveAllItems()
  3901. - void SetSelection(unsigned index)
  3902. - void SetSelections(const PODVector<unsigned>& indices)
  3903. - void AddSelection(unsigned index)
  3904. - void RemoveSelection(unsigned index)
  3905. - void ToggleSelection(unsigned index)
  3906. - void ChangeSelection(int delta, bool additive = false)
  3907. - void ClearSelection()
  3908. - void SetHighlightMode(HighlightMode mode)
  3909. - void SetMultiselect(bool enable)
  3910. - void SetHierarchyMode(bool enable)
  3911. - void SetBaseIndent(int baseIndent)
  3912. - void SetClearSelectionOnDefocus(bool enable)
  3913. - void Expand(unsigned index, bool enable, bool recursive = false)
  3914. - void ToggleExpand(unsigned index, bool recursive = false)
  3915. - unsigned GetNumItems() const
  3916. - UIElement* GetItem(unsigned index) const
  3917. - const PODVector<UIElement*>& GetItems() const
  3918. - unsigned FindItem(UIElement* item) const
  3919. - unsigned GetSelection() const
  3920. - const PODVector<unsigned>& GetSelections() const
  3921. - UIElement* GetSelectedItem() const
  3922. - const PODVector<UIElement*>& GetSelectedItems() const
  3923. - bool IsSelected(unsigned index) const
  3924. - bool IsExpanded(unsigned index) const
  3925. - HighlightMode GetHighlightMode() const
  3926. - bool GetMultiselect() const
  3927. - bool GetClearSelectionOnDefocus() const
  3928. - bool GetHierarchyMode() const
  3929. - int GetBaseIndent() const
  3930. Properties:
  3931. - unsigned numItems (readonly)
  3932. - unsigned selection
  3933. - UIElement* selectedItem (readonly)
  3934. - HighlightMode highlightMode
  3935. - bool multiselect
  3936. - bool clearSelectionOnDefocus
  3937. - bool hierarchyMode
  3938. - int baseIndent
  3939. ### Sprite : UIElement
  3940. Methods:
  3941. - Sprite()
  3942. - virtual ~Sprite()
  3943. - void SetPosition(const Vector2& position)
  3944. - void SetPosition(float x, float y)
  3945. - void SetHotSpot(const IntVector2& hotSpot)
  3946. - void SetHotSpot(int x, int y)
  3947. - void SetScale(const Vector2& scale)
  3948. - void SetScale(float x, float y)
  3949. - void SetScale(float scale)
  3950. - void SetRotation(float angle)
  3951. - void SetTexture(Texture* texture)
  3952. - void SetImageRect(const IntRect& rect)
  3953. - void SetFullImageRect()
  3954. - void SetBlendMode(BlendMode mode)
  3955. - const Vector2& GetPosition() const
  3956. - const IntVector2& GetHotSpot() const
  3957. - const Vector2& GetScale() const
  3958. - float GetRotation() const
  3959. - Texture* GetTexture() const
  3960. - const IntRect& GetImageRect() const
  3961. - BlendMode GetBlendMode() const
  3962. - const Matrix3x4& GetTransform() const
  3963. Properties:
  3964. - Vector2& position
  3965. - IntVector2& hotSpot
  3966. - Vector2& scale
  3967. - float rotation
  3968. - Texture* texture
  3969. - IntRect& imageRect
  3970. - BlendMode blendMode
  3971. - Matrix3x4& transform (readonly)
  3972. ### Text : UIElement
  3973. Methods:
  3974. - Text()
  3975. - virtual ~Text()
  3976. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  3977. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  3978. - void SetText(const String text)
  3979. - void SetTextAlignment(HorizontalAlignment align)
  3980. - void SetRowSpacing(float spacing)
  3981. - void SetWordwrap(bool enable)
  3982. - void SetSelection(unsigned start, unsigned length = M_MAX_UNSIGNED)
  3983. - void ClearSelection()
  3984. - void SetSelectionColor(const Color& color)
  3985. - void SetHoverColor(const Color& color)
  3986. - void SetTextEffect(TextEffect textEffect)
  3987. - void SetEffectColor(const Color& effectColor)
  3988. - Font* GetFont() const
  3989. - int GetFontSize() const
  3990. - const String GetText() const
  3991. - HorizontalAlignment GetTextAlignment() const
  3992. - float GetRowSpacing() const
  3993. - bool GetWordwrap() const
  3994. - unsigned GetSelectionStart() const
  3995. - unsigned GetSelectionLength() const
  3996. - const Color& GetSelectionColor() const
  3997. - const Color& GetHoverColor() const
  3998. - TextEffect GetTextEffect() const
  3999. - const Color& GetEffectColor() const
  4000. - int GetRowHeight() const
  4001. - unsigned GetNumRows() const
  4002. - const PODVector<int>& GetRowWidths() const
  4003. - const PODVector<IntVector2>& GetCharPositions() const
  4004. - const PODVector<IntVector2>& GetCharSizes() const
  4005. - void SetEffectDepthBias(float bias)
  4006. - float GetEffectDepthBias() const
  4007. Properties:
  4008. - Font* font
  4009. - int fontSize (readonly)
  4010. - String text
  4011. - HorizontalAlignment textAlignment
  4012. - float rowSpacing
  4013. - bool wordwrap
  4014. - unsigned selectionStart (readonly)
  4015. - unsigned selectionLength (readonly)
  4016. - Color& selectionColor
  4017. - Color& hoverColor
  4018. - TextEffect textEffect
  4019. - Color& effectColor
  4020. - int rowHeight (readonly)
  4021. - unsigned numRows (readonly)
  4022. ### Text3D : Drawable
  4023. Methods:
  4024. - Text3D()
  4025. - ~Text3D()
  4026. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  4027. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  4028. - void SetMaterial(Material* material)
  4029. - void SetText(const String text)
  4030. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  4031. - void SetHorizontalAlignment(HorizontalAlignment align)
  4032. - void SetVerticalAlignment(VerticalAlignment align)
  4033. - void SetTextAlignment(HorizontalAlignment align)
  4034. - void SetRowSpacing(float spacing)
  4035. - void SetWordwrap(bool enable)
  4036. - void SetTextEffect(TextEffect textEffect)
  4037. - void SetEffectColor(const Color& effectColor)
  4038. - void SetEffectDepthBias(float bias)
  4039. - void SetWidth(int width)
  4040. - void SetColor(const Color& color)
  4041. - void SetColor(Corner corner, const Color& color)
  4042. - void SetOpacity(float opacity)
  4043. - void SetFaceCamera(bool enable)
  4044. - Font* GetFont() const
  4045. - Material* GetMaterial() const
  4046. - int GetFontSize() const
  4047. - const String GetText() const
  4048. - HorizontalAlignment GetTextAlignment() const
  4049. - HorizontalAlignment GetHorizontalAlignment() const
  4050. - VerticalAlignment GetVerticalAlignment() const
  4051. - float GetRowSpacing() const
  4052. - bool GetWordwrap() const
  4053. - TextEffect GetTextEffect() const
  4054. - const Color& GetEffectColor() const
  4055. - float GetEffectDepthBias() const
  4056. - int GetWidth() const
  4057. - int GetRowHeight() const
  4058. - unsigned GetNumRows() const
  4059. - const PODVector<int>& GetRowWidths() const
  4060. - const Color& GetColor(Corner corner) const
  4061. - float GetOpacity() const
  4062. - bool GetFaceCamera() const
  4063. Properties:
  4064. - Font* font
  4065. - Material* material
  4066. - int fontSize (readonly)
  4067. - String text
  4068. - HorizontalAlignment textAlignment
  4069. - HorizontalAlignment horizontalAlignment
  4070. - VerticalAlignment verticalAlignment
  4071. - float rowSpacing
  4072. - bool wordwrap
  4073. - TextEffect textEffect
  4074. - Color& effectColor
  4075. - float effectDepthBias
  4076. - int width
  4077. - int rowHeight (readonly)
  4078. - unsigned numRows (readonly)
  4079. - float opacity
  4080. - bool faceCamera
  4081. ### ToolTip : UIElement
  4082. Methods:
  4083. - ToolTip()
  4084. - virtual ~ToolTip()
  4085. - void SetDelay(float delay)
  4086. - float GetDelay() const
  4087. Properties:
  4088. - float delay
  4089. ### UI : Object
  4090. Methods:
  4091. - void SetCursor(Cursor* cursor)
  4092. - void SetFocusElement(UIElement* element, bool byKey = false)
  4093. - bool SetModalElement(UIElement* modalElement, bool enable)
  4094. - void Clear()
  4095. - void Update(float timeStep)
  4096. - void RenderUpdate()
  4097. - void Render()
  4098. - void DebugDraw(UIElement* element)
  4099. - bool SaveLayout(Serializer& dest, UIElement* element)
  4100. - void SetClipBoardText(const String text)
  4101. - void SetDoubleClickInterval(float interval)
  4102. - void SetDragBeginInterval(float interval)
  4103. - void SetDragBeginDistance(int pixels)
  4104. - void SetDefaultToolTipDelay(float delay)
  4105. - void SetMaxFontTextureSize(int size)
  4106. - void SetNonFocusedMouseWheel(bool nonFocusedMouseWheel)
  4107. - void SetUseSystemClipBoard(bool enable)
  4108. - void SetUseScreenKeyboard(bool enable)
  4109. - void SetUseMutableGlyphs(bool enable)
  4110. - void SetForceAutoHint(bool enable)
  4111. - UIElement* GetRoot() const
  4112. - UIElement* GetRootModalElement() const
  4113. - Cursor* GetCursor() const
  4114. - IntVector2 GetCursorPosition() const
  4115. - UIElement* GetElementAt(const IntVector2& position, bool enabledOnly = true)
  4116. - UIElement* GetElementAt(int x, int y, bool enabledOnly = true)
  4117. - UIElement* GetFocusElement() const
  4118. - UIElement* GetFrontElement() const
  4119. - UIElement* GetDragElement() const
  4120. - const String GetClipBoardText() const
  4121. - float GetDoubleClickInterval() const
  4122. - float GetDragBeginInterval() const
  4123. - int GetDragBeginDistance() const
  4124. - float GetDefaultToolTipDelay() const
  4125. - int GetMaxFontTextureSize() const
  4126. - bool IsNonFocusedMouseWheel() const
  4127. - bool GetUseSystemClipBoard() const
  4128. - bool GetUseScreenKeyboard() const
  4129. - bool GetUseMutableGlyphs() const
  4130. - bool GetForceAutoHint() const
  4131. - bool HasModalElement() const
  4132. Properties:
  4133. - UIElement* root (readonly)
  4134. - UIElement* rootModalElement (readonly)
  4135. - Cursor* cursor
  4136. - IntVector2 cursorPosition (readonly)
  4137. - UIElement* focusElement (readonly)
  4138. - UIElement* frontElement (readonly)
  4139. - UIElement* dragElement (readonly)
  4140. - String clipBoardText
  4141. - float doubleClickInterval
  4142. - float dragBeginInterval
  4143. - int dragBeginDistance
  4144. - float defaultToolTipDelay
  4145. - int maxFontTextureSize
  4146. - bool nonFocusedMouseWheel
  4147. - bool useSystemClipBoard
  4148. - bool useScreenKeyboard
  4149. - bool useMutableGlyphs
  4150. - bool forceAutoHint
  4151. - bool modalElement (readonly)
  4152. ### Window : BorderImage
  4153. Methods:
  4154. - Window()
  4155. - virtual ~Window()
  4156. - void SetMovable(bool enable)
  4157. - void SetResizable(bool enable)
  4158. - void SetFixedWidthResizing(bool enable)
  4159. - void SetFixedHeightResizing(bool enable)
  4160. - void SetResizeBorder(const IntRect& rect)
  4161. - void SetModal(bool modal)
  4162. - void SetModalShadeColor(const Color& color)
  4163. - void SetModalFrameColor(const Color& color)
  4164. - void SetModalFrameSize(const IntVector2& size)
  4165. - bool IsMovable() const
  4166. - bool IsResizable() const
  4167. - bool GetFixedWidthResizing() const
  4168. - bool GetFixedHeightResizing() const
  4169. - const IntRect& GetResizeBorder() const
  4170. - bool IsModal() const
  4171. - const Color& GetModalShadeColor() const
  4172. - const Color& GetModalFrameColor() const
  4173. - const IntVector2& GetModalFrameSize() const
  4174. Properties:
  4175. - bool movable
  4176. - bool resizable
  4177. - bool fixedWidthResizing
  4178. - bool fixedHeightResizing
  4179. - IntRect& resizeBorder
  4180. - bool modal
  4181. - Color& modalShadeColor
  4182. - Color& modalFrameColor
  4183. - IntVector2& modalFrameSize
  4184. ### View3D : Window
  4185. Methods:
  4186. - View3D()
  4187. - ~View3D()
  4188. - void SetView(Scene* scene, Camera* camera)
  4189. - void SetFormat(unsigned format)
  4190. - void SetAutoUpdate(bool enable)
  4191. - void QueueUpdate()
  4192. - unsigned GetFormat() const
  4193. - bool GetAutoUpdate() const
  4194. - Scene* GetScene() const
  4195. - Node* GetCameraNode() const
  4196. - Texture2D* GetRenderTexture() const
  4197. - Texture2D* GetDepthTexture() const
  4198. - Viewport* GetViewport() const
  4199. Properties:
  4200. - unsigned format
  4201. - bool autoUpdate
  4202. \section LuaScriptAPI_Enums Enumerations
  4203. ### SoundType
  4204. - int SOUND_EFFECT
  4205. - int SOUND_AMBIENT
  4206. - int SOUND_VOICE
  4207. - int SOUND_MUSIC
  4208. - int SOUND_MASTER
  4209. - int MAX_SOUND_TYPES
  4210. ### VariantType
  4211. - int VAR_NONE
  4212. - int VAR_INT
  4213. - int VAR_BOOL
  4214. - int VAR_FLOAT
  4215. - int VAR_VECTOR2
  4216. - int VAR_VECTOR3
  4217. - int VAR_VECTOR4
  4218. - int VAR_QUATERNION
  4219. - int VAR_COLOR
  4220. - int VAR_STRING
  4221. - int VAR_BUFFER
  4222. - int VAR_PTR
  4223. - int VAR_RESOURCEREF
  4224. - int VAR_RESOURCEREFLIST
  4225. - int VAR_VARIANTVECTOR
  4226. - int VAR_VARIANTMAP
  4227. - int VAR_INTRECT
  4228. - int VAR_INTVECTOR2
  4229. - int MAX_VAR_TYPES
  4230. ### PrimitiveType
  4231. - int TRIANGLE_LIST
  4232. - int LINE_LIST
  4233. ### GeometryType
  4234. - int GEOM_STATIC
  4235. - int GEOM_SKINNED
  4236. - int GEOM_INSTANCED
  4237. - int GEOM_BILLBOARD
  4238. - int GEOM_STATIC_NOINSTANCING
  4239. - int MAX_GEOMETRYTYPES
  4240. ### BlendMode
  4241. - int BLEND_REPLACE
  4242. - int BLEND_ADD
  4243. - int BLEND_MULTIPLY
  4244. - int BLEND_ALPHA
  4245. - int BLEND_ADDALPHA
  4246. - int BLEND_PREMULALPHA
  4247. - int BLEND_INVDESTALPHA
  4248. - int MAX_BLENDMODES
  4249. ### CompareMode
  4250. - int CMP_ALWAYS
  4251. - int CMP_EQUAL
  4252. - int CMP_NOTEQUAL
  4253. - int CMP_LESS
  4254. - int CMP_LESSEQUAL
  4255. - int CMP_GREATER
  4256. - int CMP_GREATEREQUAL
  4257. - int MAX_COMPAREMODES
  4258. ### CullMode
  4259. - int CULL_NONE
  4260. - int CULL_CCW
  4261. - int CULL_CW
  4262. - int MAX_CULLMODES
  4263. ### FillMode
  4264. - int FILL_SOLID
  4265. - int FILL_WIREFRAME
  4266. - int FILL_POINT
  4267. ### StencilOp
  4268. - int OP_KEEP
  4269. - int OP_ZERO
  4270. - int OP_REF
  4271. - int OP_INCR
  4272. - int OP_DECR
  4273. ### LockState
  4274. - int LOCK_NONE
  4275. - int LOCK_HARDWARE
  4276. - int LOCK_SHADOW
  4277. - int LOCK_SCRATCH
  4278. ### VertexElement
  4279. - int ELEMENT_POSITION
  4280. - int ELEMENT_NORMAL
  4281. - int ELEMENT_COLOR
  4282. - int ELEMENT_TEXCOORD1
  4283. - int ELEMENT_TEXCOORD2
  4284. - int ELEMENT_CUBETEXCOORD1
  4285. - int ELEMENT_CUBETEXCOORD2
  4286. - int ELEMENT_TANGENT
  4287. - int ELEMENT_BLENDWEIGHTS
  4288. - int ELEMENT_BLENDINDICES
  4289. - int ELEMENT_INSTANCEMATRIX1
  4290. - int ELEMENT_INSTANCEMATRIX2
  4291. - int ELEMENT_INSTANCEMATRIX3
  4292. - int MAX_VERTEX_ELEMENTS
  4293. ### TextureFilterMode
  4294. - int FILTER_NEAREST
  4295. - int FILTER_BILINEAR
  4296. - int FILTER_TRILINEAR
  4297. - int FILTER_ANISOTROPIC
  4298. - int FILTER_DEFAULT
  4299. - int MAX_FILTERMODES
  4300. ### TextureAddressMode
  4301. - int ADDRESS_WRAP
  4302. - int ADDRESS_MIRROR
  4303. - int ADDRESS_CLAMP
  4304. - int ADDRESS_BORDER
  4305. - int MAX_ADDRESSMODES
  4306. ### TextureCoordinate
  4307. - int COORD_U
  4308. - int COORD_V
  4309. - int COORD_W
  4310. - int MAX_COORDS
  4311. ### TextureUsage
  4312. - int TEXTURE_STATIC
  4313. - int TEXTURE_DYNAMIC
  4314. - int TEXTURE_RENDERTARGET
  4315. - int TEXTURE_DEPTHSTENCIL
  4316. ### CubeMapFace
  4317. - int FACE_POSITIVE_X
  4318. - int FACE_NEGATIVE_X
  4319. - int FACE_POSITIVE_Y
  4320. - int FACE_NEGATIVE_Y
  4321. - int FACE_POSITIVE_Z
  4322. - int FACE_NEGATIVE_Z
  4323. - int MAX_CUBEMAP_FACES
  4324. ### RenderSurfaceUpdateMode
  4325. - int SURFACE_MANUALUPDATE
  4326. - int SURFACE_UPDATEVISIBLE
  4327. - int SURFACE_UPDATEALWAYS
  4328. ### ShaderType
  4329. - int VS
  4330. - int PS
  4331. ### TextureUnit
  4332. - int TU_DIFFUSE
  4333. - int TU_ALBEDOBUFFER
  4334. - int TU_NORMAL
  4335. - int TU_NORMALBUFFER
  4336. - int TU_SPECULAR
  4337. - int TU_EMISSIVE
  4338. - int TU_ENVIRONMENT
  4339. - int MAX_MATERIAL_TEXTURE_UNITS
  4340. - int TU_LIGHTRAMP
  4341. - int TU_LIGHTSHAPE
  4342. - int TU_SHADOWMAP
  4343. - int TU_FACESELECT
  4344. - int TU_INDIRECTION
  4345. - int TU_DEPTHBUFFER
  4346. - int TU_LIGHTBUFFER
  4347. - int TU_VOLUMEMAP
  4348. - int MAX_TEXTURE_UNITS
  4349. ### ShaderParameterGroup
  4350. - int SP_FRAME
  4351. - int SP_CAMERA
  4352. - int SP_VIEWPORT
  4353. - int SP_ZONE
  4354. - int SP_LIGHT
  4355. - int SP_VERTEXLIGHTS
  4356. - int SP_MATERIAL
  4357. - int SP_OBJECTTRANSFORM
  4358. - int MAX_SHADER_PARAMETER_GROUPS
  4359. ### UpdateGeometryType
  4360. - int UPDATE_NONE
  4361. - int UPDATE_MAIN_THREAD
  4362. - int UPDATE_WORKER_THREAD
  4363. ### LightType
  4364. - int LIGHT_DIRECTIONAL
  4365. - int LIGHT_SPOT
  4366. - int LIGHT_POINT
  4367. ### RayQueryLevel
  4368. - int RAY_AABB
  4369. - int RAY_OBB
  4370. - int RAY_TRIANGLE
  4371. ### EmitterType
  4372. - int EMITTER_SPHERE
  4373. - int EMITTER_BOX
  4374. ### LightVSVariation
  4375. - int LVS_DIR
  4376. - int LVS_SPOT
  4377. - int LVS_POINT
  4378. - int LVS_SPEC
  4379. - int LVS_SPOTSPEC
  4380. - int LVS_POINTSPEC
  4381. - int LVS_SHADOW
  4382. - int LVS_SPOTSHADOW
  4383. - int LVS_POINTSHADOW
  4384. - int LVS_DIRSPECSHADOW
  4385. - int LVS_SPOTSPECSHADOW
  4386. - int LVS_POINTSPECSHADOW
  4387. - int MAX_LIGHT_VS_VARIATIONS
  4388. ### VertexLightVSVariation
  4389. - int VLVS_NOLIGHTS
  4390. - int VLVS_1LIGHT
  4391. - int VLVS_2LIGHTS
  4392. - int VLVS_3LIGHTS
  4393. - int VLVS_4LIGHTS
  4394. - int MAX_VERTEXLIGHT_VS_VARIATIONS
  4395. ### LightPSVariation
  4396. - int LPS_NONE
  4397. - int LPS_SPOT
  4398. - int LPS_POINT
  4399. - int LPS_POINTMASK
  4400. - int LPS_SPEC
  4401. - int LPS_SPOTSPEC
  4402. - int LPS_POINTSPEC
  4403. - int LPS_POINTMASKSPEC
  4404. - int LPS_SHADOW
  4405. - int LPS_SPOTSHADOW
  4406. - int LPS_POINTSHADOW
  4407. - int LPS_POINTMASKSHADOW
  4408. - int LPS_SHADOWSPEC
  4409. - int LPS_SPOTSHADOWSPEC
  4410. - int LPS_POINTSHADOWSPEC
  4411. - int LPS_POINTMASKSHADOWSPEC
  4412. - int MAX_LIGHT_PS_VARIATIONS
  4413. ### DeferredLightVSVariation
  4414. - int DLVS_NONE
  4415. - int DLVS_DIR
  4416. - int DLVS_ORTHO
  4417. - int DLVS_ORTHODIR
  4418. - int MAX_DEFERRED_LIGHT_VS_VARIATIONS
  4419. ### DeferredLightPSVariation
  4420. - int DLPS_NONE
  4421. - int DLPS_SPOT
  4422. - int DLPS_POINT
  4423. - int DLPS_POINTMASK
  4424. - int DLPS_SPEC
  4425. - int DLPS_SPOTSPEC
  4426. - int DLPS_POINTSPEC
  4427. - int DLPS_POINTMASKSPEC
  4428. - int DLPS_SHADOW
  4429. - int DLPS_SPOTSHADOW
  4430. - int DLPS_POINTSHADOW
  4431. - int DLPS_POINTMASKSHADOW
  4432. - int DLPS_SHADOWSPEC
  4433. - int DLPS_SPOTSHADOWSPEC
  4434. - int DLPS_POINTSHADOWSPEC
  4435. - int DLPS_POINTMASKSHADOWSPEC
  4436. - int DLPS_ORTHO
  4437. - int DLPS_ORTHOSPOT
  4438. - int DLPS_ORTHOPOINT
  4439. - int DLPS_ORTHOPOINTMASK
  4440. - int DLPS_ORTHOSPEC
  4441. - int DLPS_ORTHOSPOTSPEC
  4442. - int DLPS_ORTHOPOINTSPEC
  4443. - int DLPS_ORTHOPOINTMASKSPEC
  4444. - int DLPS_ORTHOSHADOW
  4445. - int DLPS_ORTHOSPOTSHADOW
  4446. - int DLPS_ORTHOPOINTSHADOW
  4447. - int DLPS_ORTHOPOINTMASKSHADOW
  4448. - int DLPS_ORTHOSHADOWSPEC
  4449. - int DLPS_ORTHOSPOTSHADOWSPEC
  4450. - int DLPS_ORTHOPOINTSHADOWSPEC
  4451. - int DLPS_ORTHOPOINTMASKSHADOWSPEC
  4452. - int MAX_DEFERRED_LIGHT_PS_VARIATIONS
  4453. ### PassLightingMode
  4454. - int LIGHTING_UNLIT
  4455. - int LIGHTING_PERVERTEX
  4456. - int LIGHTING_PERPIXEL
  4457. ### FileMode
  4458. - int FILE_READ
  4459. - int FILE_WRITE
  4460. - int FILE_READWRITE
  4461. ### Intersection
  4462. - int OUTSIDE
  4463. - int INTERSECTS
  4464. - int INSIDE
  4465. ### FrustumPlane
  4466. - int PLANE_NEAR
  4467. - int PLANE_LEFT
  4468. - int PLANE_RIGHT
  4469. - int PLANE_UP
  4470. - int PLANE_DOWN
  4471. - int PLANE_FAR
  4472. ### HttpRequestState
  4473. - int HTTP_INITIALIZING
  4474. - int HTTP_ERROR
  4475. - int HTTP_OPEN
  4476. - int HTTP_CLOSED
  4477. ### ShapeType
  4478. - int SHAPE_BOX
  4479. - int SHAPE_SPHERE
  4480. - int SHAPE_STATICPLANE
  4481. - int SHAPE_CYLINDER
  4482. - int SHAPE_CAPSULE
  4483. - int SHAPE_CONE
  4484. - int SHAPE_TRIANGLEMESH
  4485. - int SHAPE_CONVEXHULL
  4486. - int SHAPE_TERRAIN
  4487. ### ConstraintType
  4488. - int CONSTRAINT_POINT
  4489. - int CONSTRAINT_HINGE
  4490. - int CONSTRAINT_SLIDER
  4491. - int CONSTRAINT_CONETWIST
  4492. ### CollisionEventMode
  4493. - int COLLISION_NEVER
  4494. - int COLLISION_ACTIVE
  4495. - int COLLISION_ALWAYS
  4496. ### CompressedFormat
  4497. - int CF_NONE
  4498. - int CF_DXT1
  4499. - int CF_DXT3
  4500. - int CF_DXT5
  4501. - int CF_ETC1
  4502. - int CF_PVRTC_RGB_2BPP
  4503. - int CF_PVRTC_RGBA_2BPP
  4504. - int CF_PVRTC_RGB_4BPP
  4505. - int CF_PVRTC_RGBA_4BPP
  4506. ### CreateMode
  4507. - int REPLICATED
  4508. - int LOCAL
  4509. ### InterpolationMode
  4510. - int BEZIER_CURVE
  4511. ### HorizontalAlignment
  4512. - int HA_LEFT
  4513. - int HA_CENTER
  4514. - int HA_RIGHT
  4515. ### VerticalAlignment
  4516. - int VA_TOP
  4517. - int VA_CENTER
  4518. - int VA_BOTTOM
  4519. ### Corner
  4520. - int C_TOPLEFT
  4521. - int C_TOPRIGHT
  4522. - int C_BOTTOMLEFT
  4523. - int C_BOTTOMRIGHT
  4524. - int MAX_UIELEMENT_CORNERS
  4525. ### Orientation
  4526. - int O_HORIZONTAL
  4527. - int O_VERTICAL
  4528. ### FocusMode
  4529. - int FM_NOTFOCUSABLE
  4530. - int FM_RESETFOCUS
  4531. - int FM_FOCUSABLE
  4532. - int FM_FOCUSABLE_DEFOCUSABLE
  4533. ### LayoutMode
  4534. - int LM_FREE
  4535. - int LM_HORIZONTAL
  4536. - int LM_VERTICAL
  4537. ### TraversalMode
  4538. - int TM_BREADTH_FIRST
  4539. - int TM_DEPTH_FIRST
  4540. ### CursorShape
  4541. - int CS_NORMAL
  4542. - int CS_RESIZEVERTICAL
  4543. - int CS_RESIZEDIAGONAL_TOPRIGHT
  4544. - int CS_RESIZEHORIZONTAL
  4545. - int CS_RESIZEDIAGONAL_TOPLEFT
  4546. - int CS_ACCEPTDROP
  4547. - int CS_REJECTDROP
  4548. - int CS_BUSY
  4549. - int CS_MAX_SHAPES
  4550. ### HighlightMode
  4551. - int HM_NEVER
  4552. - int HM_FOCUS
  4553. - int HM_ALWAYS
  4554. ### TextEffect
  4555. - int TE_NONE
  4556. - int TE_SHADOW
  4557. - int TE_STROKE
  4558. ### WindowDragMode
  4559. - int DRAG_NONE
  4560. - int DRAG_MOVE
  4561. - int DRAG_RESIZE_TOPLEFT
  4562. - int DRAG_RESIZE_TOP
  4563. - int DRAG_RESIZE_TOPRIGHT
  4564. - int DRAG_RESIZE_RIGHT
  4565. - int DRAG_RESIZE_BOTTOMRIGHT
  4566. - int DRAG_RESIZE_BOTTOM
  4567. - int DRAG_RESIZE_BOTTOMLEFT
  4568. - int DRAG_RESIZE_LEFT
  4569. \section LuaScriptAPI_GlobalFunctions Global functions
  4570. - Audio* GetAudio()
  4571. - Context* GetContext()
  4572. - Object* GetEventSender()
  4573. - EventHandler* GetEventHandler() const
  4574. - void ErrorDialog(const String title, const String message)
  4575. - void ErrorExit(const String message = String::EMPTY, int exitCode = EXIT_FAILURE)
  4576. - void OpenConsoleWindow()
  4577. - void PrintLine(const String str, bool error = false)
  4578. - const Vector<String>& GetArguments()
  4579. - String GetConsoleInput()
  4580. - String GetPlatform()
  4581. - unsigned GetNumPhysicalCPUs()
  4582. - unsigned GetNumLogicalCPUs()
  4583. - bool ToBool(const String source)
  4584. - float ToFloat(const String source)
  4585. - int ToInt(const String source)
  4586. - unsigned ToUInt(const String source)
  4587. - Color ToColor(const String source)
  4588. - IntRect ToIntRect(const String source)
  4589. - IntVector2 ToIntVector2(const String source)
  4590. - Quaternion ToQuaternion(const String source)
  4591. - Rect ToRect(const String source)
  4592. - Vector2 ToVector2(const String source)
  4593. - Vector3 ToVector3(const String source)
  4594. - Vector4 ToVector4(const String source, bool allowMissingCoords = false)
  4595. - String ToString(void* value)
  4596. - String ToStringHex(unsigned value)
  4597. - bool IsAlpha(unsigned ch)
  4598. - bool IsDigit(unsigned ch)
  4599. - unsigned ToUpper(unsigned ch)
  4600. - unsigned ToLower(unsigned ch)
  4601. - Time* GetTime()
  4602. - Console* GetConsole()
  4603. - DebugHud* GetDebugHud()
  4604. - Engine* GetEngine()
  4605. - Graphics* GetGraphics()
  4606. - Renderer* GetRenderer()
  4607. - String GetPath(const String fullPath)
  4608. - String GetFileName(const String fullPath)
  4609. - String GetExtension(const String fullPath, bool lowercaseExtension = true)
  4610. - String GetFileNameAndExtension(const String fullPath, bool lowercaseExtension = false)
  4611. - String ReplaceExtension(const String fullPath, const String newExtension)
  4612. - String AddTrailingSlash(const String pathName)
  4613. - String RemoveTrailingSlash(const String pathName)
  4614. - String GetParentPath(const String pathName)
  4615. - String GetInternalPath(const String pathName)
  4616. - String GetNativePath(const String pathName)
  4617. - bool IsAbsolutePath(const String pathName)
  4618. - FileSystem * GetFileSystem()
  4619. - Log* GetLog()
  4620. - Input* GetInput()
  4621. - void SendEvent(const String eventName, VariantMap& eventData)
  4622. - void SubscribeToEvent(const String eventName, const String functionName)
  4623. - void UnsubscribeFromEvent(const String eventName)
  4624. - void UnsubscribeFromAllEvents()
  4625. - void SubscribeToEvent(void* sender, const String eventName, const String functionName)
  4626. - void UnsubscribeFromEvent(void* sender, const String eventName)
  4627. - void UnsubscribeFromEvents(void* sender)
  4628. - float Lerp(float lhs, float rhs, float t)
  4629. - float Min(float lhs, float rhs)
  4630. - float Max(float lhs, float rhs)
  4631. - float Abs(float value)
  4632. - float Sign(float value)
  4633. - float Clamp(float value, float min, float max)
  4634. - float SmoothStep(float lhs, float rhs, float t)
  4635. - bool Equals(float lhs, float rhs)
  4636. - float Random()
  4637. - float Random(float range)
  4638. - float Random(float min, float max)
  4639. - int RandomInt(int range)
  4640. - int RandomInt(int min, int max)
  4641. - void SetRandomSeed(unsigned seed)
  4642. - unsigned GetRandomSeed()
  4643. - int Rand()
  4644. - Network* GetNetwork()
  4645. - ResourceCache* GetCache()
  4646. - UI* GetUI()
  4647. \section LuaScriptAPI_GlobalProperties Global properties
  4648. - Audio* audio (readonly)
  4649. - Time* time (readonly)
  4650. - Console* console (readonly)
  4651. - DebugHud* debugHud (readonly)
  4652. - Engine* engine (readonly)
  4653. - Graphics* graphics (readonly)
  4654. - Renderer* renderer (readonly)
  4655. - FileSystem* fileSystem (readonly)
  4656. - Log* log (readonly)
  4657. - Input* input (readonly)
  4658. - Network* network (readonly)
  4659. - ResourceCache* cache (readonly)
  4660. - UI* ui (readonly)
  4661. \section LuaScriptAPI_GlobalConstants Global constants
  4662. - unsigned DEBUGHUD_SHOW_NONE
  4663. - unsigned DEBUGHUD_SHOW_STATS
  4664. - unsigned DEBUGHUD_SHOW_MODE
  4665. - unsigned DEBUGHUD_SHOW_PROFILER
  4666. - unsigned DEBUGHUD_SHOW_ALL
  4667. - int QUALITY_LOW
  4668. - int QUALITY_MEDIUM
  4669. - int QUALITY_HIGH
  4670. - int QUALITY_MAX
  4671. - int SHADOWQUALITY_LOW_16BIT
  4672. - int SHADOWQUALITY_LOW_24BIT
  4673. - int SHADOWQUALITY_HIGH_16BIT
  4674. - int SHADOWQUALITY_HIGH_24BIT
  4675. - unsigned CLEAR_COLOR
  4676. - unsigned CLEAR_DEPTH
  4677. - unsigned CLEAR_STENCIL
  4678. - unsigned DRAWABLE_GEOMETRY
  4679. - unsigned DRAWABLE_LIGHT
  4680. - unsigned DRAWABLE_ZONE
  4681. - unsigned DRAWABLE_ANY
  4682. - unsigned DEFAULT_VIEWMASK
  4683. - unsigned DEFAULT_LIGHTMASK
  4684. - unsigned DEFAULT_SHADOWMASK
  4685. - unsigned DEFAULT_ZONEMASK
  4686. - int MAX_VERTEX_LIGHTS
  4687. - float ANIMATION_LOD_BASESCALE
  4688. - unsigned char CHANNEL_POSITION
  4689. - unsigned char CHANNEL_ROTATION
  4690. - unsigned char CHANNEL_SCALE
  4691. - unsigned VO_NONE
  4692. - unsigned VO_LOW_MATERIAL_QUALITY
  4693. - unsigned VO_DISABLE_SHADOWS
  4694. - unsigned VO_DISABLE_OCCLUSION
  4695. - int SHADOW_MIN_PIXELS
  4696. - int INSTANCING_BUFFER_DEFAULT_SIZE
  4697. - unsigned SCAN_FILES
  4698. - unsigned SCAN_DIRS
  4699. - unsigned SCAN_HIDDEN
  4700. - int LOG_DEBUG
  4701. - int LOG_INFO
  4702. - int LOG_WARNING
  4703. - int LOG_ERROR
  4704. - int LOG_NONE
  4705. - int MOUSEB_LEFT
  4706. - int MOUSEB_MIDDLE
  4707. - int MOUSEB_RIGHT
  4708. - int QUAL_SHIFT
  4709. - int QUAL_CTRL
  4710. - int QUAL_ALT
  4711. - int QUAL_ANY
  4712. - int KEY_1
  4713. - int KEY_2
  4714. - int KEY_3
  4715. - int KEY_4
  4716. - int KEY_5
  4717. - int KEY_6
  4718. - int KEY_7
  4719. - int KEY_8
  4720. - int KEY_9
  4721. - int KEY_0
  4722. - int KEY_A
  4723. - int KEY_B
  4724. - int KEY_C
  4725. - int KEY_D
  4726. - int KEY_E
  4727. - int KEY_F
  4728. - int KEY_G
  4729. - int KEY_H
  4730. - int KEY_I
  4731. - int KEY_J
  4732. - int KEY_K
  4733. - int KEY_L
  4734. - int KEY_M
  4735. - int KEY_N
  4736. - int KEY_O
  4737. - int KEY_P
  4738. - int KEY_Q
  4739. - int KEY_R
  4740. - int KEY_S
  4741. - int KEY_T
  4742. - int KEY_U
  4743. - int KEY_V
  4744. - int KEY_W
  4745. - int KEY_X
  4746. - int KEY_Y
  4747. - int KEY_Z
  4748. - int KEY_BACKSPACE
  4749. - int KEY_TAB
  4750. - int KEY_RETURN
  4751. - int KEY_RETURN2
  4752. - int KEY_KP_ENTER
  4753. - int KEY_SHIFT
  4754. - int KEY_CTRL
  4755. - int KEY_ALT
  4756. - int KEY_PAUSE
  4757. - int KEY_CAPSLOCK
  4758. - int KEY_ESC
  4759. - int KEY_SPACE
  4760. - int KEY_PAGEUP
  4761. - int KEY_PAGEDOWN
  4762. - int KEY_END
  4763. - int KEY_HOME
  4764. - int KEY_LEFT
  4765. - int KEY_UP
  4766. - int KEY_RIGHT
  4767. - int KEY_DOWN
  4768. - int KEY_SELECT
  4769. - int KEY_PRINTSCREEN
  4770. - int KEY_INSERT
  4771. - int KEY_DELETE
  4772. - int KEY_LWIN
  4773. - int KEY_RWIN
  4774. - int KEY_APPS
  4775. - int KEY_NUMPAD0
  4776. - int KEY_NUMPAD1
  4777. - int KEY_NUMPAD2
  4778. - int KEY_NUMPAD3
  4779. - int KEY_NUMPAD4
  4780. - int KEY_NUMPAD5
  4781. - int KEY_NUMPAD6
  4782. - int KEY_NUMPAD7
  4783. - int KEY_NUMPAD8
  4784. - int KEY_NUMPAD9
  4785. - int KEY_MULTIPLY
  4786. - int KEY_ADD
  4787. - int KEY_SUBTRACT
  4788. - int KEY_DECIMAL
  4789. - int KEY_DIVIDE
  4790. - int KEY_F1
  4791. - int KEY_F2
  4792. - int KEY_F3
  4793. - int KEY_F4
  4794. - int KEY_F5
  4795. - int KEY_F6
  4796. - int KEY_F7
  4797. - int KEY_F8
  4798. - int KEY_F9
  4799. - int KEY_F10
  4800. - int KEY_F11
  4801. - int KEY_F12
  4802. - int KEY_F13
  4803. - int KEY_F14
  4804. - int KEY_F15
  4805. - int KEY_F16
  4806. - int KEY_F17
  4807. - int KEY_F18
  4808. - int KEY_F19
  4809. - int KEY_F20
  4810. - int KEY_F21
  4811. - int KEY_F22
  4812. - int KEY_F23
  4813. - int KEY_F24
  4814. - int KEY_NUMLOCK
  4815. - int KEY_SCROLLLOCK
  4816. - int KEY_LSHIFT
  4817. - int KEY_RSHIFT
  4818. - int KEY_LCTRL
  4819. - int KEY_RCTRL
  4820. - int KEY_LALT
  4821. - int KEY_RALT
  4822. - int HAT_CENTER
  4823. - int HAT_UP
  4824. - int HAT_RIGHT
  4825. - int HAT_DOWN
  4826. - int HAT_LEFT
  4827. - int CONTROLLER_BUTTON_A
  4828. - int CONTROLLER_BUTTON_B
  4829. - int CONTROLLER_BUTTON_X
  4830. - int CONTROLLER_BUTTON_Y
  4831. - int CONTROLLER_BUTTON_BACK
  4832. - int CONTROLLER_BUTTON_GUIDE
  4833. - int CONTROLLER_BUTTON_START
  4834. - int CONTROLLER_BUTTON_LEFTSTICK
  4835. - int CONTROLLER_BUTTON_RIGHTSTICK
  4836. - int CONTROLLER_BUTTON_LEFTSHOULDER
  4837. - int CONTROLLER_BUTTON_RIGHTSHOULDER
  4838. - int CONTROLLER_BUTTON_DPAD_UP
  4839. - int CONTROLLER_BUTTON_DPAD_DOWN
  4840. - int CONTROLLER_BUTTON_DPAD_LEFT
  4841. - int CONTROLLER_BUTTON_DPAD_RIGHT
  4842. - int CONTROLLER_AXIS_LEFTX
  4843. - int CONTROLLER_AXIS_LEFTY
  4844. - int CONTROLLER_AXIS_RIGHTX
  4845. - int CONTROLLER_AXIS_RIGHTY
  4846. - int CONTROLLER_AXIS_TRIGGERLEFT
  4847. - int CONTROLLER_AXIS_TRIGGERRIGHT
  4848. - float M_PI
  4849. - int M_MIN_INT
  4850. - int M_MAX_INT
  4851. - unsigned M_MIN_UNSIGNED
  4852. - unsigned M_MAX_UNSIGNED
  4853. - float M_EPSILON
  4854. - float M_LARGE_EPSILON
  4855. - float M_MIN_NEARCLIP
  4856. - float M_MAX_FOV
  4857. - float M_LARGE_VALUE
  4858. - float M_INFINITY
  4859. - float M_DEGTORAD
  4860. - float M_DEGTORAD_2
  4861. - float M_RADTODEG
  4862. - unsigned NUM_FRUSTUM_PLANES
  4863. - unsigned NUM_FRUSTUM_VERTICES
  4864. - unsigned FIRST_REPLICATED_ID
  4865. - unsigned LAST_REPLICATED_ID
  4866. - unsigned FIRST_LOCAL_ID
  4867. - unsigned LAST_LOCAL_ID
  4868. - unsigned DD_DISABLED
  4869. - unsigned DD_SOURCE
  4870. - unsigned DD_TARGET
  4871. - unsigned DD_SOURCE_AND_TARGET
  4872. \section LuaScriptAPI_RenameTypes Rename types
  4873. - SharedPtr<HttpRequest> becomes HttpRequestSPtr
  4874. */
  4875. }