plopp.backends.pythreejs.outline.Outline#

class plopp.backends.pythreejs.outline.Outline(limits, tick_size=None)[source]#

Create an object that draws a rectangular outline, given some limits for the XYZ dimensions. Along the lower edges of the cube are added some tick labels and axes labels, according to the dimension extents, dimension names, and units given in the limits.

Parameters:

limits (tuple[Variable, Variable, Variable]) – A tuple of variables, each of length 2, which contain the lower and upper bounds for the outline. Each variable also has a dimension, which is to be used as the dimension for that direction, as well as a unit, which will be used to label the corresponding axis.
tick_size (Optional[float], default: None) – A number to scale the tick size.

__init__(limits, tick_size=None)[source]#: Public constructor

Methods

`__init__`(limits[, tick_size])	Public constructor
`add`(children)
`add_traits`(**traits)	Dynamically add trait attributes to 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`()
`exec_three_obj_method`(method_name, *args, ...)	Execute a method on the three object.
`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.
`lookAt`(vector)
`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`(children)
`rotateX`(rad)
`rotateY`(rad)
`rotateZ`(rad)
`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.
`setRotationFromMatrix`(m)	m is a 3 by 3 matrix, as a list of rows.
`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.
`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

`castShadow`	A boolean (True, False) trait.
`children`	An instance of a Python tuple.
`comm`	A trait which allows any value.
`cross_validation_lock`	A contextmanager for running a block with our cross validation lock set to True.
`frustumCulled`	A boolean (True, False) trait.
`keys`	The traits which are synced.
`log`	A trait whose value must be an instance of a specified class.
`matrix`	A trait for a 16-tuple corresponding to a three.js Matrix4.
`matrixAutoUpdate`	A boolean (True, False) trait.
`matrixWorld`	A trait for a 16-tuple corresponding to a three.js Matrix4.
`matrixWorldNeedsUpdate`	A boolean (True, False) trait.
`modelViewMatrix`	A trait for a 16-tuple corresponding to a three.js Matrix4.
`model_id`	Gets the model id of this widget.
`name`	A trait for unicode strings.
`normalMatrix`	A trait for a 9-tuple corresponding to a three.js Matrix3.
`position`	A trait for a 3-tuple corresponding to a three.js Vector3.
`quaternion`	A trait for a 4-tuple corresponding to a three.js Vector4.
`receiveShadow`	A boolean (True, False) trait.
`renderOrder`	A casting version of the int trait.
`rotation`	A trait for a set of Euler angles.
`scale`	A trait for a 3-tuple corresponding to a three.js Vector3.
`type`	A trait for unicode strings.
`up`	A trait for a 3-tuple corresponding to a three.js Vector3.
`visible`	A boolean (True, False) trait.
`widget_types`
`widgets`