IAppWindowFactory

class omni.appwindow.IAppWindowFactory

Bases: pybind11_object

Application window creation factory

Methods

__init__(*args, **kwargs)
create_window_by_type(self, window_type)	Create application window according to the input window type.
create_window_from_settings(self)	Create application window.
create_window_ptr_by_type(self, window_type)	Create application window from the input settings.
create_window_ptr_from_settings(self)	Create application window from the input settings.
destroy_window_ptr(self, app_window)	Destroy the input application window.
get_app_window(self)	Get default application window.
get_default_window(self)	Get default application window.
get_window_at(self, index)	Get application window by the input index.
get_window_count(self)	Get the number of application windows.
get_windows(self)	Get a tuple of all the application windows.
set_default_window(self, Arg0)	Set default application window.

__init__(*args, **kwargs)

create_window_by_type(

self: omni.appwindow._appwindow.IAppWindowFactory,

window_type: omni.appwindow._appwindow.WindowType,

) → omni.appwindow._appwindow.IAppWindow

Create application window according to the input window type.

Parameters:

window_type – Type of the window: virtual or OS.

Returns:

Application window carb object pointer.

create_window_from_settings(

self: omni.appwindow._appwindow.IAppWindowFactory,

) → omni.appwindow._appwindow.IAppWindow

Create application window.

Returns:

The application window carb object pointer.

create_window_ptr_by_type(

self: omni.appwindow._appwindow.IAppWindowFactory,

window_type: omni.appwindow._appwindow.WindowType,

) → omni.appwindow._appwindow.IAppWindow

Create application window from the input settings.

Parameters:

window_type – Type of the window: virtual or OS.

Returns:

Application window pointer.

create_window_ptr_from_settings(

self: omni.appwindow._appwindow.IAppWindowFactory,

) → omni.appwindow._appwindow.IAppWindow

Create application window from the input settings.

Returns:

Application window pointer.

destroy_window_ptr(

self: omni.appwindow._appwindow.IAppWindowFactory,

app_window: omni.appwindow._appwindow.IAppWindow,

) → None

Destroy the input application window.

Parameters:

app_window – The application window pointer.

get_app_window(

self: omni.appwindow._appwindow.IAppWindowFactory,

) → omni.appwindow._appwindow.IAppWindow

Get default application window.

Returns:

The application window pointer.

get_default_window(

self: omni.appwindow._appwindow.IAppWindowFactory,

) → omni.appwindow._appwindow.IAppWindow

Get default application window.

Returns:

The application window pointer.

get_window_at(

self: omni.appwindow._appwindow.IAppWindowFactory,

index: int,

) → omni.appwindow._appwindow.IAppWindow

Get application window by the input index.

Parameters:

• index – window index

• Return – The application window pointer.

get_window_count(

self: omni.appwindow._appwindow.IAppWindowFactory,

) → int

Get the number of application windows.

Returns:

The number of application windows.

get_windows(

self: omni.appwindow._appwindow.IAppWindowFactory,

) → tuple

Get a tuple of all the application windows.

Returns:

A tuple of all the application windows.

set_default_window(

self: omni.appwindow._appwindow.IAppWindowFactory,

Arg0: omni.appwindow._appwindow.IAppWindow,

) → None

Set default application window.

Parameters:

Arg0 – The input application window pointer.