omni.kit.widget.nucleus_connector
A helper extension for connecting to the Nucleus server.
- class omni.kit.widget.nucleus_connector.NucleusConnectorExtension
Helper extension for connecting to Nucleus servers
- connect(name: str, url: str, on_success_fn: Optional[Callable] = None, on_failed_fn: Optional[Callable] = None)
Connects to the named server.
- Parameters
name (str) – Name of server
url (str) – Url of server
on_success_fn (Callable) – Invoked when successful, on_success_fn(name: str, url: str)
on_faild_fn (Callable) – Invoked when failed, on_faild_fn(name: str, url: str)
- connect_with_dialog(on_success_fn: Optional[Callable] = None, on_failed_fn: Optional[Callable] = None)
Prompts for server name and Url and proceeds to connect to it.
- Parameters
on_success_fn (Callable) – Invoked when successful, on_success_fn(name: str, url: str)
on_faild_fn (Callable) – Invoked when failed, on_faild_fn(name: str, url: str)
- disconnect(url: str)
Disconnects from the server.
- Parameters
url (str) – Url of server
- reconnect(url: str, on_success_fn: Optional[Callable] = None, on_failed_fn: Optional[Callable] = None)
Reconnects to the named server.
- Parameters
url (str) – Url of server
on_success_fn (Callable) – Invoked when successful, on_success_fn(url: str)
on_faild_fn (Callable) – Invoked when failed, on_faild_fn(url: str)
- omni.kit.widget.nucleus_connector.get_nucleus_connector() NucleusConnectorExtension
Returns
NucleusConnectorExtensioninterface