LuaScriptAPI.dox 144 KB

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