Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "userdata" attribute for unvalidated attributes #3764

Draft
wants to merge 25 commits into
base: master
Choose a base branch
from

Conversation

ffreyer
Copy link
Collaborator

@ffreyer ffreyer commented Apr 3, 2024

This is more of a proposal to make plot attribute validation a bit less breaking. It adds userdata as valid attribute so you can do plot(..., userdata = ...).

Could be useful for #3650 (comment) or for passing extra data for DataInspector labels

Another possibility to continue allowing user created attributes would be to have users explicitly allow names. E.g. plot(..., my_attrib = ..., allow = (:my_attrib, )).

SimonDanisch and others added 25 commits February 23, 2024 14:35
* prototyping

* fix joint with non-uniform linewidths

* fix transform

* add patterns

* fix pattern sampling

* fix truncated join cutoff + some cleanup

* improve pattern overwrite threshhold

* reorganize code

* cleanup

* add function for line vec -> line normal

* don't try to cleanup joints if linewidth difference is critical

* rename some variables

* cleanup comments, restructure linewidth sdf generation

* minor cleanup + notes

* fix orientation problems with truncated joints

* minor performance tweaks + cleanup

* handle line joints in fragment shader & ditch variable linewidths

* improve truncation overlap/gap

* improve pattern adjustments for truncated joints

* cleanup

* reorganize code to reduce memory usage

* mostly fix gap in sharp joints

* explain pattern overwrite a bit more

* use new fragment shader for linesegments

* disable debug rendering

* fix incorrect line placement

* adjust line segments to pattern

* use const over define & fix dots

* tweak debug rendering

* make truncation overlap a bit nicer

* minor cleanup

* fix linestyle in linesegments

* skip rendering at 0 linewidth

* add slight bias to avoid missing pixels

* differentiate different segments in debug render

* make color interpolation continuous at joint

* fix dense line color artifacts

* remove unused

* allocate space for joints

* use sdf for AA + debug render

* add miter joints

* handle colors

* some cleanup + linesegments prep

* fix some errors [skip ci]

* add patterns

* clean up linesegments

* add normal rendering mode

* minor cleanup

* experiment with geometry adjustments

* use rounding to solve joint over/underdraw

* WebGL doesn't like scaling

* smooth out inner edge of truncated join

* remove derivative to reduce float accuracy issues

* improve thin lines

* fix lastlen error

* match buffer sizes to number of drawn segments

* avoid dissipation of lines at high point densities

* calculate uv from quad_sdf1

* reduce number of interleaved buffers

* fix disappearing grid lines

* fix missing preprocessors

* fix pattern artifacts in dense line sections

* cleanup some variables

* allow patterns to adjust to linewidth

* fix AA at line end

* fix nan handling

* discard fully transparent pixels

* fix patterns with nan, reset pattern on nan

* fix size issues

* extrude lines slightly to cleanly close them

* fix pixel skipping?

* cleanup patterns

* remove linewidth from pattern based line adjustments

* consider AA in shape factor

* reset shape_factor if pattern changes segment shape

* minor cleanup

* apply changes to WGLMakie + cleanup

* cleanup pattern overwrite

* use the same AA_RADIUS in fragment shader

* fix linelen transform

* disable debug

* fix line start/end AA

* fix px_per_unit?

* fix px_per_unit?

* reduce line start/end extrusion

* simplify extrusion and shape_factor

* summarize breaking changes

* move miter joint test

* update docstring

* minor cleanup

* enable more tests

* move gappy & friends to Makie

* note change to linestyle scaling

* cleanup

* fix line start/end AA

* remove global var

* disable GeoMakie tests for now

* improve transparency for WGLMakie

* fix problems with 180° change in line direction

* fix directionality

* interpolate colormap in fragment shader

* remove util.vert from line/segments

---------

Co-authored-by: SimonDanisch <sdanisch@protonmail.com>
* fix lines shader

* cleanup debug code

* fix rebase error

* fix pattern connectivity

* some cleanup

* apply changes to WGLMakie

* add test

* fix CairoMakie too

* update changelog

* fix missing start/end segment

* Update CHANGELOG.md

* update comments

---------

Co-authored-by: Simon <sdanisch@protonmail.com>
* add second `@recipe` method

* rename function

* implement recipe and keyword validation

* fix some bugs

* rename for clarity

* change Scatter recipe

* use argument symbols correctly

* change Lines

* change linesegments

* do a bunch of plots more

* fix text bugs

* splice in internal attribute after mesh creation

* add allowlist

* fix text

* add attribute deprecation mechanism

* add explanation

* remove `text` for GLMakie

* fix contour volume attributes

* add rasterize to allowlist

* add `enable_depth` to volume

* add `matcap` to mesh

* set `fxaa = false` on scatter, lines, linesegments, text

* move fxaa after mixins

* fix keywords

* remove markersize attribute

* remove invalid markersize

* add depthsorting to attributes for scatter

* fix forwarded attributes

* add absorption to volume

* don't use `used_attributes` for datashader canvas convert

* fix positional args

* image

* add better printing and rudimentary tests

* make allowlist a tuple for fewer allocations

* attribute names tuple instead of set

* make deprecations also a tuple

* avoid intermediate vector to speed up attribute creation

* apply same optimization to blocks

* implement mechanism to augment user docstring

* delete manually written out attribute docs

* use funcsym in docstring

* incorporate attribute docs into docstring again

* use equal

* add changelog

* introduce `DocumentedAttributes` with macro

* add function to access `DocumentedAttributes` of a recipe

* fix module mutation problem for now

* move definition behind PlotType

* return Attributes instead of Dict

* convert wireframe recipe

* close over reference

* don't include prereleases in benchmark, failed with 1.11 alpha

* stringify default expr

* convert arrows

* add docs

* directly convert default exprs to strings

* convert ablines

* print wrong attribute in red

* convert annotations

* convert arc

* remove attributes in arrows docstring

* convert band

* fix escaping issue

* convert barplot

* convert bracket

* fix barplot usage in hist

* convert contourf

* typo

* convert contour

* fix waterfall

* comment out arrows test

* convert datashader

* convert errorbar and rangebar

* convert hvlines

* convert hvspan

* convert pie

* convert rainclouds

* convert scatterlines

* convert series

* convert spy

* convert stairs

* convert stem

* convert streamplot

* convert timeseries

* convert tooltip

* convert tricontourf

* add transformation to allowlist

* convert triplot

* convert volumeslices

* convert voronoiplot

* convert waterfall

* convert boxplot

* convert crossbar

* convert density

* convert qqplot and qqnorm

* convert ecdfplot

* convert hexbin

* convert hist

* convert violin

* improve error message printing

* add docstrings for mutating functions and plot types

* add missing docstrings

* reconnect lines docstring

* move functions out of macro

* fix arrows example and adjust docs

* put necessary functions back into macro

---------

Co-authored-by: Simon <sdanisch@protonmail.com>
* create voxel rendering prototype

* enable lighting

* prototype voxel id generation & color handling

* add is_air attribute

* prototype texture mapping

* fix shader reloading

* fix texture mapping

* implement local updates

* optimize render order (depthsorting = false)

* add depthsorting = true

* render z planes first

* add lowclip and highclip

* add refimg tests + some fixes

* fix colorrange

* fix local chunk update

* handle colorrange more efficiently

* handle voxel id data more efficiently

* docstring & formatting

* switch back to lrbt order for uvmap

* add docs

* try fix tests

* fix show

* fix test?

* add missing dimensions

* add arguments for placement and scale

* allow Colon

* add Colon() to local_update

* minor cleanup

* prototype WGLMakie version

* add fallback in CairoMakie

* add RPRMakie fallback

* skip invisible voxels

* fix typo

* rename voxel -> voxels

* update docs, fix placement

* update news

* fix Colorbar for voxels

* enable tests

* fix texture rotation

* cleanup print

* cleanup comment

* generalize array access

* debug WGLMakie

* get voxels rendering in WGLMakie

* fix texture mapping

* activate tests

* fix moving planes, cleanup prints

* add unit tests

* add gap attribute

* tests & docs

* mention potential issues with picking

* fix WGLMakie picking

* fix depthsorting/gap handling

* switch to integer mod

* fix render order

* use RNG

* fix 1.6 3d array syntax

* fix refimage

* Update CHANGELOG.md

* fix julia 1.6

---------

Co-authored-by: Simon <sdanisch@protonmail.com>
* implement float64 precision

* remove merge conflicts

* update CairoMakie

* move some code around

* simplify syntax

* add non-Observable apply_transform_and_f32_conversion

* clean up convert_arguments

* update WGLMakie

* fix tests

* patch model to act after f32convert

* fix function name

* update project and plot_to_screen

* fix patch_model

* add first test

* rename file

* fix type after patch_model

* fix ticks beyond limits

* fix image and heatmap conversion

* convert to float types

* update test

* Fix CairoMakie not precompiling

missed a `Makie.` in the image recipe

* update mesh converts

* fix poly convert type

* fix dict access

* fix first test in WGLMakie

* don't use triangle_mesh

* fix incorrect convert_arguments

* fix test

* fix DataInspector error

* add meshscatter + surface to tests, fix convert_arguments for poly

* Fix docs + Makie tests

* Fix 1.6!?

* fix picking test

* update DataInspector

* fix indicator rotation for meshscatter in DataInspector

* fix Vector{<: Integer}, Vector{Float32} -> Vector{Float32} [skip ci]

* fix stackoverflow on mixed tuple types [skip ci]

* fix tuples correctly [skip ci]

* fix geom -> points eltype [skip ci]

* fix geom -> PointBased output type

* fix Rect2 -> points output type [skip ci]

* fix PointBased mesh conversion

* fix PointBased multi-linestrings type [skip ci]

* update bezierpath

* split up conversions

* fix missing Points convert [skip ci]

* fix CellGridBased types [skip ci]

* always convert volumes to float32

* start adding type tests for every convert_arguments

* fix tests

* undo splitting conversions.jl

* test and cleanup mesh conversions

* fix docs

* update & test Annotations

* update & test arrows

* update and test band and bracket

* update & test errorbars and rangebars conversions

* test & update series converts

* make type stable on 1.6

* update & test remaining convert_arguments

* fix & test model application

* add tests for float32convert

* at floatmin/max refimg test

* fix typo

* update text bbox test & add backtrace

* avoid Float32 in data_limits

* fix Polygon -> Bezierpath conversion

* fix WGLMakie meshscatter model patching

* fix Float64 normals

* fix Float64 matrices in Voxels

* test normal and uv types

* fix for 1.6

* make new project method more complete

* clean up some TODOs

* restore text tests

* restore Polar transform tests

* avoid BBox for Axis limits

* fix rectangle zoom, deprecate to_world with matrix inputs

* fix 1.6

* fix Float64 latexstrings

* fix hvlines, hvspan, errorbars, rangebars

* fix & test ablines

* fix other usage of projview_to_2d_limits

* remove dublicated line

* update changelog + cleanup [skip ci]

* fix missing to_value

* consider markersize and offset for scatter data_limits

* fix tests

* revert BBox -> Rect2d changes

* get hist and barplot working

---------

Co-authored-by: ffreyer <frederic481994@hotmail.de>
Co-authored-by: Anshul Singhvi <anshulsinghvi@gmail.com>
* document conversion pipeline

* fix doc build

* fix block

---------

Co-authored-by: SimonDanisch <sdanisch@protonmail.com>
* deprecate `rotations` for `rotation` for Scatter and MeshScatter

* one more rename

* remove double conversion

* fix cairomakie meshscatter

* fix usage in docs

* remove mat4 code again

* fix CairoMakie rror

* change one more rotations

* fix WGLMakie

* add changelog entry

---------

Co-authored-by: ffreyer <frederic481994@hotmail.de>
* implement scatter boundingbox with marker metrics

* add tests

* always consider marker rotations

* update changelog [skip ci]

* fix data_limits

* fix some more issues

* rotations -> rotation

* Update boundingboxes.jl

---------

Co-authored-by: Simon <sdanisch@protonmail.com>
* change how boundingbox is deprecated

* update changelog

* fix test errors

* fix docs errors and cleanup error message

* fix type instability

* fix function name

* fix function name

* fix boundingbox overwrites

* update changelog

* add types to function args

maybe this allows boundingbox(::MyPlot, space) to work without ::Symbol...

* fix typing

* fully remove :world space

* fix test
* fix error for 2d meshscatter data_limits

* avoid Rect3(::Rect2) constructor

* allow :inspector_label

* allow inspector_clear and inspector_hover too

* fix rect zoom & cleanup to_world

* move inspector attributes to default attributes
@MakieBot
Copy link
Collaborator

MakieBot commented Apr 3, 2024

Compile Times benchmark

Note, that these numbers may fluctuate on the CI servers, so take them with a grain of salt. All benchmark results are based on the mean time and negative percent mean faster than the base branch. Note, that GLMakie + WGLMakie run on an emulated GPU, so the runtime benchmark is much slower. Results are from running:

using_time = @ctime using Backend
# Compile time
create_time = @ctime fig = scatter(1:4; color=1:4, colormap=:turbo, markersize=20, visible=true)
display_time = @ctime Makie.colorbuffer(display(fig))
# Runtime
create_time = @benchmark fig = scatter(1:4; color=1:4, colormap=:turbo, markersize=20, visible=true)
display_time = @benchmark Makie.colorbuffer(fig)
using create display create display
GLMakie 3.49s (3.41, 3.61) 0.07+- 137.95ms (132.65, 145.73) 4.22+- 542.31ms (526.67, 571.54) 15.52+- 8.18ms (7.95, 8.93) 0.34+- 25.80ms (25.30, 26.77) 0.52+-
breaking-0.21 3.44s (3.35, 3.52) 0.05+- 135.80ms (132.92, 142.66) 3.25+- 536.57ms (525.97, 548.84) 8.17+- 7.94ms (7.72, 8.35) 0.21+- 25.63ms (25.30, 26.28) 0.33+-
evaluation 0.99x invariant, 0.05s (0.80d, 0.16p, 0.06std) 0.98x invariant, 2.15ms (0.57d, 0.31p, 3.73std) 0.99x invariant, 5.74ms (0.46d, 0.41p, 11.84std) 0.97x invariant, 0.24ms (0.83d, 0.15p, 0.28std) 0.99x invariant, 0.17ms (0.38d, 0.49p, 0.43std)
CairoMakie 3.24s (3.15, 3.32) 0.05+- 146.22ms (138.29, 155.17) 5.88+- 124.41ms (121.68, 127.53) 2.11+- 8.42ms (8.06, 8.76) 0.22+- 920.86μs (917.11, 923.32) 2.17+-
breaking-0.21 3.23s (3.14, 3.28) 0.06+- 147.96ms (139.41, 156.83) 6.24+- 123.59ms (119.31, 128.35) 3.20+- 8.32ms (8.09, 8.52) 0.16+- 936.71μs (931.31, 944.50) 4.39+-
evaluation 1.00x invariant, 0.01s (0.13d, 0.81p, 0.05std) 1.01x invariant, -1.74ms (-0.29d, 0.60p, 6.06std) 0.99x invariant, 0.82ms (0.30d, 0.58p, 2.65std) 0.99x invariant, 0.1ms (0.49d, 0.38p, 0.19std) 1.02x faster ✓, -15.84μs (-4.58d, 0.00p, 3.28std)
WGLMakie 3.83s (3.67, 4.00) 0.10+- 140.10ms (135.44, 153.31) 6.01+- 8.85s (8.61, 8.99) 0.13+- 10.58ms (10.32, 10.85) 0.23+- 70.83ms (69.36, 72.69) 1.18+-
breaking-0.21 3.84s (3.71, 3.98) 0.10+- 143.84ms (136.45, 152.83) 6.75+- 9.03s (8.71, 9.62) 0.38+- 11.12ms (10.07, 15.35) 1.88+- 70.95ms (69.69, 72.45) 0.94+-
evaluation 1.00x invariant, -0.01s (-0.07d, 0.89p, 0.10std) 1.03x invariant, -3.74ms (-0.59d, 0.30p, 6.38std) 1.02x invariant, -0.18s (-0.65d, 0.26p, 0.26std) 1.05x noisy🤷‍♀️, -0.54ms (-0.40d, 0.48p, 1.05std) 1.00x invariant, -0.12ms (-0.12d, 0.83p, 1.06std)

@ffreyer ffreyer mentioned this pull request Apr 10, 2024
12 tasks
Base automatically changed from breaking-0.21 to master May 8, 2024 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants