Element.cpp 82 KB

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