LuaScriptAPI.dox 149 KB

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