Central object responsible for running the main event loop and creating other central objects.
More...
Central object responsible for running the main event loop and creating other central objects.
The Application object is a central object for accessing other important objects. It is also responsible for starting the main event loop. It is passed on to plugins so it can be easily used to access objects required for those plugins.
def UM.Application.Application.__init__ |
( |
|
self, |
|
|
|
name, |
|
|
|
version, |
|
|
|
buildtype = "" , |
|
|
|
kwargs |
|
) |
| |
Init method.
- Parameters
-
name | string The name of the application. |
version | string Version, formatted as major.minor.rev |
def UM.Application.Application.addCommandLineOptions |
( |
|
cls, |
|
|
|
parser |
|
) |
| |
Can be overridden to add additional command line options to the parser.
- Parameters
-
parser | argparse.ArgumentParser The parser that will parse the command line. |
def UM.Application.Application.callLater |
( |
|
self, |
|
|
|
function, |
|
|
|
args, |
|
|
|
kwargs |
|
) |
| |
Call a function the next time the event loop runs.
- Parameters
-
function | The function to call. |
args | The positional arguments to pass to the function. |
kwargs | The keyword arguments to pass to the function. |
def UM.Application.Application.functionEvent |
( |
|
self, |
|
|
|
event |
|
) |
| |
Post a function event onto the event loop.
This takes a CallFunctionEvent object and puts it into the actual event loop.
- Exceptions
-
def UM.Application.Application.getApplicationName |
( |
|
self | ) |
|
Get name of the application.
- Returns
- application_name string
def UM.Application.Application.getBackend |
( |
|
self | ) |
|
Get the backend of the application (the program that does the heavy lifting).
- Returns
- Backend Backend
def UM.Application.Application.getBuildType |
( |
|
self | ) |
|
Get the buildtype of the application.
- Returns
- version string
def UM.Application.Application.getController |
( |
|
self | ) |
|
Get the Controller of this application.
- Returns
- Controller Controller
def UM.Application.Application.getMainThread |
( |
|
self | ) |
|
Get the application"s main thread.
def UM.Application.Application.getMeshFileHandler |
( |
|
self | ) |
|
Get the MeshFileHandler of this application.
- Returns
- MeshFileHandler MeshFileHandler
def UM.Application.Application.getPluginRegistry |
( |
|
self | ) |
|
Get the PluginRegistry of this application.
- Returns
- PluginRegistry PluginRegistry
def UM.Application.Application.getRenderer |
( |
|
self | ) |
|
Return an application-specific Renderer object.
- Exceptions
-
def UM.Application.Application.getRequiredPlugins |
( |
|
self | ) |
|
Application has a list of plugins that it must have.
If it does not have these, it cannot function. These plugins can not be disabled in any way.
- Returns
- required_plugins list
def UM.Application.Application.getVersion |
( |
|
self | ) |
|
Get the version of the application.
- Returns
- version string
def UM.Application.Application.getVisibleMessages |
( |
|
self | ) |
|
Get list of all visible messages.
- Returns
- visible_messages list
def UM.Application.Application.hideMessageById |
( |
|
self, |
|
|
|
message_id |
|
) |
| |
Remove a message from the visible message list so it will no longer be displayed.
This should only be called by message object itself. in principle, this should only be called by the message itself (hide)
- Parameters
-
message | Message message object |
- See also
- Message::hide() def hideMessage(self, message): with self._message_lock: if message in self._visible_messages: self._visible_messages.remove(message) self.visibleMessageRemoved.emit(message) Hide message by ID (as provided by built-in id function)
- Parameters
-
def UM.Application.Application.run |
( |
|
self | ) |
|
Run the main event loop.
This method should be re-implemented by subclasses to start the main event loop.
- Exceptions
-
def UM.Application.Application.setBackend |
( |
|
self, |
|
|
|
backend |
|
) |
| |
Set the backend of the application (the program that does the heavy lifting).
- Parameters
-
def UM.Application.Application.setRequiredPlugins |
( |
|
self, |
|
|
|
plugin_names |
|
) |
| |
Set the plugins that the application must have in order to function.
- Parameters
-
plugin_names | list List of strings with the names of the required plugins |
tuple UM.Application.Application.visibleMessageAdded = Signal() |
|
static |
Add a message to the visible message list so it will be displayed.
This should only be called by message object itself. To show a message, simply create it and call its .show() function.
- Parameters
-
message | Message message object |
- See also
- Message::show() def showMessage(self, message): with self._message_lock: if message not in self._visible_messages: self._visible_messages.append(message) self.visibleMessageAdded.emit(message)
The documentation for this class was generated from the following file: