ScatterStack#

ScatterStack#

Constructor#

ScatterStack(data, *[, colors, cmap, ...])

Create a stack of graphics.

Properties#

ScatterStack.alpha

The opacity of the graphic

ScatterStack.alpha_mode

How the alpha is handled by the renderer

ScatterStack.alpha_modes

get or set the alpha_modes of the graphics in the collection

ScatterStack.alphas

get or set the alphas of the graphics in the collection

ScatterStack.axes

ScatterStack.block_events

Used to block events for a graphic and prevent recursion.

ScatterStack.block_handlers

Used to block event handlers for a graphic and prevent recursion.

ScatterStack.cmap

get or set the colormap(s) across the collection

ScatterStack.cmap_range

get or set the cmap_range of the graphics in the collection

ScatterStack.cmap_transform

get or set the cmap_transform across the collection

ScatterStack.colors

get or set the colors of the graphics in the collection

ScatterStack.data

get or set the data of the graphics in the collection

ScatterStack.deleted

used to emit an event after the graphic is deleted

ScatterStack.edge_colors

get or set the edge_colors of the graphics in the collection

ScatterStack.edge_width

get or set the edge_width of the graphics in the collection

ScatterStack.event_handlers

Registered event handlers.

ScatterStack.graphics

the graphics in the collection

ScatterStack.image

get or set the image of the graphics in the collection

ScatterStack.imgui_right_click

The imgui popup of each graphic of this collection, in order.

ScatterStack.markers

get or set the markers of the graphics in the collection

ScatterStack.metadatas

get or set the metadatas of the graphics in the collection

ScatterStack.name

Graphic name

ScatterStack.names

get or set the names of the graphics in the collection

ScatterStack.offset

[x, y, z]

ScatterStack.offsets

get or set the offsets of the graphics in the collection

ScatterStack.point_rotations

get or set the point_rotations of the graphics in the collection

ScatterStack.rotation

Orientation of the graphic as a quaternion

ScatterStack.rotations

get or set the rotations of the graphics in the collection

ScatterStack.scale

(x, y, z) scaling factor

ScatterStack.scales

get or set the scales of the graphics in the collection

ScatterStack.separation

get or set the (x, y, z) gap added to the step along the stacking axes

ScatterStack.separation_axis

get or set the axes to stack along, e.g. "y", "xy", "xyz".

ScatterStack.size_space

get or set the size_space of the graphics in the collection

ScatterStack.sizes

get or set the sizes of the graphics in the collection

ScatterStack.steps

get or set the per-graphic (x, y, z) steps used to space the stack, None to auto-determine

ScatterStack.supported_events

events supported by this graphic

ScatterStack.tooltip_format

set a custom tooltip format function which takes a pick_info dict and returns a str to be displayed in the tooltip

ScatterStack.visible

Whether the graphic is visible

ScatterStack.visibles

get or set the visibles of the graphics in the collection

ScatterStack.world_object

Associated pygfx WorldObject.

Methods#

ScatterStack.add_axes()

Add axes onto this Graphic

ScatterStack.add_event_handler(*args)

Register an event handler.

ScatterStack.add_graphic(graphic)

Add a graphic to the collection.

ScatterStack.add_linear_region_selector([...])

Add a LinearRegionSelector.

ScatterStack.add_linear_selector([...])

Add a LinearSelector.

ScatterStack.add_polygon_selector([selection])

Add a PolygonSelector.

ScatterStack.add_rectangle_selector([selection])

Add a RectangleSelector.

ScatterStack.append_imgui_right_click([gui])

Append imgui elements to the popup of every graphic of this collection.

ScatterStack.clear_event_handlers()

clear all event handlers added to this graphic

ScatterStack.format_pick_info(ev)

Takes a pygfx.PointerEvent and returns formatted pick info.

ScatterStack.map_model_to_world(position)

map position from model (data) space to world space, basically applies the world affine transform

ScatterStack.map_world_to_model(position)

map position from world space to model (data) space, basically applies the inverse world affine transform

ScatterStack.remove_event_handler(callback, ...)

remove a registered event handler

ScatterStack.remove_graphic(graphic)

Remove a graphic from the collection.

ScatterStack.remove_imgui_right_click(popup)

Remove popup from every graphic of this collection that has it set.

ScatterStack.rotate(alpha[, axis])

Rotate the Graphic with respect to the world.

ScatterStack.set_imgui_right_click([popup, ...])

Set the imgui popup opened by a right-click on any graphic of this collection.