open3d.visualization.gui.ImageWidget#

class open3d.visualization.gui.ImageWidget#

Displays a bitmap

class Constraints#

Constraints object for Widget.calc_preferred_size()

__init__(self: open3d.cpu.pybind.visualization.gui.Widget.Constraints) → None#
property height#
property width#
class EventCallbackResult#

Returned by event handlers

Members:

IGNORED : Event handler ignored the event, widget will handle event normally

HANDLED : Event handler handled the event, but widget will still handle the event normally. This is useful when you are augmenting base functionality

CONSUMED : Event handler consumed the event, event handling stops, widget will not handle the event. This is useful when you are replacing functionality

CONSUMED = <EventCallbackResult.CONSUMED: 2>#
HANDLED = <EventCallbackResult.HANDLED: 1>#
IGNORED = <EventCallbackResult.IGNORED: 0>#
property name#
property value#
__init__(*args, **kwargs)#

Overloaded function.

  1. __init__(self: open3d.cpu.pybind.visualization.gui.ImageWidget) -> None

Creates an ImageWidget with no image

  1. __init__(self: open3d.cpu.pybind.visualization.gui.ImageWidget, arg0: str) -> None

Creates an ImageWidget from the image at the specified path

  1. __init__(self: open3d.cpu.pybind.visualization.gui.ImageWidget, arg0: open3d.cpu.pybind.geometry.Image) -> None

Creates an ImageWidget from the provided image

  1. __init__(self: open3d.cpu.pybind.visualization.gui.ImageWidget, arg0: open3d.cpu.pybind.t.geometry.Image) -> None

Creates an ImageWidget from the provided tgeometry image

add_child(self: open3d.cpu.pybind.visualization.gui.Widget, arg0: open3d.cpu.pybind.visualization.gui.Widget) → None#

Adds a child widget

calc_preferred_size(self: open3d.cpu.pybind.visualization.gui.Widget, arg0: open3d.cpu.pybind.visualization.gui.LayoutContext, arg1: open3d.cpu.pybind.visualization.gui.Widget.Constraints) → open3d.cpu.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.cpu.pybind.visualization.gui.Widget) → list[open3d.cpu.pybind.visualization.gui.Widget]#

Returns the array of children. Do not modify.

set_on_key(self: open3d.cpu.pybind.visualization.gui.ImageWidget, arg0: Callable[[open3d.cpu.pybind.visualization.gui.KeyEvent], int]) → None#

Sets a callback for key events. This callback is passed a KeyEvent object. The callback must return EventCallbackResult.IGNORED, EventCallbackResult.HANDLED, or EventCallackResult.CONSUMED.

set_on_mouse(self: open3d.cpu.pybind.visualization.gui.ImageWidget, arg0: Callable[[open3d.cpu.pybind.visualization.gui.MouseEvent], int]) → None#

Sets a callback for mouse events. This callback is passed a MouseEvent object. The callback must return EventCallbackResult.IGNORED, EventCallbackResult.HANDLED, or EventCallbackResult.CONSUMED.

update_image(*args, **kwargs)#

Overloaded function.

  1. update_image(self: open3d.cpu.pybind.visualization.gui.ImageWidget, arg0: open3d.cpu.pybind.geometry.Image) -> None

Mostly a convenience function for ui_image.update_image(). If ‘image’ is the same size as the current image, will update the texture with the contents of ‘image’. This is the fastest path for setting an image, and is recommended if you are displaying video. If ‘image’ is a different size, it will allocate a new texture, which is essentially the same as creating a new UIImage and calling SetUIImage(). This is the slow path, and may eventually exhaust internal texture resources.

  1. update_image(self: open3d.cpu.pybind.visualization.gui.ImageWidget, arg0: open3d.cpu.pybind.t.geometry.Image) -> None

Mostly a convenience function for ui_image.update_image(). If ‘image’ is the same size as the current image, will update the texture with the contents of ‘image’. This is the fastest path for setting an image, and is recommended if you are displaying video. If ‘image’ is a different size, it will allocate a new texture, which is essentially the same as creating a new UIImage and calling SetUIImage(). This is the slow path, and may eventually exhaust internal texture resources.

CONSUMED = <EventCallbackResult.CONSUMED: 2>#
HANDLED = <EventCallbackResult.HANDLED: 1>#
IGNORED = <EventCallbackResult.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 ui_image#

Replaces the texture with a new texture. This is not a fast path, and is not recommended for video as you will exhaust internal texture resources.

property visible#

True if widget is visible, False otherwise