Uranium
Application Framework
|
▼NUM | This is the main library for Uranium applications |
▶NApplication | |
CApplication | Central object responsible for running the main event loop and creating other central objects |
▶NBackend | |
▶NBackend | |
CBackend | Base class for any backend communication (separate piece of software) |
CBackendState | The current processing state of the backend |
▶NSignalSocket | |
CSignalSocket | A small extension of an Arcus socket that emits queued signals when socket events happen |
▶NColorGenerator | |
CColorGenerator | Very simple class filled with a bunch of colours that are chosen thusly that they are easily distinguishable for humans |
▶NController | |
CController | Glue class that holds the scene, (active) view(s), (active) tool(s) and possible user inputs |
▶NDecorators | |
CInvalidOverrideError | Raised when the override decorator does not find the function it claims to override |
▶NEvent | |
CCallFunctionEvent | Event used to call a function |
CKeyEvent | Event regarding the keyboard |
CMouseEvent | Mouse Event class |
CToolEvent | Tool related event class |
CViewEvent | View related event class |
CWheelEvent | Event relating to what's happening with the scroll wheel of a mouse |
▶NExtension | |
CExtension | Base class for plugins that extend the functionality of Uranium |
▶NFileHandler | |
▶NFileHandler | |
CFileHandler | Central class for reading and writing meshes |
▶NFileWriter | |
CFileWriter | Base class for writer objects |
▶NReadFileJob | |
CReadFileJob | A Job subclass that performs file loading |
▶NWriteFileJob | |
CWriteFileJob | A Job subclass that performs writing |
▶Ni18n | |
Ci18nCatalog | Wraps a gettext translation catalog for simplified use |
▶NInputDevice | |
CInputDevice | Abstract base class for all input devices (Human Input Devices) Examples of this are mouse & keyboard |
▶NJob | |
CJob | Base class for things that should be performed in a thread |
▶NJobQueue | |
C_Worker | Internal |
CJobQueue | A thread pool and queue manager for Jobs |
▶NLockFile | |
CLockFile | Manage a lock file for reading / writing in a directory |
▶NLogger | |
CLogger | Static class used for logging purposes |
CLogOutput | Abstract base class for log output classes |
▶NMath | |
▶NAxisAlignedBox | |
CAxisAlignedBox | Axis aligned bounding box |
▶NColor | |
CColor | An RGBA color value |
▶NFloat | |
CFloat | Class containing helper functions for dealing with IEEE-754 floating point numbers |
▶NLineSegment | |
CLineSegment | Represents a line segment in 2D |
▶NMatrix | |
CMatrix | This class is a 4x4 homogeneous matrix wrapper around numpy |
▶NPlane | |
CPlane | Plane representation using normal and distance |
▶NPolygon | |
CPolygon | A class representing an immutable arbitrary 2-dimensional polygon |
▶NQuaternion | |
CQuaternion | Unit Quaternion class based on numpy arrays |
▶NVector | |
CVector | Simple 3D-vector class based on numpy arrays |
▶NVector2 | |
CVector2 | Simple 2D-vector class based on numpy arrays |
▶NMesh | |
▶NMeshBuilder | |
CMeshBuilder | Builds new meshes by adding primitives |
▶NMeshData | |
CMeshData | Class to hold a list of verts and possibly how (and if) they are connected |
▶NMeshFileHandler | |
CMeshFileHandler | Central class for reading and writing meshes |
▶NMeshWriter | |
CMeshWriter | Base class for mesh writer objects |
▶NReadMeshJob | |
CReadMeshJob | A Job subclass that performs mesh loading |
▶NVertex | |
CVertex | A vertex with a position and a normal |
▶NWriteMeshJob | |
CWriteMeshJob | A Job subclass that performs mesh writing |
▶NMessage | |
CMessage | Class for displaying messages to the user |
▶NMimeTypeDatabase | |
CMimeType | Simple value type class that encapsulates MIME type data |
CMimeTypeDatabase | Handles lookup of MIME types for files with support for custom MIME types |
CMimeTypeNotFoundError | Raised when a MIME type can not be found |
▶NOperations | |
▶NAddSceneNodeOperation | |
CAddSceneNodeOperation | Operation that adds a new node to the scene |
▶NGroupedOperation | |
CGroupedOperation | An operation that groups several other operations together |
▶NLayFlatOperation | |
CLayFlatOperation | Operation that lays a mesh flat on the scene |
▶NMirrorOperation | |
CMirrorOperation | Operation that mirrors a scene node |
▶NOperation | |
COperation | Base class for operations that should support undo and redo |
▶NOperationStack | |
COperationStack | A stack of operations |
▶NRemoveSceneNodeOperation | |
CRemoveSceneNodeOperation | An operation that removes a SceneNode from the scene |
▶NRotateOperation | |
CRotateOperation | Operation that rotates a scene node |
▶NScaleOperation | |
CScaleOperation | Operation that scales a scene node, uniformly or non-uniformly |
▶NScaleToBoundsOperation | |
CScaleToBoundsOperation | Operation subclass that will scale a node to fit within the bounds provided |
▶NSetTransformOperation | |
CSetTransformOperation | Operation that translates, rotates and scales a node all at once |
▶NTranslateOperation | |
CTranslateOperation | An operation that moves a scene node |
▶NOutputDevice | |
▶NOutputDevice | |
COutputDevice | Base class for output devices |
▶NOutputDeviceError | |
CDeviceBusyError | The device is busy and cannot accept write requests at the moment |
CPermissionDeniedError | Permission was denied when trying to write to the device |
CUserCanceledError | The user canceled the operation |
CWriteRequestFailedError | Base class for error raised by OutputDevice::requestWrite() |
▶NOutputDeviceManager | |
COutputDeviceManager | Manages all available output devices and the plugin objects used to create them |
▶NOutputDevicePlugin | |
COutputDevicePlugin | Base class for output device plugins |
▶NPlatform | |
CPlatform | Convenience class to simplify OS checking and similar platform-specific handling |
▶NPluginError | |
CInvalidMetaDataError | Raised when a plugin provides incorrect metadata |
CPluginError | A general class for any error raised by a plugin |
CPluginNotFoundError | Raised when a plugin could not be found |
▶NPluginObject | |
CPluginObject | Base class for objects that can be provided by a plugin |
▶NPluginRegistry | |
CPluginRegistry | A central object to dynamically load modules as plugins |
▶NPreferences | |
CPreferences | Preferences are application based settings that are saved for future use |
▶NQt | |
▶NBindings | |
▶NMainWindow | |
CMainWindow | QQuickWindow subclass that provides the main window |
▶NOpenGLContextProxy | |
COpenGLContextProxy | Expose OpenGLContext functions to qml |
▶NOutputDevicesModel | |
COutputDevicesModel | A list model providing a list of all registered OutputDevice instances |
▶NStageModel | |
CStageModel | The StageModel is a representation of all stages in QML |
▶NDuration | |
CDuration | A class representing a time duration |
▶NListModel | |
CListModel | Convenience base class for models of a list of items |
▶NQtApplication | |
C_QtFunctionEvent | Internal |
CQtApplication | Application subclass that provides a Qt application object |
▶NQtKeyDevice | |
CQtKeyDevice | In between class that converts QT key events to Uranium events |
▶NQtMouseDevice | |
CQtMouseDevice | An InputDevice subclass that processes Qt mouse events and returns a UM.Event.MouseEvent |
▶NQtRenderer | |
CQtRenderer | A Renderer implementation using PyQt's OpenGL implementation to render |
▶NResources | |
CResources | Class to look up any form of resource used by Uranium or an application using Uranium |
▶NSaveFile | |
CSaveFile | A class to handle atomic writes to a file |
▶NScene | |
▶NCamera | |
CCamera | A SceneNode subclass that provides a camera object |
▶NIterator | |
▶NIterator | |
CIterator | Abstract iterator class |
▶NPlatform | |
C_LoadPlatformJob | Protected class that ensures that the mesh for the machine platform is loaded |
CPlatform | Platform is a special case of Scene node |
▶NScene | |
CScene | Container object for the scene graph |
▶NSceneNode | |
CSceneNode | A scene node object |
▶NSceneNodeDecorator | |
CSceneNodeDecorator | The point of a SceneNodeDecorator is that it can be added to a SceneNode, where it then provides decorations Decorations are functions of a SceneNodeDecorator that can be called (except for functions already defined in SceneNodeDecorator) |
▶NSelection | |
CSelection | This class is responsible for keeping track of what objects are selected It uses signals to notify others of changes in the selection It also has a convenience function that allows it to apply a single operation to all selected objects |
▶NToolHandle | |
CToolHandle | A tool handle is a object in the scene that gives queues for what the tool it is 'paired' with can do |
▶NSettings | |
▶NContainerProvider | |
CContainerProvider | This class serves as a database for containers |
▶NContainerQuery | |
CContainerQuery | Wrapper class to perform a search for a certain set of containers |
▶NContainerRegistry | |
CContainerRegistry | Central class to manage all setting providers |
▶NContainerStack | |
CContainerStack | A stack of setting containers to handle setting value retrieval |
▶NDefinitionContainer | |
CDefinitionContainer | A container for SettingDefinition objects |
▶NInstanceContainer | |
CInstanceContainer | A container for SettingInstance objects |
▶NInterfaces | |
CContainerInterface | Shared interface between setting container types |
CContainerRegistryInterface | Shared interface between setting container types |
▶NModels | |
▶NContainerPropertyProvider | |
CContainerPropertyProvider | This class provides the value and change notifications for the properties of a single setting |
▶NContainerStacksModel | |
CContainerStacksModel | Model that holds container stacks |
▶NDefinitionContainersModel | |
CDefinitionContainersModel | Model that holds definition containers |
▶NInstanceContainersModel | |
CInstanceContainersModel | Model that holds instance containers |
▶NSettingDefinitionsModel | |
CSettingDefinitionsModel | Model that provides a flattened list of the tree of SettingDefinition objects in a DefinitionContainer |
▶NSettingPropertyProvider | |
CSettingPropertyProvider | This class provides the value and change notifications for the properties of a single setting |
▶NPropertyEvaluationContext | |
CPropertyEvaluationContext | Context for evaluating a property value It contains: |
▶NSettingDefinition | |
CDefinitionPropertyType | Type of definition property |
CSettingDefinition | Defines a single Setting with its properties |
▶NSettingFunction | |
CSettingFunction | Encapsulates Python code that provides a simple value calculation function |
▶NSettingInstance | |
CInstanceState | The state of the instance |
CSettingInstance | Encapsulates all state of a setting |
▶NSettingRelation | |
CRelationType | The type of relation, i.e |
CSettingRelation | A representation of a relationship between two settings |
▶NValidator | |
CValidator | Validates that a SettingInstance's value is within a certain minimum and maximum value |
▶NSignal | |
CSignal | Simple implementation of signals and slots |
CSignalEmitter | Convenience class to simplify signal creation |
CWeakImmutableList | Minimal implementation of a weak reference list with immutable tendencies |
CWeakImmutableListIterator | Iterator wrapper which filters out missing values |
CWeakImmutablePairList | A variation of WeakImmutableList which holds a pair of values using weak refernces |
▶NSortedList | |
CSortedList | |
CSortedListWithKey | |
▶NStage | |
CStage | Stages handle combined views in an Uranium application |
▶NTool | |
CTool | Abstract base class for tools that manipulate (or otherwise interact with) the scene |
▶NVersionUpgrade | |
CFormatException | An exception to throw if the formatting of a file is wrong |
CInvalidVersionException | An exception to throw if the version number of a file is wrong |
CVersionUpgrade | A type of plug-in that upgrades the configuration from an old file format to a newer one |
▶NVersionUpgradeManager | |
CVersionUpgradeManager | Regulates the upgrading of configuration from one application version to the next |
▶NView | |
▶NCompositePass | |
CCompositePass | A RenderPass subclass providing the final composition render |
▶NDefaultPass | |
CDefaultPass | A render pass subclass that renders everything with the default parameters |
▶NGL | |
▶NFrameBufferObject | |
CFrameBufferObject | An interface for OpenGL FrameBuffer Objects |
▶NOpenGL | |
▶COpenGL | Convenience methods for dealing with OpenGL |
CVendor | Different OpenGL chipset vendors |
▶NShaderProgram | |
CInvalidShaderProgramError | Raised when an error occurs during loading of the shader file |
CShaderProgram | An abstract class for dealing with shader programs |
▶NTexture | |
CTexture | A class describing the interface to be used for texture objects |
▶NRenderBatch | |
▶CRenderBatch | The RenderBatch class represent a batch of objects that should be rendered |
CBlendMode | Blending mode |
CRenderMode | The mode to render objects in |
CRenderType | The type of render batch |
▶NRenderer | |
CRenderer | Abstract base class for different rendering implementations |
▶NRenderPass | |
CRenderPass | Base class for a rendering pass |
▶NSelectionPass | |
CSelectionPass | A RenderPass subclass responsible for rendering selectable objects to a texture |
▶NView | |
CView | Abstract base class for view objects |
▶NWorkspace | |
▶NWorkspaceFileHandler | |
CWorkspaceFileHandler | Central class for reading and writing workspaces |