IAppWindowFactory

Fully qualified name: omni::kit::IAppWindowFactory

class IAppWindowFactory

Application window creation factory.

Public Functions

inline IAppWindowPtr createWindowFromSettings()

Create new application window.

Returns:

The application window carb object pointer.

virtual IAppWindow *createWindowPtrFromSettings() = 0

Create new application window.

Returns:

application window pointer.

virtual void destroyWindowPtr(IAppWindow *appWindow) = 0

Destroy the input application window.

Parameters:

appWindow – input application window pointer.

virtual IAppWindow *getDefaultWindow() = 0

Get default application window.

Returns:

application window pointer.

virtual void setDefaultWindow(IAppWindow*) = 0

Set default application window.

Parameters:

input – application window pointer.

virtual size_t getWindowCount() = 0

Get the number of application windows.

Returns:

The number of application windows.

virtual IAppWindow *getWindowAt(size_t index) = 0

Get application window by index.

Parameters:

index – window index

virtual void startupActionMappingSet() = 0

Start up action mapping set.

virtual void shutdownActionMappingSet() = 0

Shutdown action mapping set.

virtual carb::input::ActionMappingSet *getActionMappingSet(

) const = 0

Get window action mapping set.

Returns:

Window action mapping set.

virtual bool startup() = 0

Application window startup.

Returns:

Whether the startup operation was completed successfully.

virtual bool shutdown() = 0

Application window shutdown.

Returns:

Whether the shutdown operation was completed successfully.

virtual carb::events::IEventStream *getWindowCreationEventStream() = 0

Get event stream of application window creation.

Warning

Deprecated: Use carb::eventdispatcher::IEventDispatcher with Factory Events.

Returns:

Event stream pointer of application window creation.

virtual IAppWindow *getAppWindowFromHandle(

int64_t appWindowHandle,

) = 0

Get application window from handle.

Parameters:

appWindowHandle – Application window handle.

Returns:

application window pointer.

inline IAppWindowPtr createWindowByType(WindowType windowType)

Create window according to the input window type.

Parameters:

windowType – Type of the window: virtual or OS.

Returns:

application window carb object pointer.

virtual IAppWindow *createWindowPtrByType(WindowType windowType) = 0

Create window according to the input window type.

Parameters:

windowType – Type of the window: virtual or OS.

Returns:

application window pointer.