LuaScriptAPI.dox 148 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164
  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. - 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. ### Vector : VectorBase
  692. Methods:
  693. - TOLUA_TEMPLATE_BIND(T, String)
  694. - Vector()
  695. - Vector(const Vector<T>& vector)
  696. - ~Vector()
  697. - Vector<T> operator + (const T& rhs) const
  698. - Vector<T> operator + (const Vector<T>& rhs) const
  699. - bool operator == (const Vector<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 Vector<T>& vector)
  706. - void Pop()
  707. - void Insert(unsigned pos, const T& value)
  708. - void Insert(unsigned pos, const Vector<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. ### PODVector
  728. Methods:
  729. - TOLUA_TEMPLATE_BIND(T, Vector3)
  730. - PODVector()
  731. - PODVector(const PODVector<T>& vector)
  732. - ~PODVector()
  733. - PODVector<T> operator + (const T& rhs) const
  734. - PODVector<T> operator + (const PODVector<T>& rhs) const
  735. - bool operator == (const PODVector<T>& rhs) const
  736. - T& operator [] (unsigned index)
  737. - const T& operator [] (unsigned index) const
  738. - T& At(unsigned index)
  739. - const T& At(unsigned index) const
  740. - void Push(const T& value)
  741. - void Push(const PODVector<T>& vector)
  742. - void Pop()
  743. - void Insert(unsigned pos, const T& value)
  744. - void Insert(unsigned pos, const PODVector<T>& vector)
  745. - void Erase(unsigned pos, unsigned length = 1)
  746. - bool Remove(const T& value)
  747. - void Clear()
  748. - void Resize(unsigned newSize)
  749. - void Reserve(unsigned newCapacity)
  750. - void Compact()
  751. - bool Contains(const T& value) const
  752. - T& Front()
  753. - const T& Front() const
  754. - T& Back()
  755. - const T& Back() const
  756. - unsigned Size() const
  757. - unsigned Capacity() const
  758. - bool Empty() const
  759. Properties:
  760. - unsigned size (readonly)
  761. - unsigned capacity (readonly)
  762. - bool empty (readonly)
  763. ### Context
  764. Methods:
  765. - Object* GetEventSender() const
  766. - EventHandler* GetEventHandler() const
  767. - const String& GetTypeName(ShortStringHash type) const
  768. ### Object : RefCounted
  769. Methods:
  770. - ShortStringHash GetType() const
  771. - const String& GetTypeName() const
  772. - const String& GetCategory() const
  773. - void SendEvent(const String eventName, VariantMap* eventData = 0)
  774. Properties:
  775. - ShortStringHash type (readonly)
  776. - const String typeName (readonly)
  777. - const String category (readonly)
  778. ### Time : Object
  779. Methods:
  780. - unsigned GetFrameNumber() const
  781. - float GetTimeStep() const
  782. - unsigned GetTimerPeriod() const
  783. - float GetElapsedTime()
  784. - static unsigned GetSystemTime()
  785. - static String GetTimeStamp()
  786. - static void Sleep(unsigned mSec)
  787. Properties:
  788. - unsigned frameNumber (readonly)
  789. - float timeStep (readonly)
  790. - unsigned timerPeriod (readonly)
  791. - float elapsedTime (readonly)
  792. ### ResourceRef
  793. Methods:
  794. - ResourceRef()
  795. - ResourceRef(ShortStringHash type)
  796. - ResourceRef(ShortStringHash type, StringHash id)
  797. - ResourceRef(const ResourceRef& rhs)
  798. Properties:
  799. - ShortStringHash type
  800. - StringHash id
  801. - bool operator == (const ResourceRef& rhs) const
  802. ### ResourceRefList
  803. Methods:
  804. - ResourceRefList()
  805. - ResourceRefList(ShortStringHash type)
  806. Properties:
  807. - ShortStringHash type
  808. - bool operator == (const ResourceRefList& rhs) const
  809. ### Variant
  810. Methods:
  811. - Variant()
  812. - Variant(int value)
  813. - Variant(unsigned value)
  814. - Variant(const StringHash& value)
  815. - Variant(const ShortStringHash& value)
  816. - Variant(bool value)
  817. - Variant(float value)
  818. - Variant(const Vector2& value)
  819. - Variant(const Vector3& value)
  820. - Variant(const Vector4& value)
  821. - Variant(const Quaternion& value)
  822. - Variant(const Color& value)
  823. - Variant(const String value)
  824. - Variant(const char* value)
  825. - Variant(const ResourceRef& value)
  826. - Variant(const ResourceRefList& value)
  827. - Variant(const IntRect& value)
  828. - Variant(const IntVector2& value)
  829. - Variant(const String type, const String value)
  830. - Variant(VariantType type, const String value)
  831. - Variant(VariantType type, const char* value)
  832. - Variant(const Variant& value)
  833. - ~Variant()
  834. - void Clear()
  835. - bool operator == (const Variant& rhs) const
  836. - bool operator == (int rhs) const
  837. - bool operator == (unsigned rhs) const
  838. - bool operator == (bool rhs) const
  839. - bool operator == (float rhs) const
  840. - bool operator == (const Vector2& rhs)
  841. - bool operator == (const Vector3& rhs) const
  842. - bool operator == (const Vector4& rhs) const
  843. - bool operator == (const Quaternion& rhs) const
  844. - bool operator == (const Color& rhs) const
  845. - bool operator == (const String& rhs) const
  846. - bool operator == (const ResourceRef& rhs) const
  847. - bool operator == (const ResourceRefList& rhs) const
  848. - bool operator == (const IntRect& rhs) const
  849. - bool operator == (const IntVector2& rhs) const
  850. - bool operator == (const StringHash& rhs) const
  851. - bool operator == (const ShortStringHash& rhs) const
  852. - void SetInt(int value)
  853. - void SetUint(unsigned value)
  854. - void SetStringHash(const StringHash& value)
  855. - void SetShortStringHash(const ShortStringHash& value)
  856. - void SetBool(bool value)
  857. - void SetFloat(float value)
  858. - void SetVector2(const Vector2& value)
  859. - void SetVector3(const Vector3& value)
  860. - void SetVector4(const Vector4& value)
  861. - void SetQuaternion(const Quaternion& value)
  862. - void SetColor(const Color& value)
  863. - void SetString(const String value)
  864. - void SetBuffer(const VectorBuffer& value)
  865. - void SetResourceRef(const ResourceRef& value)
  866. - void SetResourceRefList(const ResourceRefList& value)
  867. - void SetIntRect(const IntRect& value)
  868. - void SetIntVector2(const IntVector2& value)
  869. - int GetInt() const
  870. - int GetUInt() const
  871. - StringHash GetStringHash()
  872. - ShortStringHash GetShortStringHash()
  873. - bool GetBool() const
  874. - float GetFloat() const
  875. - const Vector2& GetVector2() const
  876. - const Vector3& GetVector3() const
  877. - const Vector4& GetVector4() const
  878. - const Quaternion& GetQuaternion() const
  879. - const Color& GetColor() const
  880. - const String& GetString() const
  881. - VectorBuffer GetBuffer() const
  882. - const ResourceRef& GetResourceRef() const
  883. - const ResourceRefList& GetResourceRefList() const
  884. - const IntRect& GetIntRect() const
  885. - const IntVector2& GetIntVector2() const
  886. - VariantType GetType() const
  887. - String GetTypeName() const
  888. - String ToString() const
  889. - bool IsZero() const
  890. - bool IsEmpty() const
  891. Properties:
  892. - VariantType type (readonly)
  893. - String typeName (readonly)
  894. - bool zero (readonly)
  895. - bool empty (readonly)
  896. ### VariantMap
  897. Methods:
  898. - VariantMap()
  899. - ~VariantMap()
  900. - void SetInt(const String key, int value)
  901. - void SetUInt(const String key, unsigned value)
  902. - void SetStringHash(const String key, const StringHash& value)
  903. - void SetShortStringHash(const String key, const ShortStringHash& value)
  904. - void SetBool(const String key, bool value)
  905. - void SetFloat(const String key, float value)
  906. - void SetVector2(const String key, const Vector2 value)
  907. - void SetVector3(const String key, const Vector3 value)
  908. - void SetVector4(const String key, const Vector4 value)
  909. - void SetQuaternion(const String key, const Quaternion value)
  910. - void SetColor(const String key, const Color value)
  911. - void SetString(const String key, const String value)
  912. - void SetBuffer(const String key, const VectorBuffer& value)
  913. - void SetResourceRef(const String key, const ResourceRef value)
  914. - void SetResourceRefList(const String key, const ResourceRefList value)
  915. - void SetIntRect(const String key, const IntRect value)
  916. - void SetIntVector2(const String key, const IntVector2 value)
  917. - void SetPtr(const String key, void* value)
  918. - int GetInt(const String key)
  919. - int GetUInt(const String key)
  920. - StringHash GetStringHash(const String key)
  921. - ShortStringHash GetShortStringHash(const String key)
  922. - bool GetBool(const String key)
  923. - float GetFloat(const String key)
  924. - const Vector2& GetVector2(const String key)
  925. - const Vector3& GetVector3(const String key)
  926. - const Vector4& GetVector4(const String key)
  927. - const Quaternion& GetQuaternion(const String key)
  928. - const Color& GetColor(const String key)
  929. - const String& GetString(const String key)
  930. - VectorBuffer GetBuffer(const String key)
  931. - const ResourceRef& GetResourceRef(const String key)
  932. - const ResourceRefList& GetResourceRefList(const String key)
  933. - const IntRect& GetIntRect(const String key)
  934. - const IntVector2& GetIntVector2(const String key)
  935. - const void* GetPtr(const String type, const String key)
  936. ### Console : Object
  937. Methods:
  938. - void SetDefaultStyle(XMLFile* style)
  939. - void SetVisible(bool enable)
  940. - void Toggle()
  941. - void SetNumRows(unsigned rows)
  942. - void SetNumHistoryRows(unsigned rows)
  943. - void UpdateElements()
  944. - XMLFile* GetDefaultStyle() const
  945. - BorderImage* GetBackground() const
  946. - LineEdit* GetLineEdit() const
  947. - bool IsVisible() const
  948. - unsigned GetNumRows() const
  949. - unsigned GetNumHistoryRows() const
  950. - unsigned GetHistoryPosition() const
  951. - const String& GetHistoryRow(unsigned index) const
  952. Properties:
  953. - XMLFile* defaultStyle
  954. - BorderImage* background (readonly)
  955. - LineEdit* lineEdit (readonly)
  956. - bool visible
  957. - unsigned numRows
  958. - unsigned numHistoryRows
  959. - unsigned historyPosition (readonly)
  960. ### DebugHud : Object
  961. Methods:
  962. - void SetDefaultStyle(XMLFile* style)
  963. - void SetMode(unsigned mode)
  964. - void SetProfilerMaxDepth(unsigned depth)
  965. - void SetProfilerInterval(float interval)
  966. - void SetUseRendererStats(bool enable)
  967. - void Toggle(unsigned mode)
  968. - void ToggleAll()
  969. - XMLFile* GetDefaultStyle() const
  970. - Text* GetStatsText() const
  971. - Text* GetModeText() const
  972. - Text* GetProfilerText() const
  973. - unsigned GetMode() const
  974. - unsigned GetProfilerMaxDepth() const
  975. - float GetProfilerInterval() const
  976. - bool GetUseRendererStats() const
  977. - void SetAppStats(const String label, const Variant stats)
  978. - void SetAppStats(const String label, const String stats)
  979. - bool ResetAppStats(const String label)
  980. - void ClearAppStats()
  981. Properties:
  982. - XMLFile* defaultStyle
  983. - Text* statsText (readonly)
  984. - Text* modeText (readonly)
  985. - Text* profilerText (readonly)
  986. - unsigned mode
  987. - unsigned profilerMaxDepth
  988. - float profilerInterval
  989. - bool useRendererStats
  990. ### Engine : Object
  991. Methods:
  992. - void RunFrame()
  993. - Console* CreateConsole()
  994. - DebugHud* CreateDebugHud()
  995. - void SetMinFps(int fps)
  996. - void SetMaxFps(int fps)
  997. - void SetMaxInactiveFps(int fps)
  998. - void SetPauseMinimized(bool enable)
  999. - void SetAutoExit(bool enable)
  1000. - void Exit()
  1001. - void DumpProfiler()
  1002. - void DumpResources()
  1003. - void DumpMemory()
  1004. - int GetMinFps() const
  1005. - int GetMaxFps() const
  1006. - int GetMaxInactiveFps() const
  1007. - bool GetPauseMinimized() const
  1008. - bool GetAutoExit() const
  1009. - bool IsInitialized() const
  1010. - bool IsExiting() const
  1011. - bool IsHeadless() const
  1012. Properties:
  1013. - int minFps
  1014. - int maxFps
  1015. - int maxInactiveFps
  1016. - bool pauseMinimized
  1017. - bool autoExit
  1018. - bool initialized (readonly)
  1019. - bool exiting (readonly)
  1020. - bool headless (readonly)
  1021. ### AnimatedModel : StaticModel
  1022. Methods:
  1023. - void SetModel(Model* model)
  1024. - AnimationState* AddAnimationState(Animation* animation)
  1025. - void RemoveAnimationState(Animation* animation)
  1026. - void RemoveAnimationState(const String animationName)
  1027. - void RemoveAnimationState(StringHash animationNameHash)
  1028. - void RemoveAnimationState(AnimationState* state)
  1029. - void RemoveAnimationState(unsigned index)
  1030. - void RemoveAllAnimationStates()
  1031. - void SetAnimationLodBias(float bias)
  1032. - void SetInvisibleLodFactor(float factor)
  1033. - void SetMorphWeight(unsigned index, float weight)
  1034. - void SetMorphWeight(const String name, float weight)
  1035. - void SetMorphWeight(StringHash nameHash, float weight)
  1036. - void ResetMorphWeights()
  1037. - Skeleton& GetSkeleton()
  1038. - unsigned GetNumAnimationStates() const
  1039. - AnimationState* GetAnimationState(Animation* animation) const
  1040. - AnimationState* GetAnimationState(const String animationName) const
  1041. - AnimationState* GetAnimationState(const StringHash animationNameHash) const
  1042. - AnimationState* GetAnimationState(unsigned index) const
  1043. - float GetAnimationLodBias() const
  1044. - float GetInvisibleLodFactor() const
  1045. - unsigned GetNumMorphs() const
  1046. - float GetMorphWeight(unsigned index) const
  1047. - float GetMorphWeight(const String name) const
  1048. - float GetMorphWeight(StringHash nameHash) const
  1049. - bool IsMaster() const
  1050. Properties:
  1051. - Model* model
  1052. - Skeleton& skeleton (readonly)
  1053. - unsigned numAnimationStates (readonly)
  1054. - float animationLodBias
  1055. - float invisibleLodFactor
  1056. - unsigned numMorphs (readonly)
  1057. - bool master (readonly)
  1058. ### AnimationKeyFrame
  1059. Methods:
  1060. Properties:
  1061. - float time
  1062. - Vector3 position
  1063. - Quaternion rotation
  1064. - Vector3 scale
  1065. ### Animation : Resource
  1066. Methods:
  1067. - const String& GetAnimationName() const
  1068. - StringHash GetAnimationNameHash() const
  1069. - float GetLength() const
  1070. - unsigned GetNumTracks() const
  1071. - const AnimationTrack* GetTrack(unsigned index) const
  1072. - const AnimationTrack* GetTrack(const String name) const
  1073. - const AnimationTrack* GetTrack(StringHash nameHash) const
  1074. - unsigned GetNumTriggers() const
  1075. Properties:
  1076. - String& animationName (readonly)
  1077. - StringHash animationNameHash (readonly)
  1078. - float length (readonly)
  1079. - unsigned numTracks (readonly)
  1080. - unsigned numTriggers (readonly)
  1081. ### AnimationControl
  1082. Methods:
  1083. - AnimationControl()
  1084. Properties:
  1085. - StringHash hash_
  1086. - float speed_
  1087. - float targetWeight_
  1088. - float fadeTime_
  1089. - float autoFadeTime_
  1090. - float setTimeTtl_
  1091. - float setWeightTtl_
  1092. - unsigned short setTime_
  1093. - unsigned char setWeight_
  1094. - unsigned char setTimeRev_
  1095. - unsigned char setWeightRev_
  1096. ### AnimationController : Component
  1097. Methods:
  1098. - bool Play(const String name, unsigned char layer, bool looped, float fadeInTime = 0.0f)
  1099. - bool PlayExclusive(const String name, unsigned char layer, bool looped, float fadeTime = 0.0f)
  1100. - bool Stop(const String name, float fadeOutTime = 0.0f)
  1101. - void StopLayer(unsigned char layer, float fadeOutTime = 0.0f)
  1102. - void StopAll(float fadeTime = 0.0f)
  1103. - bool Fade(const String name, float targetWeight, float fadeTime)
  1104. - bool FadeOthers(const String name, float targetWeight, float fadeTime)
  1105. - bool SetLayer(const String name, unsigned char layer)
  1106. - bool SetStartBone(const String name, const String startBoneName)
  1107. - bool SetTime(const String name, float time)
  1108. - bool SetWeight(const String name, float weight)
  1109. - bool SetLooped(const String name, bool enable)
  1110. - bool SetSpeed(const String name, float speed)
  1111. - bool SetAutoFade(const String name, float fadeOutTime)
  1112. - bool IsPlaying(const String name) const
  1113. - bool IsFadingIn(const String name) const
  1114. - bool IsFadingOut(const String name) const
  1115. - unsigned char GetLayer(const String name) const
  1116. - Bone* GetStartBone(const String name) const
  1117. - const String& GetStartBoneName(const String name) const
  1118. - float GetTime(const String name) const
  1119. - float GetWeight(const String name) const
  1120. - bool IsLooped(const String name) const
  1121. - float GetLength(const String name) const
  1122. - float GetSpeed(const String name) const
  1123. - float GetFadeTarget(const String name) const
  1124. - float GetFadeTime(const String name) const
  1125. - float GetAutoFade(const String name) const
  1126. ### AnimationState
  1127. Methods:
  1128. - AnimationState(AnimatedModel* model, Animation* animation)
  1129. - AnimationState(Node* node, Animation* animation)
  1130. - ~AnimationState()
  1131. - void SetStartBone(Bone* bone)
  1132. - void SetLooped(bool looped)
  1133. - void SetWeight(float weight)
  1134. - void SetTime(float time)
  1135. - void SetBoneWeight(unsigned index, float weight)
  1136. - void SetBoneWeight(const String name, float weight)
  1137. - void SetBoneWeight(StringHash nameHash, float weight)
  1138. - void AddWeight(float delta)
  1139. - void AddTime(float delta)
  1140. - void SetLayer(unsigned char layer)
  1141. - Animation* GetAnimation() const
  1142. - Bone* GetStartBone() const
  1143. - float GetBoneWeight(unsigned index) const
  1144. - float GetBoneWeight(const String name) const
  1145. - float GetBoneWeight(StringHash nameHash) const
  1146. - unsigned GetTrackIndex(const String name) const
  1147. - unsigned GetTrackIndex(StringHash nameHash) const
  1148. - bool IsEnabled() const
  1149. - bool IsLooped() const
  1150. - float GetWeight() const
  1151. - float GetTime() const
  1152. - float GetLength() const
  1153. - unsigned char GetLayer() const
  1154. Properties:
  1155. - Animation* animation (readonly)
  1156. - Bone* startBone
  1157. - bool enabled (readonly)
  1158. - bool looped
  1159. - float weight
  1160. - float time
  1161. - float length (readonly)
  1162. - unsigned char layer
  1163. ### Billboard
  1164. Methods:
  1165. Properties:
  1166. - Vector3 position
  1167. - Vector2 size
  1168. - Rect uv
  1169. - Color color
  1170. - float rotation
  1171. - bool enabled
  1172. - float sortDistance
  1173. ### BillboardSet : Drawable
  1174. Methods:
  1175. - void SetMaterial(Material* material)
  1176. - void SetNumBillboards(unsigned num)
  1177. - void SetRelative(bool enable)
  1178. - void SetScaled(bool enable)
  1179. - void SetSorted(bool enable)
  1180. - void SetAnimationLodBias(float bias)
  1181. - void Commit()
  1182. - Material* GetMaterial() const
  1183. - unsigned GetNumBillboards() const
  1184. - Billboard* GetBillboard(unsigned index)
  1185. - bool IsRelative() const
  1186. - bool IsScaled() const
  1187. - bool IsSorted() const
  1188. - float GetAnimationLodBias() const
  1189. Properties:
  1190. - Material* material
  1191. - unsigned numBillboards
  1192. - bool relative
  1193. - bool scaled
  1194. - bool sorted
  1195. - float animationLodBias
  1196. ### Camera : Component
  1197. Methods:
  1198. - void SetNearClip(float nearClip)
  1199. - void SetFarClip(float farClip)
  1200. - void SetFov(float fov)
  1201. - void SetOrthoSize(float orthoSize)
  1202. - void SetOrthoSize(const Vector2& orthoSize)
  1203. - void SetAspectRatio(float aspectRatio)
  1204. - void SetFillMode(FillMode mode)
  1205. - void SetZoom(float zoom)
  1206. - void SetLodBias(float bias)
  1207. - void SetViewMask(unsigned mask)
  1208. - void SetViewOverrideFlags(unsigned flags)
  1209. - void SetOrthographic(bool enable)
  1210. - void SetAutoAspectRatio(bool enable)
  1211. - void SetProjectionOffset(const Vector2& offset)
  1212. - float GetFarClip() const
  1213. - float GetNearClip() const
  1214. - float GetFov() const
  1215. - float GetOrthoSize() const
  1216. - float GetAspectRatio() const
  1217. - float GetZoom() const
  1218. - float GetLodBias() const
  1219. - unsigned GetViewMask() const
  1220. - unsigned GetViewOverrideFlags() const
  1221. - FillMode GetFillMode() const
  1222. - bool IsOrthographic() const
  1223. - bool GetAutoAspectRatio() const
  1224. - const Frustum& GetFrustum() const
  1225. - const Matrix4& GetProjection() const
  1226. - Matrix4 GetProjection(bool apiSpecific) const
  1227. - const Matrix3x4& GetView() const
  1228. - void GetFrustumSize(Vector3& near, Vector3& far) const
  1229. - float GetHalfViewSize() const
  1230. - Frustum GetSplitFrustum(float nearClip, float farClip) const
  1231. - Frustum GetViewSpaceFrustum() const
  1232. - Frustum GetViewSpaceSplitFrustum(float nearClip, float farClip) const
  1233. - Ray GetScreenRay(float x, float y) const
  1234. - Vector2 WorldToScreenPoint(const Vector3& worldPos) const
  1235. - Vector3 ScreenToWorldPoint(const Vector3& screenPos) const
  1236. - Vector3 GetForwardVector() const
  1237. - Vector3 GetRightVector() const
  1238. - Vector3 GetUpVector() const
  1239. - const Vector2& GetProjectionOffset() const
  1240. - float GetDistance(const Vector3& worldPos) const
  1241. - float GetDistanceSquared(const Vector3& worldPos) const
  1242. - float GetLodDistance(float distance, float scale, float bias) const
  1243. - bool IsProjectionValid() const
  1244. Properties:
  1245. - float farClip
  1246. - float nearClip
  1247. - float fov
  1248. - float orthoSize
  1249. - float aspectRatio
  1250. - float zoom
  1251. - float lodBias
  1252. - unsigned viewMask
  1253. - unsigned viewOverrideFlags
  1254. - FillMode fillMode
  1255. - bool orthographic
  1256. - bool autoAspectRatio
  1257. - Frustum& frustum (readonly)
  1258. - Matrix4& projection (readonly)
  1259. - Matrix3x4& view (readonly)
  1260. - float halfViewSize (readonly)
  1261. - Frustum viewSpaceFrustum (readonly)
  1262. - Vector3 forwardVector (readonly)
  1263. - Vector3 rightVector (readonly)
  1264. - Vector3 upVector (readonly)
  1265. - Vector2& projectionOffset
  1266. - bool projectionValid (readonly)
  1267. ### DebugRenderer : Component
  1268. Methods:
  1269. - void SetView(Camera* camera)
  1270. - void AddLine(const Vector3& start, const Vector3& end, const Color& color, bool depthTest = true)
  1271. - void AddLine(const Vector3& start, const Vector3& end, unsigned color, bool depthTest = true)
  1272. - void AddNode(Node* node, float scale = 1.0f, bool depthTest = true)
  1273. - void AddBoundingBox(const BoundingBox& box, const Color& color, bool depthTest = true)
  1274. - void AddBoundingBox(const BoundingBox& box, const Matrix3x4& transform, const Color& color, bool depthTest = true)
  1275. - void AddFrustum(const Frustum& frustum, const Color& color, bool depthTest = true)
  1276. - void AddPolyhedron(const Polyhedron& poly, const Color& color, bool depthTest = true)
  1277. - void AddSphere(const Sphere& sphere, const Color& color, bool depthTest = true)
  1278. - void AddSkeleton(const Skeleton& skeleton, const Color& color, bool depthTest = true)
  1279. - 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)
  1280. - void Render()
  1281. - const Matrix3x4& GetView() const
  1282. - const Matrix4& GetProjection() const
  1283. - const Frustum& GetFrustum() const
  1284. - bool IsInside(const BoundingBox& box) const
  1285. Properties:
  1286. - Matrix3x4& view (readonly)
  1287. - Matrix4& projection (readonly)
  1288. - Frustum& frustum (readonly)
  1289. ### DecalSet : Drawable
  1290. Methods:
  1291. - void SetMaterial(Material* material)
  1292. - void SetMaxVertices(unsigned num)
  1293. - void SetMaxIndices(unsigned num)
  1294. - 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)
  1295. - void RemoveDecals(unsigned num)
  1296. - void RemoveAllDecals()
  1297. - Material* GetMaterial() const
  1298. - unsigned GetNumDecals() const
  1299. - unsigned GetNumVertices() const
  1300. - unsigned GetNumIndices() const
  1301. - unsigned GetMaxVertices() const
  1302. - unsigned GetMaxIndices() const
  1303. Properties:
  1304. - Material* material
  1305. - unsigned numDecals (readonly)
  1306. - unsigned numVertices (readonly)
  1307. - unsigned numIndices (readonly)
  1308. - unsigned maxVertices
  1309. - unsigned maxIndices
  1310. ### Drawable : Component
  1311. Methods:
  1312. - void SetDrawDistance(float distance)
  1313. - void SetShadowDistance(float distance)
  1314. - void SetLodBias(float bias)
  1315. - void SetViewMask(unsigned mask)
  1316. - void SetLightMask(unsigned mask)
  1317. - void SetShadowMask(unsigned mask)
  1318. - void SetZoneMask(unsigned mask)
  1319. - void SetMaxLights(unsigned num)
  1320. - void SetCastShadows(bool enable)
  1321. - void SetOccluder(bool enable)
  1322. - void SetOccludee(bool enable)
  1323. - void MarkForUpdate()
  1324. - const BoundingBox& GetBoundingBox() const
  1325. - const BoundingBox& GetWorldBoundingBox()
  1326. - unsigned char GetDrawableFlags() const
  1327. - float GetDrawDistance() const
  1328. - float GetShadowDistance() const
  1329. - float GetLodBias() const
  1330. - unsigned GetViewMask() const
  1331. - unsigned GetLightMask() const
  1332. - unsigned GetShadowMask() const
  1333. - unsigned GetZoneMask() const
  1334. - unsigned GetMaxLights() const
  1335. - bool GetCastShadows() const
  1336. - bool IsOccluder() const
  1337. - bool IsOccludee() const
  1338. - void SetZone(Zone* zone, bool temporary = false)
  1339. - void SetSortValue(float value)
  1340. - void SetMinMaxZ(float minZ, float maxZ)
  1341. - void MarkInView(const FrameInfo& frame, bool mainView = true)
  1342. - void ClearLights()
  1343. - void AddLight(Light* light)
  1344. - void AddVertexLight(Light* light)
  1345. - void LimitLights()
  1346. - void LimitVertexLights()
  1347. - void SetBasePass(unsigned batchIndex)
  1348. - Octant* GetOctant() const
  1349. - Zone* GetZone() const
  1350. - Zone* GetLastZone() const
  1351. - bool IsZoneDirty() const
  1352. - float GetDistance() const
  1353. - float GetLodDistance() const
  1354. - float GetSortValue() const
  1355. - bool IsInView(unsigned frameNumber) const
  1356. - bool IsInView(const FrameInfo& frame, bool mainView = true) const
  1357. - bool HasBasePass(unsigned batchIndex) const
  1358. - Light* GetFirstLight() const
  1359. - float GetMinZ() const
  1360. - float GetMaxZ() const
  1361. Properties:
  1362. - BoundingBox& worldBoundingBox (readonly)
  1363. - unsigned char drawableFlags (readonly)
  1364. - float drawDistance
  1365. - float shadowDistance
  1366. - float lodBias
  1367. - unsigned viewMask
  1368. - unsigned lightMask
  1369. - unsigned shadowMask
  1370. - unsigned zoneMask
  1371. - unsigned maxLights
  1372. - bool castShadows
  1373. - bool occluder
  1374. - bool occludee
  1375. - Octant* octant (readonly)
  1376. - Zone* zone
  1377. - Zone* lastZone (readonly)
  1378. - bool zoneDirty (readonly)
  1379. - float distance (readonly)
  1380. - float lodDistance (readonly)
  1381. - float sortValue
  1382. - Light* firstLight (readonly)
  1383. - float minZ (readonly)
  1384. - float maxZ (readonly)
  1385. ### Graphics : Object
  1386. Methods:
  1387. - void SetWindowTitle(const String windowTitle)
  1388. - bool SetMode(int width, int height, bool fullscreen, bool resizable, bool vsync, bool tripleBuffer, int multiSample)
  1389. - bool SetMode(int width, int height)
  1390. - void SetSRGB(bool enable)
  1391. - bool ToggleFullscreen()
  1392. - void Close()
  1393. - bool TakeScreenShot(Image& destImage)
  1394. - bool IsInitialized() const
  1395. - void* GetExternalWindow() const
  1396. - const String& GetWindowTitle() const
  1397. - int GetWidth() const
  1398. - int GetHeight() const
  1399. - int GetMultiSample() const
  1400. - bool GetFullscreen() const
  1401. - bool GetResizable() const
  1402. - bool GetVSync() const
  1403. - bool GetTripleBuffer() const
  1404. - bool GetSRGB() const
  1405. - bool IsDeviceLost() const
  1406. - unsigned GetNumPrimitives() const
  1407. - unsigned GetNumBatches() const
  1408. - unsigned GetDummyColorFormat() const
  1409. - unsigned GetShadowMapFormat() const
  1410. - unsigned GetHiresShadowMapFormat() const
  1411. - bool GetSM3Support() const
  1412. - bool GetInstancingSupport() const
  1413. - bool GetLightPrepassSupport() const
  1414. - bool GetDeferredSupport() const
  1415. - bool GetHardwareShadowSupport() const
  1416. - bool GetStreamOffsetSupport() const
  1417. - bool GetSRGBSupport() const
  1418. - bool GetSRGBWriteSupport() const
  1419. - static unsigned GetRGBFormat()
  1420. Properties:
  1421. - bool initialized (readonly)
  1422. - const String windowTitle
  1423. - int width (readonly)
  1424. - int height (readonly)
  1425. - int multiSample (readonly)
  1426. - bool fullscreen (readonly)
  1427. - bool resizable (readonly)
  1428. - bool vSync (readonly)
  1429. - bool tripleBuffer (readonly)
  1430. - bool sRGB
  1431. - bool deviceLost (readonly)
  1432. - unsigned numPrimitives (readonly)
  1433. - unsigned numBatches (readonly)
  1434. - unsigned dummyColorFormat (readonly)
  1435. - unsigned shadowMapFormat (readonly)
  1436. - unsigned hiresShadowMapFormat (readonly)
  1437. - bool sM3Support (readonly)
  1438. - bool instancingSupport (readonly)
  1439. - bool lightPrepassSupport (readonly)
  1440. - bool deferredSupport (readonly)
  1441. - bool hardwareShadowSupport (readonly)
  1442. - bool streamOffsetSupport (readonly)
  1443. - bool sRGBSupport (readonly)
  1444. - bool sRGBWriteSupport (readonly)
  1445. ### BiasParameters
  1446. Methods:
  1447. - BiasParameters()
  1448. - BiasParameters(float constantBias, float slopeScaledBias)
  1449. ### CascadeParameters
  1450. Methods:
  1451. - CascadeParameters()
  1452. - CascadeParameters(float split1, float split2, float split3, float split4, float fadeStart, float biasAutoAdjust = 1.0f)
  1453. ### FocusParameters
  1454. Methods:
  1455. - FocusParameters()
  1456. - FocusParameters(bool focus, bool nonUniform, bool autoSize, float quantize, float minView)
  1457. ### Light : Drawable
  1458. Methods:
  1459. - void SetLightType(LightType type)
  1460. - void SetPerVertex(bool enable)
  1461. - void SetColor(const Color& color)
  1462. - void SetSpecularIntensity(float intensity)
  1463. - void SetRange(float range)
  1464. - void SetFov(float fov)
  1465. - void SetAspectRatio(float aspectRatio)
  1466. - void SetFadeDistance(float distance)
  1467. - void SetShadowFadeDistance(float distance)
  1468. - void SetShadowBias(const BiasParameters& parameters)
  1469. - void SetShadowCascade(const CascadeParameters& parameters)
  1470. - void SetShadowFocus(const FocusParameters& parameters)
  1471. - void SetShadowIntensity(float intensity)
  1472. - void SetShadowResolution(float resolution)
  1473. - void SetShadowNearFarRatio(float nearFarRatio)
  1474. - void SetRampTexture(Texture* texture)
  1475. - void SetShapeTexture(Texture* texture)
  1476. - LightType GetLightType() const
  1477. - bool GetPerVertex() const
  1478. - const Color& GetColor() const
  1479. - float GetSpecularIntensity() const
  1480. - float GetRange() const
  1481. - float GetFov() const
  1482. - float GetAspectRatio() const
  1483. - float GetFadeDistance() const
  1484. - float GetShadowFadeDistance() const
  1485. - const BiasParameters& GetShadowBias() const
  1486. - const CascadeParameters& GetShadowCascade() const
  1487. - const FocusParameters& GetShadowFocus() const
  1488. - float GetShadowIntensity() const
  1489. - float GetShadowResolution() const
  1490. - float GetShadowNearFarRatio() const
  1491. - Texture* GetRampTexture() const
  1492. - Texture* GetShapeTexture() const
  1493. - Frustum GetFrustum() const
  1494. Properties:
  1495. - LightType lightType
  1496. - bool perVertex
  1497. - Color& color
  1498. - float specularIntensity
  1499. - float range
  1500. - float fov
  1501. - float aspectRatio
  1502. - float fadeDistance
  1503. - float shadowFadeDistance
  1504. - BiasParameters& shadowBias
  1505. - CascadeParameters& shadowCascade
  1506. - FocusParameters& shadowFocus
  1507. - float shadowIntensity
  1508. - float shadowResolution
  1509. - float shadowNearFarRatio
  1510. - Texture* rampTexture
  1511. - Texture* shapeTexture
  1512. - Frustum frustum (readonly)
  1513. ### Material : Resource
  1514. Methods:
  1515. - Material(Context* context)
  1516. - ~Material()
  1517. - void SetNumTechniques(unsigned num)
  1518. - void SetTechnique(unsigned index, Technique* tech, unsigned qualityLevel = 0, float lodDistance = 0.0f)
  1519. - void SetShaderParameter(const String name, const Variant& value)
  1520. - void SetTexture(TextureUnit unit, Texture* texture)
  1521. - void SetUVTransform(const Vector2& offset, float rotation, const Vector2& repeat)
  1522. - void SetUVTransform(const Vector2& offset, float rotation, float repeat)
  1523. - void SetCullMode(CullMode mode)
  1524. - void SetShadowCullMode(CullMode mode)
  1525. - void SetDepthBias(const BiasParameters& parameters)
  1526. - void RemoveShaderParameter(const String name)
  1527. - void ReleaseShaders()
  1528. - void SortTechniques()
  1529. - void MarkForAuxView(unsigned frameNumber)
  1530. - unsigned GetNumTechniques() const
  1531. - Technique* GetTechnique(unsigned index) const
  1532. - Pass* GetPass(unsigned index, StringHash passType) const
  1533. - Pass* GetPass(unsigned index, const String passType) const
  1534. - Texture* GetTexture(TextureUnit unit) const
  1535. - CullMode GetCullMode() const
  1536. - CullMode GetShadowCullMode() const
  1537. - const BiasParameters& GetDepthBias() const
  1538. - unsigned GetAuxViewFrameNumber() const
  1539. - bool GetOcclusion() const
  1540. - bool GetSpecular() const
  1541. Properties:
  1542. - CullMode cullMode (readonly)
  1543. - CullMode shadowCullMode (readonly)
  1544. - unsigned auxViewFrameNumber (readonly)
  1545. - bool occlusion (readonly)
  1546. - bool specular (readonly)
  1547. ### Model : Resource
  1548. Methods:
  1549. - const BoundingBox& GetBoundingBox() const
  1550. - Skeleton& GetSkeleton()
  1551. - unsigned GetNumGeometries() const
  1552. - unsigned GetNumGeometryLodLevels(unsigned index) const
  1553. - Geometry* GetGeometry(unsigned index, unsigned lodLevel) const
  1554. - unsigned GetNumMorphs() const
  1555. - const ModelMorph* GetMorph(unsigned index) const
  1556. - const ModelMorph* GetMorph(const String name) const
  1557. - const ModelMorph* GetMorph(StringHash nameHash) const
  1558. - unsigned GetMorphRangeStart(unsigned bufferIndex) const
  1559. - unsigned GetMorphRangeCount(unsigned bufferIndex) const
  1560. Properties:
  1561. - BoundingBox& boundingBox (readonly)
  1562. - Skeleton skeleton (readonly)
  1563. - unsigned numGeometries (readonly)
  1564. - unsigned numMorphs (readonly)
  1565. ### Octree : Component
  1566. Methods:
  1567. - void SetSize(const BoundingBox& box, unsigned numLevels)
  1568. - void Update(const FrameInfo& frame)
  1569. - void AddManualDrawable(Drawable* drawable)
  1570. - void RemoveManualDrawable(Drawable* drawable)
  1571. - RayQueryResult RaycastSingle(const Ray& ray, RayQueryLevel level, float maxDistance, unsigned char drawableFlags) const
  1572. - unsigned GetNumLevels() const
  1573. - void QueueUpdate(Drawable* drawable)
  1574. - void DrawDebugGeometry(bool depthTest)
  1575. Properties:
  1576. - unsigned numLevels (readonly)
  1577. ### RayQueryResult
  1578. Methods:
  1579. Properties:
  1580. - Drawable* drawable
  1581. - Node* node
  1582. - float distance
  1583. - unsigned subObject
  1584. ### ColorFrame
  1585. Methods:
  1586. - ColorFrame()
  1587. - ColorFrame(const Color& color)
  1588. - ColorFrame(const Color& color, float time)
  1589. - Color Interpolate(const ColorFrame& next, float time)
  1590. Properties:
  1591. - Color color
  1592. - float time
  1593. ### TextureFrame
  1594. Methods:
  1595. - TextureFrame()
  1596. Properties:
  1597. - Rect uv
  1598. - float time
  1599. ### ParticleEmitter : BillboardSet
  1600. Methods:
  1601. - bool Load(XMLFile* file)
  1602. - void SetNumParticles(unsigned num)
  1603. - void SetEmissionRate(float rate)
  1604. - void SetMinEmissionRate(float rate)
  1605. - void SetMaxEmissionRate(float rate)
  1606. - void SetEmitterType(EmitterType type)
  1607. - void SetEmitterSize(const Vector3& size)
  1608. - void SetActiveTime(float time)
  1609. - void SetInactiveTime(float time)
  1610. - void SetEmitting(bool enable, bool resetPeriod = false)
  1611. - void SetUpdateInvisible(bool enable)
  1612. - void SetTimeToLive(float time)
  1613. - void SetMinTimeToLive(float time)
  1614. - void SetMaxTimeToLive(float time)
  1615. - void SetParticleSize(const Vector2& size)
  1616. - void SetMinParticleSize(const Vector2& size)
  1617. - void SetMaxParticleSize(const Vector2& size)
  1618. - void SetMinDirection(const Vector3& direction)
  1619. - void SetMaxDirection(const Vector3& direction)
  1620. - void SetVelocity(float velocity)
  1621. - void SetMinVelocity(float velocity)
  1622. - void SetMaxVelocity(float velocity)
  1623. - void SetRotation(float rotation)
  1624. - void SetMinRotation(float rotation)
  1625. - void SetMaxRotation(float rotation)
  1626. - void SetRotationSpeed(float speed)
  1627. - void SetMinRotationSpeed(float speed)
  1628. - void SetMaxRotationSpeed(float speed)
  1629. - void SetConstantForce(const Vector3& force)
  1630. - void SetDampingForce(float force)
  1631. - void SetSizeAdd(float sizeAdd)
  1632. - void SetSizeMul(float sizeMul)
  1633. - void SetColor(const Color& color)
  1634. - void SetNumColors(unsigned num)
  1635. - void SetNumTextureFrames(unsigned num)
  1636. - unsigned GetNumParticles() const
  1637. - bool IsEmitting() const
  1638. - bool GetUpdateInvisible() const
  1639. - float GetMinEmissionRate() const
  1640. - float GetMaxEmissionRate() const
  1641. - EmitterType GetEmitterType() const
  1642. - const Vector3& GetEmitterSize() const
  1643. - float GetActiveTime() const
  1644. - float GetInactiveTime() const
  1645. - float GetMinTimeToLive() const
  1646. - float GetMaxTimeToLive() const
  1647. - const Vector2& GetMinParticleSize() const
  1648. - const Vector2& GetMaxParticleSize() const
  1649. - const Vector3& GetMinDirection() const
  1650. - const Vector3& GetMaxDirection() const
  1651. - float GetMinVelocity() const
  1652. - float GetMaxVelocity() const
  1653. - float GetMinRotation() const
  1654. - float GetMaxRotation() const
  1655. - float GetMinRotationSpeed() const
  1656. - float GetMaxRotationSpeed() const
  1657. - const Vector3& GetConstantForce() const
  1658. - float GetDampingForce() const
  1659. - float GetSizeAdd() const
  1660. - float GetSizeMul() const
  1661. - unsigned GetNumColors() const
  1662. - ColorFrame* GetColor(unsigned index)
  1663. - unsigned GetNumTextureFrames() const
  1664. - TextureFrame* GetTextureFrame(unsigned index)
  1665. Properties:
  1666. - unsigned numParticles
  1667. - bool emitting
  1668. - bool updateInvisible
  1669. - float minEmissionRate
  1670. - float maxEmissionRate
  1671. - EmitterType emitterType
  1672. - Vector3& emitterSize
  1673. - float activeTime
  1674. - float inactiveTime
  1675. - float minTimeToLive
  1676. - float maxTimeToLive
  1677. - Vector2& minParticleSize
  1678. - Vector2& maxParticleSize
  1679. - Vector3& minDirection
  1680. - Vector3& maxDirection
  1681. - float minVelocity
  1682. - float maxVelocity
  1683. - float minRotation
  1684. - float maxRotation
  1685. - float minRotationSpeed
  1686. - float maxRotationSpeed
  1687. - Vector3& constantForce
  1688. - float dampingForce
  1689. - float sizeAdd
  1690. - float sizeMul
  1691. - unsigned numColors
  1692. - unsigned numTextureFrames
  1693. ### Renderer
  1694. Methods:
  1695. - void SetNumViewports(unsigned num)
  1696. - void SetViewport(unsigned index, Viewport* viewport)
  1697. - void SetDefaultRenderPath(RenderPath* renderPath)
  1698. - void SetDefaultRenderPath(XMLFile* file)
  1699. - void SetSpecularLighting(bool enable)
  1700. - void SetTextureAnisotropy(int level)
  1701. - void SetTextureFilterMode(TextureFilterMode mode)
  1702. - void SetTextureQuality(int quality)
  1703. - void SetMaterialQuality(int quality)
  1704. - void SetDrawShadows(bool enable)
  1705. - void SetShadowMapSize(int size)
  1706. - void SetShadowQuality(int quality)
  1707. - void SetReuseShadowMaps(bool enable)
  1708. - void SetMaxShadowMaps(int shadowMaps)
  1709. - void SetMaxShadowCascades(int cascades)
  1710. - void SetDynamicInstancing(bool enable)
  1711. - void SetMinInstances(int instances)
  1712. - void SetMaxInstanceTriangles(int triangles)
  1713. - void SetMaxSortedInstances(int instances)
  1714. - void SetMaxOccluderTriangles(int triangles)
  1715. - void SetOcclusionBufferSize(int size)
  1716. - void SetOccluderSizeThreshold(float screenSize)
  1717. - void ReloadShaders()
  1718. - unsigned GetNumViewports() const
  1719. - Viewport* GetViewport(unsigned index) const
  1720. - RenderPath* GetDefaultRenderPath() const
  1721. - bool GetSpecularLighting() const
  1722. - bool GetDrawShadows() const
  1723. - int GetTextureAnisotropy() const
  1724. - TextureFilterMode GetTextureFilterMode() const
  1725. - int GetTextureQuality() const
  1726. - int GetMaterialQuality() const
  1727. - int GetShadowMapSize() const
  1728. - int GetShadowQuality() const
  1729. - bool GetReuseShadowMaps() const
  1730. - int GetMaxShadowMaps() const
  1731. - int GetMaxShadowCascades() const
  1732. - bool GetDynamicInstancing() const
  1733. - int GetMinInstances() const
  1734. - int GetMaxInstanceTriangles() const
  1735. - int GetMaxSortedInstances() const
  1736. - int GetMaxOccluderTriangles() const
  1737. - int GetOcclusionBufferSize() const
  1738. - float GetOccluderSizeThreshold() const
  1739. - unsigned GetNumViews() const
  1740. - unsigned GetNumPrimitives() const
  1741. - unsigned GetNumBatches() const
  1742. - unsigned GetNumGeometries(bool allViews = false) const
  1743. - unsigned GetNumLights(bool allViews = false) const
  1744. - unsigned GetNumShadowMaps(bool allViews = false) const
  1745. - unsigned GetNumOccluders(bool allViews = false) const
  1746. - Zone* GetDefaultZone() const
  1747. - Light* GetQuadDirLight() const
  1748. - Material* GetDefaultMaterial() const
  1749. - Texture2D* GetDefaultLightRamp() const
  1750. - Texture2D* GetDefaultLightSpot() const
  1751. - TextureCube* GetFaceSelectCubeMap() const
  1752. - TextureCube* GetIndirectionCubeMap() const
  1753. - VertexBuffer* GetInstancingBuffer() const
  1754. - ShaderVariation* GetVertexShader(const String name, bool checkExists = false) const
  1755. - ShaderVariation* GetPixelShader(const String name, bool checkExists = false) const
  1756. - ShaderVariation* GetStencilVS() const
  1757. - ShaderVariation* GetStencilPS() const
  1758. - const FrameInfo& GetFrameInfo()
  1759. - void DrawDebugGeometry(bool depthTest)
  1760. Properties:
  1761. - unsigned numViewports
  1762. - RenderPath* defaultRenderPath
  1763. - bool specularLighting
  1764. - bool drawShadows
  1765. - int textureAnisotropy
  1766. - TextureFilterMode textureFilterMode
  1767. - int textureQuality
  1768. - int materialQuality
  1769. - int shadowMapSize
  1770. - int shadowQuality
  1771. - bool reuseShadowMaps
  1772. - int maxShadowMaps
  1773. - int maxShadowCascades
  1774. - bool dynamicInstancing
  1775. - int minInstances
  1776. - int maxInstanceTriangles
  1777. - int maxSortedInstances
  1778. - int maxOccluderTriangles
  1779. - int occlusionBufferSize
  1780. - float occluderSizeThreshold
  1781. - unsigned numViews (readonly)
  1782. - unsigned numPrimitives (readonly)
  1783. - unsigned numBatches (readonly)
  1784. - Zone* defaultZone (readonly)
  1785. - Light* quadDirLight (readonly)
  1786. - Material* defaultMaterial (readonly)
  1787. - Texture2D* defaultLightRamp (readonly)
  1788. - Texture2D* defaultLightSpot (readonly)
  1789. - TextureCube* faceSelectCubeMap (readonly)
  1790. - TextureCube* indirectionCubeMap (readonly)
  1791. - VertexBuffer* instancingBuffer (readonly)
  1792. - ShaderVariation* stencilVS (readonly)
  1793. - ShaderVariation* stencilPS (readonly)
  1794. ### RenderPath
  1795. Methods:
  1796. - RenderPath* Clone()
  1797. - bool Load(XMLFile* file)
  1798. - bool Append(XMLFile* file)
  1799. - void SetEnabled(const String tag, bool active)
  1800. - void ToggleEnabled(const String tag)
  1801. - void SetRenderTarget(unsigned index, const RenderTargetInfo& info)
  1802. - void AddRenderTarget(const RenderTargetInfo& info)
  1803. - void RemoveRenderTarget(unsigned index)
  1804. - void RemoveRenderTarget(const String name)
  1805. - void RemoveRenderTargets(const String tag)
  1806. - void SetCommand(unsigned index, const RenderPathCommand& command)
  1807. - void AddCommand(const RenderPathCommand& command)
  1808. - void InsertCommand(unsigned index, const RenderPathCommand& command)
  1809. - void RemoveCommand(unsigned index)
  1810. - void RemoveCommands(const String tag)
  1811. - void SetShaderParameter(const String name, const Variant& value)
  1812. - unsigned GetNumRenderTargets() const
  1813. - unsigned GetNumCommands() const
  1814. - const Variant& GetShaderParameter(const String name) const
  1815. ### RenderSurface
  1816. Methods:
  1817. - RenderSurface(Texture* parentTexture)
  1818. - ~RenderSurface()
  1819. - void SetNumViewports(unsigned num)
  1820. - void SetViewport(unsigned index, Viewport* viewport)
  1821. - void SetUpdateMode(RenderSurfaceUpdateMode mode)
  1822. - void SetLinkedRenderTarget(RenderSurface* renderTarget)
  1823. - void SetLinkedDepthStencil(RenderSurface* depthStencil)
  1824. - void QueueUpdate()
  1825. - void Release()
  1826. - Texture* GetParentTexture() const
  1827. - int GetWidth() const
  1828. - int GetHeight() const
  1829. - TextureUsage GetUsage() const
  1830. - unsigned GetNumViewports() const
  1831. - Viewport* GetViewport(unsigned index) const
  1832. - RenderSurfaceUpdateMode GetUpdateMode() const
  1833. - RenderSurface* GetLinkedRenderTarget() const
  1834. - RenderSurface* GetLinkedDepthStencil() const
  1835. Properties:
  1836. - Texture* parentTexture (readonly)
  1837. - int width (readonly)
  1838. - int height (readonly)
  1839. - TextureUsage usage (readonly)
  1840. - unsigned numViewports
  1841. - RenderSurfaceUpdateMode updateMode
  1842. - RenderSurface* linkedRenderTarget
  1843. - RenderSurface* linkedDepthStencil
  1844. ### Bone
  1845. Methods:
  1846. - Bone()
  1847. Properties:
  1848. - String name
  1849. - StringHash nameHash
  1850. - unsigned parentIndex
  1851. - Vector3 initialPosition
  1852. - Quaternion initialRotation
  1853. - Vector3 initialScale
  1854. - Matrix3x4 offsetMatrix
  1855. - bool animated
  1856. - unsigned char collisionMask
  1857. - float radius
  1858. - BoundingBox boundingBox
  1859. - Node* node
  1860. ### Skeleton
  1861. Methods:
  1862. - unsigned GetNumBones() const
  1863. - Bone* GetRootBone()
  1864. - Bone* GetBone(unsigned index)
  1865. Properties:
  1866. - unsigned numBones (readonly)
  1867. - Bone* rootBone (readonly)
  1868. ### Skybox : StaticModel
  1869. Methods:
  1870. ### StaticModelGeometryData
  1871. Methods:
  1872. Properties:
  1873. - Vector3 center
  1874. - unsigned lodLevel
  1875. ### StaticModel : Drawable
  1876. Methods:
  1877. - void SetModel(Model* model)
  1878. - void SetMaterial(Material* material)
  1879. - bool SetMaterial(unsigned index, Material* material)
  1880. - void SetOcclusionLodLevel(unsigned level)
  1881. - Model* GetModel() const
  1882. - unsigned GetNumGeometries() const
  1883. - Material* GetMaterial(unsigned index = 0) const
  1884. - unsigned GetOcclusionLodLevel() const
  1885. - bool IsInside(const Vector3& point) const
  1886. - bool IsInsideLocal(const Vector3& point) const
  1887. Properties:
  1888. - Model* model
  1889. - Material* material
  1890. - BoundingBox& boundingBox (readonly)
  1891. - unsigned numGeometries (readonly)
  1892. - unsigned occlusionLodLevel
  1893. ### StaticModelGroup : StaticModel
  1894. Methods:
  1895. - void AddInstanceNode(Node* node)
  1896. - void RemoveInstanceNode(Node* node)
  1897. - void RemoveAllInstanceNodes()
  1898. - unsigned GetNumInstanceNodes() const
  1899. - Node* GetInstanceNode(unsigned index) const
  1900. Properties:
  1901. - unsigned numInstanceNodes (readonly)
  1902. ### Pass : RefCounted
  1903. Methods:
  1904. ### Technique : Resource
  1905. Methods:
  1906. - bool HasPass(const String type) const
  1907. - Pass* GetPass(const String type) const
  1908. - bool IsSM3() const
  1909. Properties:
  1910. - bool SM3 (readonly)
  1911. ### Terrain : Component
  1912. Methods:
  1913. - void SetPatchSize(int size)
  1914. - void SetSpacing(const Vector3& spacing)
  1915. - void SetSmoothing(bool enable)
  1916. - bool SetHeightMap(Image* image)
  1917. - void SetMaterial(Material* material)
  1918. - void SetDrawDistance(float distance)
  1919. - void SetShadowDistance(float distance)
  1920. - void SetLodBias(float bias)
  1921. - void SetViewMask(unsigned mask)
  1922. - void SetLightMask(unsigned mask)
  1923. - void SetShadowMask(unsigned mask)
  1924. - void SetZoneMask(unsigned mask)
  1925. - void SetMaxLights(unsigned num)
  1926. - void SetCastShadows(bool enable)
  1927. - void SetOccluder(bool enable)
  1928. - void SetOccludee(bool enable)
  1929. - int GetPatchSize() const
  1930. - const Vector3& GetSpacing() const
  1931. - const IntVector2& GetNumVertices() const
  1932. - const IntVector2& GetNumPatches() const
  1933. - bool GetSmoothing() const
  1934. - Image* GetHeightMap() const
  1935. - Material* GetMaterial() const
  1936. - TerrainPatch* GetPatch(unsigned index) const
  1937. - TerrainPatch* GetPatch(int x, int z) const
  1938. - float GetHeight(const Vector3& worldPosition) const
  1939. - Vector3 GetNormal(const Vector3& worldPosition) const
  1940. - SharedArrayPtr<float> GetHeightData() const
  1941. - float GetDrawDistance() const
  1942. - float GetShadowDistance() const
  1943. - float GetLodBias() const
  1944. - unsigned GetViewMask() const
  1945. - unsigned GetLightMask() const
  1946. - unsigned GetShadowMask() const
  1947. - unsigned GetZoneMask() const
  1948. - unsigned GetMaxLights() const
  1949. - bool IsVisible() const
  1950. - bool GetCastShadows() const
  1951. - bool IsOccluder() const
  1952. - bool IsOccludee() const
  1953. Properties:
  1954. - int patchSize
  1955. - Vector3& spacing
  1956. - IntVector2& numVertices (readonly)
  1957. - IntVector2& numPatches (readonly)
  1958. - bool smoothing
  1959. - Image* heightMap
  1960. - Material* material
  1961. - float drawDistance
  1962. - float shadowDistance
  1963. - float lodBias
  1964. - unsigned viewMask
  1965. - unsigned lightMask
  1966. - unsigned shadowMask
  1967. - unsigned zoneMask
  1968. - unsigned maxLights
  1969. - bool visible (readonly)
  1970. - bool castShadows
  1971. - bool occluder
  1972. - bool occludee
  1973. ### TerrainPatch : Drawable
  1974. Methods:
  1975. - void SetOwner(Terrain* terrain)
  1976. - void SetNeighbors(TerrainPatch* north, TerrainPatch* south, TerrainPatch* west, TerrainPatch* east)
  1977. - void SetMaterial(Material* material)
  1978. - void SetBoundingBox(const BoundingBox& box)
  1979. - void SetCoordinates(const IntVector2& coordinates)
  1980. - void SetOcclusionOffset(float offset)
  1981. - void ResetLod()
  1982. - Geometry* GetGeometry() const
  1983. - Geometry* GetMaxLodGeometry() const
  1984. - Geometry* GetMinLodGeometry() const
  1985. - VertexBuffer* GetVertexBuffer() const
  1986. - Terrain* GetOwner() const
  1987. - TerrainPatch* GetNorthPatch() const
  1988. - TerrainPatch* GetSouthPatch() const
  1989. - TerrainPatch* GetWestPatch() const
  1990. - TerrainPatch* GetEastPatch() const
  1991. - const IntVector2& GetCoordinates() const
  1992. - unsigned GetLodLevel() const
  1993. - float GetOcclusionOffset() const
  1994. Properties:
  1995. - Geometry* geometry (readonly)
  1996. - Geometry* maxLodGeometry (readonly)
  1997. - Geometry* minLodGeometry (readonly)
  1998. - VertexBuffer* vertexBuffer (readonly)
  1999. - Terrain* owner
  2000. - TerrainPatch* northPatch (readonly)
  2001. - TerrainPatch* southPatch (readonly)
  2002. - TerrainPatch* westPatch (readonly)
  2003. - TerrainPatch* eastPatch (readonly)
  2004. - BoundingBox& boundingBox
  2005. - IntVector2& coordinates
  2006. - unsigned lodLevel (readonly)
  2007. - float occlusionOffset
  2008. ### Texture : Resource
  2009. Methods:
  2010. - void SetNumLevels(unsigned levels)
  2011. - void SetFilterMode(TextureFilterMode filter)
  2012. - void SetAddressMode(TextureCoordinate coord, TextureAddressMode address)
  2013. - void SetBorderColor(const Color& color)
  2014. - void SetSRGB(bool enable)
  2015. - void SetBackupTexture(Texture* texture)
  2016. - void SetMipsToSkip(int quality, int mips)
  2017. - unsigned GetFormat() const
  2018. - bool IsCompressed() const
  2019. - unsigned GetLevels() const
  2020. - int GetWidth() const
  2021. - int GetHeight() const
  2022. - TextureFilterMode GetFilterMode() const
  2023. - TextureAddressMode GetAddressMode(TextureCoordinate coord) const
  2024. - const Color& GetBorderColor() const
  2025. - bool GetSRGB() const
  2026. - Texture* GetBackupTexture() const
  2027. - int GetMipsToSkip(int quality) const
  2028. - int GetLevelWidth(unsigned level) const
  2029. - int GetLevelHeight(unsigned level) const
  2030. - TextureUsage GetUsage() const
  2031. - unsigned GetDataSize(int width, int height) const
  2032. - unsigned GetRowDataSize(int width) const
  2033. Properties:
  2034. - unsigned format (readonly)
  2035. - bool compressed (readonly)
  2036. - unsigned levels (readonly)
  2037. - int width (readonly)
  2038. - int height (readonly)
  2039. - TextureFilterMode filterMode
  2040. - Color& borderColor
  2041. - bool sRGB
  2042. - Texture* backupTexture
  2043. - TextureUsage usage (readonly)
  2044. ### Texture2D : Texture
  2045. Methods:
  2046. - Texture2D(Context* context)
  2047. - ~Texture2D()
  2048. - bool SetSize(int width, int height, unsigned format, TextureUsage usage = TEXTURE_STATIC)
  2049. - RenderSurface* GetRenderSurface() const
  2050. Properties:
  2051. - RenderSurface* renderSurface (readonly)
  2052. ### TextureCube : Texture
  2053. Methods:
  2054. - RenderSurface* GetRenderSurface(CubeMapFace face) const
  2055. ### Viewport
  2056. Methods:
  2057. - Viewport(Context* context)
  2058. - Viewport(Context* context, Scene* scene, Camera* camera, RenderPath* renderPath = 0)
  2059. - Viewport(Context* context, Scene* scene, Camera* camera, const IntRect& rect, RenderPath* renderPath = 0)
  2060. - ~Viewport()
  2061. - void SetScene(Scene* scene)
  2062. - void SetCamera(Camera* camera)
  2063. - void SetRect(const IntRect& rect)
  2064. - void SetRenderPath(RenderPath* path)
  2065. - void SetRenderPath(XMLFile* file)
  2066. - Scene* GetScene() const
  2067. - Camera* GetCamera() const
  2068. - const IntRect& GetRect() const
  2069. - RenderPath* GetRenderPath() const
  2070. Properties:
  2071. - Scene* scene
  2072. - Camera* camera
  2073. - IntRect& rect
  2074. - RenderPath* renderPath
  2075. ### Zone : Drawable
  2076. Methods:
  2077. - void SetBoundingBox(const BoundingBox& box)
  2078. - void SetAmbientColor(const Color& color)
  2079. - void SetFogColor(const Color& color)
  2080. - void SetFogStart(float start)
  2081. - void SetFogEnd(float end)
  2082. - void SetPriority(int priority)
  2083. - void SetOverride(bool enable)
  2084. - void SetAmbientGradient(bool enable)
  2085. - const Matrix3x4& GetInverseWorldTransform() const
  2086. - const Color& GetAmbientColor() const
  2087. - const Color& GetAmbientStartColor()
  2088. - const Color& GetAmbientEndColor()
  2089. - const Color& GetFogColor() const
  2090. - float GetFogStart() const
  2091. - float GetFogEnd() const
  2092. - int GetPriority() const
  2093. - bool GetOverride() const
  2094. - bool GetAmbientGradient() const
  2095. - bool IsInside(const Vector3& point) const
  2096. Properties:
  2097. - BoundingBox& boundingBox
  2098. - Matrix3x4& inverseWorldTransform (readonly)
  2099. - Color& ambientColor
  2100. - Color& ambientStartColor (readonly)
  2101. - Color& ambientEndColor (readonly)
  2102. - Color& fogColor
  2103. - float fogStart
  2104. - float fogEnd
  2105. - int priority
  2106. - bool override
  2107. - bool ambientGradient
  2108. ### TouchState
  2109. Methods:
  2110. Properties:
  2111. - int touchID
  2112. - IntVector2 position
  2113. - IntVector2 lastPosition
  2114. - IntVector2 delta
  2115. - float pressure
  2116. ### JoystickState
  2117. Methods:
  2118. - unsigned GetNumButtons() const
  2119. - unsigned GetNumAxes() const
  2120. - unsigned GetNumHats() const
  2121. - bool GetButtonDown(unsigned index) const
  2122. - bool GetButtonPress(unsigned index) const
  2123. - float GetAxisPosition(unsigned index) const
  2124. - int GetHatPosition(unsigned index) const
  2125. Properties:
  2126. - unsigned numButtons (readonly)
  2127. - unsigned numAxes (readonly)
  2128. - unsigned numHats (readonly)
  2129. ### Input : Object
  2130. Methods:
  2131. - void SetToggleFullscreen(bool enable)
  2132. - void SetMouseVisible(bool enable)
  2133. - bool OpenJoystick(unsigned index)
  2134. - void CloseJoystick(unsigned index)
  2135. - bool DetectJoysticks()
  2136. - bool GetKeyDown(int key) const
  2137. - bool GetKeyPress(int key) const
  2138. - bool GetMouseButtonDown(int button) const
  2139. - bool GetMouseButtonPress(int button) const
  2140. - bool GetQualifierDown(int qualifier) const
  2141. - bool GetQualifierPress(int qualifier) const
  2142. - int GetQualifiers() const
  2143. - IntVector2 GetMousePosition() const
  2144. - const IntVector2& GetMouseMove() const
  2145. - int GetMouseMoveX() const
  2146. - int GetMouseMoveY() const
  2147. - int GetMouseMoveWheel() const
  2148. - unsigned GetNumTouches() const
  2149. - TouchState* GetTouch(unsigned index) const
  2150. - unsigned GetNumJoysticks() const
  2151. - const String& GetJoystickName(unsigned index) const
  2152. - JoystickState* GetJoystick(unsigned index)
  2153. - bool GetToggleFullscreen() const
  2154. - bool IsMouseVisible() const
  2155. - bool HasFocus()
  2156. - bool IsMinimized() const
  2157. Properties:
  2158. - int qualifiers (readonly)
  2159. - IntVector2 mousePosition (readonly)
  2160. - IntVector2& mouseMove (readonly)
  2161. - int mouseMoveX (readonly)
  2162. - int mouseMoveY (readonly)
  2163. - int mouseMoveWheel (readonly)
  2164. - unsigned numTouches (readonly)
  2165. - unsigned numJoysticks (readonly)
  2166. - bool toggleFullscreen (readonly)
  2167. - bool mouseVisible
  2168. - bool focus (readonly)
  2169. - bool minimized (readonly)
  2170. ### Deserializer
  2171. Methods:
  2172. - unsigned Seek(unsigned position)
  2173. - const String& GetName() const
  2174. - unsigned GetChecksum()
  2175. - unsigned GetPosition() const
  2176. - unsigned GetSize() const
  2177. - bool IsEof() const
  2178. - int ReadInt()
  2179. - short ReadShort()
  2180. - signed char ReadByte()
  2181. - unsigned ReadUInt()
  2182. - unsigned short ReadUShort()
  2183. - unsigned char ReadUByte()
  2184. - bool ReadBool()
  2185. - float ReadFloat()
  2186. - IntRect ReadIntRect()
  2187. - IntVector2 ReadIntVector2()
  2188. - Rect ReadRect()
  2189. - Vector2 ReadVector2()
  2190. - Vector3 ReadVector3()
  2191. - Vector3 ReadPackedVector3(float maxAbsCoord)
  2192. - Vector4 ReadVector4()
  2193. - Quaternion ReadQuaternion()
  2194. - Quaternion ReadPackedQuaternion()
  2195. - Color ReadColor()
  2196. - BoundingBox ReadBoundingBox()
  2197. - String ReadString()
  2198. - String ReadFileID()
  2199. - StringHash ReadStringHash()
  2200. - ShortStringHash ReadShortStringHash()
  2201. - VectorBuffer ReadBuffer()
  2202. - ResourceRef ReadResourceRef()
  2203. - ResourceRefList ReadResourceRefList()
  2204. - Variant ReadVariant()
  2205. - Variant ReadVariant(VariantType type)
  2206. - VariantVector ReadVariantVector()
  2207. - VariantMap ReadVariantMap()
  2208. - unsigned ReadVLE()
  2209. - unsigned ReadNetID()
  2210. - String ReadLine()
  2211. Properties:
  2212. - String& name (readonly)
  2213. - unsigned checksum (readonly)
  2214. - unsigned position (readonly)
  2215. - unsigned size (readonly)
  2216. - bool eof (readonly)
  2217. ### File : Object
  2218. Methods:
  2219. - File(Context* context)
  2220. - File(Context* context, const String fileName, FileMode mode = FILE_READ)
  2221. - File(Context* context, PackageFile* package, const String fileName)
  2222. - ~File()
  2223. - bool Open(const String fileName, FileMode mode = FILE_READ)
  2224. - bool Open(PackageFile* package, const String fileName)
  2225. - void Close()
  2226. - void Flush()
  2227. - void SetName(const String name)
  2228. - FileMode GetMode() const
  2229. - bool IsOpen() const
  2230. - void* GetHandle() const
  2231. - bool IsPackaged() const
  2232. - unsigned Seek(unsigned position)
  2233. - const String& GetName() const
  2234. - unsigned GetChecksum()
  2235. - unsigned GetPosition() const
  2236. - unsigned GetSize() const
  2237. - bool IsEof() const
  2238. - int ReadInt()
  2239. - short ReadShort()
  2240. - signed char ReadByte()
  2241. - unsigned ReadUInt()
  2242. - unsigned short ReadUShort()
  2243. - unsigned char ReadUByte()
  2244. - bool ReadBool()
  2245. - float ReadFloat()
  2246. - IntRect ReadIntRect()
  2247. - IntVector2 ReadIntVector2()
  2248. - Rect ReadRect()
  2249. - Vector2 ReadVector2()
  2250. - Vector3 ReadVector3()
  2251. - Vector3 ReadPackedVector3(float maxAbsCoord)
  2252. - Vector4 ReadVector4()
  2253. - Quaternion ReadQuaternion()
  2254. - Quaternion ReadPackedQuaternion()
  2255. - Color ReadColor()
  2256. - BoundingBox ReadBoundingBox()
  2257. - String ReadString()
  2258. - String ReadFileID()
  2259. - StringHash ReadStringHash()
  2260. - ShortStringHash ReadShortStringHash()
  2261. - VectorBuffer ReadBuffer()
  2262. - ResourceRef ReadResourceRef()
  2263. - ResourceRefList ReadResourceRefList()
  2264. - Variant ReadVariant()
  2265. - Variant ReadVariant(VariantType type)
  2266. - VariantVector ReadVariantVector()
  2267. - VariantMap ReadVariantMap()
  2268. - unsigned ReadVLE()
  2269. - unsigned ReadNetID()
  2270. - String ReadLine()
  2271. - bool WriteInt(int value)
  2272. - bool WriteShort(short value)
  2273. - bool WriteByte(signed char value)
  2274. - bool WriteUInt(unsigned value)
  2275. - bool WriteUShort(unsigned short value)
  2276. - bool WriteUByte(unsigned char value)
  2277. - bool WriteBool(bool value)
  2278. - bool WriteFloat(float value)
  2279. - bool WriteIntRect(const IntRect& value)
  2280. - bool WriteIntVector2(const IntVector2& value)
  2281. - bool WriteRect(const Rect& value)
  2282. - bool WriteVector2(const Vector2& value)
  2283. - bool WriteVector3(const Vector3& value)
  2284. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  2285. - bool WriteVector4(const Vector4& value)
  2286. - bool WriteQuaternion(const Quaternion& value)
  2287. - bool WritePackedQuaternion(const Quaternion& value)
  2288. - bool WriteColor(const Color& value)
  2289. - bool WriteBoundingBox(const BoundingBox& value)
  2290. - bool WriteString(const String value)
  2291. - bool WriteFileID(const String value)
  2292. - bool WriteStringHash(const StringHash& value)
  2293. - bool WriteShortStringHash(const ShortStringHash& value)
  2294. - bool WriteBuffer(const VectorBuffer& buffer)
  2295. - bool WriteResourceRef(const ResourceRef& value)
  2296. - bool WriteResourceRefList(const ResourceRefList& value)
  2297. - bool WriteVariant(const Variant& value)
  2298. - bool WriteVariantData(const Variant& value)
  2299. - bool WriteVariantVector(const VariantVector& value)
  2300. - bool WriteVariantMap(const VariantMap& value)
  2301. - bool WriteVLE(unsigned value)
  2302. - bool WriteNetID(unsigned value)
  2303. - bool WriteLine(const String value)
  2304. Properties:
  2305. - FileMode mode (readonly)
  2306. - bool open (readonly)
  2307. - bool packaged (readonly)
  2308. - String& name (readonly)
  2309. - unsigned checksum (readonly)
  2310. - unsigned position (readonly)
  2311. - unsigned size (readonly)
  2312. - bool eof (readonly)
  2313. ### FileSystem : Object
  2314. Methods:
  2315. - bool SetCurrentDir(const String pathName)
  2316. - bool CreateDir(const String pathName)
  2317. - int SystemCommand(const String commandLine)
  2318. - bool SystemOpen(const String fileName, const String mode = String::EMPTY)
  2319. - bool Copy(const String srcFileName, const String destFileName)
  2320. - bool Rename(const String srcFileName, const String destFileName)
  2321. - bool Delete(const String fileName)
  2322. - void RegisterPath(const String pathName)
  2323. - String GetCurrentDir() const
  2324. - bool HasRegisteredPaths() const
  2325. - bool CheckAccess(const String pathName) const
  2326. - unsigned GetLastModifiedTime(const String fileName) const
  2327. - bool FileExists(const String fileName) const
  2328. - bool DirExists(const String pathName) const
  2329. - Vector<String> ScanDir(const String pathName, const String filter, unsigned flags, bool recursive) const
  2330. - String GetProgramDir() const
  2331. - String GetUserDocumentsDir() const
  2332. ### Log : Object
  2333. Methods:
  2334. - void Open(const String fileName)
  2335. - void SetLevel(int level)
  2336. - void SetTimeStamp(bool enable)
  2337. - void SetQuiet(bool quiet)
  2338. - int GetLevel() const
  2339. - bool GetTimeStamp() const
  2340. - String GetLastMessage() const
  2341. - bool IsQuiet() const
  2342. - static void Write(int level, const String message)
  2343. - static void WriteRaw(const String message, bool error = false)
  2344. Properties:
  2345. - int level
  2346. - bool timeStamp
  2347. - bool quiet
  2348. ### PackageEntry
  2349. Methods:
  2350. Properties:
  2351. - unsigned offset
  2352. - unsigned size
  2353. - unsigned checksum
  2354. ### PackageFile : Object
  2355. Methods:
  2356. - PackageFile(Context* context)
  2357. - PackageFile(Context* context, const String fileName)
  2358. - ~PackageFile()
  2359. - bool Open(const String fileName)
  2360. - bool Exists(const String fileName) const
  2361. - const PackageEntry* GetEntry(const String fileName) const
  2362. - const HashMap<String, PackageEntry>& GetEntries() const
  2363. - const String& GetName() const
  2364. - StringHash GetNameHash() const
  2365. - unsigned GetNumFiles() const
  2366. - unsigned GetTotalSize() const
  2367. - unsigned GetChecksum() const
  2368. Properties:
  2369. - String& name (readonly)
  2370. - StringHash nameHash (readonly)
  2371. - unsigned numFiles (readonly)
  2372. - unsigned totalSize (readonly)
  2373. - unsigned checksum (readonly)
  2374. ### Serializer
  2375. Methods:
  2376. - bool WriteInt(int value)
  2377. - bool WriteShort(short value)
  2378. - bool WriteByte(signed char value)
  2379. - bool WriteUInt(unsigned value)
  2380. - bool WriteUShort(unsigned short value)
  2381. - bool WriteUByte(unsigned char value)
  2382. - bool WriteBool(bool value)
  2383. - bool WriteFloat(float value)
  2384. - bool WriteIntRect(const IntRect& value)
  2385. - bool WriteIntVector2(const IntVector2& value)
  2386. - bool WriteRect(const Rect& value)
  2387. - bool WriteVector2(const Vector2& value)
  2388. - bool WriteVector3(const Vector3& value)
  2389. - bool WritePackedVector3(const Vector3& value, float maxAbsCoord)
  2390. - bool WriteVector4(const Vector4& value)
  2391. - bool WriteQuaternion(const Quaternion& value)
  2392. - bool WritePackedQuaternion(const Quaternion& value)
  2393. - bool WriteColor(const Color& value)
  2394. - bool WriteBoundingBox(const BoundingBox& value)
  2395. - bool WriteString(const String value)
  2396. - bool WriteFileID(const String value)
  2397. - bool WriteStringHash(const StringHash& value)
  2398. - bool WriteShortStringHash(const ShortStringHash& value)
  2399. - bool WriteBuffer(const VectorBuffer& buffer)
  2400. - bool WriteResourceRef(const ResourceRef& value)
  2401. - bool WriteResourceRefList(const ResourceRefList& value)
  2402. - bool WriteVariant(const Variant& value)
  2403. - bool WriteVariantData(const Variant& value)
  2404. - bool WriteVariantVector(const VariantVector& value)
  2405. - bool WriteVariantMap(const VariantMap& value)
  2406. - bool WriteVLE(unsigned value)
  2407. - bool WriteNetID(unsigned value)
  2408. - bool WriteLine(const String value)
  2409. ### LuaScriptInstance : Component
  2410. Methods:
  2411. - bool CreateObject(const String scriptObjectType)
  2412. - bool CreateObject(const String scriptFileName, const String scriptObjectType)
  2413. - void SetScriptFileName(const String scriptFileName)
  2414. - void SetScriptObjectType(const String scriptObjectType)
  2415. - void SubscribeToEvent(const String eventName, const String functionName)
  2416. - void UnsubscribeFromEvent(const String eventName)
  2417. - void UnsubscribeFromAllEvents()
  2418. - void SubscribeToEvent(void* sender, const String eventName, const String functionName)
  2419. - void UnsubscribeFromEvent(void* sender, const String eventName)
  2420. - void UnsubscribeFromEvents(void* sender)
  2421. - const String& GetScriptFileName() const
  2422. - const String& GetScriptObjectType() const
  2423. Properties:
  2424. - const String scriptFileName
  2425. - const String scriptObjectType
  2426. ### BoundingBox
  2427. Methods:
  2428. - BoundingBox()
  2429. - BoundingBox(const BoundingBox& box)
  2430. - BoundingBox(const Rect& rect)
  2431. - BoundingBox(const Vector3& min, const Vector3& max)
  2432. - BoundingBox(float min, float max)
  2433. - BoundingBox(const Frustum& frustum)
  2434. - BoundingBox(const Polyhedron& poly)
  2435. - BoundingBox(const Sphere& sphere)
  2436. - ~BoundingBox()
  2437. - bool operator == (const BoundingBox& rhs) const
  2438. - void Define(const BoundingBox& box)
  2439. - void Define(const Rect& rect)
  2440. - void Define(const Vector3& min, const Vector3& max)
  2441. - void Define(float min, float max)
  2442. - void Define(const Vector3& point)
  2443. - void Define(const Frustum& frustum)
  2444. - void Define(const Polyhedron& poly)
  2445. - void Define(const Sphere& sphere)
  2446. - void Merge(const Vector3& point)
  2447. - void Merge(const BoundingBox& box)
  2448. - void Merge(const Frustum& frustum)
  2449. - void Merge(const Polyhedron& poly)
  2450. - void Merge(const Sphere& sphere)
  2451. - void Clip(const BoundingBox& box)
  2452. - void Transform(const Matrix3& transform)
  2453. - void Transform(const Matrix3x4& transform)
  2454. - void Clear()
  2455. - Vector3 Center() const
  2456. - Vector3 Size() const
  2457. - Vector3 HalfSize() const
  2458. - BoundingBox Transformed(const Matrix3& transform) const
  2459. - BoundingBox Transformed(const Matrix3x4& transform) const
  2460. - Rect Projected(const Matrix4& projection) const
  2461. - Intersection IsInside(const Vector3& point) const
  2462. - Intersection IsInside(const BoundingBox& box) const
  2463. - Intersection IsInsideFast(const BoundingBox& box) const
  2464. - Intersection IsInside(const Sphere& sphere) const
  2465. - Intersection IsInsideFast(const Sphere& sphere) const
  2466. - String ToString() const
  2467. Properties:
  2468. - Vector3 min
  2469. - Vector3 max
  2470. - bool defined
  2471. - Vector3 center (readonly)
  2472. - Vector3 size (readonly)
  2473. - Vector3 halfSize (readonly)
  2474. ### Color
  2475. Methods:
  2476. - Color()
  2477. - Color(const Color& color)
  2478. - Color(const Color& color, float a)
  2479. - Color(float r, float g, float b)
  2480. - Color(float r, float g, float b, float a)
  2481. - ~Color()
  2482. - bool operator == (const Color& rhs) const
  2483. - Color operator * (float rhs) const
  2484. - Color operator + (const Color& rhs)
  2485. - unsigned ToUInt() const
  2486. - Vector3 ToHSL() const
  2487. - Vector3 ToHSV() const
  2488. - void FromHSL(float h, float s, float l, float a)
  2489. - void FromHSV(float h, float s, float v, float a)
  2490. - Vector3 ToVector3() const
  2491. - Vector4 ToVector4() const
  2492. - float SumRGB() const
  2493. - float Average() const
  2494. - float Luma() const
  2495. - float Chroma() const
  2496. - float Hue() const
  2497. - float SaturationHSL() const
  2498. - float SaturationHSV() const
  2499. - float Value() const
  2500. - float Lightness() const
  2501. - float MaxRGB() const
  2502. - float MinRGB() const
  2503. - float Range() const
  2504. - void Clip(bool clipAlpha = false)
  2505. - void Invert(bool invertAlpha = false)
  2506. - Color Lerp(const Color& rhs, float t) const
  2507. - String ToString() const
  2508. Properties:
  2509. - float r
  2510. - float g
  2511. - float b
  2512. - float a
  2513. - static const Color WHITE
  2514. - static const Color GRAY
  2515. - static const Color BLACK
  2516. - static const Color RED
  2517. - static const Color GREEN
  2518. - static const Color BLUE
  2519. - static const Color CYAN
  2520. - static const Color MAGENTA
  2521. - static const Color YELLOW
  2522. - static const Color TRANSPARENT
  2523. ### Frustum
  2524. Methods:
  2525. - Frustum()
  2526. - Frustum(const Frustum& frustum)
  2527. - ~Frustum()
  2528. - void Define(float fov, float aspectRatio, float zoom, float nearZ, float farZ, const Matrix3x4& transform = Matrix3x4::IDENTITY)
  2529. - void Define(const Vector3& near, const Vector3& far, const Matrix3x4& transform = Matrix3x4::IDENTITY)
  2530. - void Define(const BoundingBox& box, const Matrix3x4& transform = Matrix3x4::IDENTITY)
  2531. - void DefineOrtho(float orthoSize, float aspectRatio, float zoom, float nearZ, float farZ, const Matrix3x4& transform = Matrix3x4::IDENTITY)
  2532. - void Transform(const Matrix3& transform)
  2533. - void Transform(const Matrix3x4& transform)
  2534. - Intersection IsInside(const Vector3& point) const
  2535. - Intersection IsInside(const Sphere& sphere) const
  2536. - Intersection IsInsideFast(const Sphere& sphere) const
  2537. - Intersection IsInside(const BoundingBox& box) const
  2538. - Intersection IsInsideFast(const BoundingBox& box) const
  2539. - float Distance(const Vector3& point) const
  2540. - Frustum Transformed(const Matrix3& transform) const
  2541. - Frustum Transformed(const Matrix3x4& transform) const
  2542. - Rect Projected(const Matrix4& transform) const
  2543. - void UpdatePlanes()
  2544. ### Matrix3
  2545. Methods:
  2546. - Matrix3()
  2547. - Matrix3(const Matrix3& matrix)
  2548. Properties:
  2549. - Matrix3(float v00, float v01, float v02,
  2550. - float v10, float v11, float v12,
  2551. - float v20, float v21, float v22)
  2552. - ~Matrix3()
  2553. - bool operator == (const Matrix3& rhs) const
  2554. - Vector3 operator * (const Vector3& rhs) const
  2555. - Matrix3 operator + (const Matrix3& rhs) const
  2556. - Matrix3 operator - (const Matrix3& rhs) const
  2557. - Matrix3 operator * (float rhs) const
  2558. - Matrix3 operator * (const Matrix3& rhs) const
  2559. - void SetScale(const Vector3& scale)
  2560. - void SetScale(float scale)
  2561. - Vector3 Scale() const
  2562. - Matrix3 Transpose() const
  2563. - Matrix3 Scaled(const Vector3& scale) const
  2564. - bool Equals(const Matrix3& rhs) const
  2565. - Matrix3 Inverse() const
  2566. - float m00
  2567. - float m01
  2568. - float m02
  2569. - float m10
  2570. - float m11
  2571. - float m12
  2572. - float m20
  2573. - float m21
  2574. - float m22
  2575. - static const Matrix3 ZERO
  2576. - static const Matrix3 IDENTITY
  2577. ### Matrix3x4
  2578. Methods:
  2579. - Matrix3x4()
  2580. - Matrix3x4(const Matrix3x4& matrix)
  2581. - Matrix3x4(const Matrix3& matrix)
  2582. - Matrix3x4(const Matrix4& matrix)
  2583. Properties:
  2584. - Matrix3x4(float v00, float v01, float v02, float v03,
  2585. - float v10, float v11, float v12, float v13,
  2586. - float v20, float v21, float v22, float v23)
  2587. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, float scale)
  2588. - Matrix3x4(const Vector3& translation, const Quaternion& rotation, const Vector3& scale)
  2589. - bool operator == (const Matrix3x4& rhs) const
  2590. - Vector3 operator * (const Vector3& rhs) const
  2591. - Vector3 operator * (const Vector4& rhs) const
  2592. - Matrix3x4 operator + (const Matrix3x4& rhs) const
  2593. - Matrix3x4 operator - (const Matrix3x4& rhs) const
  2594. - Matrix3x4 operator * (float rhs) const
  2595. - Matrix3x4 operator * (const Matrix3x4& rhs) const
  2596. - Matrix4 operator * (const Matrix4& rhs) const
  2597. - void SetTranslation(const Vector3& translation)
  2598. - void SetRotation(const Matrix3& rotation)
  2599. - void SetScale(const Vector3& scale)
  2600. - void SetScale(float scale)
  2601. - Matrix3 ToMatrix3() const
  2602. - Matrix3 RotationMatrix() const
  2603. - Vector3 Translation() const
  2604. - Quaternion Rotation() const
  2605. - Vector3 Scale() const
  2606. - bool Equals(const Matrix3x4& rhs) const
  2607. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  2608. - Matrix3x4 Inverse() const
  2609. - float m00
  2610. - float m01
  2611. - float m02
  2612. - float m03
  2613. - float m10
  2614. - float m11
  2615. - float m12
  2616. - float m13
  2617. - float m20
  2618. - float m21
  2619. - float m22
  2620. - float m23
  2621. - static const Matrix3x4 ZERO
  2622. - static const Matrix3x4 IDENTITY
  2623. ### Matrix4
  2624. Methods:
  2625. - Matrix4()
  2626. - Matrix4(const Matrix4& matrix)
  2627. - Matrix4(const Matrix3& matrix)
  2628. Properties:
  2629. - Matrix4(float v00, float v01, float v02, float v03,
  2630. - float v10, float v11, float v12, float v13,
  2631. - float v20, float v21, float v22, float v23,
  2632. - float v30, float v31, float v32, float v33)
  2633. - ~Matrix4()
  2634. - bool operator == (const Matrix4& rhs) const
  2635. - Vector3 operator * (const Vector3& rhs) const
  2636. - Vector4 operator * (const Vector4& rhs) const
  2637. - Matrix4 operator + (const Matrix4& rhs) const
  2638. - Matrix4 operator - (const Matrix4& rhs) const
  2639. - Matrix4 operator * (float rhs) const
  2640. - Matrix4 operator * (const Matrix4& rhs) const
  2641. - void SetTranslation(const Vector3& translation)
  2642. - void SetRotation(const Matrix3& rotation)
  2643. - void SetScale(const Vector3& scale)
  2644. - void SetScale(float scale)
  2645. - Matrix3 ToMatrix3() const
  2646. - Matrix3 RotationMatrix() const
  2647. - Vector3 Translation() const
  2648. - Quaternion Rotation() const
  2649. - Vector3 Scale() const
  2650. - Matrix4 Transpose() const
  2651. - bool Equals(const Matrix4& rhs) const
  2652. - void Decompose(Vector3& translation, Quaternion& rotation, Vector3& scale) const
  2653. - Matrix4 Inverse() const
  2654. - float m00
  2655. - float m01
  2656. - float m02
  2657. - float m03
  2658. - float m10
  2659. - float m11
  2660. - float m12
  2661. - float m13
  2662. - float m20
  2663. - float m21
  2664. - float m22
  2665. - float m23
  2666. - float m30
  2667. - float m31
  2668. - float m32
  2669. - float m33
  2670. - static const Matrix4 ZERO
  2671. - static const Matrix4 IDENTITY
  2672. ### Plane
  2673. Methods:
  2674. - Plane()
  2675. - Plane(const Plane& plane)
  2676. - Plane(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  2677. - Plane(const Vector3& normal, const Vector3& point)
  2678. - ~Plane()
  2679. - void Define(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  2680. - void Define(const Vector3& normal, const Vector3& point)
  2681. - float Distance(const Vector3& point) const
  2682. Properties:
  2683. - Vector3 normal
  2684. - Vector3 absNormal
  2685. - float intercept
  2686. ### Polyhedron
  2687. Methods:
  2688. - Polyhedron()
  2689. - Polyhedron(const Polyhedron& polyhedron)
  2690. - Polyhedron(const BoundingBox& box)
  2691. - Polyhedron(const Frustum& frustum)
  2692. - ~Polyhedron()
  2693. - void Define(const BoundingBox& box)
  2694. - void Define(const Frustum& frustum)
  2695. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2)
  2696. - void AddFace(const Vector3& v0, const Vector3& v1, const Vector3& v2, const Vector3& v3)
  2697. - void Clip(const Plane& plane)
  2698. - void Clip(const BoundingBox& box)
  2699. - void Clip(const Frustum& box)
  2700. - void Clear()
  2701. - void Transform(const Matrix3& transform)
  2702. - void Transform(const Matrix3x4& transform)
  2703. - Polyhedron Transformed(const Matrix3& transform) const
  2704. - Polyhedron Transformed(const Matrix3x4& transform) const
  2705. - bool Empty() const
  2706. Properties:
  2707. - bool empty (readonly)
  2708. ### Quaternion
  2709. Methods:
  2710. - Quaternion()
  2711. - Quaternion(const Quaternion& quat)
  2712. - Quaternion(float w, float x, float y, float z)
  2713. - Quaternion(float angle, const Vector3& axis)
  2714. - Quaternion(float x, float y, float z)
  2715. - Quaternion(const Vector3& start, const Vector3& end)
  2716. - Quaternion(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  2717. - Quaternion(const Matrix3& matrix)
  2718. - ~Quaternion()
  2719. - bool operator == (const Quaternion& rhs) const
  2720. - Quaternion operator * (float rhs) const
  2721. - Quaternion operator - () const
  2722. - bool operator == (const Quaternion& rhs) const
  2723. - Quaternion operator * (float rhs) const
  2724. - Quaternion operator - () const
  2725. - Quaternion operator + (const Quaternion& rhs) const
  2726. - Quaternion operator - (const Quaternion& rhs) const
  2727. - Quaternion operator * (const Quaternion& rhs) const
  2728. - Vector3 operator * (const Vector3& rhs) const
  2729. - void FromAngleAxis(float angle, const Vector3& axis)
  2730. - void FromEulerAngles(float x, float y, float z)
  2731. - void FromRotationTo(const Vector3& start, const Vector3& end)
  2732. - void FromAxes(const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis)
  2733. - void FromRotationMatrix(const Matrix3& matrix)
  2734. - void Normalize()
  2735. - Quaternion Normalized() const
  2736. - Quaternion Inverse() const
  2737. - float LengthSquared() const
  2738. - float DotProduct(const Quaternion& rhs) const
  2739. - bool Equals(const Quaternion& rhs) const
  2740. - Quaternion Conjugate() const
  2741. - Vector3 EulerAngles() const
  2742. - float YawAngle() const
  2743. - float PitchAngle() const
  2744. - float RollAngle() const
  2745. - Matrix3 RotationMatrix() const
  2746. - Quaternion Slerp(Quaternion rhs, float t) const
  2747. - String ToString() const
  2748. Properties:
  2749. - float w
  2750. - float x
  2751. - float y
  2752. - float z
  2753. - static const Quaternion IDENTITY
  2754. ### Ray
  2755. Methods:
  2756. - Ray()
  2757. - Ray(const Vector3& origin, const Vector3& direction)
  2758. - Ray(const Ray& ray)
  2759. - ~Ray()
  2760. - bool operator == (const Ray& rhs) const
  2761. - void Define(const Vector3& origin, const Vector3& direction)
  2762. - Vector3 Project(const Vector3& point) const
  2763. - float Distance(const Vector3& point) const
  2764. - Vector3 ClosestPoint(const Ray& ray) const
  2765. - float HitDistance(const Plane& plane) const
  2766. - float HitDistance(const BoundingBox& box) const
  2767. - float HitDistance(const Frustum& frustum, bool solidInside = true) const
  2768. - float HitDistance(const Sphere& sphere) const
  2769. - float HitDistance(const Vector3& v0, const Vector3& v1, const Vector3& v2) const
  2770. - Ray Transformed(const Matrix3x4& transform) const
  2771. Properties:
  2772. - Vector3 origin
  2773. - Vector3 direction
  2774. ### Rect
  2775. Methods:
  2776. - Rect()
  2777. - Rect(const Rect& rect)
  2778. - Rect(const Vector2& min, const Vector2& max)
  2779. - Rect(float left, float top, float right, float bottom)
  2780. - Rect(const Vector4& vector)
  2781. - ~Rect()
  2782. - bool operator == (const Rect& rhs) const
  2783. - void Define(const Rect& rect)
  2784. - void Define(const Vector2& min, const Vector2& max)
  2785. - void Define(const Vector2& point)
  2786. - void Merge(const Vector2& point)
  2787. - void Merge(const Rect& rect)
  2788. - void Clear()
  2789. - void Clip(const Rect& rect)
  2790. - Vector2 Center() const
  2791. - Vector2 Size() const
  2792. - Vector2 HalfSize() const
  2793. - bool Equals(const Rect& rhs) const
  2794. - Vector4 ToVector4() const
  2795. - String ToString() const
  2796. Properties:
  2797. - Vector2 min
  2798. - Vector2 max
  2799. - static const Rect FULL
  2800. - static const Rect POSITIVE
  2801. - static const Rect ZERO
  2802. - Vector2 center (readonly)
  2803. - Vector2 size (readonly)
  2804. - Vector2 halfSize (readonly)
  2805. ### IntRect
  2806. Methods:
  2807. - IntRect()
  2808. - IntRect(int left, int top, int right, int bottom)
  2809. - ~IntRect()
  2810. - bool operator == (const IntRect& rhs) const
  2811. - IntVector2 Size() const
  2812. - int Width() const
  2813. - int Height() const
  2814. Properties:
  2815. - int left
  2816. - int top
  2817. - int right
  2818. - int bottom
  2819. - static const IntRect ZERO
  2820. - IntVector2 size (readonly)
  2821. - int width (readonly)
  2822. - int height (readonly)
  2823. ### Sphere
  2824. Methods:
  2825. - Sphere()
  2826. - Sphere(const Sphere& sphere)
  2827. - Sphere(const Vector3& center, float radius)
  2828. - Sphere(const BoundingBox& box)
  2829. - Sphere(const Frustum& frustum)
  2830. - Sphere(const Polyhedron& poly)
  2831. - ~Sphere()
  2832. - bool operator == (const Sphere& rhs) const
  2833. - void Define(const Sphere& sphere)
  2834. - void Define(const Vector3& center, float radius)
  2835. - void Define(const BoundingBox& box)
  2836. - void Define(const Frustum& frustum)
  2837. - void Define(const Polyhedron& poly)
  2838. - void Merge(const Vector3& point)
  2839. - void Merge(const BoundingBox& box)
  2840. - void Merge(const Frustum& frustum)
  2841. - void Merge(const Polyhedron& poly)
  2842. - void Merge(const Sphere& sphere)
  2843. - void Clear()
  2844. - Intersection IsInside(const Vector3& point) const
  2845. - Intersection IsInside(const Sphere& sphere) const
  2846. - Intersection IsInsideFast(const Sphere& sphere) const
  2847. - Intersection IsInside(const BoundingBox& box) const
  2848. - Intersection IsInsideFast(const BoundingBox& box) const
  2849. - float Distance(const Vector3& point) const
  2850. Properties:
  2851. - Vector3 center
  2852. - float radius
  2853. - bool defined
  2854. ### StringHash
  2855. Methods:
  2856. - StringHash()
  2857. - StringHash(const StringHash& rhs)
  2858. - StringHash(unsigned value)
  2859. - StringHash(const String str)
  2860. - ~StringHash()
  2861. - StringHash operator + (const StringHash& rhs) const
  2862. - bool operator == (const StringHash& rhs) const
  2863. - bool operator < (const StringHash& rhs) const
  2864. - operator bool () const
  2865. - unsigned Value() const
  2866. - String ToString() const
  2867. - unsigned ToHash() const
  2868. - static unsigned Calculate(const char* str)
  2869. Properties:
  2870. - static const StringHash ZERO
  2871. - unsigned value (readonly)
  2872. ### ShortStringHash
  2873. Methods:
  2874. - ShortStringHash()
  2875. - ShortStringHash(const ShortStringHash& rhs)
  2876. - ShortStringHash(const StringHash& rhs)
  2877. - ShortStringHash(unsigned short value)
  2878. - ShortStringHash(const String str)
  2879. - ~ShortStringHash()
  2880. - ShortStringHash operator + (const ShortStringHash& rhs) const
  2881. - bool operator == (const ShortStringHash& rhs) const
  2882. - bool operator < (const ShortStringHash& rhs) const
  2883. - unsigned short Value() const
  2884. - static unsigned short Calculate(const char* str)
  2885. Properties:
  2886. - static const ShortStringHash ZERO
  2887. - unsigned short value (readonly)
  2888. ### Vector2
  2889. Methods:
  2890. - Vector2()
  2891. - Vector2(const Vector2& vector)
  2892. - Vector2(float x, float y)
  2893. - ~Vector2()
  2894. - bool operator == (const Vector2& rhs) const
  2895. - Vector2 operator + (const Vector2& rhs) const
  2896. - Vector2 operator - () const
  2897. - Vector2 operator - (const Vector2& rhs) const
  2898. - Vector2 operator * (float rhs) const
  2899. - Vector2 operator * (const Vector2& rhs) const
  2900. - Vector2 operator / (float rhs) const
  2901. - Vector2 operator / (const Vector2& rhs) const
  2902. - Vector2 operator / (const Vector2& rhs) const
  2903. - void Normalize()
  2904. - float Length() const
  2905. - float LengthSquared() const
  2906. - float DotProduct(const Vector2& rhs) const
  2907. - float AbsDotProduct(const Vector2& rhs) const
  2908. - Vector2 Abs() const
  2909. - Vector2 Lerp(const Vector2& rhs, float t) const
  2910. - bool Equals(const Vector2& rhs) const
  2911. - Vector2 Normalized() const
  2912. - String ToString() const
  2913. Properties:
  2914. - float x
  2915. - float y
  2916. - static const Vector2 ZERO
  2917. - static const Vector2 LEFT
  2918. - static const Vector2 RIGHT
  2919. - static const Vector2 UP
  2920. - static const Vector2 DOWN
  2921. - static const Vector2 ONE
  2922. ### IntVector2
  2923. Methods:
  2924. - IntVector2()
  2925. - IntVector2(int x, int y)
  2926. - IntVector2(const IntVector2& rhs)
  2927. - ~IntVector2()
  2928. - bool operator == (const IntVector2& rhs) const
  2929. - IntVector2 operator + (const IntVector2& rhs) const
  2930. - IntVector2 operator - () const
  2931. - IntVector2 operator - (const IntVector2& rhs) const
  2932. - IntVector2 operator * (int rhs) const
  2933. - IntVector2 operator / (int rhs) const
  2934. - IntVector2 operator / (int rhs) const
  2935. - String ToString() const
  2936. Properties:
  2937. - int x
  2938. - int y
  2939. - static const IntVector2 ZERO
  2940. ### Vector3
  2941. Methods:
  2942. - Vector3()
  2943. - Vector3(const Vector3& vector)
  2944. - Vector3(const Vector2& vector, float z)
  2945. - Vector3(float x, float y, float z)
  2946. - ~Vector3()
  2947. - bool operator == (const Vector3& rhs) const
  2948. - Vector3 operator + (const Vector3& rhs) const
  2949. - Vector3 operator - () const
  2950. - Vector3 operator - (const Vector3& rhs) const
  2951. - Vector3 operator * (float rhs) const
  2952. - Vector3 operator * (const Vector3& rhs) const
  2953. - Vector3 operator / (float rhs) const
  2954. - Vector3 operator / (const Vector3& rhs) const
  2955. - Vector3 operator / (const Vector3& rhs) const
  2956. - void Normalize()
  2957. - float Length() const
  2958. - float LengthSquared() const
  2959. - float DotProduct(const Vector3& rhs) const
  2960. - float AbsDotProduct(const Vector3& rhs) const
  2961. - Vector3 CrossProduct(const Vector3& rhs) const
  2962. - Vector3 Abs() const
  2963. - Vector3 Lerp(const Vector3& rhs, float t) const
  2964. - bool Equals(const Vector3& rhs) const
  2965. - Vector3 Normalized() const
  2966. - String ToString() const
  2967. Properties:
  2968. - float x
  2969. - float y
  2970. - float z
  2971. - static const Vector3 ZERO
  2972. - static const Vector3 LEFT
  2973. - static const Vector3 RIGHT
  2974. - static const Vector3 UP
  2975. - static const Vector3 DOWN
  2976. - static const Vector3 FORWARD
  2977. - static const Vector3 BACK
  2978. - static const Vector3 ONE
  2979. ### Vector4
  2980. Methods:
  2981. - Vector4()
  2982. - Vector4(const Vector4& vector)
  2983. - Vector4(const Vector3& vector, float w)
  2984. - Vector4(float x, float y, float z, float w)
  2985. - ~Vector4()
  2986. - bool operator == (const Vector4& rhs) const
  2987. - Vector4 operator + (const Vector4& rhs) const
  2988. - Vector4 operator - () const
  2989. - Vector4 operator - (const Vector4& rhs) const
  2990. - Vector4 operator * (float rhs) const
  2991. - Vector4 operator * (const Vector4& rhs) const
  2992. - Vector4 operator / (float rhs) const
  2993. - Vector4 operator / (const Vector4& rhs) const
  2994. - Vector4 operator / (const Vector4& rhs) const
  2995. - float DotProduct(const Vector4& rhs) const
  2996. - float AbsDotProduct(const Vector4& rhs) const
  2997. - Vector4 Abs() const
  2998. - Vector4 Lerp(const Vector4& rhs, float t) const
  2999. - bool Equals(const Vector4& rhs) const
  3000. - String ToString() const
  3001. Properties:
  3002. - float x
  3003. - float y
  3004. - float z
  3005. - float w
  3006. - static const Vector4 ZERO
  3007. - static const Vector4 ONE
  3008. ### Navigable : Component
  3009. Methods:
  3010. - void SetRecursive(bool enable)
  3011. - bool IsRecursive() const
  3012. Properties:
  3013. - bool recursive
  3014. ### NavigationGeometryInfo
  3015. Methods:
  3016. Properties:
  3017. - Component* component
  3018. - unsigned lodLevel
  3019. - Matrix3x4 transform
  3020. - BoundingBox boundingBox
  3021. ### NavigationMesh : Component
  3022. Methods:
  3023. - void SetTileSize(int size)
  3024. - void SetCellSize(float size)
  3025. - void SetCellHeight(float height)
  3026. - void SetAgentHeight(float height)
  3027. - void SetAgentRadius(float radius)
  3028. - void SetAgentMaxClimb(float maxClimb)
  3029. - void SetAgentMaxSlope(float maxSlope)
  3030. - void SetRegionMinSize(float size)
  3031. - void SetRegionMergeSize(float size)
  3032. - void SetEdgeMaxLength(float length)
  3033. - void SetEdgeMaxError(float error)
  3034. - void SetDetailSampleDistance(float distance)
  3035. - void SetDetailSampleMaxError(float error)
  3036. - void SetPadding(const Vector3& padding)
  3037. - bool Build()
  3038. - bool Build(const BoundingBox& boundingBox)
  3039. - PODVector<Vector3> FindPath(const Vector3& start, const Vector3& end, const Vector3& extents = Vector3::ONE)
  3040. - Vector3 GetRandomPoint()
  3041. - Vector3 GetRandomPointInCircle(const Vector3& center, float radius, const Vector3& extents = Vector3::ONE)
  3042. - float GetDistanceToWall(const Vector3& point, float radius, const Vector3& extents = Vector3::ONE)
  3043. - Vector3 Raycast(const Vector3& start, const Vector3& end, const Vector3& extents = Vector3::ONE)
  3044. - void DrawDebugGeometry(bool depthTest)
  3045. - int GetTileSize() const
  3046. - float GetCellSize() const
  3047. - float GetCellHeight() const
  3048. - float GetAgentHeight() const
  3049. - float GetAgentRadius() const
  3050. - float GetAgentMaxClimb() const
  3051. - float GetAgentMaxSlope() const
  3052. - float GetRegionMinSize() const
  3053. - float GetRegionMergeSize() const
  3054. - float GetEdgeMaxLength() const
  3055. - float GetEdgeMaxError() const
  3056. - float GetDetailSampleDistance() const
  3057. - float GetDetailSampleMaxError() const
  3058. - const Vector3& GetPadding() const
  3059. - bool IsInitialized() const
  3060. - const BoundingBox& GetBoundingBox() const
  3061. - BoundingBox GetWorldBoundingBox() const
  3062. - IntVector2 GetNumTiles() const
  3063. Properties:
  3064. - int tileSize
  3065. - float cellSize
  3066. - float cellHeight
  3067. - float agentHeight
  3068. - float agentRadius
  3069. - float agentMaxClimb
  3070. - float agentMaxSlope
  3071. - float regionMinSize
  3072. - float regionMergeSize
  3073. - float edgeMaxLength
  3074. - float edgeMaxError
  3075. - float detailSampleDistance
  3076. - float detailSampleMaxError
  3077. - Vector3& padding
  3078. - bool initialized (readonly)
  3079. - BoundingBox& boundingBox (readonly)
  3080. - BoundingBox worldBoundingBox (readonly)
  3081. - IntVector2 numTiles (readonly)
  3082. ### OffMeshConnection : Component
  3083. Methods:
  3084. - void SetEndPoint(Node* node)
  3085. - void SetRadius(float radius)
  3086. - void SetBidirectional(bool enabled)
  3087. - Node* GetEndPoint() const
  3088. - float GetRadius() const
  3089. - bool IsBidirectional() const
  3090. Properties:
  3091. - Node* endPoint
  3092. - float radius
  3093. - bool bidirectional
  3094. ### RemoteEvent
  3095. Methods:
  3096. Properties:
  3097. - unsigned senderID
  3098. - StringHash eventType
  3099. - VariantMap eventData
  3100. - bool inOrder
  3101. ### Connection : Object
  3102. Methods:
  3103. - void SendMessage(int msgID, bool reliable, bool inOrder, const VectorBuffer& msg, unsigned contentID = 0)
  3104. - void SendRemoteEvent(StringHash eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  3105. - void SendRemoteEvent(const String eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  3106. - void SendRemoteEvent(Node* node, StringHash eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  3107. - void SendRemoteEvent(Node* node, const String eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  3108. - void SetScene(Scene* newScene)
  3109. - void SetIdentity(const VariantMap& identity)
  3110. - void SetControls(const Controls& newControls)
  3111. - void SetPosition(const Vector3& position)
  3112. - void SetConnectPending(bool connectPending)
  3113. - void SetLogStatistics(bool enable)
  3114. - void Disconnect(int waitMSec = 0)
  3115. - void SendServerUpdate()
  3116. - void SendClientUpdate()
  3117. - void SendRemoteEvents()
  3118. - void SendPackages()
  3119. - void ProcessPendingLatestData()
  3120. - bool ProcessMessage(int msgID, MemoryBuffer& msg)
  3121. - const VariantMap& GetIdentity() const
  3122. - Scene* GetScene() const
  3123. - const Controls& GetControls() const
  3124. - const Vector3& GetPosition() const
  3125. - bool IsClient() const
  3126. - bool IsConnected() const
  3127. - bool IsConnectPending() const
  3128. - bool IsSceneLoaded() const
  3129. - bool GetLogStatistics() const
  3130. - String GetAddress() const
  3131. - unsigned short GetPort() const
  3132. - String ToString() const
  3133. - unsigned GetNumDownloads() const
  3134. - const String& GetDownloadName() const
  3135. - float GetDownloadProgress() const
  3136. Properties:
  3137. - VariantMap& identity
  3138. - Scene* scene
  3139. - Controls& controls
  3140. - Vector3& position
  3141. - bool client (readonly)
  3142. - bool connected (readonly)
  3143. - bool connectPending
  3144. - bool sceneLoaded (readonly)
  3145. - bool logStatistics
  3146. - String address (readonly)
  3147. - unsigned short port (readonly)
  3148. - unsigned numDownloads (readonly)
  3149. - String& downloadName (readonly)
  3150. - float downloadProgress (readonly)
  3151. ### Controls
  3152. Methods:
  3153. - Controls()
  3154. - void Reset()
  3155. - void Set(unsigned buttons, bool down = true)
  3156. - bool IsDown(unsigned button) const
  3157. - bool IsPressed(unsigned button, const Controls& previousControls) const
  3158. Properties:
  3159. - unsigned buttons
  3160. - float yaw
  3161. - float pitch
  3162. - VariantMap extraData
  3163. ### Network
  3164. Methods:
  3165. - bool Connect(const String address, unsigned short port, Scene* scene, const VariantMap& identity = Variant::emptyVariantMap)
  3166. - void Disconnect(int waitMSec = 0)
  3167. - bool StartServer(unsigned short port)
  3168. - void StopServer()
  3169. - void BroadcastMessage(int msgID, bool reliable, bool inOrder, const VectorBuffer& msg, unsigned contentID = 0)
  3170. - void BroadcastRemoteEvent(StringHash eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  3171. - void BroadcastRemoteEvent(const String eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  3172. - void BroadcastRemoteEvent(Scene* scene, StringHash eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  3173. - void BroadcastRemoteEvent(Scene* scene, const String eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  3174. - void BroadcastRemoteEvent(Node* node, StringHash eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  3175. - void BroadcastRemoteEvent(Node* node, const String eventType, bool inOrder, const VariantMap& eventData = Variant::emptyVariantMap)
  3176. - void SetUpdateFps(int fps)
  3177. - void RegisterRemoteEvent(StringHash eventType)
  3178. - void RegisterRemoteEvent(const String eventType)
  3179. - void UnregisterRemoteEvent(StringHash eventType)
  3180. - void UnregisterRemoteEvent(const String eventType)
  3181. - void UnregisterAllRemoteEvents()
  3182. - void SetPackageCacheDir(const String path)
  3183. - int GetUpdateFps() const
  3184. - Connection* GetServerConnection() const
  3185. - bool IsServerRunning() const
  3186. - bool CheckRemoteEvent(StringHash eventType) const
  3187. - const String& GetPackageCacheDir() const
  3188. Properties:
  3189. - int updateFps
  3190. - Connection* serverConnection (readonly)
  3191. - bool serverRunning (readonly)
  3192. - String& packageCacheDir
  3193. ### NetworkPriority : Component
  3194. Methods:
  3195. - void SetBasePriority(float priority)
  3196. - void SetDistanceFactor(float factor)
  3197. - void SetMinPriority(float priority)
  3198. - void SetAlwaysUpdateOwner(bool enable)
  3199. - float GetBasePriority() const
  3200. - float GetDistanceFactor() const
  3201. - float GetMinPriority() const
  3202. - bool GetAlwaysUpdateOwner() const
  3203. - bool CheckUpdate(float distance, float& accumulator)
  3204. Properties:
  3205. - float basePriority
  3206. - float distanceFactor
  3207. - float minPriority
  3208. - bool alwaysUpdateOwner
  3209. ### CollisionShape : Component
  3210. Methods:
  3211. - void SetBox(const Vector3& size, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  3212. - void SetSphere(float diameter, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  3213. - void SetStaticPlane(const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  3214. - void SetCylinder(float diameter, float height, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  3215. - void SetCapsule(float diameter, float height, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  3216. - void SetCone(float diameter, float height, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  3217. - void SetTriangleMesh(Model* model, unsigned lodLevel = 0, const Vector3& scale = Vector3::ONE, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  3218. - void SetConvexHull(Model* model, unsigned lodLevel = 0, const Vector3& scale = Vector3::ONE, const Vector3& position = Vector3::ZERO, const Quaternion& rotation = Quaternion::IDENTITY)
  3219. - void SetTerrain()
  3220. - void SetShapeType(ShapeType type)
  3221. - void SetSize(const Vector3& size)
  3222. - void SetPosition(const Vector3& position)
  3223. - void SetRotation(const Quaternion& rotation)
  3224. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  3225. - void SetMargin(float margin)
  3226. - void SetModel(Model* model)
  3227. - void SetLodLevel(unsigned lodLevel)
  3228. - PhysicsWorld* GetPhysicsWorld() const
  3229. - ShapeType GetShapeType() const
  3230. - const Vector3& GetSize() const
  3231. - const Vector3& GetPosition() const
  3232. - const Quaternion& GetRotation() const
  3233. - float GetMargin() const
  3234. - Model* GetModel() const
  3235. - unsigned GetLodLevel() const
  3236. - BoundingBox GetWorldBoundingBox() const
  3237. - void NotifyRigidBody(bool updateMass = true)
  3238. - void SetModelAttr(ResourceRef value)
  3239. - ResourceRef GetModelAttr() const
  3240. - void ReleaseShape()
  3241. Properties:
  3242. - PhysicsWorld* physicsWorld (readonly)
  3243. - ShapeType shapeType
  3244. - Vector3& size
  3245. - Vector3& position
  3246. - Quaternion& rotation
  3247. - float margin
  3248. - Model* model
  3249. - unsigned lodLevel
  3250. - tolua_readonlyBoundingBox worldBoundingBox (readonly)
  3251. - ResourceRef modelAttr
  3252. ### Constraint : Component
  3253. Methods:
  3254. - void SetConstraintType(ConstraintType type)
  3255. - void SetOtherBody(RigidBody* body)
  3256. - void SetPosition(const Vector3& position)
  3257. - void SetRotation(const Quaternion& rotation)
  3258. - void SetAxis(const Vector3& axis)
  3259. - void SetOtherPosition(const Vector3& position)
  3260. - void SetOtherRotation(const Quaternion& rotation)
  3261. - void SetOtherAxis(const Vector3& axis)
  3262. - void SetWorldPosition(const Vector3& position)
  3263. - void SetHighLimit(const Vector2& limit)
  3264. - void SetLowLimit(const Vector2& limit)
  3265. - void SetERP(float erp)
  3266. - void SetCFM(float cfm)
  3267. - void SetDisableCollision(bool disable)
  3268. - PhysicsWorld* GetPhysicsWorld() const
  3269. - ConstraintType GetConstraintType() const
  3270. - RigidBody* GetOwnBody() const
  3271. - RigidBody* GetOtherBody() const
  3272. - const Vector3& GetPosition() const
  3273. - const Quaternion& GetRotation() const
  3274. - const Vector3& GetOtherPosition() const
  3275. - const Quaternion& GetOtherRotation() const
  3276. - Vector3 GetWorldPosition() const
  3277. - const Vector2& GetHighLimit() const
  3278. - const Vector2& GetLowLimit() const
  3279. - float GetERP() const
  3280. - float GetCFM() const
  3281. - bool GetDisableCollision() const
  3282. - void ReleaseConstraint()
  3283. - void ApplyFrames()
  3284. Properties:
  3285. - PhysicsWorld* physicsWorld (readonly)
  3286. - ConstraintType constraintType
  3287. - RigidBody* ownBody (readonly)
  3288. - RigidBody* otherBody
  3289. - Vector3& position
  3290. - Quaternion& rotation
  3291. - Vector3& otherPosition
  3292. - Quaternion& otherRotation
  3293. - Vector3 worldPosition
  3294. - Vector2& highLimit
  3295. - Vector2& lowLimit
  3296. - float ERP
  3297. - float CFM
  3298. - bool disableCollision
  3299. ### PhysicsRaycastResult
  3300. Methods:
  3301. - PhysicsRaycastResult()
  3302. Properties:
  3303. - Vector3 position
  3304. - Vector3 normal
  3305. - float distance
  3306. - RigidBody* body
  3307. ### DelayedWorldTransform
  3308. Methods:
  3309. Properties:
  3310. - RigidBody* rigidBody
  3311. - RigidBody* parentRigidBody
  3312. - Vector3 worldPosition
  3313. - Quaternion worldRotation
  3314. ### PhysicsWorld : Component
  3315. Methods:
  3316. - void Update(float timeStep)
  3317. - void UpdateCollisions()
  3318. - void SetFps(int fps)
  3319. - void SetGravity(Vector3 gravity)
  3320. - void SetNumIterations(int num)
  3321. - void SetInterpolation(bool enable)
  3322. - void SetInternalEdge(bool enable)
  3323. - void SetSplitImpulse(bool enable)
  3324. - void SetMaxNetworkAngularVelocity(float velocity)
  3325. - PhysicsRaycastResult RaycastSingle(const Ray& ray, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3326. - / void SphereCast(PhysicsRaycastResult& result, const Ray& ray, float radius, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3327. - PhysicsRaycastResult SphereCast(const Ray& ray, float radius, float maxDistance, unsigned collisionMask = M_MAX_UNSIGNED)
  3328. - Vector3 GetGravity() const
  3329. - int GetNumIterations() const
  3330. - bool GetInterpolation() const
  3331. - bool GetInternalEdge() const
  3332. - bool GetSplitImpulse() const
  3333. - int GetFps() const
  3334. - float GetMaxNetworkAngularVelocity() const
  3335. - void AddRigidBody(RigidBody* body)
  3336. - void RemoveRigidBody(RigidBody* body)
  3337. - void AddCollisionShape(CollisionShape* shape)
  3338. - void RemoveCollisionShape(CollisionShape* shape)
  3339. - void AddConstraint(Constraint* joint)
  3340. - void RemoveConstraint(Constraint* joint)
  3341. - void AddDelayedWorldTransform(const DelayedWorldTransform& transform)
  3342. - void DrawDebugGeometry(bool depthTest)
  3343. - void SetDebugRenderer(DebugRenderer* debug)
  3344. - void SetDebugDepthTest(bool enable)
  3345. - void CleanupGeometryCache()
  3346. - void SetApplyingTransforms(bool enable)
  3347. - bool IsApplyingTransforms() const
  3348. Properties:
  3349. - Vector3 gravity
  3350. - int numIterations
  3351. - bool interpolation
  3352. - bool internalEdge
  3353. - bool splitImpulse
  3354. - int fps
  3355. - float maxNetworkAngularVelocity
  3356. - bool applyingTransforms
  3357. ### RigidBody : Component
  3358. Methods:
  3359. - void SetMass(float mass)
  3360. - void SetPosition(Vector3 position)
  3361. - void SetRotation(Quaternion rotation)
  3362. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  3363. - void SetLinearVelocity(Vector3 velocity)
  3364. - void SetLinearFactor(Vector3 factor)
  3365. - void SetLinearRestThreshold(float threshold)
  3366. - void SetLinearDamping(float damping)
  3367. - void SetAngularVelocity(Vector3 angularVelocity)
  3368. - void SetAngularFactor(Vector3 factor)
  3369. - void SetAngularRestThreshold(float threshold)
  3370. - void SetAngularDamping(float factor)
  3371. - void SetFriction(float friction)
  3372. - void SetRollingFriction(float friction)
  3373. - void SetRestitution(float restitution)
  3374. - void SetContactProcessingThreshold(float threshold)
  3375. - void SetCcdRadius(float radius)
  3376. - void SetCcdMotionThreshold(float threshold)
  3377. - void SetUseGravity(bool enable)
  3378. - void SetGravityOverride(const Vector3& gravity)
  3379. - void SetKinematic(bool enable)
  3380. - void SetPhantom(bool enable)
  3381. - void SetCollisionLayer(unsigned layer)
  3382. - void SetCollisionMask(unsigned mask)
  3383. - void SetCollisionLayerAndMask(unsigned layer, unsigned mask)
  3384. - void SetCollisionEventMode(CollisionEventMode mode)
  3385. - void ApplyForce(const Vector3& force)
  3386. - void ApplyForce(const Vector3& force, const Vector3& position)
  3387. - void ApplyTorque(const Vector3& torque)
  3388. - void ApplyImpulse(const Vector3& impulse)
  3389. - void ApplyImpulse(const Vector3& impulse, const Vector3& position)
  3390. - void ApplyTorqueImpulse(const Vector3& torque)
  3391. - void ResetForces()
  3392. - void Activate()
  3393. - void ReAddBodyToWorld()
  3394. - PhysicsWorld* GetPhysicsWorld() const
  3395. - float GetMass() const
  3396. - Vector3 GetPosition() const
  3397. - Quaternion GetRotation() const
  3398. - Vector3 GetLinearVelocity() const
  3399. - Vector3 GetLinearFactor() const
  3400. - Vector3 GetVelocityAtPoint(const Vector3& position) const
  3401. - float GetLinearRestThreshold() const
  3402. - float GetLinearDamping() const
  3403. - Vector3 GetAngularVelocity() const
  3404. - Vector3 GetAngularFactor() const
  3405. - float GetAngularRestThreshold() const
  3406. - float GetAngularDamping() const
  3407. - float GetFriction() const
  3408. - float GetRollingFriction() const
  3409. - float GetRestitution() const
  3410. - float GetContactProcessingThreshold() const
  3411. - float GetCcdRadius() const
  3412. - float GetCcdMotionThreshold() const
  3413. - bool GetUseGravity() const
  3414. - const Vector3& GetGravityOverride() const
  3415. - const Vector3& GetCenterOfMass() const
  3416. - bool IsKinematic() const
  3417. - bool IsPhantom() const
  3418. - bool IsActive() const
  3419. - unsigned GetCollisionLayer() const
  3420. - unsigned GetCollisionMask() const
  3421. - CollisionEventMode GetCollisionEventMode() const
  3422. - void ApplyWorldTransform(const Vector3& newWorldPosition, const Quaternion& newWorldRotation)
  3423. - void UpdateMass()
  3424. - void UpdateGravity()
  3425. - void AddConstraint(Constraint* constraint)
  3426. - void RemoveConstraint(Constraint* constraint)
  3427. - void ReleaseBody()
  3428. Properties:
  3429. - PhysicsWorld* physicsWorld (readonly)
  3430. - float mass
  3431. - Vector3 position
  3432. - Quaternion rotation
  3433. - Vector3 linearVelocity
  3434. - Vector3 linearFactor
  3435. - float linearRestThreshold
  3436. - float linearDamping
  3437. - Vector3 angularVelocity
  3438. - Vector3 angularFactor
  3439. - float angularRestThreshold
  3440. - float angularDamping
  3441. - float friction
  3442. - float rollingFriction
  3443. - float restitution
  3444. - float contactProcessingThreshold
  3445. - float ccdRadius
  3446. - float ccdMotionThreshold
  3447. - bool useGravity
  3448. - Vector3& gravityOverride
  3449. - Vector3& centerOfMass (readonly)
  3450. - bool kinematic
  3451. - bool phantom
  3452. - bool active (readonly)
  3453. - unsigned collisionLayer
  3454. - unsigned collisionMask
  3455. - CollisionEventMode collisionEventMode
  3456. ### Image : Resource
  3457. Methods:
  3458. - void FlipVertical()
  3459. - bool SaveBMP(const String fileName)
  3460. - bool SavePNG(const String fileName)
  3461. - bool SaveTGA(const String fileName)
  3462. - bool SaveJPG(const String fileName, int quality)
  3463. - int GetWidth() const
  3464. - int GetHeight() const
  3465. - unsigned GetComponents() const
  3466. - bool IsCompressed() const
  3467. - CompressedFormat GetCompressedFormat() const
  3468. - unsigned GetNumCompressedLevels() const
  3469. - CompressedLevel GetCompressedLevel(unsigned index) const
  3470. Properties:
  3471. - int width (readonly)
  3472. - int height (readonly)
  3473. - unsigned components (readonly)
  3474. - bool compressed (readonly)
  3475. - CompressedFormat compressedFormat (readonly)
  3476. - unsigned numCompressedLevels (readonly)
  3477. ### Resource
  3478. Methods:
  3479. - const String& GetName() const
  3480. - StringHash GetNameHash() const
  3481. - unsigned GetMemoryUse() const
  3482. Properties:
  3483. - String& name (readonly)
  3484. - StringHash nameHash (readonly)
  3485. - unsigned memoryUse (readonly)
  3486. ### ResourceCache
  3487. Methods:
  3488. - void ReleaseAllResources(bool force = false)
  3489. - bool ReloadResource(Resource* resource)
  3490. - void SetMemoryBudget(ShortStringHash type, unsigned budget)
  3491. - void SetMemoryBudget(const String type, unsigned budget)
  3492. - void SetAutoReloadResources(bool enable)
  3493. - Resource* GetResource(const String type, const String name)
  3494. - bool Exists(const String name) const
  3495. - bool Exists(StringHash nameHash) const
  3496. - unsigned GetMemoryBudget(ShortStringHash type) const
  3497. - unsigned GetMemoryUse(ShortStringHash type) const
  3498. - unsigned GetTotalMemoryUse() const
  3499. - const String& GetResourceName(StringHash nameHash) const
  3500. - String GetResourceFileName(const String name) const
  3501. - bool GetAutoReloadResources() const
  3502. Properties:
  3503. - unsigned totalMemoryUse (readonly)
  3504. - bool autoReloadResources (readonly)
  3505. ### XMLElement
  3506. Methods:
  3507. - bool IsNull() const
  3508. - bool NotNull() const
  3509. - operator bool () const
  3510. - String GetName() const
  3511. - bool HasChild(const String name) const
  3512. - XMLElement GetChild(const String name = String::EMPTY) const
  3513. - XMLElement GetNext(const String name = String::EMPTY) const
  3514. - XMLElement GetParent() const
  3515. - unsigned GetNumAttributes() const
  3516. - bool HasAttribute(const String name) const
  3517. - bool GetBool(const String name) const
  3518. - BoundingBox GetBoundingBox() const
  3519. - Color GetColor(const String name) const
  3520. - float GetFloat(const String name) const
  3521. - unsigned GetUInt(const String name) const
  3522. - int GetInt(const String name) const
  3523. - IntRect GetIntRect(const String name) const
  3524. - IntVector2 GetIntVector2(const String name) const
  3525. - Rect GetRect(const String name) const
  3526. - Quaternion GetQuaternion(const String name) const
  3527. - Variant GetVariant() const
  3528. - Variant GetVariantValue(VariantType type) const
  3529. - ResourceRef GetResourceRef() const
  3530. - ResourceRefList GetResourceRefList() const
  3531. - VariantMap GetVariantMap() const
  3532. - Vector2 GetVector2(const String name) const
  3533. - Vector3 GetVector3(const String name) const
  3534. - Vector4 GetVector4(const String name) const
  3535. - Vector4 GetVector(const String name) const
  3536. - XMLFile* GetFile() const
  3537. Properties:
  3538. - static const XMLElement EMPTY
  3539. - bool null (readonly)
  3540. - String name (readonly)
  3541. - XMLElement parent (readonly)
  3542. - unsigned numAttributes (readonly)
  3543. - XMLFile* file (readonly)
  3544. ### XMLFile : Resource
  3545. Methods:
  3546. - XMLElement GetRoot(const String name = String::EMPTY)
  3547. ### Component : Serializable
  3548. Methods:
  3549. - void SetEnabled(bool enable)
  3550. - void Remove()
  3551. - unsigned GetID() const
  3552. - Node* GetNode() const
  3553. - Scene* GetScene() const
  3554. - bool IsEnabled() const
  3555. - bool IsEnabledEffective() const
  3556. - Component* GetComponent(ShortStringHash type) const
  3557. - Component* GetComponent(const String type) const
  3558. ### Node : Serializable
  3559. Methods:
  3560. - Node(Context* context)
  3561. - virtual ~Node()
  3562. - bool SaveXML(File* dest) const
  3563. - void SetName(const String name)
  3564. - void SetPosition(const Vector3& position)
  3565. - void SetPositionXYZ(float x, float y, float z)
  3566. - void SetRotation(const Quaternion& rotation)
  3567. - void SetRotationXYZ(float x, float y, float z)
  3568. - void SetDirection(const Vector3& direction)
  3569. - void SetDirectionXYZ(float x, float y, float z)
  3570. - void SetScale(float scale)
  3571. - void SetScale(const Vector3& scale)
  3572. - void SetScaleXYZ(float x, float y, float z)
  3573. - void SetTransform(const Vector3& position, const Quaternion& rotation)
  3574. - void SetTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3575. - void SetTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3576. - void SetWorldPosition(const Vector3& position)
  3577. - void SetWorldPositionXYZ(float x, float y, float z)
  3578. - void SetWorldRotation(const Quaternion& rotation)
  3579. - void SetWorldRotationXYZ(float x, float y, float z)
  3580. - void SetWorldDirection(const Vector3& direction)
  3581. - void SetWorldDirectionXYZ(float x, float y, float z)
  3582. - void SetWorldScale(float scale)
  3583. - void SetWorldScale(const Vector3& scale)
  3584. - void SetWorldScaleXYZ(float x, float y, float z)
  3585. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation)
  3586. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, float scale)
  3587. - void SetWorldTransform(const Vector3& position, const Quaternion& rotation, const Vector3& scale)
  3588. - void Translate(const Vector3& delta)
  3589. - void TranslateXYZ(float x, float y, float z)
  3590. - void TranslateRelative(const Vector3& delta)
  3591. - void TranslateRelativeXYZ(float x, float y, float z)
  3592. - void Rotate(const Quaternion& delta, bool fixedAxis = false)
  3593. - void RotateXYZ(float x, float y, float z, bool fixedAxis = false)
  3594. - void Pitch(float angle, bool fixedAxis = false)
  3595. - void Yaw(float angle, bool fixedAxis = false)
  3596. - void Roll(float angle, bool fixedAxis = false)
  3597. - void LookAt(const Vector3& target, const Vector3& upAxis = Vector3::UP)
  3598. - void LookAtXYZ(float x, float y, float z, float upX = 0.0f, float upY = 1.0f, float upZ = 0.0f)
  3599. - void Scale(float scale)
  3600. - void Scale(const Vector3& scale)
  3601. - void ScaleXYZ(float x, float y, float z)
  3602. - void SetEnabled(bool enable)
  3603. - void SetEnabled(bool enable, bool recursive)
  3604. - void SetOwner(Connection* owner)
  3605. - void MarkDirty()
  3606. - Node* CreateChild(const String name = String::EMPTY, CreateMode mode = REPLICATED, unsigned id = 0)
  3607. - void AddChild(Node* node)
  3608. - void RemoveChild(Node* node)
  3609. - void RemoveAllChildren()
  3610. - void RemoveChildren(bool removeReplicated, bool removeLocal, bool recursive)
  3611. - void RemoveComponent(Component* component)
  3612. - void RemoveComponent(ShortStringHash type)
  3613. - void RemoveComponent(const String type)
  3614. - void RemoveAllComponents()
  3615. - void RemoveComponents(bool removeReplicated, bool removeLocal)
  3616. - Node* Clone(CreateMode mode = REPLICATED)
  3617. - void Remove()
  3618. - void SetParent(Node* parent)
  3619. - void SetVar(ShortStringHash key, const Variant& value)
  3620. - void AddListener(Component* component)
  3621. - void RemoveListener(Component* component)
  3622. - Component* CreateComponent(const String type, CreateMode mode = REPLICATED, unsigned id = 0)
  3623. - int CreateScriptObject(const String scriptObjectType)
  3624. - int CreateScriptObject(const String fileName, const String scriptObjectType)
  3625. - int GetScriptObject() const
  3626. - int GetScriptObject(const String scriptObjectType) const
  3627. - unsigned GetID() const
  3628. - const String& GetName() const
  3629. - StringHash GetNameHash() const
  3630. - Node* GetParent() const
  3631. - Scene* GetScene() const
  3632. - bool IsEnabled() const
  3633. - Connection* GetOwner() const
  3634. - const Vector3& GetPosition() const
  3635. - void GetPositionXYZ(float* x = 0.0f, float* y = 0.0f, float* z = 0.0f) const
  3636. - const Quaternion& GetRotation() const
  3637. - void GetRotationXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3638. - void GetRotationWXYZ(float* *w = 0.0f, float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3639. - Vector3 GetDirection() const
  3640. - void GetDirectionXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3641. - const Vector3& GetScale() const
  3642. - void GetScaleXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3643. - Matrix3x4 GetTransform() const
  3644. - Vector3 GetWorldPosition() const
  3645. - void GetWorldPositionXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3646. - Quaternion GetWorldRotation() const
  3647. - void GetWorldRotationXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3648. - void GetWorldRotationWXYZ(float* *w = 0.0f, float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3649. - Vector3 GetWorldDirection() const
  3650. - void GetWorldDirectionXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3651. - Vector3 GetWorldScale() const
  3652. - void GetWorldScaleXYZ(float* *x = 0.0f, float* *y = 0.0f, float* *z = 0.0f) const
  3653. - const Matrix3x4& GetWorldTransform() const
  3654. - Vector3 LocalToWorld(const Vector3& position) const
  3655. - Vector3 LocalToWorld(const Vector4& vector) const
  3656. - Vector3 WorldToLocal(const Vector3& position) const
  3657. - Vector3 WorldToLocal(const Vector4& vector) const
  3658. - bool IsDirty() const
  3659. - unsigned GetNumChildren(bool recursive = false) const
  3660. - Node* GetChild(unsigned index) const
  3661. - Node* GetChild(const String name, bool recursive = false) const
  3662. - Node* GetChild(StringHash nameHash, bool recursive = false) const
  3663. - unsigned GetNumComponents() const
  3664. - unsigned GetNumNetworkComponents() const
  3665. - bool HasComponent(ShortStringHash type) const
  3666. - bool HasComponent(const String type) const
  3667. - const Variant& GetVar(ShortStringHash key) const
  3668. - const VariantMap& GetVars() const
  3669. - Component* GetComponent(const String type) const
  3670. - void SetID(unsigned id)
  3671. - void SetScene(Scene* scene)
  3672. - void ResetScene()
  3673. - bool Load(Deserializer& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3674. - bool LoadXML(const XMLElement& source, SceneResolver& resolver, bool loadChildren = true, bool rewriteIDs = false, CreateMode mode = REPLICATED)
  3675. - Node* CreateChild(unsigned id, CreateMode mode)
  3676. - void AddComponent(Component* component, unsigned id, CreateMode mode)
  3677. Properties:
  3678. - unsigned ID
  3679. - String& name
  3680. - StringHash nameHash (readonly)
  3681. - Node* parent
  3682. - Scene* scene
  3683. - bool enabled
  3684. - Connection* owner
  3685. - Vector3& position
  3686. - Quaternion& rotation
  3687. - Vector3 direction
  3688. - Vector3& scale
  3689. - Matrix3x4 transform (readonly)
  3690. - Vector3 worldPosition
  3691. - Quaternion worldRotation
  3692. - Vector3 worldDirection
  3693. - Vector3 worldScale
  3694. - Matrix3x4& worldTransform (readonly)
  3695. - bool dirty (readonly)
  3696. - unsigned numComponents (readonly)
  3697. - unsigned numNetworkComponents (readonly)
  3698. ### Scene : Node
  3699. Methods:
  3700. - Scene(Context* context)
  3701. - virtual ~Scene()
  3702. - bool LoadXML(File* source)
  3703. - bool SaveXML(File* dest) const
  3704. - bool LoadXML(const String fileName)
  3705. - bool SaveXML(const String fileName) const
  3706. - bool LoadAsync(File* file)
  3707. - bool LoadAsyncXML(File* file)
  3708. - void StopAsyncLoading()
  3709. - void Clear(bool clearReplicated = true, bool clearLocal = true)
  3710. - void SetUpdateEnabled(bool enable)
  3711. - void SetTimeScale(float scale)
  3712. - void SetElapsedTime(float time)
  3713. - void SetSmoothingConstant(float constant)
  3714. - void SetSnapThreshold(float threshold)
  3715. - Node* GetNode(unsigned id) const
  3716. - bool IsUpdateEnabled() const
  3717. - bool IsAsyncLoading() const
  3718. - float GetAsyncProgress() const
  3719. - const String& GetFileName() const
  3720. - unsigned GetChecksum() const
  3721. - float GetTimeScale() const
  3722. - float GetElapsedTime() const
  3723. - float GetSmoothingConstant() const
  3724. - float GetSnapThreshold() const
  3725. - const String& GetVarName(ShortStringHash hash) const
  3726. - void Update(float timeStep)
  3727. - void BeginThreadedUpdate()
  3728. - void EndThreadedUpdate()
  3729. - void DelayedMarkedDirty(Component* component)
  3730. - bool IsThreadedUpdate() const
  3731. - unsigned GetFreeNodeID(CreateMode mode)
  3732. - unsigned GetFreeComponentID(CreateMode mode)
  3733. - void NodeAdded(Node* node)
  3734. - void NodeRemoved(Node* node)
  3735. - void ComponentAdded(Component* component)
  3736. - void ComponentRemoved(Component* component)
  3737. - void SetVarNamesAttr(String value)
  3738. - String GetVarNamesAttr() const
  3739. - void PrepareNetworkUpdate()
  3740. - void CleanupConnection(Connection* connection)
  3741. - void MarkNetworkUpdate(Node* node)
  3742. - void MarkNetworkUpdate(Component* component)
  3743. - void MarkReplicationDirty(Node* node)
  3744. Properties:
  3745. - bool updateEnabled
  3746. - bool asyncLoading (readonly)
  3747. - float asyncProgress (readonly)
  3748. - const String fileName
  3749. - unsigned checksum (readonly)
  3750. - float timeScale
  3751. - float elapsedTime
  3752. - float smoothingConstant
  3753. - float snapThreshold
  3754. - bool threadedUpdate (readonly)
  3755. - String varNamesAttr
  3756. ### Serializable : Object
  3757. Methods:
  3758. - void SetTemporary(bool enable)
  3759. - bool IsTemporary() const
  3760. Properties:
  3761. - bool temporary
  3762. ### BorderImage : UIElement
  3763. Methods:
  3764. - BorderImage(Context* context)
  3765. - virtual ~BorderImage()
  3766. - void SetTexture(Texture* texture)
  3767. - void SetImageRect(const IntRect& rect)
  3768. - void SetFullImageRect()
  3769. - void SetBorder(const IntRect& rect)
  3770. - void SetHoverOffset(const IntVector2& offset)
  3771. - void SetHoverOffset(int x, int y)
  3772. - void SetBlendMode(BlendMode mode)
  3773. - void SetTiled(bool enable)
  3774. - Texture* GetTexture() const
  3775. - const IntRect& GetImageRect() const
  3776. - const IntRect& GetBorder() const
  3777. - const IntVector2& GetHoverOffset() const
  3778. - BlendMode GetBlendMode() const
  3779. - bool IsTiled() const
  3780. - void SetTextureAttr(ResourceRef value)
  3781. - ResourceRef GetTextureAttr() const
  3782. Properties:
  3783. - Texture* texture
  3784. - IntRect& imageRect
  3785. - IntRect& border
  3786. - IntVector2& hoverOffset
  3787. - BlendMode blendMode
  3788. - bool tiled
  3789. - ResourceRef textureAttr
  3790. ### Button : BorderImage
  3791. Methods:
  3792. - Button(Context* context)
  3793. - virtual ~Button()
  3794. - void SetPressedOffset(const IntVector2& offset)
  3795. - void SetPressedOffset(int x, int y)
  3796. - void SetPressedChildOffset(const IntVector2& offset)
  3797. - void SetPressedChildOffset(int x, int y)
  3798. - void SetRepeat(float delay, float rate)
  3799. - void SetRepeatDelay(float delay)
  3800. - void SetRepeatRate(float rate)
  3801. - const IntVector2& GetPressedOffset() const
  3802. - const IntVector2& GetPressedChildOffset() const
  3803. - float GetRepeatDelay() const
  3804. - float GetRepeatRate() const
  3805. - bool IsPressed() const
  3806. Properties:
  3807. - IntVector2& pressedOffset
  3808. - IntVector2& pressedChildOffset
  3809. - float repeatDelay
  3810. - float repeatRate
  3811. - bool pressed (readonly)
  3812. ### CheckBox : BorderImage
  3813. Methods:
  3814. - CheckBox(Context* context)
  3815. - virtual ~CheckBox()
  3816. - void SetChecked(bool enable)
  3817. - void SetCheckedOffset(const IntVector2& rect)
  3818. - void SetCheckedOffset(int x, int y)
  3819. - bool IsChecked() const
  3820. - const IntVector2& GetCheckedOffset() const
  3821. Properties:
  3822. - bool checked
  3823. - IntVector2& checkedOffset
  3824. ### Cursor : BorderImage
  3825. Methods:
  3826. - Cursor(Context* context)
  3827. - virtual ~Cursor()
  3828. - void DefineShape(CursorShape shape, Image* image, const IntRect& imageRect, const IntVector2& hotSpot)
  3829. - void SetShape(CursorShape shape)
  3830. - void SetUseSystemShapes(bool enable)
  3831. - CursorShape GetShape() const
  3832. - bool GetUseSystemShapes() const
  3833. Properties:
  3834. - CursorShape shape
  3835. - bool useSystemShapes
  3836. ### DropDownList : Menu
  3837. Methods:
  3838. - DropDownList(Context* context)
  3839. - ~DropDownList()
  3840. - void AddItem(UIElement* item)
  3841. - void InsertItem(unsigned index, UIElement* item)
  3842. - void RemoveItem(UIElement* item)
  3843. - void RemoveItem(unsigned index)
  3844. - void RemoveAllItems()
  3845. - void SetSelection(unsigned index)
  3846. - void SetPlaceholderText(const String text)
  3847. - void SetResizePopup(bool enable)
  3848. - unsigned GetNumItems() const
  3849. - UIElement* GetItem(unsigned index) const
  3850. - unsigned GetSelection() const
  3851. - UIElement* GetSelectedItem() const
  3852. - ListView* GetListView() const
  3853. - UIElement* GetPlaceholder() const
  3854. - const String& GetPlaceholderText() const
  3855. - bool GetResizePopup() const
  3856. - void SetSelectionAttr(unsigned index)
  3857. Properties:
  3858. - unsigned numItems (readonly)
  3859. - unsigned selection
  3860. - UIElement* selectedItem (readonly)
  3861. - ListView* listView (readonly)
  3862. - UIElement* placeholder (readonly)
  3863. - String& placeholderText
  3864. - bool resizePopup
  3865. ### FileSelectorEntry
  3866. Methods:
  3867. Properties:
  3868. - String name
  3869. - bool directory
  3870. ### FileSelector : Object
  3871. Methods:
  3872. - FileSelector(Context* context)
  3873. - virtual ~FileSelector()
  3874. - void SetDefaultStyle(XMLFile* style)
  3875. - void SetTitle(const String text)
  3876. - void SetButtonTexts(const String okText, const String cancelText)
  3877. - void SetPath(const String path)
  3878. - void SetFileName(const String fileName)
  3879. - void SetDirectoryMode(bool enable)
  3880. - void UpdateElements()
  3881. - XMLFile* GetDefaultStyle() const
  3882. - Window* GetWindow() const
  3883. - Text* GetTitleText() const
  3884. - ListView* GetFileList() const
  3885. - LineEdit* GetPathEdit() const
  3886. - LineEdit* GetFileNameEdit() const
  3887. - DropDownList* GetFilterList() const
  3888. - Button* GetOKButton() const
  3889. - Button* GetCancelButton() const
  3890. - Button* GetCloseButton() const
  3891. - const String& GetTitle() const
  3892. - const String& GetPath() const
  3893. - const String& GetFileName() const
  3894. - const String& GetFilter() const
  3895. - unsigned GetFilterIndex() const
  3896. - bool GetDirectoryMode() const
  3897. Properties:
  3898. - XMLFile* defaultStyle
  3899. - Window* window (readonly)
  3900. - Text* titleText (readonly)
  3901. - ListView* fileList (readonly)
  3902. - LineEdit* pathEdit (readonly)
  3903. - LineEdit* fileNameEdit (readonly)
  3904. - DropDownList* filterList (readonly)
  3905. - Button* OKButton (readonly)
  3906. - Button* cancelButton (readonly)
  3907. - Button* closeButton (readonly)
  3908. - String& title
  3909. - String& path
  3910. - String& fileName
  3911. - String& filter (readonly)
  3912. - unsigned filterIndex (readonly)
  3913. - bool directoryMode
  3914. ### Font : Resource
  3915. Methods:
  3916. ### LineEdit : BorderImage
  3917. Methods:
  3918. - LineEdit(Context* context)
  3919. - virtual ~LineEdit()
  3920. - void SetText(const String text)
  3921. - void SetCursorPosition(unsigned position)
  3922. - void SetCursorBlinkRate(float rate)
  3923. - void SetMaxLength(unsigned length)
  3924. - void SetEchoCharacter(unsigned c)
  3925. - void SetCursorMovable(bool enable)
  3926. - void SetTextSelectable(bool enable)
  3927. - void SetTextCopyable(bool enable)
  3928. - const String& GetText() const
  3929. - unsigned GetCursorPosition() const
  3930. - float GetCursorBlinkRate() const
  3931. - unsigned GetMaxLength() const
  3932. - unsigned GetEchoCharacter() const
  3933. - bool IsCursorMovable() const
  3934. - bool IsTextSelectable() const
  3935. - bool IsTextCopyable() const
  3936. - Text* GetTextElement() const
  3937. - BorderImage* GetCursor() const
  3938. Properties:
  3939. - String& text
  3940. - unsigned cursorPosition
  3941. - float cursorBlinkRate
  3942. - unsigned maxLength
  3943. - unsigned echoCharacter
  3944. - bool cursorMovable
  3945. - bool textSelectable
  3946. - bool textCopyable
  3947. - Text* textElement (readonly)
  3948. - BorderImage* cursor (readonly)
  3949. ### ListView : ScrollView
  3950. Methods:
  3951. - ListView(Context* context)
  3952. - virtual ~ListView()
  3953. - void AddItem(UIElement* item)
  3954. - void InsertItem(unsigned index, UIElement* item, UIElement* parentItem = 0)
  3955. - void RemoveItem(UIElement* item, unsigned index = 0)
  3956. - void RemoveItem(unsigned index)
  3957. - void RemoveAllItems()
  3958. - void SetSelection(unsigned index)
  3959. - void AddSelection(unsigned index)
  3960. - void RemoveSelection(unsigned index)
  3961. - void ToggleSelection(unsigned index)
  3962. - void ChangeSelection(int delta, bool additive = false)
  3963. - void ClearSelection()
  3964. - void SetHighlightMode(HighlightMode mode)
  3965. - void SetMultiselect(bool enable)
  3966. - void SetHierarchyMode(bool enable)
  3967. - void SetBaseIndent(int baseIndent)
  3968. - void SetClearSelectionOnDefocus(bool enable)
  3969. - void Expand(unsigned index, bool enable, bool recursive = false)
  3970. - void ToggleExpand(unsigned index, bool recursive = false)
  3971. - unsigned GetNumItems() const
  3972. - UIElement* GetItem(unsigned index) const
  3973. - unsigned FindItem(UIElement* item) const
  3974. - unsigned GetSelection() const
  3975. - UIElement* GetSelectedItem() 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. - void SetFontAttr(ResourceRef value)
  4159. - ResourceRef GetFontAttr() const
  4160. Properties:
  4161. - Font* font
  4162. - int fontSize (readonly)
  4163. - String& text
  4164. - HorizontalAlignment textAlignment
  4165. - float rowSpacing
  4166. - bool wordwrap
  4167. - unsigned selectionStart (readonly)
  4168. - unsigned selectionLength (readonly)
  4169. - Color& selectionColor
  4170. - Color& hoverColor
  4171. - TextEffect textEffect
  4172. - Color& effectColor
  4173. - int rowHeight (readonly)
  4174. - unsigned numRows (readonly)
  4175. - ResourceRef fontAttr
  4176. ### Text3D : Drawable
  4177. Methods:
  4178. - Text3D(Context* context)
  4179. - ~Text3D()
  4180. - bool SetFont(const String fontName, int size = DEFAULT_FONT_SIZE)
  4181. - bool SetFont(Font* font, int size = DEFAULT_FONT_SIZE)
  4182. - bool SetFont(Font* font)
  4183. - void SetMaterial(Material* material)
  4184. - void SetText(const String text)
  4185. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  4186. - void SetHorizontalAlignment(HorizontalAlignment align)
  4187. - void SetVerticalAlignment(VerticalAlignment align)
  4188. - void SetTextAlignment(HorizontalAlignment align)
  4189. - void SetRowSpacing(float spacing)
  4190. - void SetWordwrap(bool enable)
  4191. - void SetTextEffect(TextEffect textEffect)
  4192. - void SetEffectColor(const Color& effectColor)
  4193. - void SetEffectDepthBias(float bias)
  4194. - void SetWidth(int width)
  4195. - void SetColor(const Color& color)
  4196. - void SetColor(Corner corner, const Color& color)
  4197. - void SetOpacity(float opacity)
  4198. - void SetFaceCamera(bool enable)
  4199. - Font* GetFont() const
  4200. - Material* GetMaterial() const
  4201. - int GetFontSize() const
  4202. - const String& GetText() const
  4203. - HorizontalAlignment GetTextAlignment() const
  4204. - HorizontalAlignment GetHorizontalAlignment() const
  4205. - VerticalAlignment GetVerticalAlignment() const
  4206. - float GetRowSpacing() const
  4207. - bool GetWordwrap() const
  4208. - TextEffect GetTextEffect() const
  4209. - const Color& GetEffectColor() const
  4210. - float GetEffectDepthBias() const
  4211. - int GetWidth() const
  4212. - int GetRowHeight() const
  4213. - unsigned GetNumRows() const
  4214. - const Color& GetColor(Corner corner) const
  4215. - float GetOpacity() const
  4216. - bool GetFaceCamera() const
  4217. - void SetFontAttr(ResourceRef value)
  4218. - ResourceRef GetFontAttr() const
  4219. - void SetMaterialAttr(ResourceRef value)
  4220. - ResourceRef GetMaterialAttr() const
  4221. - const Color& GetColorAttr() const
  4222. Properties:
  4223. - Font* font
  4224. - Material* material
  4225. - int fontSize (readonly)
  4226. - String& text
  4227. - HorizontalAlignment textAlignment
  4228. - HorizontalAlignment horizontalAlignment
  4229. - VerticalAlignment verticalAlignment
  4230. - float rowSpacing
  4231. - bool wordwrap
  4232. - TextEffect textEffect
  4233. - Color& effectColor
  4234. - float effectDepthBias
  4235. - int width
  4236. - int rowHeight (readonly)
  4237. - unsigned numRows (readonly)
  4238. - float opacity
  4239. - bool faceCamera
  4240. - ResourceRef fontAttr
  4241. - ResourceRef materialAttr
  4242. - Color& colorAttr (readonly)
  4243. ### UI : Object
  4244. Methods:
  4245. - void SetCursor(Cursor* cursor)
  4246. - void SetFocusElement(UIElement* element)
  4247. - bool SetModalElement(UIElement* modalElement, bool enable)
  4248. - void Clear()
  4249. - void Update(float timeStep)
  4250. - void RenderUpdate()
  4251. - void Render()
  4252. - void DebugDraw(UIElement* element)
  4253. - bool SaveLayout(Serializer& dest, UIElement* element)
  4254. - void SetClipBoardText(const String text)
  4255. - void SetDoubleClickInterval(float interval)
  4256. - void SetNonFocusedMouseWheel(bool nonFocusedMouseWheel)
  4257. - UIElement* GetRoot() const
  4258. - UIElement* GetRootModalElement() const
  4259. - Cursor* GetCursor() const
  4260. - UIElement* GetElementAt(const IntVector2& position, bool enabledOnly = true)
  4261. - UIElement* GetElementAt(int x, int y, bool enabledOnly = true)
  4262. - UIElement* GetFocusElement() const
  4263. - UIElement* GetFrontElement() const
  4264. - IntVector2 GetCursorPosition() const
  4265. - const String& GetClipBoardText() const
  4266. - float GetDoubleClickInterval() const
  4267. - bool IsNonFocusedMouseWheel() const
  4268. - bool HasModalElement() const
  4269. Properties:
  4270. - UIElement* root (readonly)
  4271. - UIElement* rootModalElement (readonly)
  4272. - Cursor* cursor
  4273. - UIElement* focusElement (readonly)
  4274. - UIElement* frontElement (readonly)
  4275. - IntVector2 cursorPosition (readonly)
  4276. - String& clipBoardText
  4277. - float doubleClickInterval
  4278. - bool nonFocusedMouseWheel (readonly)
  4279. - bool modalElement (readonly)
  4280. ### UIElement : Serializable
  4281. Methods:
  4282. - UIElement(Context* context)
  4283. - virtual ~UIElement()
  4284. - virtual const IntVector2& GetScreenPosition() const
  4285. - bool LoadXML(Deserializer& source)
  4286. - bool SaveXML(Serializer& dest) const
  4287. - bool FilterAttributes(XMLElement& dest) const
  4288. - void SetName(const String name)
  4289. - void SetPosition(const IntVector2& position)
  4290. - void SetPosition(int x, int y)
  4291. - void SetSize(const IntVector2& size)
  4292. - void SetSize(int width, int height)
  4293. - void SetWidth(int width)
  4294. - void SetHeight(int height)
  4295. - void SetMinSize(const IntVector2& minSize)
  4296. - void SetMinSize(int width, int height)
  4297. - void SetMinWidth(int width)
  4298. - void SetMinHeight(int height)
  4299. - void SetMaxSize(const IntVector2& maxSize)
  4300. - void SetMaxSize(int width, int height)
  4301. - void SetMaxWidth(int width)
  4302. - void SetMaxHeight(int height)
  4303. - void SetFixedSize(const IntVector2& size)
  4304. - void SetFixedSize(int width, int height)
  4305. - void SetFixedWidth(int width)
  4306. - void SetFixedHeight(int height)
  4307. - void SetAlignment(HorizontalAlignment hAlign, VerticalAlignment vAlign)
  4308. - void SetHorizontalAlignment(HorizontalAlignment align)
  4309. - void SetVerticalAlignment(VerticalAlignment align)
  4310. - void SetClipBorder(const IntRect& rect)
  4311. - void SetColor(const Color& color)
  4312. - void SetColor(Corner corner, const Color& color)
  4313. - void SetPriority(int priority)
  4314. - void SetOpacity(float opacity)
  4315. - void SetBringToFront(bool enable)
  4316. - void SetBringToBack(bool enable)
  4317. - void SetClipChildren(bool enable)
  4318. - void SetSortChildren(bool enable)
  4319. - void SetUseDerivedOpacity(bool enable)
  4320. - void SetEnabled(bool enable)
  4321. - void SetFocus(bool enable)
  4322. - void SetSelected(bool enable)
  4323. - void SetVisible(bool enable)
  4324. - void SetFocusMode(FocusMode mode)
  4325. - void SetDragDropMode(unsigned mode)
  4326. - bool SetStyle(const String styleName, XMLFile* file = 0)
  4327. - bool SetStyle(const XMLElement& element)
  4328. - bool SetStyleAuto(XMLFile* file = 0)
  4329. - void SetDefaultStyle(XMLFile* style)
  4330. - void SetLayout(LayoutMode mode, int spacing = 0, const IntRect& border = IntRect::ZERO)
  4331. - void SetLayoutMode(LayoutMode mode)
  4332. - void SetLayoutSpacing(int spacing)
  4333. - void SetLayoutBorder(const IntRect& border)
  4334. - void SetIndent(int indent)
  4335. - void SetIndentSpacing(int indentSpacing)
  4336. - void UpdateLayout()
  4337. - void DisableLayoutUpdate()
  4338. - void EnableLayoutUpdate()
  4339. - void BringToFront()
  4340. - UIElement* CreateChild(const String type, const String name = String::EMPTY, unsigned index = M_MAX_UNSIGNED)
  4341. - void AddChild(UIElement* element)
  4342. - void InsertChild(unsigned index, UIElement* element)
  4343. - void RemoveChild(UIElement* element, unsigned index = 0)
  4344. - void RemoveChild(unsigned index)
  4345. - void RemoveAllChildren()
  4346. - void Remove()
  4347. - unsigned FindChild(UIElement* element) const
  4348. - void SetParent(UIElement* parent, unsigned index = M_MAX_UNSIGNED)
  4349. - void SetVar(ShortStringHash key, const Variant& value)
  4350. - void SetInternal(bool enable)
  4351. - void SetTraversalMode(TraversalMode traversalMode)
  4352. - void SetElementEventSender(bool flag)
  4353. - const String& GetName() const
  4354. - const IntVector2& GetPosition() const
  4355. - const IntVector2& GetSize() const
  4356. - int GetWidth() const
  4357. - int GetHeight() const
  4358. - const IntVector2& GetMinSize() const
  4359. - int GetMinWidth() const
  4360. - int GetMinHeight() const
  4361. - const IntVector2& GetMaxSize() const
  4362. - int GetMaxWidth() const
  4363. - int GetMaxHeight() const
  4364. - bool IsFixedSize() const
  4365. - bool IsFixedWidth() const
  4366. - bool IsFixedHeight() const
  4367. - const IntVector2& GetChildOffset() const
  4368. - HorizontalAlignment GetHorizontalAlignment() const
  4369. - VerticalAlignment GetVerticalAlignment() const
  4370. - const IntRect& GetClipBorder() const
  4371. - const Color& GetColor(Corner corner) const
  4372. - int GetPriority() const
  4373. - float GetOpacity() const
  4374. - float GetDerivedOpacity() const
  4375. - bool GetBringToFront() const
  4376. - bool GetBringToBack() const
  4377. - bool GetClipChildren() const
  4378. - bool GetSortChildren() const
  4379. - bool GetUseDerivedOpacity() const
  4380. - bool HasFocus() const
  4381. - bool IsEnabled() const
  4382. - bool IsSelected() const
  4383. - bool IsVisible() const
  4384. - bool IsHovering() const
  4385. - bool IsInternal() const
  4386. - bool HasColorGradient() const
  4387. - FocusMode GetFocusMode() const
  4388. - unsigned GetDragDropMode() const
  4389. - const String& GetAppliedStyle() const
  4390. - XMLFile* GetDefaultStyle(bool recursiveUp = true) const
  4391. - LayoutMode GetLayoutMode() const
  4392. - int GetLayoutSpacing() const
  4393. - const IntRect& GetLayoutBorder() const
  4394. - unsigned GetNumChildren(bool recursive = false) const
  4395. - UIElement* GetChild(unsigned index) const
  4396. - UIElement* GetChild(const String name, bool recursive = false) const
  4397. - UIElement* GetParent() const
  4398. - UIElement* GetRoot() const
  4399. - const Color& GetDerivedColor() const
  4400. - const Variant& GetVar(ShortStringHash key) const
  4401. - const VariantMap& GetVars() const
  4402. - IntVector2 ScreenToElement(const IntVector2& screenPosition)
  4403. - IntVector2 ElementToScreen(const IntVector2& position)
  4404. - bool IsInside(IntVector2 position, bool isScreen)
  4405. - bool IsInsideCombined(IntVector2 position, bool isScreen)
  4406. - IntRect GetCombinedScreenRect()
  4407. - void SortChildren()
  4408. - int GetLayoutMinSize() const
  4409. - int GetIndent() const
  4410. - int GetIndentSpacing() const
  4411. - int GetIndentWidth() const
  4412. - void SetChildOffset(const IntVector2& offset)
  4413. - void SetHovering(bool enable)
  4414. - const Color& GetColorAttr() const
  4415. - TraversalMode GetTraversalMode() const
  4416. - bool IsElementEventSender() const
  4417. - UIElement* GetElementEventSender() const
  4418. Properties:
  4419. - IntVector2& screenPosition (readonly)
  4420. - String& name
  4421. - IntVector2& position
  4422. - IntVector2 size
  4423. - int width
  4424. - int height
  4425. - IntVector2 minSize
  4426. - int minWidth
  4427. - int minHeight
  4428. - IntVector2 maxSize
  4429. - int maxWidth
  4430. - int maxHeight
  4431. - bool fixedSize (readonly)
  4432. - bool fixedWidth (readonly)
  4433. - bool fixedHeight (readonly)
  4434. - IntVector2& childOffset
  4435. - HorizontalAlignment horizontalAlignment
  4436. - VerticalAlignment verticalAlignment
  4437. - IntRect clipBorder
  4438. - int priority
  4439. - float opacity
  4440. - float derivedOpacity (readonly)
  4441. - bool bringToFront
  4442. - bool bringToBack
  4443. - bool clipChildren
  4444. - bool sortChildren
  4445. - bool useDerivedOpacity
  4446. - bool focus
  4447. - bool enabled
  4448. - bool selected
  4449. - bool visible
  4450. - bool hovering
  4451. - bool internal
  4452. - bool colorGradient (readonly)
  4453. - FocusMode focusMode
  4454. - unsigned dragDropMode
  4455. - String& style
  4456. - XMLFile* defaultStyle
  4457. - LayoutMode layoutMode
  4458. - int layoutSpacing
  4459. - IntRect& layoutBorder
  4460. - unsigned numChildren (readonly)
  4461. - UIElement* parent
  4462. - UIElement* root (readonly)
  4463. - Color& derivedColor (readonly)
  4464. - IntRect combinedScreenRect (readonly)
  4465. - int layoutMinSize (readonly)
  4466. - int indent
  4467. - int indentSpacing
  4468. - int indentWidth (readonly)
  4469. - Color& colorAttr
  4470. - TraversalMode traversalMode
  4471. - bool elementEventSender
  4472. ### View3D : Window
  4473. Methods:
  4474. - View3D(Context* context)
  4475. - ~View3D()
  4476. - void SetView(Scene* scene, Camera* camera)
  4477. - void SetFormat(unsigned format)
  4478. - void SetAutoUpdate(bool enable)
  4479. - void QueueUpdate()
  4480. - unsigned GetFormat() const
  4481. - bool GetAutoUpdate() const
  4482. - Scene* GetScene() const
  4483. - Node* GetCameraNode() const
  4484. - Texture2D* GetRenderTexture() const
  4485. - Texture2D* GetDepthTexture() const
  4486. - Viewport* GetViewport() const
  4487. Properties:
  4488. - unsigned format
  4489. - bool autoUpdate
  4490. ### Window : BorderImage
  4491. Methods:
  4492. - Window(Context* context)
  4493. - virtual ~Window()
  4494. - void SetMovable(bool enable)
  4495. - void SetResizable(bool enable)
  4496. - void SetFixedWidthResizing(bool enable)
  4497. - void SetFixedHeightResizing(bool enable)
  4498. - void SetResizeBorder(const IntRect& rect)
  4499. - void SetModal(bool modal)
  4500. - void SetModalShadeColor(const Color& color)
  4501. - void SetModalFrameColor(const Color& color)
  4502. - void SetModalFrameSize(const IntVector2& size)
  4503. - bool IsMovable() const
  4504. - bool IsResizable() const
  4505. - bool GetFixedWidthResizing() const
  4506. - bool GetFixedHeightResizing() const
  4507. - const IntRect& GetResizeBorder() const
  4508. - bool IsModal() const
  4509. - const Color& GetModalShadeColor() const
  4510. - const Color& GetModalFrameColor() const
  4511. - const IntVector2& GetModalFrameSize() const
  4512. Properties:
  4513. - bool movable
  4514. - bool resizable
  4515. - bool fixedWidthResizing
  4516. - bool fixedHeightResizing
  4517. - IntRect& resizeBorder
  4518. - bool modal
  4519. - Color& modalShadeColor
  4520. - Color& modalFrameColor
  4521. - IntVector2& modalFrameSize
  4522. */
  4523. }