LuaScriptAPI.dox 155 KB

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