Central object responsible for running the main event loop and creating other central objects.
More...
|
def | __init__ |
| Init method. More...
|
|
def | getContainerRegistry (self) |
|
def | setGlobalContainerStack |
|
def | getGlobalContainerStack (self) |
|
def | hideMessage (self, message) |
|
def | showMessage (self, message) |
|
def | showToastMessage |
|
def | getVersion (self) |
| Get the version of the application. More...
|
|
def | getStaticVersion (cls) |
|
def | getBuildType (self) |
| Get the buildtype of the application. More...
|
|
def | hideMessageById (self, message_id) |
| Hide message by ID (as provided by built-in id function) More...
|
|
def | getVisibleMessages (self) |
| Get list of all visible messages. More...
|
|
def | getCommandLineOption (self, name, default=None) |
|
def | getApplicationName (self) |
| Get name of the application. More...
|
|
def | getApplicationLanguage (self) |
|
def | getRequiredPlugins (self) |
| Application has a list of plugins that it must have. More...
|
|
def | setRequiredPlugins |
| Set the plugins that the application must have in order to function. More...
|
|
def | setBackend |
| Set the backend of the application (the program that does the heavy lifting). More...
|
|
def | getBackend (self) |
| Get the backend of the application (the program that does the heavy lifting). More...
|
|
def | getPluginRegistry (self) |
| Get the PluginRegistry of this application. More...
|
|
def | getController (self) |
| Get the Controller of this application. More...
|
|
def | getMeshFileHandler (self) |
| Get the MeshFileHandler of this application. More...
|
|
def | getWorkspaceFileHandler (self) |
|
def | getOperationStack (self) |
|
def | getOutputDeviceManager (self) |
|
def | run (self) |
| Run the main event loop. More...
|
|
def | getRenderer (self) |
| Return an application-specific Renderer object. More...
|
|
def | functionEvent (self, event) |
| Post a function event onto the event loop. More...
|
|
def | callLater |
| Call a function the next time the event loop runs. More...
|
|
def | getMainThread (self) |
| Get the application"s main thread. More...
|
|
def | getInstance (cls) |
| Return the singleton instance of the application object.
|
|
def | parseCommandLine (self) |
|
def | addCommandLineOptions (cls, parser) |
| Can be overridden to add additional command line options to the parser. More...
|
|
def | addExtension |
|
def | getExtensions (self) |
|
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.
◆ __init__()
def UM.Application.Application.__init__ |
( |
|
self, |
|
|
|
name |
|
) |
| |
Init method.
- Parameters
-
name | string The name of the application. |
version | string Version, formatted as major.minor.rev |
◆ addCommandLineOptions()
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. |
◆ callLater()
def UM.Application.Application.callLater |
( |
|
self, |
|
|
|
func |
|
) |
| |
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. |
◆ functionEvent()
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
-
◆ getApplicationName()
def UM.Application.Application.getApplicationName |
( |
|
self, |
|
|
|
str |
|
) |
| |
Get name of the application.
- Returns
- application_name string
◆ getBackend()
def UM.Application.Application.getBackend |
( |
|
self, |
|
|
|
Backend |
|
) |
| |
Get the backend of the application (the program that does the heavy lifting).
- Returns
- Backend Backend
◆ getBuildType()
def UM.Application.Application.getBuildType |
( |
|
self, |
|
|
|
str |
|
) |
| |
Get the buildtype of the application.
- Returns
- version string
◆ getController()
def UM.Application.Application.getController |
( |
|
self, |
|
|
|
Controller |
|
) |
| |
Get the Controller of this application.
- Returns
- Controller Controller
◆ getMainThread()
def UM.Application.Application.getMainThread |
( |
|
self | ) |
|
Get the application"s main thread.
◆ getMeshFileHandler()
def UM.Application.Application.getMeshFileHandler |
( |
|
self, |
|
|
|
MeshFileHandler |
|
) |
| |
Get the MeshFileHandler of this application.
- Returns
- MeshFileHandler MeshFileHandler
◆ getPluginRegistry()
def UM.Application.Application.getPluginRegistry |
( |
|
self, |
|
|
|
PluginRegistry |
|
) |
| |
Get the PluginRegistry of this application.
- Returns
- PluginRegistry PluginRegistry
◆ getRenderer()
def UM.Application.Application.getRenderer |
( |
|
self | ) |
|
Return an application-specific Renderer object.
- Exceptions
-
◆ getRequiredPlugins()
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
◆ getVersion()
def UM.Application.Application.getVersion |
( |
|
self, |
|
|
|
str |
|
) |
| |
Get the version of the application.
- Returns
- version string
◆ getVisibleMessages()
def UM.Application.Application.getVisibleMessages |
( |
|
self | ) |
|
Get list of all visible messages.
- Returns
- visible_messages list
◆ hideMessageById()
def UM.Application.Application.hideMessageById |
( |
|
self, |
|
|
|
message_id |
|
) |
| |
Hide message by ID (as provided by built-in id function)
- Parameters
-
◆ run()
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
-
◆ setBackend()
def UM.Application.Application.setBackend |
( |
|
self, |
|
|
|
backend |
|
) |
| |
Set the backend of the application (the program that does the heavy lifting).
- Parameters
-
◆ setRequiredPlugins()
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 |
The documentation for this class was generated from the following file: