Image

class omni.ui.scene.Image

Bases: Rectangle

Methods

__init__(*args, **kwargs)

Overloaded function.

Attributes

fill_policy

Define what happens when the source image has a different size than the item.

image_height

The resolution of rasterization of svg and for ImageProvider.

image_provider

" path, a direct path or the path relative to the application root directory.

image_width

The resolution for rasterization of svg and for ImageProvider.

source_url

" path, a direct path or the path relative to the application root directory.
__init__(*args, **kwargs)

Overloaded function.

  1. __init__(self: omni.ui_scene._scene.Image, source_url: str, width: float = 1.0, height: float = 1.0, **kwargs) -> None

Created an image with the given URL.

`kwargsdict`

See below

### Keyword Arguments:

`source_url`

This property holds the image URL. It can be an “omni:” path, a “file:” path, a direct path or the path relative to the application root directory.

`image_provider`

This property holds the image provider. It can be an “omni:” path, a “file:” path, a direct path or the path relative to the application root directory.

`fill_policy`

Define what happens when the source image has a different size than the item.

`image_width`

The resolution for rasterization of svg and for ImageProvider.

`image_height`

The resolution of rasterization of svg and for ImageProvider.

`width`

The size of the rectangle.

`height`

The size of the rectangle.

`thickness`

The thickness of the line.

`intersection_thickness`

The thickness of the line for the intersection.

`color`

The color of the line.

`axis`

The axis the rectangle is perpendicular to.

`wireframe`

When true, it’s a line. When false it’s a mesh.

`gesture`

All the gestures assigned to this shape.

`gestures`

All the gestures assigned to this shape.

`visible`

This property holds whether the item is visible.

  1. __init__(self: omni.ui_scene._scene.Image, image_provider: ImageProvider, width: float = 1.0, height: float = 1.0, **kwargs) -> None

Created an image with the given provider.

`kwargsdict`

See below

### Keyword Arguments:

`source_url`

This property holds the image URL. It can be an “omni:” path, a “file:” path, a direct path or the path relative to the application root directory.

`image_provider`

This property holds the image provider. It can be an “omni:” path, a “file:” path, a direct path or the path relative to the application root directory.

`fill_policy`

Define what happens when the source image has a different size than the item.

`image_width`

The resolution for rasterization of svg and for ImageProvider.

`image_height`

The resolution of rasterization of svg and for ImageProvider.

`width`

The size of the rectangle.

`height`

The size of the rectangle.

`thickness`

The thickness of the line.

`intersection_thickness`

The thickness of the line for the intersection.

`color`

The color of the line.

`axis`

The axis the rectangle is perpendicular to.

`wireframe`

When true, it’s a line. When false it’s a mesh.

`gesture`

All the gestures assigned to this shape.

`gestures`

All the gestures assigned to this shape.

`visible`

This property holds whether the item is visible.

  1. __init__(self: omni.ui_scene._scene.Image, width: float = 1.0, height: float = 1.0, **kwargs) -> None

Created an empty image.

`kwargsdict`

See below

### Keyword Arguments:

`source_url`

This property holds the image URL. It can be an “omni:” path, a “file:” path, a direct path or the path relative to the application root directory.

`image_provider`

This property holds the image provider. It can be an “omni:” path, a “file:” path, a direct path or the path relative to the application root directory.

`fill_policy`

Define what happens when the source image has a different size than the item.

`image_width`

The resolution for rasterization of svg and for ImageProvider.

`image_height`

The resolution of rasterization of svg and for ImageProvider.

`width`

The size of the rectangle.

`height`

The size of the rectangle.

`thickness`

The thickness of the line.

`intersection_thickness`

The thickness of the line for the intersection.

`color`

The color of the line.

`axis`

The axis the rectangle is perpendicular to.

`wireframe`

When true, it’s a line. When false it’s a mesh.

`gesture`

All the gestures assigned to this shape.

`gestures`

All the gestures assigned to this shape.

`visible`

This property holds whether the item is visible.

class FillPolicy

Bases: pybind11_object

Members:

STRETCH

PRESERVE_ASPECT_FIT

PRESERVE_ASPECT_CROP

property name
property fill_policy

Define what happens when the source image has a different size than the item.

property image_height

The resolution of rasterization of svg and for ImageProvider.

property image_provider

” path, a direct path or the path relative to the application root directory.

Type

This property holds the image provider. It can be an “omni

Type

” path, a “file

property image_width

The resolution for rasterization of svg and for ImageProvider.

property source_url

” path, a direct path or the path relative to the application root directory.

Type

This property holds the image URL. It can be an “omni

Type

” path, a “file