Skip to content

Add support for mesh and surface #953

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.

Sign up for GitHub

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

Merged
kushalkolar merged 23 commits into from
Dec 4, 2025
Merged

Add support for mesh and surface #953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
00b7ccf
Add support for mesh and surface
almarklein Nov 28, 2025
d944f55
restore line example
almarklein Nov 28, 2025
d4897b4
Implement image-surface example
almarklein Nov 28, 2025
99d00aa
Fix 3D camera for mesh examples
almarklein Nov 28, 2025
3505005
Just remove selector logic for now
almarklein Nov 28, 2025
c93b13f
new examples in gallery
almarklein Nov 28, 2025
a5c7285
mesh with graphic features (#954)
kushalkolar Dec 2, 2025
8bac8b9
remove unused import
kushalkolar Dec 2, 2025
83ac73d
update graphics mixin
kushalkolar Dec 2, 2025
fbecf03
docs
kushalkolar Dec 2, 2025
2ccd785
black
kushalkolar Dec 2, 2025
5dfdb08
don't need to set limit for docs gen
kushalkolar Dec 2, 2025
2ddb97f
add missing comma
kushalkolar Dec 2, 2025
a4eecea
dont run terrain example
kushalkolar Dec 2, 2025
c3c528e
new screenshots
kushalkolar Dec 2, 2025
8344216
remove (i expect) unnecessary check
almarklein Dec 3, 2025
1c6dbde
lights as properties
kushalkolar Dec 4, 2025
14159ef
just use VertexPositions
kushalkolar Dec 4, 2025
bf29ba2
Merge branch 'mesh' of https://github.com/fastplotlib/fastplotlib int…
kushalkolar Dec 4, 2025
26533b9
Merge branch 'main' into mesh
kushalkolar Dec 4, 2025
c60fe31
update PolyData
kushalkolar Dec 4, 2025
9d3a007
I need to use precommit
kushalkolar Dec 4, 2025
868ee95
update api docs
kushalkolar Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions docs/source/api/graphic_features/MeshCmap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. _api.MeshCmap:

MeshCmap
********

========
MeshCmap
========
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: MeshCmap_api

MeshCmap

Properties
~~~~~~~~~~
.. autosummary::
:toctree: MeshCmap_api

MeshCmap.value

Methods
~~~~~~~
.. autosummary::
:toctree: MeshCmap_api

MeshCmap.add_event_handler
MeshCmap.block_events
MeshCmap.clear_event_handlers
MeshCmap.remove_event_handler
MeshCmap.set_value

36 changes: 36 additions & 0 deletions docs/source/api/graphic_features/MeshIndices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. _api.MeshIndices:

MeshIndices
***********

===========
MeshIndices
===========
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: MeshIndices_api

MeshIndices

Properties
~~~~~~~~~~
.. autosummary::
:toctree: MeshIndices_api

MeshIndices.buffer
MeshIndices.value

Methods
~~~~~~~
.. autosummary::
:toctree: MeshIndices_api

MeshIndices.add_event_handler
MeshIndices.block_events
MeshIndices.clear_event_handlers
MeshIndices.remove_event_handler
MeshIndices.set_value

35 changes: 35 additions & 0 deletions docs/source/api/graphic_features/SurfaceData.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. _api.SurfaceData:

SurfaceData
***********

===========
SurfaceData
===========
.. currentmodule:: fastplotlib.graphics.features

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: SurfaceData_api

SurfaceData

Properties
~~~~~~~~~~
.. autosummary::
:toctree: SurfaceData_api

SurfaceData.value

Methods
~~~~~~~
.. autosummary::
:toctree: SurfaceData_api

SurfaceData.add_event_handler
SurfaceData.block_events
SurfaceData.clear_event_handlers
SurfaceData.remove_event_handler
SurfaceData.set_value

3 changes: 3 additions & 0 deletions docs/source/api/graphic_features/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ Graphic Features
SizeSpace
VertexPositions
VertexCmap
MeshIndices
MeshCmap
SurfaceData
Thickness
VertexMarkers
UniformMarker
Expand Down
55 changes: 55 additions & 0 deletions docs/source/api/graphics/MeshGraphic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
.. _api.MeshGraphic:

MeshGraphic
***********

===========
MeshGraphic
===========
.. currentmodule:: fastplotlib

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: MeshGraphic_api

MeshGraphic

Properties
~~~~~~~~~~
.. autosummary::
:toctree: MeshGraphic_api

MeshGraphic.alpha
MeshGraphic.alpha_mode
MeshGraphic.axes
MeshGraphic.block_events
MeshGraphic.clim
MeshGraphic.cmap
MeshGraphic.colors
MeshGraphic.deleted
MeshGraphic.event_handlers
MeshGraphic.indices
MeshGraphic.mapcoords
MeshGraphic.mode
MeshGraphic.name
MeshGraphic.offset
MeshGraphic.plane
MeshGraphic.positions
MeshGraphic.right_click_menu
MeshGraphic.rotation
MeshGraphic.supported_events
MeshGraphic.visible
MeshGraphic.world_object

Methods
~~~~~~~
.. autosummary::
:toctree: MeshGraphic_api

MeshGraphic.add_axes
MeshGraphic.add_event_handler
MeshGraphic.clear_event_handlers
MeshGraphic.remove_event_handler
MeshGraphic.rotate

56 changes: 56 additions & 0 deletions docs/source/api/graphics/PolygonGraphic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
.. _api.PolygonGraphic:

PolygonGraphic
**************

==============
PolygonGraphic
==============
.. currentmodule:: fastplotlib

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: PolygonGraphic_api

PolygonGraphic

Properties
~~~~~~~~~~
.. autosummary::
:toctree: PolygonGraphic_api

PolygonGraphic.alpha
PolygonGraphic.alpha_mode
PolygonGraphic.axes
PolygonGraphic.block_events
PolygonGraphic.clim
PolygonGraphic.cmap
PolygonGraphic.colors
PolygonGraphic.data
PolygonGraphic.deleted
PolygonGraphic.event_handlers
PolygonGraphic.indices
PolygonGraphic.mapcoords
PolygonGraphic.mode
PolygonGraphic.name
PolygonGraphic.offset
PolygonGraphic.plane
PolygonGraphic.positions
PolygonGraphic.right_click_menu
PolygonGraphic.rotation
PolygonGraphic.supported_events
PolygonGraphic.visible
PolygonGraphic.world_object

Methods
~~~~~~~
.. autosummary::
:toctree: PolygonGraphic_api

PolygonGraphic.add_axes
PolygonGraphic.add_event_handler
PolygonGraphic.clear_event_handlers
PolygonGraphic.remove_event_handler
PolygonGraphic.rotate

56 changes: 56 additions & 0 deletions docs/source/api/graphics/SurfaceGraphic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
.. _api.SurfaceGraphic:

SurfaceGraphic
**************

==============
SurfaceGraphic
==============
.. currentmodule:: fastplotlib

Constructor
~~~~~~~~~~~
.. autosummary::
:toctree: SurfaceGraphic_api

SurfaceGraphic

Properties
~~~~~~~~~~
.. autosummary::
:toctree: SurfaceGraphic_api

SurfaceGraphic.alpha
SurfaceGraphic.alpha_mode
SurfaceGraphic.axes
SurfaceGraphic.block_events
SurfaceGraphic.clim
SurfaceGraphic.cmap
SurfaceGraphic.colors
SurfaceGraphic.data
SurfaceGraphic.deleted
SurfaceGraphic.event_handlers
SurfaceGraphic.indices
SurfaceGraphic.mapcoords
SurfaceGraphic.mode
SurfaceGraphic.name
SurfaceGraphic.offset
SurfaceGraphic.plane
SurfaceGraphic.positions
SurfaceGraphic.right_click_menu
SurfaceGraphic.rotation
SurfaceGraphic.supported_events
SurfaceGraphic.visible
SurfaceGraphic.world_object

Methods
~~~~~~~
.. autosummary::
:toctree: SurfaceGraphic_api

SurfaceGraphic.add_axes
SurfaceGraphic.add_event_handler
SurfaceGraphic.clear_event_handlers
SurfaceGraphic.remove_event_handler
SurfaceGraphic.rotate

3 changes: 3 additions & 0 deletions docs/source/api/graphics/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Graphics
ImageGraphic
ImageVolumeGraphic
VectorsGraphic
MeshGraphic
SurfaceGraphic
PolygonGraphic
TextGraphic
LineCollection
LineStack
5 changes: 5 additions & 0 deletions docs/source/api/layouts/subplot.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,14 @@ Properties
.. autosummary::
:toctree: Subplot_api

Subplot.ambient_light
Subplot.animations
Subplot.axes
Subplot.background_color
Subplot.camera
Subplot.canvas
Subplot.controller
Subplot.directional_light
Subplot.docks
Subplot.frame
Subplot.graphics
Expand All @@ -52,7 +54,10 @@ Methods
Subplot.add_line
Subplot.add_line_collection
Subplot.add_line_stack
Subplot.add_mesh
Subplot.add_polygon
Subplot.add_scatter
Subplot.add_surface
Subplot.add_text
Subplot.add_vectors
Subplot.auto_scale
Expand Down
14 changes: 6 additions & 8 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,12 @@
os.environ["WGPU_FORCE_OFFSCREEN"] = "1"

import fastplotlib
import pygfx
from pygfx.utils.gallery_scraper import find_examples_for_gallery
from pathlib import Path
import sys
from sphinx_gallery.sorting import ExplicitOrder
import imageio.v3 as iio

MAX_TEXTURE_SIZE = 2048
pygfx.renderers.wgpu.set_wgpu_limits(**{"max-texture-dimension-2d": MAX_TEXTURE_SIZE})

ROOT_DIR = Path(__file__).parents[1].parents[0] # repo root
EXAMPLES_DIR = Path.joinpath(ROOT_DIR, "examples")
Expand All @@ -44,7 +41,7 @@
"sphinx.ext.viewcode",
"sphinx_copybutton",
"sphinx_design",
"sphinx_gallery.gen_gallery"
"sphinx_gallery.gen_gallery",
]

sphinx_gallery_conf = {
Expand All @@ -65,6 +62,7 @@
"../../examples/controllers",
"../../examples/line",
"../../examples/line_collection",
"../../examples/mesh",
"../../examples/scatter",
"../../examples/vectors",
"../../examples/text",
Expand All @@ -77,9 +75,9 @@
"../../examples/qt",
]
),
"ignore_pattern": r'__init__\.py',
"ignore_pattern": r"__init__\.py",
"nested_sections": False,
"thumbnail_size": (250, 250)
"thumbnail_size": (250, 250),
}

extra_conf = find_examples_for_gallery(EXAMPLES_DIR)
Expand Down Expand Up @@ -107,15 +105,15 @@
"check_switcher": True,
"switcher": {
"json_url": "http://www.fastplotlib.org/_static/switcher.json",
"version_match": release
"version_match": release,
},
"icon_links": [
{
"name": "Github",
"url": "https://github.com/fastplotlib/fastplotlib",
"icon": "fa-brands fa-github",
}
]
],
}

html_static_path = ["_static"]
Expand Down
Loading