open3d.visualization.gui.WidgetStack#

class open3d.visualization.gui.WidgetStack#

A widget stack saves all widgets pushed into by push_widget and always shows the top one. The WidgetStack is a subclass of WidgetProxy, in otherwords, the topmost widget will delegate itself to WidgetStack. pop_widget will remove the topmost widget and callback set by set_on_top taking the new topmost widget will be called. The WidgetStack disappears in GUI if there is no widget in stack.

class Constraints#

Constraints object for Widget.calc_preferred_size()

__init__(self: open3d.pybind.visualization.gui.Widget.Constraints) → None#

property height#

property width#

class EventCallbackResult(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)#

Returned by event handlers

__init__(*args, **kwds)#

as_integer_ratio()#

Return a pair of integers, whose ratio is equal to the original int.

The ratio is in lowest terms and has a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

bit_count()#

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

bit_length()#

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

conjugate()#: Returns self, the complex conjugate of any int.

from_bytes(byteorder='big', *, signed=False)#

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value. Default is to use ‘big’.
signed: Indicates whether two’s complement is used to represent the integer.

is_integer()#: Returns True. Exists for duck type compatibility with float.is_integer.

to_bytes(length=1, byteorder='big', *, signed=False)#

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.
byteorder: The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder’ as the byte order value. Default is to use ‘big’.
signed: Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

CONSUMED = 2#

HANDLED = 1#

IGNORED = 0#

denominator#: the denominator of a rational number in lowest terms

imag#: the imaginary part of a complex number

numerator#: the numerator of a rational number in lowest terms

real#: the real part of a complex number

__init__(self: open3d.pybind.visualization.gui.WidgetStack) → None#: Creates a widget stack. The widget stack without anywidget will not be shown in GUI until set_widget iscalled to push a widget.

add_child(self: open3d.pybind.visualization.gui.Widget, arg0: open3d.pybind.visualization.gui.Widget) → None#: Adds a child widget

calc_preferred_size(self: open3d.pybind.visualization.gui.Widget, arg0: open3d.pybind.visualization.gui.LayoutContext, arg1: open3d.pybind.visualization.gui.Widget.Constraints) → open3d.pybind.visualization.gui.Size#: Returns the preferred size of the widget. This is intended to be called only during layout, although it will also work during drawing. Calling it at other times will not work, as it requires some internal setup in order to function properly

get_children(self: open3d.pybind.visualization.gui.Widget) → list[open3d.pybind.visualization.gui.Widget]#: Returns the array of children. Do not modify.

get_widget(self: open3d.pybind.visualization.gui.WidgetProxy) → open3d.pybind.visualization.gui.Widget#: Retrieve current delegated widget.return instance of current delegated widget set by set_widget. An empty pointer will be returned if there is none.

pop_widget(self: open3d.pybind.visualization.gui.WidgetStack) → open3d.pybind.visualization.gui.Widget#: pop the topmost widget in the stack. The new topmost widgetof stack will be the widget on the show in GUI.

push_widget(self: open3d.pybind.visualization.gui.WidgetStack, arg0: open3d.pybind.visualization.gui.Widget) → None#: push a new widget onto the WidgetStack’s stack, hiding whatever widget was there before and making the new widget visible.

set_on_top(self: open3d.pybind.visualization.gui.WidgetStack, arg0: collections.abc.Callable[[open3d.pybind.visualization.gui.Widget], None]) → None#: Callable[[widget] -> None], called while a widget becomes the topmost of stack after some widget is poppedout. It won’t be called if a widget is pushed into stackby set_widget.

set_widget(self: open3d.pybind.visualization.gui.WidgetProxy, arg0: open3d.pybind.visualization.gui.Widget) → None#: set a new widget to be delegated by this one. After set_widget, the previously delegated widget , will be abandon all calls to Widget’s API will be conducted to widget. Before any set_widget call, this widget is invisible and disabled, seems it does not exist because it won’t be drawn or in a layout.

CONSUMED = 2#

HANDLED = 1#

IGNORED = 0#

property background_color#: Background color of the widget

property enabled#: True if widget is enabled, False if disabled

property frame#: The widget’s frame. Setting this value will be overridden if the frame is within a layout.

property tooltip#: Widget’s tooltip that is displayed on mouseover

property visible#: True if widget is visible, False otherwise