Placer

class omni.ui.Placer

Bases: Container

The Placer class place a single widget to a particular position based on the offet.

Methods

__init__(self, **kwargs)	Construct Placer.
invalidate_raster(self)	This method regenerates the raster image of the widget, even if the widget's content has not changed.
set_offset_x_changed_fn(self, arg0)	offsetX defines the offset placement for the child widget relative to the Placer
set_offset_y_changed_fn(self, arg0)	offsetY defines the offset placement for the child widget relative to the Placer

Attributes

drag_axis	Sets if dragging can be horizontally or vertically.
draggable	Provides a convenient way to make an item draggable.
frames_to_start_drag	The placer size depends on the position of the child when false.
offset_x	offsetX defines the offset placement for the child widget relative to the Placer
offset_y	offsetY defines the offset placement for the child widget relative to the Placer
raster_policy	Determine how the content of the frame should be rasterized.
stable_size	The placer size depends on the position of the child when false.

__init__(self: omni.ui._ui.Placer, **kwargs) → None

Construct Placer.

`kwargsdict`

See below

### Keyword Arguments:

`offset_xtoLength`

offsetX defines the offset placement for the child widget relative to the Placer

`offset_ytoLength`

offsetY defines the offset placement for the child widget relative to the Placer

`draggablebool`

Provides a convenient way to make an item draggable.

`drag_axisAxis`

Sets if dragging can be horizontally or vertically.

`stable_sizebool`

The placer size depends on the position of the child when false.

`raster_policy`

Determine how the content of the frame should be rasterized.

`offset_x_changed_fnCallable[[ui.Length], None]`

offsetX defines the offset placement for the child widget relative to the Placer

`offset_y_changed_fnCallable[[ui.Length], None]`

offsetY defines the offset placement for the child widget relative to the Placer

`widthui.Length`

This property holds the width of the widget relative to its parent. Do not use this function to find the width of a screen.

`heightui.Length`

This property holds the height of the widget relative to its parent. Do not use this function to find the height of a screen.

`namestr`

The name of the widget that user can set.

`style_type_name_overridestr`

By default, we use typeName to look up the style. But sometimes it’s necessary to use a custom name. For example, when a widget is a part of another widget. (Label is a part of Button) This property can override the name to use in style.

`identifierstr`

An optional identifier of the widget we can use to refer to it in queries.

`visiblebool`

This property holds whether the widget is visible.

`visibleMinfloat`

If the current zoom factor and DPI is less than this value, the widget is not visible.

`visibleMaxfloat`

If the current zoom factor and DPI is bigger than this value, the widget is not visible.

`tooltipstr`

Set a basic tooltip for the widget, this will simply be a Label, it will follow the Tooltip style

`tooltip_fnCallable`

Set dynamic tooltip that will be created dynamiclly the first time it is needed. the function is called inside a ui.Frame scope that the widget will be parented correctly.

`tooltip_offset_xfloat`

Set the X tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.

`tooltip_offset_yfloat`

Set the Y tooltip offset in points. In a normal state, the tooltip position is linked to the mouse position. If the tooltip offset is non zero, the top left corner of the tooltip is linked to the top left corner of the widget, and this property defines the relative position the tooltip should be shown.

`enabledbool`

This property holds whether the widget is enabled. In general an enabled widget handles keyboard and mouse events; a disabled widget does not. And widgets display themselves differently when they are disabled.

`selectedbool`

This property holds a flag that specifies the widget has to use eSelected state of the style.

`checkedbool`

This property holds a flag that specifies the widget has to use eChecked state of the style. It’s on the Widget level because the button can have sub-widgets that are also should be checked.

`draggingbool`

This property holds if the widget is being dragged.

`opaque_for_mouse_eventsbool`

If the widgets has callback functions it will by default not capture the events if it is the top most widget and setup this option to true, so they don’t get routed to the child widgets either

`skip_draw_when_clippedbool`

The flag that specifies if it’s necessary to bypass the whole draw cycle if the bounding box is clipped with a scrolling frame. It’s needed to avoid the limitation of 65535 primitives in a single draw list.

`mouse_moved_fnCallable`

Sets the function that will be called when the user moves the mouse inside the widget. Mouse move events only occur if a mouse button is pressed while the mouse is being moved. void onMouseMoved(float x, float y, int32_t modifier)

`mouse_pressed_fnCallable`

Sets the function that will be called when the user presses the mouse button inside the widget. The function should be like this: void onMousePressed(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier) Where ‘button’ is the number of the mouse button pressed. ‘modifier’ is the flag for the keyboard modifier key.

`mouse_released_fnCallable`

Sets the function that will be called when the user releases the mouse button if this button was pressed inside the widget. void onMouseReleased(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)

`mouse_double_clicked_fnCallable`

Sets the function that will be called when the user presses the mouse button twice inside the widget. The function specification is the same as in setMousePressedFn. void onMouseDoubleClicked(float x, float y, int32_t button, carb::input::KeyboardModifierFlags modifier)

`mouse_wheel_fnCallable`

Sets the function that will be called when the user uses mouse wheel on the focused window. The function specification is the same as in setMousePressedFn. void onMouseWheel(float x, float y, carb::input::KeyboardModifierFlags modifier)

`mouse_hovered_fnCallable`

Sets the function that will be called when the user use mouse enter/leave on the focused window. function specification is the same as in setMouseHovedFn. void onMouseHovered(bool hovered)

`drag_fnCallable`

Specify that this Widget is draggable, and set the callback that is attached to the drag operation.

`accept_drop_fnCallable`

Specify that this Widget can accept specific drops and set the callback that is called to check if the drop can be accepted.

`drop_fnCallable`

Specify that this Widget accepts drops and set the callback to the drop operation.

`computed_content_size_changed_fnCallable`

Called when the size of the widget is changed.

invalidate_raster(self: omni.ui._ui.Placer) → None

This method regenerates the raster image of the widget, even if the widget’s content has not changed. This can be used with both the eOnDemand and eAuto raster policies, and is used to update the content displayed in the widget. Note that this operation may be resource-intensive, and should be used sparingly.

set_offset_x_changed_fn(self: omni.ui._ui.Placer, arg0: Callable[[omni.ui._ui.Length], None]) → None

offsetX defines the offset placement for the child widget relative to the Placer

set_offset_y_changed_fn(self: omni.ui._ui.Placer, arg0: Callable[[omni.ui._ui.Length], None]) → None

offsetY defines the offset placement for the child widget relative to the Placer

property drag_axis

Sets if dragging can be horizontally or vertically.

property draggable

Provides a convenient way to make an item draggable.

property frames_to_start_drag

The placer size depends on the position of the child when false.

property offset_x

offsetX defines the offset placement for the child widget relative to the Placer

property offset_y

offsetY defines the offset placement for the child widget relative to the Placer

property raster_policy

Determine how the content of the frame should be rasterized.

property stable_size

The placer size depends on the position of the child when false.