Version 44: Coordinate Update, Optimisation & Simplification; Text Highlight API

DrawingGroup resets coordinates to avoid unnecessarily calling Position when portions of the UI move uniformly. To support this:

• DrawingGroup provides drawingGroup:AbsolutePosition() to move local coordinates to a global context. E.g., comparing bounds v.s. interaction in Responder.
• (Internal detail: To performantly propagate changes to a DrawingGroup's position, DrawingGroup will call drawingGroup:SetParentGroupPosition(x, y) on its children, to inform of the new result that would be returned by drawingGroup:AbsolutePosition())
• (Internal detail: GeometryTargets will now also register with their parent DrawingGroup (drawingGroup.childGeometryTargets) to receive geometryTarget:SetParentGroupPosition(x, y), again as a performance optimisation)
• GeometryTarget no longer provides CachedPosition. Instead, this functionality is split out into the following API:
• geometryTarget:CachedPositionRemainingInLocalContext()
• geometryTarget:CachedPositionTranslatedToGlobalContext()
• geometryTarget:CachedPositionTranslatedToContext(callerDrawingGroup)
• geometryTarget:ContainsAbsolutePoint(x, y)
• geometryTarget:ContainsPoint(x, y, callerDrawingGroup)
  (see Layout/GeometryTarget.lua for further details.)
• _debug_mouseOver is now a separate event listed in framework.events.

Other architectural changes:

• Responder, PrimaryFrame, WrappingText, and Background now inherit from GeometryTarget. See GeometryTarget for expanded interface.
• Tooltip now inherits from Responder, and tooltip is now listed in framework.events.
• Component now has a single associated drawing group. Let me stress, then the importance of making sure reusable tools inherit from Drawer, not Component! (Component must necessarily be contained in one single drawing group for reasons I can't remember. Maybe convenience, then.)
• DrawingGroup advertises CachedSize now to go with AbsolutePosition - but do not be fooled, this is NOT a full implementation of GeometryTarget.
• Remove framework.viewportDidChange. It was unused, and other, more robust methods can be used to respond to updates (e.g. AutoScalingDimension).
• drawingGroup.needsRedraw is not set in drawingGroup:UpdateLayout(calledByParent), since it's already set in drawingGroup:UpdatePosition()
• (Internal detail: drawingGroup.groupsNeedingLayout and drawingGroup.groupsNeedingPosition will not remove any groups until directly before drawingGroup:UpdatePosition() is called, to allow drawingGroup:Position(x, y) to trigger drawingGroup:UpdatePosition() if necessary.)

Text Highlight API:

• WrappingText now handles the selection highlight drawing for TextEntry with a public API! See documentation in WrappingText.lua:
  • wrappingText:HighlightRange(color, startIndex, endIndex, reuseLast)
  • wrappingText:UpdateHighlight(id, color, startIndex, endIndex, reuseLast)
  • wrappingText:RemoveHighlight(id)
• TextGroup now calls wrappingText:DrawText(glFont) rather than wrappingText:Draw(glFont) to avoid collision when DrawingGroup calls wrappingText:Draw()

Additions:

• Dialog and ConfirmationDialog
• Selected mode for Button. See button:SetSelected(newSelected), button:GetSelected()

Visual changes:

• Squared-off corners at the edge of the screen have been disabled, due to drawing no longer knowing whether it's actually at the edge of the screen.
• Round fonts to the nearest pixel size (to prevent blurry text).
• Swap color.selectedColor and color.pressColor

Debug changes:

• Add component._debugIdentifier for easier logging
• Remove redundant Internal._debug_currentElementKey in favour of Internal.activeElement.key.
• Add argument & return value validation for Position & Layout.
• Include stacktrace for framework error messages (debug mode must be enabled, because this comes with a significant performance cost).
• Add some tests matched to some solved dimension:Update(...) bugs.
• Inject some profiling only when debug mode is enabled. Other profiling has been removed.
• Some error catching has been made less fine-grained for performance reasons. With stacktraces enabled, this should not tangibly hamper debugging.
• Drawing will terminate completely after an error, rather than completing the other passes in the element's final frame.

Bug fixes:

• Hide MovableFrame handle when releasing outside bounds)
• Fix over-cropping for OffsettedViewport. (I suspect this happens with height too, but so far I haven't been able to verify. There's chance the error's something else, idk.)
• Fix bug where, when a font stopped being used in a TextGroup, it would cancel drawing for all following fonts.
• Fix continuous updating being incompatible with calling drawingGroup:DrawerUpdated(drawer)
• Fixed invalid declaration of Blending

Performance improvements:

• DrawingGroup cancels drawing when it knows it will not be visible (e.g. outside of current viewport or scissor).

• Improved caching for wrappingText:CoordinateToCharacterDisplayIndex(x, y)

• wrappingText:DisplayIndexToRawIndex(displayIndex, addedCharactersIndex, removedSpacesIndex, computedOffset) makes use of an index cache, when a partial result isn't returned. Even when not using the cache, other optimisations have sped it up around 3x.

• wrappingText:RawIndexToDisplayIndex(rawIndex, addedCharactersIndex, removedSpacesIndex, computedOffset) makes use of an index cache generated for trivial cost during wrappingText:Layout, when a partial result isn't returned. Likely, even for small intervals (above 4), this caching is faster than the existing partial-result mechanism in place. In the committed test, this speeds up from 0.11s @ 100 executions, to 0.061s @ 100000 executions. That's 1800x faster!

• MouseMove is now buffered to receive only one call per draw frame. If you need more frequent updates, set dragListener.doNotBufferMouseMove to true.

Tests:

• Introduced a test for benchmarking WrappingText methods.

Also includes further non-breaking (hopefully) optimisations and fixes.