Element.cpp 80 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818
  1. /*
  2. * This source file is part of RmlUi, the HTML/CSS Interface Middleware
  3. *
  4. * For the latest information, see http://github.com/mikke89/RmlUi
  5. *
  6. * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
  7. * Copyright (c) 2019 The RmlUi Team, and contributors
  8. *
  9. * Permission is hereby granted, free of charge, to any person obtaining a copy
  10. * of this software and associated documentation files (the "Software"), to deal
  11. * in the Software without restriction, including without limitation the rights
  12. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13. * copies of the Software, and to permit persons to whom the Software is
  14. * furnished to do so, subject to the following conditions:
  15. *
  16. * The above copyright notice and this permission notice shall be included in
  17. * all copies or substantial portions of the Software.
  18. *
  19. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25. * THE SOFTWARE.
  26. *
  27. */
  28. #include "../../Include/RmlUi/Core/Element.h"
  29. #include "../../Include/RmlUi/Core/Context.h"
  30. #include "../../Include/RmlUi/Core/Core.h"
  31. #include "../../Include/RmlUi/Core/ElementDocument.h"
  32. #include "../../Include/RmlUi/Core/ElementInstancer.h"
  33. #include "../../Include/RmlUi/Core/ElementScroll.h"
  34. #include "../../Include/RmlUi/Core/ElementUtilities.h"
  35. #include "../../Include/RmlUi/Core/Factory.h"
  36. #include "../../Include/RmlUi/Core/Dictionary.h"
  37. #include "../../Include/RmlUi/Core/Profiling.h"
  38. #include "../../Include/RmlUi/Core/PropertyIdSet.h"
  39. #include "../../Include/RmlUi/Core/PropertiesIteratorView.h"
  40. #include "../../Include/RmlUi/Core/PropertyDefinition.h"
  41. #include "../../Include/RmlUi/Core/StyleSheetSpecification.h"
  42. #include "../../Include/RmlUi/Core/TransformPrimitive.h"
  43. #include "Clock.h"
  44. #include "ComputeProperty.h"
  45. #include "DataModel.h"
  46. #include "ElementAnimation.h"
  47. #include "ElementBackgroundBorder.h"
  48. #include "ElementDefinition.h"
  49. #include "ElementStyle.h"
  50. #include "EventDispatcher.h"
  51. #include "EventSpecification.h"
  52. #include "ElementDecoration.h"
  53. #include "LayoutEngine.h"
  54. #include "PluginRegistry.h"
  55. #include "PropertiesIterator.h"
  56. #include "Pool.h"
  57. #include "StyleSheetParser.h"
  58. #include "StyleSheetNode.h"
  59. #include "TransformState.h"
  60. #include "TransformUtilities.h"
  61. #include "XMLParseTools.h"
  62. #include <algorithm>
  63. #include <cmath>
  64. namespace Rml {
  65. // Determines how many levels up in the hierarchy the OnChildAdd and OnChildRemove are called (starting at the child itself)
  66. static constexpr int ChildNotifyLevels = 2;
  67. // Meta objects for element collected in a single struct to reduce memory allocations
  68. struct ElementMeta
  69. {
  70. ElementMeta(Element* el) : event_dispatcher(el), style(el), background_border(el), decoration(el), scroll(el) {}
  71. EventDispatcher event_dispatcher;
  72. ElementStyle style;
  73. ElementBackgroundBorder background_border;
  74. ElementDecoration decoration;
  75. ElementScroll scroll;
  76. Style::ComputedValues computed_values;
  77. };
  78. static Pool< ElementMeta > element_meta_chunk_pool(200, true);
  79. /// Constructs a new RmlUi element.
  80. Element::Element(const String& tag) : tag(tag), relative_offset_base(0, 0), relative_offset_position(0, 0), absolute_offset(0, 0), scroll_offset(0, 0), content_offset(0, 0), content_box(0, 0),
  81. transform_state(), dirty_transform(false), dirty_perspective(false), dirty_animation(false), dirty_transition(false)
  82. {
  83. RMLUI_ASSERT(tag == StringUtilities::ToLower(tag));
  84. parent = nullptr;
  85. focus = nullptr;
  86. instancer = nullptr;
  87. owner_document = nullptr;
  88. offset_fixed = false;
  89. offset_parent = nullptr;
  90. offset_dirty = true;
  91. client_area = Box::PADDING;
  92. baseline = 0.0f;
  93. num_non_dom_children = 0;
  94. visible = true;
  95. z_index = 0;
  96. local_stacking_context = false;
  97. local_stacking_context_forced = false;
  98. stacking_context_dirty = false;
  99. structure_dirty = false;
  100. computed_values_are_default_initialized = true;
  101. meta = element_meta_chunk_pool.AllocateAndConstruct(this);
  102. data_model = nullptr;
  103. }
  104. Element::~Element()
  105. {
  106. RMLUI_ASSERT(parent == nullptr);
  107. PluginRegistry::NotifyElementDestroy(this);
  108. // A simplified version of RemoveChild() for destruction.
  109. for (ElementPtr& child : children)
  110. {
  111. Element* child_ancestor = child.get();
  112. for (int i = 0; i <= ChildNotifyLevels && child_ancestor; i++, child_ancestor = child_ancestor->GetParentNode())
  113. child_ancestor->OnChildRemove(child.get());
  114. child->SetParent(nullptr);
  115. }
  116. children.clear();
  117. num_non_dom_children = 0;
  118. element_meta_chunk_pool.DestroyAndDeallocate(meta);
  119. }
  120. void Element::Update(float dp_ratio, Vector2f vp_dimensions)
  121. {
  122. #ifdef RMLUI_ENABLE_PROFILING
  123. auto name = GetAddress(false, false);
  124. RMLUI_ZoneScoped;
  125. RMLUI_ZoneText(name.c_str(), name.size());
  126. #endif
  127. OnUpdate();
  128. UpdateStructure();
  129. HandleTransitionProperty();
  130. HandleAnimationProperty();
  131. AdvanceAnimations();
  132. meta->scroll.Update();
  133. UpdateProperties(dp_ratio, vp_dimensions);
  134. // Do en extra pass over the animations and properties if the 'animation' property was just changed.
  135. if (dirty_animation)
  136. {
  137. HandleAnimationProperty();
  138. AdvanceAnimations();
  139. UpdateProperties(dp_ratio, vp_dimensions);
  140. }
  141. for (size_t i = 0; i < children.size(); i++)
  142. children[i]->Update(dp_ratio, vp_dimensions);
  143. }
  144. void Element::UpdateProperties(const float dp_ratio, const Vector2f vp_dimensions)
  145. {
  146. meta->style.UpdateDefinition();
  147. if (meta->style.AnyPropertiesDirty())
  148. {
  149. const ComputedValues* parent_values = parent ? &parent->GetComputedValues() : nullptr;
  150. const ComputedValues* document_values = owner_document ? &owner_document->GetComputedValues() : nullptr;
  151. // Compute values and clear dirty properties
  152. PropertyIdSet dirty_properties = meta->style.ComputeValues(meta->computed_values, parent_values, document_values, computed_values_are_default_initialized, dp_ratio, vp_dimensions);
  153. computed_values_are_default_initialized = false;
  154. // Computed values are just calculated and can safely be used in OnPropertyChange.
  155. // However, new properties set during this call will not be available until the next update loop.
  156. if (!dirty_properties.Empty())
  157. OnPropertyChange(dirty_properties);
  158. }
  159. }
  160. void Element::Render()
  161. {
  162. #ifdef RMLUI_ENABLE_PROFILING
  163. auto name = GetAddress(false, false);
  164. RMLUI_ZoneScoped;
  165. RMLUI_ZoneText(name.c_str(), name.size());
  166. #endif
  167. // TODO: This is a work-around for the dirty offset not being properly updated when used by (stacking context?) children. This results
  168. // in scrolling not working properly. We don't care about the return value, the call is only used to force the absolute offset to update.
  169. if (offset_dirty)
  170. GetAbsoluteOffset(Box::BORDER);
  171. // Rebuild our stacking context if necessary.
  172. if (stacking_context_dirty)
  173. BuildLocalStackingContext();
  174. UpdateTransformState();
  175. // Render all elements in our local stacking context that have a z-index beneath our local index of 0.
  176. size_t i = 0;
  177. for (; i < stacking_context.size() && stacking_context[i]->z_index < 0; ++i)
  178. stacking_context[i]->Render();
  179. // Apply our transform
  180. ElementUtilities::ApplyTransform(*this);
  181. // Set up the clipping region for this element.
  182. if (ElementUtilities::SetClippingRegion(this))
  183. {
  184. meta->background_border.Render(this);
  185. meta->decoration.RenderDecorators();
  186. {
  187. RMLUI_ZoneScopedNC("OnRender", 0x228B22);
  188. OnRender();
  189. }
  190. }
  191. // Render the rest of the elements in the stacking context.
  192. for (; i < stacking_context.size(); ++i)
  193. stacking_context[i]->Render();
  194. }
  195. // Clones this element, returning a new, unparented element.
  196. ElementPtr Element::Clone() const
  197. {
  198. ElementPtr clone;
  199. if (instancer)
  200. {
  201. clone = instancer->InstanceElement(nullptr, GetTagName(), attributes);
  202. if (clone)
  203. clone->SetInstancer(instancer);
  204. }
  205. else
  206. clone = Factory::InstanceElement(nullptr, GetTagName(), GetTagName(), attributes);
  207. if (clone != nullptr)
  208. {
  209. String inner_rml;
  210. GetInnerRML(inner_rml);
  211. clone->SetInnerRML(inner_rml);
  212. }
  213. return clone;
  214. }
  215. // Sets or removes a class on the element.
  216. void Element::SetClass(const String& class_name, bool activate)
  217. {
  218. meta->style.SetClass(class_name, activate);
  219. }
  220. // Checks if a class is set on the element.
  221. bool Element::IsClassSet(const String& class_name) const
  222. {
  223. return meta->style.IsClassSet(class_name);
  224. }
  225. // Specifies the entire list of classes for this element. This will replace any others specified.
  226. void Element::SetClassNames(const String& class_names)
  227. {
  228. SetAttribute("class", class_names);
  229. }
  230. /// Return the active class list
  231. String Element::GetClassNames() const
  232. {
  233. return meta->style.GetClassNames();
  234. }
  235. // Returns the active style sheet for this element. This may be nullptr.
  236. const StyleSheet* Element::GetStyleSheet() const
  237. {
  238. if (ElementDocument * document = GetOwnerDocument())
  239. return document->GetStyleSheet();
  240. return nullptr;
  241. }
  242. // Fills an String with the full address of this element.
  243. String Element::GetAddress(bool include_pseudo_classes, bool include_parents) const
  244. {
  245. // Add the tag name onto the address.
  246. String address(tag);
  247. // Add the ID if we have one.
  248. if (!id.empty())
  249. {
  250. address += "#";
  251. address += id;
  252. }
  253. String classes = meta->style.GetClassNames();
  254. if (!classes.empty())
  255. {
  256. classes = StringUtilities::Replace(classes, ' ', '.');
  257. address += ".";
  258. address += classes;
  259. }
  260. if (include_pseudo_classes)
  261. {
  262. const PseudoClassMap& pseudo_classes = meta->style.GetActivePseudoClasses();
  263. for (auto& pseudo_class : pseudo_classes)
  264. {
  265. address += ":";
  266. address += pseudo_class.first;
  267. }
  268. }
  269. if (include_parents && parent)
  270. {
  271. address += " < ";
  272. return address + parent->GetAddress(include_pseudo_classes, true);
  273. }
  274. else
  275. return address;
  276. }
  277. // Sets the position of this element, as a two-dimensional offset from another element.
  278. void Element::SetOffset(Vector2f offset, Element* _offset_parent, bool _offset_fixed)
  279. {
  280. _offset_fixed |= GetPosition() == Style::Position::Fixed;
  281. // If our offset has definitely changed, or any of our parenting has, then these are set and
  282. // updated based on our left / right / top / bottom properties.
  283. if (relative_offset_base != offset ||
  284. offset_parent != _offset_parent ||
  285. offset_fixed != _offset_fixed)
  286. {
  287. relative_offset_base = offset;
  288. offset_fixed = _offset_fixed;
  289. offset_parent = _offset_parent;
  290. UpdateOffset();
  291. DirtyOffset();
  292. }
  293. // Otherwise, our offset is updated in case left / right / top / bottom will have an impact on
  294. // our final position, and our children are dirtied if they do.
  295. else
  296. {
  297. Vector2f& old_base = relative_offset_base;
  298. Vector2f& old_position = relative_offset_position;
  299. UpdateOffset();
  300. if (old_base != relative_offset_base ||
  301. old_position != relative_offset_position)
  302. DirtyOffset();
  303. }
  304. }
  305. // Returns the position of the top-left corner of one of the areas of this element's primary box.
  306. Vector2f Element::GetRelativeOffset(Box::Area area)
  307. {
  308. return relative_offset_base + relative_offset_position + GetBox().GetPosition(area);
  309. }
  310. // Returns the position of the top-left corner of one of the areas of this element's primary box.
  311. Vector2f Element::GetAbsoluteOffset(Box::Area area)
  312. {
  313. if (offset_dirty)
  314. {
  315. offset_dirty = false;
  316. if (offset_parent != nullptr)
  317. absolute_offset = offset_parent->GetAbsoluteOffset(Box::BORDER) + relative_offset_base + relative_offset_position;
  318. else
  319. absolute_offset = relative_offset_base + relative_offset_position;
  320. // Add any parent scrolling onto our position as well. Could cache this if required.
  321. if (!offset_fixed)
  322. {
  323. Element* scroll_parent = parent;
  324. while (scroll_parent != nullptr)
  325. {
  326. absolute_offset -= (scroll_parent->scroll_offset + scroll_parent->content_offset);
  327. if (scroll_parent == offset_parent)
  328. break;
  329. else
  330. scroll_parent = scroll_parent->parent;
  331. }
  332. }
  333. }
  334. return absolute_offset + GetBox().GetPosition(area);
  335. }
  336. // Sets an alternate area to use as the client area.
  337. void Element::SetClientArea(Box::Area _client_area)
  338. {
  339. client_area = _client_area;
  340. }
  341. // Returns the area the element uses as its client area.
  342. Box::Area Element::GetClientArea() const
  343. {
  344. return client_area;
  345. }
  346. // Sets the dimensions of the element's internal content.
  347. void Element::SetContentBox(Vector2f _content_offset, Vector2f _content_box)
  348. {
  349. if (content_offset != _content_offset ||
  350. content_box != _content_box)
  351. {
  352. // Seems to be jittering a wee bit; might need to be looked at.
  353. scroll_offset.x += (content_offset.x - _content_offset.x);
  354. scroll_offset.y += (content_offset.y - _content_offset.y);
  355. content_offset = _content_offset;
  356. content_box = _content_box;
  357. scroll_offset.x = Math::Min(scroll_offset.x, GetScrollWidth() - GetClientWidth());
  358. scroll_offset.y = Math::Min(scroll_offset.y, GetScrollHeight() - GetClientHeight());
  359. DirtyOffset();
  360. }
  361. }
  362. // Sets the box describing the size of the element.
  363. void Element::SetBox(const Box& box)
  364. {
  365. if (box != main_box || additional_boxes.size() > 0)
  366. {
  367. main_box = box;
  368. additional_boxes.clear();
  369. OnResize();
  370. meta->background_border.DirtyBackground();
  371. meta->background_border.DirtyBorder();
  372. meta->decoration.DirtyDecorators();
  373. }
  374. }
  375. // Adds a box to the end of the list describing this element's geometry.
  376. void Element::AddBox(const Box& box, Vector2f offset)
  377. {
  378. additional_boxes.emplace_back(PositionedBox{ box, offset });
  379. OnResize();
  380. meta->background_border.DirtyBackground();
  381. meta->background_border.DirtyBorder();
  382. meta->decoration.DirtyDecorators();
  383. }
  384. // Returns one of the boxes describing the size of the element.
  385. const Box& Element::GetBox()
  386. {
  387. return main_box;
  388. }
  389. // Returns one of the boxes describing the size of the element.
  390. const Box& Element::GetBox(int index, Vector2f& offset)
  391. {
  392. offset = Vector2f(0);
  393. if (index < 1)
  394. return main_box;
  395. const int additional_box_index = index - 1;
  396. if (additional_box_index >= (int)additional_boxes.size())
  397. return main_box;
  398. offset = additional_boxes[additional_box_index].offset;
  399. return additional_boxes[additional_box_index].box;
  400. }
  401. // Returns the number of boxes making up this element's geometry.
  402. int Element::GetNumBoxes()
  403. {
  404. return 1 + (int)additional_boxes.size();
  405. }
  406. // Returns the baseline of the element, in pixels offset from the bottom of the element's content area.
  407. float Element::GetBaseline() const
  408. {
  409. return baseline;
  410. }
  411. // Gets the intrinsic dimensions of this element, if it is of a type that has an inherent size.
  412. bool Element::GetIntrinsicDimensions(Vector2f& RMLUI_UNUSED_PARAMETER(dimensions), float& RMLUI_UNUSED_PARAMETER(ratio))
  413. {
  414. RMLUI_UNUSED(dimensions);
  415. RMLUI_UNUSED(ratio);
  416. return false;
  417. }
  418. // Checks if a given point in screen coordinates lies within the bordered area of this element.
  419. bool Element::IsPointWithinElement(const Vector2f point)
  420. {
  421. const Vector2f position = GetAbsoluteOffset(Box::BORDER);
  422. for (int i = 0; i < GetNumBoxes(); ++i)
  423. {
  424. Vector2f box_offset;
  425. const Box& box = GetBox(i, box_offset);
  426. const Vector2f box_position = position + box_offset;
  427. const Vector2f box_dimensions = box.GetSize(Box::BORDER);
  428. if (point.x >= box_position.x &&
  429. point.x <= (box_position.x + box_dimensions.x) &&
  430. point.y >= box_position.y &&
  431. point.y <= (box_position.y + box_dimensions.y))
  432. {
  433. return true;
  434. }
  435. }
  436. return false;
  437. }
  438. // Returns the visibility of the element.
  439. bool Element::IsVisible() const
  440. {
  441. return visible;
  442. }
  443. // Returns the z-index of the element.
  444. float Element::GetZIndex() const
  445. {
  446. return z_index;
  447. }
  448. // Returns the element's font face handle.
  449. FontFaceHandle Element::GetFontFaceHandle() const
  450. {
  451. return meta->computed_values.font_face_handle;
  452. }
  453. // Sets a local property override on the element.
  454. bool Element::SetProperty(const String& name, const String& value)
  455. {
  456. // The name may be a shorthand giving us multiple underlying properties
  457. PropertyDictionary properties;
  458. if (!StyleSheetSpecification::ParsePropertyDeclaration(properties, name, value))
  459. {
  460. Log::Message(Log::LT_WARNING, "Syntax error parsing inline property declaration '%s: %s;'.", name.c_str(), value.c_str());
  461. return false;
  462. }
  463. for (auto& property : properties.GetProperties())
  464. {
  465. if (!meta->style.SetProperty(property.first, property.second))
  466. return false;
  467. }
  468. return true;
  469. }
  470. // Sets a local property override on the element to a pre-parsed value.
  471. bool Element::SetProperty(PropertyId id, const Property& property)
  472. {
  473. return meta->style.SetProperty(id, property);
  474. }
  475. // Removes a local property override on the element.
  476. void Element::RemoveProperty(const String& name)
  477. {
  478. meta->style.RemoveProperty(StyleSheetSpecification::GetPropertyId(name));
  479. }
  480. // Removes a local property override on the element.
  481. void Element::RemoveProperty(PropertyId id)
  482. {
  483. meta->style.RemoveProperty(id);
  484. }
  485. // Returns one of this element's properties.
  486. const Property* Element::GetProperty(const String& name)
  487. {
  488. return meta->style.GetProperty(StyleSheetSpecification::GetPropertyId(name));
  489. }
  490. // Returns one of this element's properties.
  491. const Property* Element::GetProperty(PropertyId id)
  492. {
  493. return meta->style.GetProperty(id);
  494. }
  495. // Returns one of this element's properties.
  496. const Property* Element::GetLocalProperty(const String& name)
  497. {
  498. return meta->style.GetLocalProperty(StyleSheetSpecification::GetPropertyId(name));
  499. }
  500. const Property* Element::GetLocalProperty(PropertyId id)
  501. {
  502. return meta->style.GetLocalProperty(id);
  503. }
  504. const PropertyMap& Element::GetLocalStyleProperties()
  505. {
  506. return meta->style.GetLocalStyleProperties();
  507. }
  508. float Element::ResolveNumericProperty(const Property *property, float base_value)
  509. {
  510. return meta->style.ResolveNumericProperty(property, base_value);
  511. }
  512. float Element::ResolveNumericProperty(const String& property_name)
  513. {
  514. auto property = meta->style.GetProperty(StyleSheetSpecification::GetPropertyId(property_name));
  515. if (!property)
  516. return 0.0f;
  517. if (property->unit & Property::ANGLE)
  518. return ComputeAngle(*property);
  519. RelativeTarget relative_target = RelativeTarget::None;
  520. if (property->definition)
  521. relative_target = property->definition->GetRelativeTarget();
  522. float result = meta->style.ResolveLength(property, relative_target);
  523. return result;
  524. }
  525. Vector2f Element::GetContainingBlock()
  526. {
  527. Vector2f containing_block(0, 0);
  528. if (offset_parent != nullptr)
  529. {
  530. using namespace Style;
  531. Position position_property = GetPosition();
  532. const Box& parent_box = offset_parent->GetBox();
  533. if (position_property == Position::Static || position_property == Position::Relative)
  534. {
  535. containing_block = parent_box.GetSize();
  536. }
  537. else if(position_property == Position::Absolute || position_property == Position::Fixed)
  538. {
  539. containing_block = parent_box.GetSize(Box::PADDING);
  540. }
  541. }
  542. return containing_block;
  543. }
  544. Style::Position Element::GetPosition()
  545. {
  546. return meta->computed_values.position;
  547. }
  548. Style::Float Element::GetFloat()
  549. {
  550. return meta->computed_values.float_;
  551. }
  552. Style::Display Element::GetDisplay()
  553. {
  554. return meta->computed_values.display;
  555. }
  556. float Element::GetLineHeight()
  557. {
  558. return meta->computed_values.line_height.value;
  559. }
  560. // Returns this element's TransformState
  561. const TransformState *Element::GetTransformState() const noexcept
  562. {
  563. return transform_state.get();
  564. }
  565. // Project a 2D point in pixel coordinates onto the element's plane.
  566. bool Element::Project(Vector2f& point) const noexcept
  567. {
  568. if(!transform_state || !transform_state->GetTransform())
  569. return true;
  570. // The input point is in window coordinates. Need to find the projection of the point onto the current element plane,
  571. // taking into account the full transform applied to the element.
  572. if (const Matrix4f* inv_transform = transform_state->GetInverseTransform())
  573. {
  574. // Pick two points forming a line segment perpendicular to the window.
  575. Vector4f window_points[2] = {{ point.x, point.y, -10, 1}, { point.x, point.y, 10, 1 }};
  576. // Project them into the local element space.
  577. window_points[0] = *inv_transform * window_points[0];
  578. window_points[1] = *inv_transform * window_points[1];
  579. Vector3f local_points[2] = {
  580. window_points[0].PerspectiveDivide(),
  581. window_points[1].PerspectiveDivide()
  582. };
  583. // Construct a ray from the two projected points in the local space of the current element.
  584. // Find the intersection with the z=0 plane to produce our destination point.
  585. Vector3f ray = local_points[1] - local_points[0];
  586. // Only continue if we are not close to parallel with the plane.
  587. if(std::fabs(ray.z) > 1.0f)
  588. {
  589. // Solving the line equation p = p0 + t*ray for t, knowing that p.z = 0, produces the following.
  590. float t = -local_points[0].z / ray.z;
  591. Vector3f p = local_points[0] + ray * t;
  592. point = Vector2f(p.x, p.y);
  593. return true;
  594. }
  595. }
  596. // The transformation matrix is either singular, or the ray is parallel to the element's plane.
  597. return false;
  598. }
  599. PropertiesIteratorView Element::IterateLocalProperties() const
  600. {
  601. return PropertiesIteratorView(MakeUnique<PropertiesIterator>(meta->style.Iterate()));
  602. }
  603. // Sets or removes a pseudo-class on the element.
  604. void Element::SetPseudoClass(const String& pseudo_class, bool activate)
  605. {
  606. if (meta->style.SetPseudoClass(pseudo_class, activate, false))
  607. OnPseudoClassChange(pseudo_class, activate);
  608. }
  609. // Checks if a specific pseudo-class has been set on the element.
  610. bool Element::IsPseudoClassSet(const String& pseudo_class) const
  611. {
  612. return meta->style.IsPseudoClassSet(pseudo_class);
  613. }
  614. // Checks if a complete set of pseudo-classes are set on the element.
  615. bool Element::ArePseudoClassesSet(const StringList& pseudo_classes) const
  616. {
  617. for (const String& pseudo_class : pseudo_classes)
  618. {
  619. if (!IsPseudoClassSet(pseudo_class))
  620. return false;
  621. }
  622. return true;
  623. }
  624. // Gets a list of the current active pseudo classes
  625. StringList Element::GetActivePseudoClasses() const
  626. {
  627. const PseudoClassMap& pseudo_classes = meta->style.GetActivePseudoClasses();
  628. StringList names;
  629. names.reserve(pseudo_classes.size());
  630. for (auto& pseudo_class : pseudo_classes)
  631. {
  632. names.push_back(pseudo_class.first);
  633. }
  634. return names;
  635. }
  636. void Element::OverridePseudoClass(Element* element, const String& pseudo_class, bool activate)
  637. {
  638. RMLUI_ASSERT(element);
  639. element->GetStyle()->SetPseudoClass(pseudo_class, activate, true);
  640. }
  641. /// Get the named attribute
  642. Variant* Element::GetAttribute(const String& name)
  643. {
  644. return GetIf(attributes, name);
  645. }
  646. // Checks if the element has a certain attribute.
  647. bool Element::HasAttribute(const String& name) const
  648. {
  649. return attributes.find(name) != attributes.end();
  650. }
  651. // Removes an attribute from the element
  652. void Element::RemoveAttribute(const String& name)
  653. {
  654. auto it = attributes.find(name);
  655. if (it != attributes.end())
  656. {
  657. attributes.erase(it);
  658. ElementAttributes changed_attributes;
  659. changed_attributes.emplace(name, Variant());
  660. OnAttributeChange(changed_attributes);
  661. }
  662. }
  663. // Gets the outer most focus element down the tree from this node
  664. Element* Element::GetFocusLeafNode()
  665. {
  666. // If there isn't a focus, then we are the leaf.
  667. if (!focus)
  668. {
  669. return this;
  670. }
  671. // Recurse down the tree until we found the leaf focus element
  672. Element* focus_element = focus;
  673. while (focus_element->focus)
  674. focus_element = focus_element->focus;
  675. return focus_element;
  676. }
  677. // Returns the element's context.
  678. Context* Element::GetContext() const
  679. {
  680. ElementDocument* document = GetOwnerDocument();
  681. if (document != nullptr)
  682. return document->GetContext();
  683. return nullptr;
  684. }
  685. // Set a group of attributes
  686. void Element::SetAttributes(const ElementAttributes& _attributes)
  687. {
  688. attributes.reserve(attributes.size() + _attributes.size());
  689. for (auto& pair : _attributes)
  690. attributes[pair.first] = pair.second;
  691. OnAttributeChange(_attributes);
  692. }
  693. // Returns the number of attributes on the element.
  694. int Element::GetNumAttributes() const
  695. {
  696. return (int)attributes.size();
  697. }
  698. // Gets the name of the element.
  699. const String& Element::GetTagName() const
  700. {
  701. return tag;
  702. }
  703. // Gets the ID of the element.
  704. const String& Element::GetId() const
  705. {
  706. return id;
  707. }
  708. // Sets the ID of the element.
  709. void Element::SetId(const String& _id)
  710. {
  711. SetAttribute("id", _id);
  712. }
  713. // Gets the horizontal offset from the context's left edge to element's left border edge.
  714. float Element::GetAbsoluteLeft()
  715. {
  716. return GetAbsoluteOffset(Box::BORDER).x;
  717. }
  718. // Gets the vertical offset from the context's top edge to element's top border edge.
  719. float Element::GetAbsoluteTop()
  720. {
  721. return GetAbsoluteOffset(Box::BORDER).y;
  722. }
  723. // Gets the width of the left border of an element.
  724. float Element::GetClientLeft()
  725. {
  726. return GetBox().GetPosition(client_area).x;
  727. }
  728. // Gets the height of the top border of an element.
  729. float Element::GetClientTop()
  730. {
  731. return GetBox().GetPosition(client_area).y;
  732. }
  733. // Gets the inner width of the element.
  734. float Element::GetClientWidth()
  735. {
  736. return GetBox().GetSize(client_area).x - meta->scroll.GetScrollbarSize(ElementScroll::VERTICAL);
  737. }
  738. // Gets the inner height of the element.
  739. float Element::GetClientHeight()
  740. {
  741. return GetBox().GetSize(client_area).y - meta->scroll.GetScrollbarSize(ElementScroll::HORIZONTAL);
  742. }
  743. // Returns the element from which all offset calculations are currently computed.
  744. Element* Element::GetOffsetParent()
  745. {
  746. return offset_parent;
  747. }
  748. // Gets the distance from this element's left border to its offset parent's left border.
  749. float Element::GetOffsetLeft()
  750. {
  751. return relative_offset_base.x + relative_offset_position.x;
  752. }
  753. // Gets the distance from this element's top border to its offset parent's top border.
  754. float Element::GetOffsetTop()
  755. {
  756. return relative_offset_base.y + relative_offset_position.y;
  757. }
  758. // Gets the width of the element, including the client area, padding, borders and scrollbars, but not margins.
  759. float Element::GetOffsetWidth()
  760. {
  761. return GetBox().GetSize(Box::BORDER).x;
  762. }
  763. // Gets the height of the element, including the client area, padding, borders and scrollbars, but not margins.
  764. float Element::GetOffsetHeight()
  765. {
  766. return GetBox().GetSize(Box::BORDER).y;
  767. }
  768. // Gets the left scroll offset of the element.
  769. float Element::GetScrollLeft()
  770. {
  771. return scroll_offset.x;
  772. }
  773. // Sets the left scroll offset of the element.
  774. void Element::SetScrollLeft(float scroll_left)
  775. {
  776. const float new_offset = Math::Clamp(Math::RoundFloat(scroll_left), 0.0f, GetScrollWidth() - GetClientWidth());
  777. if (new_offset != scroll_offset.x)
  778. {
  779. scroll_offset.x = new_offset;
  780. meta->scroll.UpdateScrollbar(ElementScroll::HORIZONTAL);
  781. DirtyOffset();
  782. DispatchEvent(EventId::Scroll, Dictionary());
  783. }
  784. }
  785. // Gets the top scroll offset of the element.
  786. float Element::GetScrollTop()
  787. {
  788. return scroll_offset.y;
  789. }
  790. // Sets the top scroll offset of the element.
  791. void Element::SetScrollTop(float scroll_top)
  792. {
  793. const float new_offset = Math::Clamp(Math::RoundFloat(scroll_top), 0.0f, GetScrollHeight() - GetClientHeight());
  794. if(new_offset != scroll_offset.y)
  795. {
  796. scroll_offset.y = new_offset;
  797. meta->scroll.UpdateScrollbar(ElementScroll::VERTICAL);
  798. DirtyOffset();
  799. DispatchEvent(EventId::Scroll, Dictionary());
  800. }
  801. }
  802. // Gets the width of the scrollable content of the element; it includes the element padding but not its margin.
  803. float Element::GetScrollWidth()
  804. {
  805. return Math::Max(content_box.x, GetClientWidth());
  806. }
  807. // Gets the height of the scrollable content of the element; it includes the element padding but not its margin.
  808. float Element::GetScrollHeight()
  809. {
  810. return Math::Max(content_box.y, GetClientHeight());
  811. }
  812. // Gets the object representing the declarations of an element's style attributes.
  813. ElementStyle* Element::GetStyle() const
  814. {
  815. return &meta->style;
  816. }
  817. // Gets the document this element belongs to.
  818. ElementDocument* Element::GetOwnerDocument() const
  819. {
  820. #ifdef RMLUI_DEBUG
  821. if (parent && !owner_document)
  822. {
  823. // Since we have a parent but no owner_document, then we must be a 'loose' element -- that is, constructed
  824. // outside of a document and not attached to a child of any element in the hierarchy of a document.
  825. // This check ensures that we didn't just forget to set the owner document.
  826. RMLUI_ASSERT(!parent->GetOwnerDocument());
  827. }
  828. #endif
  829. return owner_document;
  830. }
  831. // Gets this element's parent node.
  832. Element* Element::GetParentNode() const
  833. {
  834. return parent;
  835. }
  836. // Recursively search for a ancestor of this node matching the given selector.
  837. Element* Element::Closest(const String& selectors) const
  838. {
  839. StyleSheetNode root_node;
  840. StyleSheetNodeListRaw leaf_nodes = StyleSheetParser::ConstructNodes(root_node, selectors);
  841. if (leaf_nodes.empty())
  842. {
  843. Log::Message(Log::LT_WARNING, "Query selector '%s' is empty. In element %s", selectors.c_str(), GetAddress().c_str());
  844. return nullptr;
  845. }
  846. Element* parent = GetParentNode();
  847. while(parent)
  848. {
  849. for (const StyleSheetNode* node : leaf_nodes)
  850. {
  851. if (node->IsApplicable(parent, false))
  852. {
  853. return parent;
  854. }
  855. }
  856. parent = parent->GetParentNode();
  857. }
  858. return nullptr;
  859. }
  860. // Gets the element immediately following this one in the tree.
  861. Element* Element::GetNextSibling() const
  862. {
  863. if (parent == nullptr)
  864. return nullptr;
  865. for (size_t i = 0; i < parent->children.size() - (parent->num_non_dom_children + 1); i++)
  866. {
  867. if (parent->children[i].get() == this)
  868. return parent->children[i + 1].get();
  869. }
  870. return nullptr;
  871. }
  872. // Gets the element immediately preceding this one in the tree.
  873. Element* Element::GetPreviousSibling() const
  874. {
  875. if (parent == nullptr)
  876. return nullptr;
  877. for (size_t i = 1; i < parent->children.size() - parent->num_non_dom_children; i++)
  878. {
  879. if (parent->children[i].get() == this)
  880. return parent->children[i - 1].get();
  881. }
  882. return nullptr;
  883. }
  884. // Returns the first child of this element.
  885. Element* Element::GetFirstChild() const
  886. {
  887. if (GetNumChildren() > 0)
  888. return children[0].get();
  889. return nullptr;
  890. }
  891. // Gets the last child of this element.
  892. Element* Element::GetLastChild() const
  893. {
  894. if (GetNumChildren() > 0)
  895. return (children.end() - (num_non_dom_children + 1))->get();
  896. return nullptr;
  897. }
  898. Element* Element::GetChild(int index) const
  899. {
  900. if (index < 0 || index >= (int) children.size())
  901. return nullptr;
  902. return children[index].get();
  903. }
  904. int Element::GetNumChildren(bool include_non_dom_elements) const
  905. {
  906. return (int) children.size() - (include_non_dom_elements ? 0 : num_non_dom_children);
  907. }
  908. // Gets the markup and content of the element.
  909. void Element::GetInnerRML(String& content) const
  910. {
  911. for (int i = 0; i < GetNumChildren(); i++)
  912. {
  913. children[i]->GetRML(content);
  914. }
  915. }
  916. // Gets the markup and content of the element.
  917. String Element::GetInnerRML() const {
  918. String result;
  919. GetInnerRML(result);
  920. return result;
  921. }
  922. // Sets the markup and content of the element. All existing children will be replaced.
  923. void Element::SetInnerRML(const String& rml)
  924. {
  925. RMLUI_ZoneScopedC(0x6495ED);
  926. // Remove all DOM children.
  927. while ((int) children.size() > num_non_dom_children)
  928. RemoveChild(children.front().get());
  929. if(!rml.empty())
  930. Factory::InstanceElementText(this, rml);
  931. }
  932. // Sets the current element as the focus object.
  933. bool Element::Focus()
  934. {
  935. // Are we allowed focus?
  936. Style::Focus focus_property = meta->computed_values.focus;
  937. if (focus_property == Style::Focus::None)
  938. return false;
  939. // Ask our context if we can switch focus.
  940. Context* context = GetContext();
  941. if (context == nullptr)
  942. return false;
  943. if (!context->OnFocusChange(this))
  944. return false;
  945. // Set this as the end of the focus chain.
  946. focus = nullptr;
  947. // Update the focus chain up the hierarchy.
  948. Element* element = this;
  949. while (Element* parent = element->GetParentNode())
  950. {
  951. parent->focus = element;
  952. element = parent;
  953. }
  954. return true;
  955. }
  956. // Removes focus from from this element.
  957. void Element::Blur()
  958. {
  959. if (parent)
  960. {
  961. Context* context = GetContext();
  962. if (context == nullptr)
  963. return;
  964. if (context->GetFocusElement() == this)
  965. {
  966. parent->Focus();
  967. }
  968. else if (parent->focus == this)
  969. {
  970. parent->focus = nullptr;
  971. }
  972. }
  973. }
  974. // Fakes a mouse click on this element.
  975. void Element::Click()
  976. {
  977. Context* context = GetContext();
  978. if (context == nullptr)
  979. return;
  980. context->GenerateClickEvent(this);
  981. }
  982. // Adds an event listener
  983. void Element::AddEventListener(const String& event, EventListener* listener, bool in_capture_phase)
  984. {
  985. EventId id = EventSpecificationInterface::GetIdOrInsert(event);
  986. meta->event_dispatcher.AttachEvent(id, listener, in_capture_phase);
  987. }
  988. // Adds an event listener
  989. void Element::AddEventListener(EventId id, EventListener* listener, bool in_capture_phase)
  990. {
  991. meta->event_dispatcher.AttachEvent(id, listener, in_capture_phase);
  992. }
  993. // Removes an event listener from this element.
  994. void Element::RemoveEventListener(const String& event, EventListener* listener, bool in_capture_phase)
  995. {
  996. EventId id = EventSpecificationInterface::GetIdOrInsert(event);
  997. meta->event_dispatcher.DetachEvent(id, listener, in_capture_phase);
  998. }
  999. // Removes an event listener from this element.
  1000. void Element::RemoveEventListener(EventId id, EventListener* listener, bool in_capture_phase)
  1001. {
  1002. meta->event_dispatcher.DetachEvent(id, listener, in_capture_phase);
  1003. }
  1004. // Dispatches the specified event
  1005. bool Element::DispatchEvent(const String& type, const Dictionary& parameters)
  1006. {
  1007. const EventSpecification& specification = EventSpecificationInterface::GetOrInsert(type);
  1008. return EventDispatcher::DispatchEvent(this, specification.id, type, parameters, specification.interruptible, specification.bubbles, specification.default_action_phase);
  1009. }
  1010. // Dispatches the specified event
  1011. bool Element::DispatchEvent(const String& type, const Dictionary& parameters, bool interruptible, bool bubbles)
  1012. {
  1013. const EventSpecification& specification = EventSpecificationInterface::GetOrInsert(type);
  1014. return EventDispatcher::DispatchEvent(this, specification.id, type, parameters, interruptible, bubbles, specification.default_action_phase);
  1015. }
  1016. // Dispatches the specified event
  1017. bool Element::DispatchEvent(EventId id, const Dictionary& parameters)
  1018. {
  1019. const EventSpecification& specification = EventSpecificationInterface::Get(id);
  1020. return EventDispatcher::DispatchEvent(this, specification.id, specification.type, parameters, specification.interruptible, specification.bubbles, specification.default_action_phase);
  1021. }
  1022. // Scrolls the parent element's contents so that this element is visible.
  1023. void Element::ScrollIntoView(bool align_with_top)
  1024. {
  1025. Vector2f size(0, 0);
  1026. if (!align_with_top)
  1027. size.y = main_box.GetSize(Box::BORDER).y;
  1028. Element* scroll_parent = parent;
  1029. while (scroll_parent != nullptr)
  1030. {
  1031. using Style::Overflow;
  1032. const ComputedValues& computed = scroll_parent->GetComputedValues();
  1033. const bool scrollable_box_x = (computed.overflow_x != Overflow::Visible && computed.overflow_x != Overflow::Hidden);
  1034. const bool scrollable_box_y = (computed.overflow_y != Overflow::Visible && computed.overflow_y != Overflow::Hidden);
  1035. const Vector2f parent_scroll_size = { scroll_parent->GetScrollWidth(), scroll_parent->GetScrollHeight() };
  1036. const Vector2f parent_client_size = { scroll_parent->GetClientWidth(), scroll_parent->GetClientHeight() };
  1037. if ((scrollable_box_x && parent_scroll_size.x > parent_client_size.x) ||
  1038. (scrollable_box_y && parent_scroll_size.y > parent_client_size.y))
  1039. {
  1040. const Vector2f relative_offset = scroll_parent->GetAbsoluteOffset(Box::BORDER) - GetAbsoluteOffset(Box::BORDER);
  1041. Vector2f scroll_offset(scroll_parent->GetScrollLeft(), scroll_parent->GetScrollTop());
  1042. scroll_offset -= relative_offset;
  1043. scroll_offset.x += scroll_parent->GetClientLeft();
  1044. scroll_offset.y += scroll_parent->GetClientTop();
  1045. if (!align_with_top)
  1046. scroll_offset.y -= (parent_client_size.y - size.y);
  1047. if (scrollable_box_x)
  1048. scroll_parent->SetScrollLeft(scroll_offset.x);
  1049. if (scrollable_box_y)
  1050. scroll_parent->SetScrollTop(scroll_offset.y);
  1051. }
  1052. scroll_parent = scroll_parent->GetParentNode();
  1053. }
  1054. }
  1055. // Appends a child to this element
  1056. Element* Element::AppendChild(ElementPtr child, bool dom_element)
  1057. {
  1058. RMLUI_ASSERT(child);
  1059. Element* child_ptr = child.get();
  1060. if (dom_element)
  1061. children.insert(children.end() - num_non_dom_children, std::move(child));
  1062. else
  1063. {
  1064. children.push_back(std::move(child));
  1065. num_non_dom_children++;
  1066. }
  1067. // Set parent just after inserting into children. This allows us to eg. get our previous sibling in SetParent.
  1068. child_ptr->SetParent(this);
  1069. Element* ancestor = child_ptr;
  1070. for (int i = 0; i <= ChildNotifyLevels && ancestor; i++, ancestor = ancestor->GetParentNode())
  1071. ancestor->OnChildAdd(child_ptr);
  1072. DirtyStackingContext();
  1073. DirtyStructure();
  1074. if (dom_element)
  1075. DirtyLayout();
  1076. return child_ptr;
  1077. }
  1078. // Adds a child to this element, directly after the adjacent element. Inherits
  1079. // the dom/non-dom status from the adjacent element.
  1080. Element* Element::InsertBefore(ElementPtr child, Element* adjacent_element)
  1081. {
  1082. RMLUI_ASSERT(child);
  1083. // Find the position in the list of children of the adjacent element. If
  1084. // it's nullptr or we can't find it, then we insert it at the end of the dom
  1085. // children, as a dom element.
  1086. size_t child_index = 0;
  1087. bool found_child = false;
  1088. if (adjacent_element)
  1089. {
  1090. for (child_index = 0; child_index < children.size(); child_index++)
  1091. {
  1092. if (children[child_index].get() == adjacent_element)
  1093. {
  1094. found_child = true;
  1095. break;
  1096. }
  1097. }
  1098. }
  1099. Element* child_ptr = nullptr;
  1100. if (found_child)
  1101. {
  1102. child_ptr = child.get();
  1103. if ((int) child_index >= GetNumChildren())
  1104. num_non_dom_children++;
  1105. else
  1106. DirtyLayout();
  1107. children.insert(children.begin() + child_index, std::move(child));
  1108. child_ptr->SetParent(this);
  1109. Element* ancestor = child_ptr;
  1110. for (int i = 0; i <= ChildNotifyLevels && ancestor; i++, ancestor = ancestor->GetParentNode())
  1111. ancestor->OnChildAdd(child_ptr);
  1112. DirtyStackingContext();
  1113. DirtyStructure();
  1114. }
  1115. else
  1116. {
  1117. child_ptr = AppendChild(std::move(child));
  1118. }
  1119. return child_ptr;
  1120. }
  1121. // Replaces the second node with the first node.
  1122. ElementPtr Element::ReplaceChild(ElementPtr inserted_element, Element* replaced_element)
  1123. {
  1124. RMLUI_ASSERT(inserted_element);
  1125. auto insertion_point = children.begin();
  1126. while (insertion_point != children.end() && insertion_point->get() != replaced_element)
  1127. {
  1128. ++insertion_point;
  1129. }
  1130. Element* inserted_element_ptr = inserted_element.get();
  1131. if (insertion_point == children.end())
  1132. {
  1133. AppendChild(std::move(inserted_element));
  1134. return nullptr;
  1135. }
  1136. children.insert(insertion_point, std::move(inserted_element));
  1137. inserted_element_ptr->SetParent(this);
  1138. ElementPtr result = RemoveChild(replaced_element);
  1139. Element* ancestor = inserted_element_ptr;
  1140. for (int i = 0; i <= ChildNotifyLevels && ancestor; i++, ancestor = ancestor->GetParentNode())
  1141. ancestor->OnChildAdd(inserted_element_ptr);
  1142. return result;
  1143. }
  1144. // Removes the specified child
  1145. ElementPtr Element::RemoveChild(Element* child)
  1146. {
  1147. size_t child_index = 0;
  1148. for (auto itr = children.begin(); itr != children.end(); ++itr)
  1149. {
  1150. // Add the element to the delete list
  1151. if (itr->get() == child)
  1152. {
  1153. Element* ancestor = child;
  1154. for (int i = 0; i <= ChildNotifyLevels && ancestor; i++, ancestor = ancestor->GetParentNode())
  1155. ancestor->OnChildRemove(child);
  1156. if (child_index >= children.size() - num_non_dom_children)
  1157. num_non_dom_children--;
  1158. ElementPtr detached_child = std::move(*itr);
  1159. children.erase(itr);
  1160. // Remove the child element as the focused child of this element.
  1161. if (child == focus)
  1162. {
  1163. focus = nullptr;
  1164. // If this child (or a descendant of this child) is the context's currently
  1165. // focused element, set the focus to us instead.
  1166. if (Context * context = GetContext())
  1167. {
  1168. Element* focus_element = context->GetFocusElement();
  1169. while (focus_element)
  1170. {
  1171. if (focus_element == child)
  1172. {
  1173. Focus();
  1174. break;
  1175. }
  1176. focus_element = focus_element->GetParentNode();
  1177. }
  1178. }
  1179. }
  1180. detached_child->SetParent(nullptr);
  1181. DirtyLayout();
  1182. DirtyStackingContext();
  1183. DirtyStructure();
  1184. return detached_child;
  1185. }
  1186. child_index++;
  1187. }
  1188. return nullptr;
  1189. }
  1190. bool Element::HasChildNodes() const
  1191. {
  1192. return (int) children.size() > num_non_dom_children;
  1193. }
  1194. Element* Element::GetElementById(const String& id)
  1195. {
  1196. // Check for special-case tokens.
  1197. if (id == "#self")
  1198. return this;
  1199. else if (id == "#document")
  1200. return GetOwnerDocument();
  1201. else if (id == "#parent")
  1202. return this->parent;
  1203. else
  1204. {
  1205. Element* search_root = GetOwnerDocument();
  1206. if (search_root == nullptr)
  1207. search_root = this;
  1208. return ElementUtilities::GetElementById(search_root, id);
  1209. }
  1210. }
  1211. // Get all elements with the given tag.
  1212. void Element::GetElementsByTagName(ElementList& elements, const String& tag)
  1213. {
  1214. return ElementUtilities::GetElementsByTagName(elements, this, tag);
  1215. }
  1216. // Get all elements with the given class set on them.
  1217. void Element::GetElementsByClassName(ElementList& elements, const String& class_name)
  1218. {
  1219. return ElementUtilities::GetElementsByClassName(elements, this, class_name);
  1220. }
  1221. static Element* QuerySelectorMatchRecursive(const StyleSheetNodeListRaw& nodes, Element* element)
  1222. {
  1223. const int num_children = element->GetNumChildren();
  1224. for (int i = 0; i < num_children; i++)
  1225. {
  1226. Element* child = element->GetChild(i);
  1227. for (const StyleSheetNode* node : nodes)
  1228. {
  1229. if (node->IsApplicable(child, false))
  1230. return child;
  1231. }
  1232. Element* matching_element = QuerySelectorMatchRecursive(nodes, child);
  1233. if (matching_element)
  1234. return matching_element;
  1235. }
  1236. return nullptr;
  1237. }
  1238. static void QuerySelectorAllMatchRecursive(ElementList& matching_elements, const StyleSheetNodeListRaw& nodes, Element* element)
  1239. {
  1240. const int num_children = element->GetNumChildren();
  1241. for (int i = 0; i < num_children; i++)
  1242. {
  1243. Element* child = element->GetChild(i);
  1244. for (const StyleSheetNode* node : nodes)
  1245. {
  1246. if (node->IsApplicable(child, false))
  1247. {
  1248. matching_elements.push_back(child);
  1249. break;
  1250. }
  1251. }
  1252. QuerySelectorAllMatchRecursive(matching_elements, nodes, child);
  1253. }
  1254. }
  1255. Element* Element::QuerySelector(const String& selectors)
  1256. {
  1257. StyleSheetNode root_node;
  1258. StyleSheetNodeListRaw leaf_nodes = StyleSheetParser::ConstructNodes(root_node, selectors);
  1259. if (leaf_nodes.empty())
  1260. {
  1261. Log::Message(Log::LT_WARNING, "Query selector '%s' is empty. In element %s", selectors.c_str(), GetAddress().c_str());
  1262. return nullptr;
  1263. }
  1264. return QuerySelectorMatchRecursive(leaf_nodes, this);
  1265. }
  1266. void Element::QuerySelectorAll(ElementList& elements, const String& selectors)
  1267. {
  1268. StyleSheetNode root_node;
  1269. StyleSheetNodeListRaw leaf_nodes = StyleSheetParser::ConstructNodes(root_node, selectors);
  1270. if (leaf_nodes.empty())
  1271. {
  1272. Log::Message(Log::LT_WARNING, "Query selector '%s' is empty. In element %s", selectors.c_str(), GetAddress().c_str());
  1273. return;
  1274. }
  1275. QuerySelectorAllMatchRecursive(elements, leaf_nodes, this);
  1276. }
  1277. // Access the event dispatcher
  1278. EventDispatcher* Element::GetEventDispatcher() const
  1279. {
  1280. return &meta->event_dispatcher;
  1281. }
  1282. String Element::GetEventDispatcherSummary() const
  1283. {
  1284. return meta->event_dispatcher.ToString();
  1285. }
  1286. // Access the element decorators
  1287. ElementDecoration* Element::GetElementDecoration() const
  1288. {
  1289. return &meta->decoration;
  1290. }
  1291. // Returns the element's scrollbar functionality.
  1292. ElementScroll* Element::GetElementScroll() const
  1293. {
  1294. return &meta->scroll;
  1295. }
  1296. DataModel* Element::GetDataModel() const
  1297. {
  1298. return data_model;
  1299. }
  1300. int Element::GetClippingIgnoreDepth()
  1301. {
  1302. return GetComputedValues().clip.number;
  1303. }
  1304. bool Element::IsClippingEnabled()
  1305. {
  1306. const auto& computed = GetComputedValues();
  1307. return computed.overflow_x != Style::Overflow::Visible || computed.overflow_y != Style::Overflow::Visible;
  1308. }
  1309. // Gets the render interface owned by this element's context.
  1310. RenderInterface* Element::GetRenderInterface()
  1311. {
  1312. if (Context* context = GetContext())
  1313. return context->GetRenderInterface();
  1314. return ::Rml::GetRenderInterface();
  1315. }
  1316. void Element::SetInstancer(ElementInstancer* _instancer)
  1317. {
  1318. // Only record the first instancer being set as some instancers call other instancers to do their dirty work, in
  1319. // which case we don't want to update the lowest level instancer.
  1320. if (!instancer)
  1321. {
  1322. instancer = _instancer;
  1323. }
  1324. }
  1325. // Forces the element to generate a local stacking context, regardless of the value of its z-index property.
  1326. void Element::ForceLocalStackingContext()
  1327. {
  1328. local_stacking_context_forced = true;
  1329. local_stacking_context = true;
  1330. DirtyStackingContext();
  1331. }
  1332. // Called during the update loop after children are rendered.
  1333. void Element::OnUpdate()
  1334. {
  1335. }
  1336. // Called during render after backgrounds, borders, decorators, but before children, are rendered.
  1337. void Element::OnRender()
  1338. {
  1339. }
  1340. void Element::OnResize()
  1341. {
  1342. }
  1343. // Called during a layout operation, when the element is being positioned and sized.
  1344. void Element::OnLayout()
  1345. {
  1346. }
  1347. void Element::OnDpRatioChange()
  1348. {
  1349. }
  1350. // Called when attributes on the element are changed.
  1351. void Element::OnAttributeChange(const ElementAttributes& changed_attributes)
  1352. {
  1353. auto it = changed_attributes.find("id");
  1354. if (it != changed_attributes.end())
  1355. {
  1356. id = it->second.Get<String>();
  1357. meta->style.DirtyDefinition();
  1358. }
  1359. it = changed_attributes.find("class");
  1360. if (it != changed_attributes.end())
  1361. {
  1362. meta->style.SetClassNames(it->second.Get<String>());
  1363. }
  1364. if (changed_attributes.count("colspan") || changed_attributes.count("rowspan"))
  1365. {
  1366. if (meta->computed_values.display == Style::Display::TableCell)
  1367. DirtyLayout();
  1368. }
  1369. if (changed_attributes.count("span"))
  1370. {
  1371. if (meta->computed_values.display == Style::Display::TableColumn || meta->computed_values.display == Style::Display::TableColumnGroup)
  1372. DirtyLayout();
  1373. }
  1374. it = changed_attributes.find("style");
  1375. if (it != changed_attributes.end())
  1376. {
  1377. if (it->second.GetType() == Variant::STRING)
  1378. {
  1379. PropertyDictionary properties;
  1380. StyleSheetParser parser;
  1381. parser.ParseProperties(properties, it->second.GetReference<String>());
  1382. for (const auto& name_value : properties.GetProperties())
  1383. {
  1384. meta->style.SetProperty(name_value.first, name_value.second);
  1385. }
  1386. }
  1387. else if (it->second.GetType() != Variant::NONE)
  1388. {
  1389. Log::Message(Log::LT_WARNING, "Invalid 'style' attribute, string type required. In element: %s", GetAddress().c_str());
  1390. }
  1391. }
  1392. }
  1393. // Called when properties on the element are changed.
  1394. void Element::OnPropertyChange(const PropertyIdSet& changed_properties)
  1395. {
  1396. RMLUI_ZoneScoped;
  1397. if (!IsLayoutDirty())
  1398. {
  1399. // Force a relayout if any of the changed properties require it.
  1400. const PropertyIdSet changed_properties_forcing_layout = (changed_properties & StyleSheetSpecification::GetRegisteredPropertiesForcingLayout());
  1401. if(!changed_properties_forcing_layout.Empty())
  1402. DirtyLayout();
  1403. }
  1404. const bool border_radius_changed = (
  1405. changed_properties.Contains(PropertyId::BorderTopLeftRadius) ||
  1406. changed_properties.Contains(PropertyId::BorderTopRightRadius) ||
  1407. changed_properties.Contains(PropertyId::BorderBottomRightRadius) ||
  1408. changed_properties.Contains(PropertyId::BorderBottomLeftRadius)
  1409. );
  1410. // Update the visibility.
  1411. if (changed_properties.Contains(PropertyId::Visibility) ||
  1412. changed_properties.Contains(PropertyId::Display))
  1413. {
  1414. bool new_visibility = (meta->computed_values.display != Style::Display::None && meta->computed_values.visibility == Style::Visibility::Visible);
  1415. if (visible != new_visibility)
  1416. {
  1417. visible = new_visibility;
  1418. if (parent != nullptr)
  1419. parent->DirtyStackingContext();
  1420. if (!visible)
  1421. Blur();
  1422. }
  1423. if (changed_properties.Contains(PropertyId::Display))
  1424. {
  1425. // Due to structural pseudo-classes, this may change the element definition in siblings and parent.
  1426. // However, the definitions will only be changed on the next update loop which may result in jarring behavior for one @frame.
  1427. // A possible workaround is to add the parent to a list of elements that need to be updated again.
  1428. if (parent != nullptr)
  1429. parent->DirtyStructure();
  1430. }
  1431. }
  1432. // Update the position.
  1433. if (changed_properties.Contains(PropertyId::Left) ||
  1434. changed_properties.Contains(PropertyId::Right) ||
  1435. changed_properties.Contains(PropertyId::Top) ||
  1436. changed_properties.Contains(PropertyId::Bottom))
  1437. {
  1438. // TODO: This should happen during/after layout, as the containing box is not properly defined yet. Off-by-one @frame issue.
  1439. UpdateOffset();
  1440. DirtyOffset();
  1441. }
  1442. // Update the z-index.
  1443. if (changed_properties.Contains(PropertyId::ZIndex))
  1444. {
  1445. Style::ZIndex z_index_property = meta->computed_values.z_index;
  1446. if (z_index_property.type == Style::ZIndex::Auto)
  1447. {
  1448. if (local_stacking_context &&
  1449. !local_stacking_context_forced)
  1450. {
  1451. // We're no longer acting as a stacking context.
  1452. local_stacking_context = false;
  1453. stacking_context_dirty = false;
  1454. stacking_context.clear();
  1455. }
  1456. // If our old z-index was not zero, then we must dirty our stacking context so we'll be re-indexed.
  1457. if (z_index != 0)
  1458. {
  1459. z_index = 0;
  1460. DirtyStackingContext();
  1461. }
  1462. }
  1463. else
  1464. {
  1465. float new_z_index = z_index_property.value;
  1466. if (new_z_index != z_index)
  1467. {
  1468. z_index = new_z_index;
  1469. if (parent != nullptr)
  1470. parent->DirtyStackingContext();
  1471. }
  1472. if (!local_stacking_context)
  1473. {
  1474. local_stacking_context = true;
  1475. stacking_context_dirty = true;
  1476. }
  1477. }
  1478. }
  1479. // Dirty the background if it's changed.
  1480. if (border_radius_changed ||
  1481. changed_properties.Contains(PropertyId::BackgroundColor) ||
  1482. changed_properties.Contains(PropertyId::Opacity) ||
  1483. changed_properties.Contains(PropertyId::ImageColor))
  1484. {
  1485. meta->background_border.DirtyBackground();
  1486. }
  1487. // Dirty the border if it's changed.
  1488. if (border_radius_changed ||
  1489. changed_properties.Contains(PropertyId::BorderTopWidth) ||
  1490. changed_properties.Contains(PropertyId::BorderRightWidth) ||
  1491. changed_properties.Contains(PropertyId::BorderBottomWidth) ||
  1492. changed_properties.Contains(PropertyId::BorderLeftWidth) ||
  1493. changed_properties.Contains(PropertyId::BorderTopColor) ||
  1494. changed_properties.Contains(PropertyId::BorderRightColor) ||
  1495. changed_properties.Contains(PropertyId::BorderBottomColor) ||
  1496. changed_properties.Contains(PropertyId::BorderLeftColor) ||
  1497. changed_properties.Contains(PropertyId::Opacity))
  1498. {
  1499. meta->background_border.DirtyBorder();
  1500. }
  1501. // Dirty the decoration if it's changed.
  1502. if (border_radius_changed ||
  1503. changed_properties.Contains(PropertyId::Decorator) ||
  1504. changed_properties.Contains(PropertyId::Opacity) ||
  1505. changed_properties.Contains(PropertyId::ImageColor))
  1506. {
  1507. meta->decoration.DirtyDecorators();
  1508. }
  1509. // Check for `perspective' and `perspective-origin' changes
  1510. if (changed_properties.Contains(PropertyId::Perspective) ||
  1511. changed_properties.Contains(PropertyId::PerspectiveOriginX) ||
  1512. changed_properties.Contains(PropertyId::PerspectiveOriginY))
  1513. {
  1514. DirtyTransformState(true, false);
  1515. }
  1516. // Check for `transform' and `transform-origin' changes
  1517. if (changed_properties.Contains(PropertyId::Transform) ||
  1518. changed_properties.Contains(PropertyId::TransformOriginX) ||
  1519. changed_properties.Contains(PropertyId::TransformOriginY) ||
  1520. changed_properties.Contains(PropertyId::TransformOriginZ))
  1521. {
  1522. DirtyTransformState(false, true);
  1523. }
  1524. // Check for `animation' changes
  1525. if (changed_properties.Contains(PropertyId::Animation))
  1526. {
  1527. dirty_animation = true;
  1528. }
  1529. // Check for `transition' changes
  1530. if (changed_properties.Contains(PropertyId::Transition))
  1531. {
  1532. dirty_transition = true;
  1533. }
  1534. }
  1535. void Element::OnPseudoClassChange(const String& /*pseudo_class*/, bool /*activate*/)
  1536. {
  1537. }
  1538. // Called when a child node has been added somewhere in the hierarchy
  1539. void Element::OnChildAdd(Element* /*child*/)
  1540. {
  1541. }
  1542. // Called when a child node has been removed somewhere in the hierarchy
  1543. void Element::OnChildRemove(Element* /*child*/)
  1544. {
  1545. }
  1546. // Forces a re-layout of this element, and any other children required.
  1547. void Element::DirtyLayout()
  1548. {
  1549. Element* document = GetOwnerDocument();
  1550. if (document != nullptr)
  1551. document->DirtyLayout();
  1552. }
  1553. // Forces a re-layout of this element, and any other children required.
  1554. bool Element::IsLayoutDirty()
  1555. {
  1556. Element* document = GetOwnerDocument();
  1557. if (document != nullptr)
  1558. return document->IsLayoutDirty();
  1559. return false;
  1560. }
  1561. void Element::ProcessDefaultAction(Event& event)
  1562. {
  1563. if (event == EventId::Mousedown)
  1564. {
  1565. const Vector2f mouse_pos(event.GetParameter("mouse_x", 0.f), event.GetParameter("mouse_y", 0.f));
  1566. if (IsPointWithinElement(mouse_pos) && event.GetParameter("button", 0) == 0)
  1567. SetPseudoClass("active", true);
  1568. }
  1569. if (event == EventId::Mousescroll)
  1570. {
  1571. if (GetScrollHeight() > GetClientHeight())
  1572. {
  1573. Style::Overflow overflow_property = meta->computed_values.overflow_y;
  1574. if (overflow_property == Style::Overflow::Auto ||
  1575. overflow_property == Style::Overflow::Scroll)
  1576. {
  1577. // Stop the propagation if the current element has scrollbars.
  1578. // This prevents scrolling in parent elements, which is often unintended. If instead desired behavior is
  1579. // to scroll in parent elements when reaching top/bottom, move StopPropagation inside the next if statement.
  1580. event.StopPropagation();
  1581. const float wheel_delta = event.GetParameter< float >("wheel_delta", 0.f);
  1582. if ((wheel_delta < 0 && GetScrollTop() > 0) ||
  1583. (wheel_delta > 0 && GetScrollHeight() > GetScrollTop() + GetClientHeight()))
  1584. {
  1585. // Defined as three times the default line-height, multiplied by the dp ratio.
  1586. float default_scroll_length = 3.f * DefaultComputedValues.line_height.value;
  1587. if (const Context* context = GetContext())
  1588. default_scroll_length *= context->GetDensityIndependentPixelRatio();
  1589. SetScrollTop(GetScrollTop() + wheel_delta * default_scroll_length);
  1590. }
  1591. }
  1592. }
  1593. return;
  1594. }
  1595. if (event.GetPhase() == EventPhase::Target)
  1596. {
  1597. switch (event.GetId())
  1598. {
  1599. case EventId::Mouseover:
  1600. SetPseudoClass("hover", true);
  1601. break;
  1602. case EventId::Mouseout:
  1603. SetPseudoClass("hover", false);
  1604. break;
  1605. case EventId::Focus:
  1606. SetPseudoClass("focus", true);
  1607. break;
  1608. case EventId::Blur:
  1609. SetPseudoClass("focus", false);
  1610. break;
  1611. default:
  1612. break;
  1613. }
  1614. }
  1615. }
  1616. const Style::ComputedValues& Element::GetComputedValues() const
  1617. {
  1618. return meta->computed_values;
  1619. }
  1620. void Element::GetRML(String& content)
  1621. {
  1622. // First we start the open tag, add the attributes then close the open tag.
  1623. // Then comes the children in order, then we add our close tag.
  1624. content += "<";
  1625. content += tag;
  1626. for (auto& pair : attributes)
  1627. {
  1628. auto& name = pair.first;
  1629. auto& variant = pair.second;
  1630. String value;
  1631. if (variant.GetInto(value))
  1632. content += " " + name + "=\"" + value + "\"";
  1633. }
  1634. if (HasChildNodes())
  1635. {
  1636. content += ">";
  1637. GetInnerRML(content);
  1638. content += "</";
  1639. content += tag;
  1640. content += ">";
  1641. }
  1642. else
  1643. {
  1644. content += " />";
  1645. }
  1646. }
  1647. void Element::SetOwnerDocument(ElementDocument* document)
  1648. {
  1649. if (owner_document && !document)
  1650. {
  1651. // We are detaching from the document and thereby also the context.
  1652. if (Context* context = owner_document->GetContext())
  1653. context->OnElementDetach(this);
  1654. }
  1655. // If this element is a document, then never change owner_document.
  1656. if (owner_document != this && owner_document != document)
  1657. {
  1658. owner_document = document;
  1659. for (ElementPtr& child : children)
  1660. child->SetOwnerDocument(document);
  1661. }
  1662. }
  1663. void Element::SetDataModel(DataModel* new_data_model)
  1664. {
  1665. RMLUI_ASSERTMSG(!data_model || !new_data_model, "We must either attach a new data model, or detach the old one.");
  1666. if (data_model == new_data_model)
  1667. return;
  1668. if (data_model)
  1669. data_model->OnElementRemove(this);
  1670. data_model = new_data_model;
  1671. if (data_model)
  1672. ElementUtilities::ApplyDataViewsControllers(this);
  1673. for (ElementPtr& child : children)
  1674. child->SetDataModel(new_data_model);
  1675. }
  1676. void Element::Release()
  1677. {
  1678. if (instancer)
  1679. instancer->ReleaseElement(this);
  1680. else
  1681. Log::Message(Log::LT_WARNING, "Leak detected: element %s not instanced via RmlUi Factory. Unable to release.", GetAddress().c_str());
  1682. }
  1683. void Element::SetParent(Element* _parent)
  1684. {
  1685. // Assumes we are already detached from the hierarchy or we are detaching now.
  1686. RMLUI_ASSERT(!parent || !_parent);
  1687. parent = _parent;
  1688. if (parent)
  1689. {
  1690. // We need to update our definition and make sure we inherit the properties of our new parent.
  1691. meta->style.DirtyDefinition();
  1692. meta->style.DirtyInheritedProperties();
  1693. }
  1694. // The transform state may require recalculation.
  1695. if (transform_state || (parent && parent->transform_state))
  1696. DirtyTransformState(true, true);
  1697. SetOwnerDocument(parent ? parent->GetOwnerDocument() : nullptr);
  1698. if (!parent)
  1699. {
  1700. if (data_model)
  1701. SetDataModel(nullptr);
  1702. }
  1703. else
  1704. {
  1705. auto it = attributes.find("data-model");
  1706. if (it == attributes.end())
  1707. {
  1708. SetDataModel(parent->data_model);
  1709. }
  1710. else if (parent->data_model)
  1711. {
  1712. String name = it->second.Get<String>();
  1713. Log::Message(Log::LT_ERROR, "Nested data models are not allowed. Data model '%s' given in element %s.", name.c_str(), GetAddress().c_str());
  1714. }
  1715. else if (Context* context = GetContext())
  1716. {
  1717. String name = it->second.Get<String>();
  1718. if (DataModel* model = context->GetDataModelPtr(name))
  1719. {
  1720. model->AttachModelRootElement(this);
  1721. SetDataModel(model);
  1722. }
  1723. else
  1724. Log::Message(Log::LT_ERROR, "Could not locate data model '%s' in element %s.", name.c_str(), GetAddress().c_str());
  1725. }
  1726. }
  1727. }
  1728. void Element::DirtyOffset()
  1729. {
  1730. if(!offset_dirty)
  1731. {
  1732. offset_dirty = true;
  1733. if(transform_state)
  1734. DirtyTransformState(true, true);
  1735. // Not strictly true ... ?
  1736. for (size_t i = 0; i < children.size(); i++)
  1737. children[i]->DirtyOffset();
  1738. }
  1739. }
  1740. void Element::UpdateOffset()
  1741. {
  1742. using namespace Style;
  1743. const auto& computed = meta->computed_values;
  1744. Position position_property = computed.position;
  1745. if (position_property == Position::Absolute ||
  1746. position_property == Position::Fixed)
  1747. {
  1748. if (offset_parent != nullptr)
  1749. {
  1750. const Box& parent_box = offset_parent->GetBox();
  1751. Vector2f containing_block = parent_box.GetSize(Box::PADDING);
  1752. // If the element is anchored left, then the position is offset by that resolved value.
  1753. if (computed.left.type != Left::Auto)
  1754. relative_offset_base.x = parent_box.GetEdge(Box::BORDER, Box::LEFT) + (ResolveValue(computed.left, containing_block.x) + GetBox().GetEdge(Box::MARGIN, Box::LEFT));
  1755. // If the element is anchored right, then the position is set first so the element's right-most edge
  1756. // (including margins) will render up against the containing box's right-most content edge, and then
  1757. // offset by the resolved value.
  1758. else if (computed.right.type != Right::Auto)
  1759. relative_offset_base.x = containing_block.x + parent_box.GetEdge(Box::BORDER, Box::LEFT) - (ResolveValue(computed.right, containing_block.x) + GetBox().GetSize(Box::BORDER).x + GetBox().GetEdge(Box::MARGIN, Box::RIGHT));
  1760. // If the element is anchored top, then the position is offset by that resolved value.
  1761. if (computed.top.type != Top::Auto)
  1762. relative_offset_base.y = parent_box.GetEdge(Box::BORDER, Box::TOP) + (ResolveValue(computed.top, containing_block.y) + GetBox().GetEdge(Box::MARGIN, Box::TOP));
  1763. // If the element is anchored bottom, then the position is set first so the element's right-most edge
  1764. // (including margins) will render up against the containing box's right-most content edge, and then
  1765. // offset by the resolved value.
  1766. else if (computed.bottom.type != Bottom::Auto)
  1767. relative_offset_base.y = containing_block.y + parent_box.GetEdge(Box::BORDER, Box::TOP) - (ResolveValue(computed.bottom, containing_block.y) + GetBox().GetSize(Box::BORDER).y + GetBox().GetEdge(Box::MARGIN, Box::BOTTOM));
  1768. }
  1769. }
  1770. else if (position_property == Position::Relative)
  1771. {
  1772. if (offset_parent != nullptr)
  1773. {
  1774. const Box& parent_box = offset_parent->GetBox();
  1775. Vector2f containing_block = parent_box.GetSize();
  1776. if (computed.left.type != Left::Auto)
  1777. relative_offset_position.x = ResolveValue(computed.left, containing_block.x);
  1778. else if (computed.right.type != Right::Auto)
  1779. relative_offset_position.x = -1 * ResolveValue(computed.right, containing_block.x);
  1780. else
  1781. relative_offset_position.x = 0;
  1782. if (computed.top.type != Top::Auto)
  1783. relative_offset_position.y = ResolveValue(computed.top, containing_block.y);
  1784. else if (computed.bottom.type != Bottom::Auto)
  1785. relative_offset_position.y = -1 * ResolveValue(computed.bottom, containing_block.y);
  1786. else
  1787. relative_offset_position.y = 0;
  1788. }
  1789. }
  1790. else
  1791. {
  1792. relative_offset_position.x = 0;
  1793. relative_offset_position.y = 0;
  1794. }
  1795. }
  1796. void Element::SetBaseline(float in_baseline)
  1797. {
  1798. baseline = in_baseline;
  1799. }
  1800. void Element::BuildLocalStackingContext()
  1801. {
  1802. stacking_context_dirty = false;
  1803. stacking_context.clear();
  1804. BuildStackingContext(&stacking_context);
  1805. std::stable_sort(stacking_context.begin(), stacking_context.end(), [](const Element* lhs, const Element* rhs) { return lhs->GetZIndex() < rhs->GetZIndex(); });
  1806. }
  1807. enum class RenderOrder { Block, TableColumnGroup, TableColumn, TableRowGroup, TableRow, TableCell, Inline, Floating, Positioned };
  1808. struct StackingOrderedChild {
  1809. Element* element;
  1810. RenderOrder order;
  1811. bool include_children;
  1812. };
  1813. void Element::BuildStackingContext(ElementList* new_stacking_context)
  1814. {
  1815. RMLUI_ZoneScoped;
  1816. // Build the list of ordered children. Our child list is sorted within the stacking context so stacked elements
  1817. // will render in the right order; ie, positioned elements will render on top of inline elements, which will render
  1818. // on top of floated elements, which will render on top of block elements.
  1819. Vector< StackingOrderedChild > ordered_children;
  1820. const size_t num_children = children.size();
  1821. ordered_children.reserve(num_children);
  1822. if (GetDisplay() == Style::Display::Table)
  1823. {
  1824. BuildStackingContextForTable(ordered_children, this);
  1825. }
  1826. else
  1827. {
  1828. for (size_t i = 0; i < num_children; ++i)
  1829. {
  1830. Element* child = children[i].get();
  1831. if (!child->IsVisible())
  1832. continue;
  1833. ordered_children.emplace_back();
  1834. StackingOrderedChild& ordered_child = ordered_children.back();
  1835. ordered_child.element = child;
  1836. ordered_child.order = RenderOrder::Inline;
  1837. ordered_child.include_children = !child->local_stacking_context;
  1838. const Style::Display child_display = child->GetDisplay();
  1839. if (child->GetPosition() != Style::Position::Static)
  1840. ordered_child.order = RenderOrder::Positioned;
  1841. else if (child->GetFloat() != Style::Float::None)
  1842. ordered_child.order = RenderOrder::Floating;
  1843. else if (child_display == Style::Display::Block || child_display == Style::Display::Table)
  1844. ordered_child.order = RenderOrder::Block;
  1845. else
  1846. ordered_child.order = RenderOrder::Inline;
  1847. }
  1848. }
  1849. // Sort the list!
  1850. std::stable_sort(ordered_children.begin(), ordered_children.end(), [](const StackingOrderedChild& lhs, const StackingOrderedChild& rhs) { return int(lhs.order) < int(rhs.order); });
  1851. // Add the list of ordered children into the stacking context in order.
  1852. for (size_t i = 0; i < ordered_children.size(); ++i)
  1853. {
  1854. new_stacking_context->push_back(ordered_children[i].element);
  1855. if (ordered_children[i].include_children)
  1856. ordered_children[i].element->BuildStackingContext(new_stacking_context);
  1857. }
  1858. }
  1859. void Element::BuildStackingContextForTable(Vector<StackingOrderedChild>& ordered_children, Element* parent)
  1860. {
  1861. const size_t num_children = parent->children.size();
  1862. for (size_t i = 0; i < num_children; ++i)
  1863. {
  1864. Element* child = parent->children[i].get();
  1865. if (!child->IsVisible())
  1866. continue;
  1867. ordered_children.emplace_back();
  1868. StackingOrderedChild& ordered_child = ordered_children.back();
  1869. ordered_child.element = child;
  1870. ordered_child.order = RenderOrder::Inline;
  1871. ordered_child.include_children = false;
  1872. bool recurse_into_children = false;
  1873. switch (child->GetDisplay())
  1874. {
  1875. case Style::Display::TableRow:
  1876. ordered_child.order = RenderOrder::TableRow;
  1877. recurse_into_children = true;
  1878. break;
  1879. case Style::Display::TableRowGroup:
  1880. ordered_child.order = RenderOrder::TableRowGroup;
  1881. recurse_into_children = true;
  1882. break;
  1883. case Style::Display::TableColumn:
  1884. ordered_child.order = RenderOrder::TableColumn;
  1885. break;
  1886. case Style::Display::TableColumnGroup:
  1887. ordered_child.order = RenderOrder::TableColumnGroup;
  1888. recurse_into_children = true;
  1889. break;
  1890. case Style::Display::TableCell:
  1891. ordered_child.order = RenderOrder::TableCell;
  1892. ordered_child.include_children = !child->local_stacking_context;
  1893. break;
  1894. default:
  1895. ordered_child.order = RenderOrder::Positioned;
  1896. ordered_child.include_children = !child->local_stacking_context;
  1897. break;
  1898. }
  1899. if (recurse_into_children)
  1900. BuildStackingContextForTable(ordered_children, child);
  1901. }
  1902. }
  1903. void Element::DirtyStackingContext()
  1904. {
  1905. // Find the first ancestor that has a local stacking context, that is our stacking context parent.
  1906. Element* stacking_context_parent = this;
  1907. while (stacking_context_parent && !stacking_context_parent->local_stacking_context)
  1908. {
  1909. stacking_context_parent = stacking_context_parent->GetParentNode();
  1910. }
  1911. if (stacking_context_parent)
  1912. stacking_context_parent->stacking_context_dirty = true;
  1913. }
  1914. void Element::DirtyStructure()
  1915. {
  1916. structure_dirty = true;
  1917. }
  1918. void Element::UpdateStructure()
  1919. {
  1920. if (structure_dirty)
  1921. {
  1922. structure_dirty = false;
  1923. // If this element or its children depend on structured selectors, they may need to be updated.
  1924. GetStyle()->DirtyDefinition();
  1925. }
  1926. }
  1927. bool Element::Animate(const String & property_name, const Property & target_value, float duration, Tween tween, int num_iterations, bool alternate_direction, float delay, const Property* start_value)
  1928. {
  1929. bool result = false;
  1930. PropertyId property_id = StyleSheetSpecification::GetPropertyId(property_name);
  1931. auto it_animation = StartAnimation(property_id, start_value, num_iterations, alternate_direction, delay, false);
  1932. if (it_animation != animations.end())
  1933. {
  1934. result = it_animation->AddKey(duration, target_value, *this, tween, true);
  1935. if (!result)
  1936. animations.erase(it_animation);
  1937. }
  1938. return result;
  1939. }
  1940. bool Element::AddAnimationKey(const String & property_name, const Property & target_value, float duration, Tween tween)
  1941. {
  1942. ElementAnimation* animation = nullptr;
  1943. PropertyId property_id = StyleSheetSpecification::GetPropertyId(property_name);
  1944. for (auto& existing_animation : animations) {
  1945. if (existing_animation.GetPropertyId() == property_id) {
  1946. animation = &existing_animation;
  1947. break;
  1948. }
  1949. }
  1950. if (!animation)
  1951. return false;
  1952. bool result = animation->AddKey(animation->GetDuration() + duration, target_value, *this, tween, true);
  1953. return result;
  1954. }
  1955. ElementAnimationList::iterator Element::StartAnimation(PropertyId property_id, const Property* start_value, int num_iterations, bool alternate_direction, float delay, bool initiated_by_animation_property)
  1956. {
  1957. auto it = std::find_if(animations.begin(), animations.end(), [&](const ElementAnimation& el) { return el.GetPropertyId() == property_id; });
  1958. if (it != animations.end())
  1959. {
  1960. *it = ElementAnimation{};
  1961. }
  1962. else
  1963. {
  1964. animations.emplace_back();
  1965. it = animations.end() - 1;
  1966. }
  1967. Property value;
  1968. if (start_value)
  1969. {
  1970. value = *start_value;
  1971. if (!value.definition)
  1972. if(auto default_value = GetProperty(property_id))
  1973. value.definition = default_value->definition;
  1974. }
  1975. else if (auto default_value = GetProperty(property_id))
  1976. {
  1977. value = *default_value;
  1978. }
  1979. if (value.definition)
  1980. {
  1981. ElementAnimationOrigin origin = (initiated_by_animation_property ? ElementAnimationOrigin::Animation : ElementAnimationOrigin::User);
  1982. double start_time = Clock::GetElapsedTime() + (double)delay;
  1983. *it = ElementAnimation{ property_id, origin, value, *this, start_time, 0.0f, num_iterations, alternate_direction };
  1984. }
  1985. if(!it->IsInitalized())
  1986. {
  1987. animations.erase(it);
  1988. it = animations.end();
  1989. }
  1990. return it;
  1991. }
  1992. bool Element::AddAnimationKeyTime(PropertyId property_id, const Property* target_value, float time, Tween tween)
  1993. {
  1994. if (!target_value)
  1995. target_value = meta->style.GetProperty(property_id);
  1996. if (!target_value)
  1997. return false;
  1998. ElementAnimation* animation = nullptr;
  1999. for (auto& existing_animation : animations) {
  2000. if (existing_animation.GetPropertyId() == property_id) {
  2001. animation = &existing_animation;
  2002. break;
  2003. }
  2004. }
  2005. if (!animation)
  2006. return false;
  2007. bool result = animation->AddKey(time, *target_value, *this, tween, true);
  2008. return result;
  2009. }
  2010. bool Element::StartTransition(const Transition & transition, const Property& start_value, const Property & target_value)
  2011. {
  2012. auto it = std::find_if(animations.begin(), animations.end(), [&](const ElementAnimation& el) { return el.GetPropertyId() == transition.id; });
  2013. if (it != animations.end() && !it->IsTransition())
  2014. return false;
  2015. float duration = transition.duration;
  2016. double start_time = Clock::GetElapsedTime() + (double)transition.delay;
  2017. if (it == animations.end())
  2018. {
  2019. // Add transition as new animation
  2020. animations.push_back(
  2021. ElementAnimation{ transition.id, ElementAnimationOrigin::Transition, start_value, *this, start_time, 0.0f, 1, false }
  2022. );
  2023. it = (animations.end() - 1);
  2024. }
  2025. else
  2026. {
  2027. // Compress the duration based on the progress of the current animation
  2028. float f = it->GetInterpolationFactor();
  2029. f = 1.0f - (1.0f - f)*transition.reverse_adjustment_factor;
  2030. duration = duration * f;
  2031. // Replace old transition
  2032. *it = ElementAnimation{ transition.id, ElementAnimationOrigin::Transition, start_value, *this, start_time, 0.0f, 1, false };
  2033. }
  2034. bool result = it->AddKey(duration, target_value, *this, transition.tween, true);
  2035. if (result)
  2036. SetProperty(transition.id, start_value);
  2037. else
  2038. animations.erase(it);
  2039. return result;
  2040. }
  2041. void Element::HandleTransitionProperty()
  2042. {
  2043. if(dirty_transition)
  2044. {
  2045. dirty_transition = false;
  2046. // Remove all transitions that are no longer in our local list
  2047. const TransitionList& keep_transitions = GetComputedValues().transition;
  2048. if (keep_transitions.all)
  2049. return;
  2050. auto it_remove = animations.end();
  2051. if (keep_transitions.none)
  2052. {
  2053. // All transitions should be removed, but only touch the animations that originate from the 'transition' property.
  2054. // Move all animations to be erased in a valid state at the end of the list, and erase later.
  2055. it_remove = std::partition(animations.begin(), animations.end(),
  2056. [](const ElementAnimation& animation) -> bool { return !animation.IsTransition(); }
  2057. );
  2058. }
  2059. else
  2060. {
  2061. // Only remove the transitions that are not in our keep list.
  2062. const auto& keep_transitions_list = keep_transitions.transitions;
  2063. it_remove = std::partition(animations.begin(), animations.end(),
  2064. [&keep_transitions_list](const ElementAnimation& animation) -> bool {
  2065. if (!animation.IsTransition())
  2066. return true;
  2067. auto it = std::find_if(keep_transitions_list.begin(), keep_transitions_list.end(),
  2068. [&animation](const Transition& transition) { return animation.GetPropertyId() == transition.id; }
  2069. );
  2070. bool keep_animation = (it != keep_transitions_list.end());
  2071. return keep_animation;
  2072. }
  2073. );
  2074. }
  2075. // We can decide what to do with cancelled transitions here.
  2076. for (auto it = it_remove; it != animations.end(); ++it)
  2077. RemoveProperty(it->GetPropertyId());
  2078. animations.erase(it_remove, animations.end());
  2079. }
  2080. }
  2081. void Element::HandleAnimationProperty()
  2082. {
  2083. // Note: We are effectively restarting all animations whenever 'dirty_animation' is set. Use the dirty flag with care,
  2084. // or find another approach which only updates actual "dirty" animations.
  2085. if (dirty_animation)
  2086. {
  2087. dirty_animation = false;
  2088. const AnimationList& animation_list = meta->computed_values.animation;
  2089. bool element_has_animations = (!animation_list.empty() || !animations.empty());
  2090. const StyleSheet* stylesheet = nullptr;
  2091. if (element_has_animations)
  2092. stylesheet = GetStyleSheet();
  2093. if (stylesheet)
  2094. {
  2095. // Remove existing animations
  2096. {
  2097. // We only touch the animations that originate from the 'animation' property.
  2098. auto it_remove = std::partition(animations.begin(), animations.end(),
  2099. [](const ElementAnimation & animation) { return animation.GetOrigin() != ElementAnimationOrigin::Animation; }
  2100. );
  2101. // We can decide what to do with cancelled animations here.
  2102. for (auto it = it_remove; it != animations.end(); ++it)
  2103. RemoveProperty(it->GetPropertyId());
  2104. animations.erase(it_remove, animations.end());
  2105. }
  2106. // Start animations
  2107. for (const auto& animation : animation_list)
  2108. {
  2109. const Keyframes* keyframes_ptr = stylesheet->GetKeyframes(animation.name);
  2110. if (keyframes_ptr && keyframes_ptr->blocks.size() >= 1 && !animation.paused)
  2111. {
  2112. auto& property_ids = keyframes_ptr->property_ids;
  2113. auto& blocks = keyframes_ptr->blocks;
  2114. bool has_from_key = (blocks[0].normalized_time == 0);
  2115. bool has_to_key = (blocks.back().normalized_time == 1);
  2116. // If the first key defines initial conditions for a given property, use those values, else, use this element's current values.
  2117. for (PropertyId id : property_ids)
  2118. StartAnimation(id, (has_from_key ? blocks[0].properties.GetProperty(id) : nullptr), animation.num_iterations, animation.alternate, animation.delay, true);
  2119. // Add middle keys: Need to skip the first and last keys if they set the initial and end conditions, respectively.
  2120. for (int i = (has_from_key ? 1 : 0); i < (int)blocks.size() + (has_to_key ? -1 : 0); i++)
  2121. {
  2122. // Add properties of current key to animation
  2123. float time = blocks[i].normalized_time * animation.duration;
  2124. for (auto& property : blocks[i].properties.GetProperties())
  2125. AddAnimationKeyTime(property.first, &property.second, time, animation.tween);
  2126. }
  2127. // If the last key defines end conditions for a given property, use those values, else, use this element's current values.
  2128. float time = animation.duration;
  2129. for (PropertyId id : property_ids)
  2130. AddAnimationKeyTime(id, (has_to_key ? blocks.back().properties.GetProperty(id) : nullptr), time, animation.tween);
  2131. }
  2132. }
  2133. }
  2134. }
  2135. }
  2136. void Element::AdvanceAnimations()
  2137. {
  2138. if (!animations.empty())
  2139. {
  2140. double time = Clock::GetElapsedTime();
  2141. for (auto& animation : animations)
  2142. {
  2143. Property property = animation.UpdateAndGetProperty(time, *this);
  2144. if (property.unit != Property::UNKNOWN)
  2145. SetProperty(animation.GetPropertyId(), property);
  2146. }
  2147. // Move all completed animations to the end of the list
  2148. auto it_completed = std::partition(animations.begin(), animations.end(), [](const ElementAnimation& animation) { return !animation.IsComplete(); });
  2149. Vector<Dictionary> dictionary_list;
  2150. Vector<bool> is_transition;
  2151. dictionary_list.reserve(animations.end() - it_completed);
  2152. is_transition.reserve(animations.end() - it_completed);
  2153. for (auto it = it_completed; it != animations.end(); ++it)
  2154. {
  2155. const String& property_name = StyleSheetSpecification::GetPropertyName(it->GetPropertyId());
  2156. dictionary_list.emplace_back();
  2157. dictionary_list.back().emplace("property", Variant(property_name));
  2158. is_transition.push_back(it->IsTransition());
  2159. // Remove completed transition- and animation-initiated properties.
  2160. // Should behave like in HandleTransitionProperty() and HandleAnimationProperty() respectively.
  2161. if (it->GetOrigin() != ElementAnimationOrigin::User)
  2162. RemoveProperty(it->GetPropertyId());
  2163. }
  2164. // Need to erase elements before submitting event, as iterators might be invalidated when calling external code.
  2165. animations.erase(it_completed, animations.end());
  2166. for (size_t i = 0; i < dictionary_list.size(); i++)
  2167. DispatchEvent(is_transition[i] ? EventId::Transitionend : EventId::Animationend, dictionary_list[i]);
  2168. }
  2169. }
  2170. void Element::DirtyTransformState(bool perspective_dirty, bool transform_dirty)
  2171. {
  2172. dirty_perspective |= perspective_dirty;
  2173. dirty_transform |= transform_dirty;
  2174. }
  2175. void Element::UpdateTransformState()
  2176. {
  2177. if (!dirty_perspective && !dirty_transform)
  2178. return;
  2179. const ComputedValues& computed = meta->computed_values;
  2180. const Vector2f pos = GetAbsoluteOffset(Box::BORDER);
  2181. const Vector2f size = GetBox().GetSize(Box::BORDER);
  2182. bool perspective_or_transform_changed = false;
  2183. if (dirty_perspective)
  2184. {
  2185. // If perspective is set on this element, then it applies to our children. We just calculate it here,
  2186. // and let the children's transform update merge it with their transform.
  2187. bool had_perspective = (transform_state && transform_state->GetLocalPerspective());
  2188. float distance = computed.perspective;
  2189. Vector2f vanish = Vector2f(pos.x + size.x * 0.5f, pos.y + size.y * 0.5f);
  2190. bool have_perspective = false;
  2191. if (distance > 0.0f)
  2192. {
  2193. have_perspective = true;
  2194. // Compute the vanishing point from the perspective origin
  2195. if (computed.perspective_origin_x.type == Style::PerspectiveOrigin::Percentage)
  2196. vanish.x = pos.x + computed.perspective_origin_x.value * 0.01f * size.x;
  2197. else
  2198. vanish.x = pos.x + computed.perspective_origin_x.value;
  2199. if (computed.perspective_origin_y.type == Style::PerspectiveOrigin::Percentage)
  2200. vanish.y = pos.y + computed.perspective_origin_y.value * 0.01f * size.y;
  2201. else
  2202. vanish.y = pos.y + computed.perspective_origin_y.value;
  2203. }
  2204. if (have_perspective)
  2205. {
  2206. // Equivalent to: Translate(x,y,0) * Perspective(distance) * Translate(-x,-y,0)
  2207. Matrix4f perspective = Matrix4f::FromRows(
  2208. { 1, 0, -vanish.x / distance, 0 },
  2209. { 0, 1, -vanish.y / distance, 0 },
  2210. { 0, 0, 1, 0 },
  2211. { 0, 0, -1 / distance, 1 }
  2212. );
  2213. if (!transform_state)
  2214. transform_state = MakeUnique<TransformState>();
  2215. perspective_or_transform_changed |= transform_state->SetLocalPerspective(&perspective);
  2216. }
  2217. else if (transform_state)
  2218. transform_state->SetLocalPerspective(nullptr);
  2219. perspective_or_transform_changed |= (have_perspective != had_perspective);
  2220. dirty_perspective = false;
  2221. }
  2222. if (dirty_transform)
  2223. {
  2224. // We want to find the accumulated transform given all our ancestors. It is assumed here that the parent transform is already updated,
  2225. // so that we only need to consider our local transform and combine it with our parent's transform and perspective matrices.
  2226. bool had_transform = (transform_state && transform_state->GetTransform());
  2227. bool have_transform = false;
  2228. Matrix4f transform = Matrix4f::Identity();
  2229. if (computed.transform)
  2230. {
  2231. // First find the current element's transform
  2232. const int n = computed.transform->GetNumPrimitives();
  2233. for (int i = 0; i < n; ++i)
  2234. {
  2235. const TransformPrimitive& primitive = computed.transform->GetPrimitive(i);
  2236. Matrix4f matrix = TransformUtilities::ResolveTransform(primitive, *this);
  2237. transform *= matrix;
  2238. have_transform = true;
  2239. }
  2240. if(have_transform)
  2241. {
  2242. // Compute the transform origin
  2243. Vector3f transform_origin(pos.x + size.x * 0.5f, pos.y + size.y * 0.5f, 0);
  2244. if (computed.transform_origin_x.type == Style::TransformOrigin::Percentage)
  2245. transform_origin.x = pos.x + computed.transform_origin_x.value * size.x * 0.01f;
  2246. else
  2247. transform_origin.x = pos.x + computed.transform_origin_x.value;
  2248. if (computed.transform_origin_y.type == Style::TransformOrigin::Percentage)
  2249. transform_origin.y = pos.y + computed.transform_origin_y.value * size.y * 0.01f;
  2250. else
  2251. transform_origin.y = pos.y + computed.transform_origin_y.value;
  2252. transform_origin.z = computed.transform_origin_z;
  2253. // Make the transformation apply relative to the transform origin
  2254. transform = Matrix4f::Translate(transform_origin) * transform * Matrix4f::Translate(-transform_origin);
  2255. }
  2256. // We may want to include the local offsets here, as suggested by the CSS specs, so that the local transform is applied after the offset I believe
  2257. // the motivation is. Then we would need to subtract the absolute zero-offsets during geometry submit whenever we have transforms.
  2258. }
  2259. if (parent && parent->transform_state)
  2260. {
  2261. // Apply the parent's local perspective and transform.
  2262. // @performance: If we have no local transform and no parent perspective, we can effectively just point to the parent transform instead of copying it.
  2263. const TransformState& parent_state = *parent->transform_state;
  2264. if (auto parent_perspective = parent_state.GetLocalPerspective())
  2265. {
  2266. transform = *parent_perspective * transform;
  2267. have_transform = true;
  2268. }
  2269. if (auto parent_transform = parent_state.GetTransform())
  2270. {
  2271. transform = *parent_transform * transform;
  2272. have_transform = true;
  2273. }
  2274. }
  2275. if (have_transform)
  2276. {
  2277. if (!transform_state)
  2278. transform_state = MakeUnique<TransformState>();
  2279. perspective_or_transform_changed |= transform_state->SetTransform(&transform);
  2280. }
  2281. else if (transform_state)
  2282. transform_state->SetTransform(nullptr);
  2283. perspective_or_transform_changed |= (had_transform != have_transform);
  2284. }
  2285. // A change in perspective or transform will require an update to children transforms as well.
  2286. if (perspective_or_transform_changed)
  2287. {
  2288. for (size_t i = 0; i < children.size(); i++)
  2289. children[i]->DirtyTransformState(false, true);
  2290. }
  2291. // No reason to keep the transform state around if transform and perspective have been removed.
  2292. if (transform_state && !transform_state->GetTransform() && !transform_state->GetLocalPerspective())
  2293. {
  2294. transform_state.reset();
  2295. }
  2296. }
  2297. void Element::DirtyDpRatio()
  2298. {
  2299. GetElementDecoration()->DirtyDecorators();
  2300. GetStyle()->DirtyPropertiesWithUnits(Property::DP);
  2301. OnDpRatioChange();
  2302. // Now dirty all of our descendant's properties that use the unit.
  2303. const int num_children = GetNumChildren(true);
  2304. for (int i = 0; i < num_children; ++i)
  2305. GetChild(i)->DirtyDpRatio();
  2306. }
  2307. void Element::DirtyDecoratorsRecursive()
  2308. {
  2309. GetElementDecoration()->DirtyDecorators();
  2310. // Now dirty all of our descendant decorators as well.
  2311. const int num_children = GetNumChildren(true);
  2312. for (int i = 0; i < num_children; ++i)
  2313. GetChild(i)->DirtyDecoratorsRecursive();
  2314. }
  2315. } // namespace Rml