plopp.widgets.clip3d.Clip3dTool#

class plopp.widgets.clip3d.Clip3dTool(limits, direction, update, color='red', linewidth=1.5, border_visible=True)[source]#

A tool that provides a slider to extract a slab of points in a three-dimensional scatter plot, and add it to the scene as an opaque cut. The slider controls the position and range of the slice. When the slider is dragged, the red outline of the cut is moved at the same time, while the actual point cloud gets updated less frequently using a debounce mechanism.

Added in version 24.04.0.

Parameters:

limits (tuple[Variable, Variable, Variable]) – The spatial extent of the points in the 3d figure in the XYZ directions.
direction (Literal['x', 'y', 'z']) – The direction normal to the slice.
update (Callable) – A function to update the scene.
color (str, default: 'red') – Color of the cut’s outline.
linewidth (float, default: 1.5) – Width of the line delineating the outline.

__init__(limits, direction, update, color='red', linewidth=1.5, border_visible=True)[source]#: Public constructor

Methods

`__init__`(limits, direction, update[, color, ...])	Public constructor
`add_class`(className)	Adds a class to the top level element of the widget.
`add_traits`(**traits)	Dynamically add trait attributes to the Widget.
`blur`()	Blur the widget.
`class_own_trait_events`(name)	Get a dict of all event handlers defined on this class, not a parent.
`class_own_traits`(**metadata)	Get a dict of all the traitlets defined on this class, not a parent.
`class_trait_names`(**metadata)	Get a list of all the names of this class' traits.
`class_traits`(**metadata)	Get a `dict` of all the traits of this class.
`close`()	Close method.
`close_all`()
`focus`()	Focus on the widget.
`get_manager_state`([drop_defaults, widgets])	Returns the full state for a widget manager for embedding
`get_state`([key, drop_defaults])	Gets the widget state, or a piece of it.
`get_view_spec`()
`handle_comm_opened`(comm, msg)	Static method, called when a widget is constructed.
`handle_control_comm_opened`(comm, msg)	Class method, called when the comm-open message on the "jupyter.widget.control" comm channel is received
`has_trait`(name)	Returns True if the object has a trait with the specified name.
`hold_sync`()	Hold syncing any state until the outermost context manager exits
`hold_trait_notifications`()	Context manager for bundling trait change notifications and cross validation.
`move`(value)	Move the outline of the cut according to new position given by the slider.
`notify_change`(change)	Called when a property has changed.
`observe`(handler[, names, type])	Setup a handler to be called when a trait changes.
`on_msg`(callback[, remove])	(Un)Register a custom msg receive callback.
`on_trait_change`([handler, name, remove])	DEPRECATED: Setup a handler to be called when a trait changes.
`on_widget_constructed`(callback)	Registers a callback to be called when a widget is constructed.
`open`()	Open a comm to the frontend if one isn't already open.
`remove_class`(className)	Removes a class from the top level element of the widget.
`send`(content[, buffers])	Sends a custom msg to the widget model in the front-end.
`send_state`([key])	Sends the widget state, or a piece of it, to the front-end, if it exists.
`set_state`(sync_data)	Called when a state is received from the front-end.
`set_trait`(name, value)	Forcibly sets trait attribute, including read-only attributes.
`setup_instance`(**kwargs)	This is called before self.__init__ is called.
`toggle`(owner)	Toggle the visibility of the cut on and off.
`toggle_border`(value)	Toggle the border visibility.
`trait_defaults`(names, *metadata)	Return a trait's default value or a dictionary of them
`trait_events`([name])	Get a `dict` of all the event handlers of this class.
`trait_has_value`(name)	Returns True if the specified trait has a value.
`trait_metadata`(traitname, key[, default])	Get metadata values for trait by key.
`trait_names`(**metadata)	Get a list of all the names of this class' traits.
`trait_values`(**metadata)	A `dict` of trait names and their values.
`traits`(**metadata)	Get a `dict` of all the traits of this class.
`unobserve`(handler[, names, type])	Remove a trait change handler.
`unobserve_all`([name])	Remove trait change handlers of any type for the specified name.

Attributes

`box_style`	Use a predefined styling for the box.
`children`	List of widget children
`comm`	A trait which allows any value.
`cross_validation_lock`	A contextmanager for running a block with our cross validation lock set to True.
`keys`	The traits which are synced.
`layout`	An instance trait which coerces a dict to an instance.
`log`	A trait whose value must be an instance of a specified class.
`model_id`	Gets the model id of this widget.
`range`
`tabbable`	Is widget tabbable?
`tooltip`	A tooltip caption.
`widget_types`
`widgets`