LuaScriptAPI.dox 157 KB

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