Editor API
UnigineEditor public API
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
 NUnigineEditor
 CActionThis basic class is used to represent any possible user action
 CAssetDialogsThis class is used to represent a standard asset dialog of the UnigineEditor that can be used for opening and saving assets
 CSelectedAssetStructure representing an asset selected in the dialog
 CAssetManagerThis class is used to manage assets in the Editor. You can check if an asset with the specified GUID exists, get its file path, or subscribe for signals to perform certain actions when an asset is added, moved, updated, or deleted. AssetManager extends the functionality of UNIGINE's File System, being based on it. It performs operations itself while controlling the File System. Paths and GUIDs used for Unigine::FileSystem can be used for UnigineEditor::AssetManager as well. All paths returned by the AssetManager (via getAssetPaths, getDirectoryPaths, etc.) are virtual
 CCollectionThis class is used to represent a collection of values (boolean, integer, float, or string) that can represent a set of import parameters for an asset
 CCreateNodesActionThis class is used to represent any user's action creating nodes
 CEnableNodeActionThis class is used to represent any user's action changing node's enabled state
 CEngineGuiWindowThis class is used to represent a window widget to which an image can be rendered by the Engine with inputs handling by the Engine GUI. For example, to create a curve or a node graph editor of your own. By default EngineGuiWindow creates a Controls exclusive context to process mouse and keyboard events for this window exclusively, without sending them to the common Editor's Controls handling system
 CIndexListThis class represents a list of indices of selected subitems of a selected node. When an object is selected, some of its surfaces or collision shapes can also be selected, the index list shall contain indices for all of them grouped by type
 CLandscapeMapImportParametersThis class is used to manage import parameters for Landscape Layer Map assets(.lmap)
 CMountPointParametersThis class is used to manage parameters of mount points, such as access, path, filters. Mount points are used to extend the Engine's file system. Mount point is a sort of a symlink enabling you to extend the virtual file system of your project by adding any external folders and packages to the "data" directory
 CPluginThis class is used for plugin interface implementation when creating Editor plugins. It is a base class for all Editor plugins
 CPluginDependencyDefines dependency on a plugin
 CPluginInfoThis class it is responsible for plugin loading/unloading and contains all necessary plugin metadata (name, version, dependencies, etc.). It can also be used to check the current plugin state and get information on errors (if any)
 CPluginManagerThe UnigineEditor::PluginManager is the main controller class of the Plugin System, it is responsible for:

  • Locating dynamic libraries in folders specified by the user.
  • Plugins initialization their lifecycle management and destruction via the instances of PluginInfo class.
  • Building plugins loading queue, as the order in which the plugins are loaded is important. If a plugin has a required dependency it expects for certain symbols to be loaded.
  • Providing the user with information on plugins. Currently used to build target UI in the Editor.
 CRemoveNodesActionThis class is used to represent any user's action removing nodes
 CRenameNodeActionThis class is used to represent any user's action changing node's name
 CRenderWindowThis class is used to represent a window widget to which an image can be rendered by the Engine. For example, to render node or texture previews, frame sequences, etc
 CReparentNodesActionThis class is used to represent any user's action changing nodes parents
 CSelectionActionThis class is used to represent any user's selection action
 CSelectorGUIDsSelector for GUIDs-based items (materials, properties, runtimes). An item of this type is associated with a file referred to via a GUID
 CSelectorNodesThis class is used to manage selected nodes along with their subobjects (such as surfaces, shapes, joints, billboards, etc.)
 CSubItemListThis class represents a list of selected subitems of a selected node. When an object is selected, some of its surfaces or collision shapes can also be selected, the subitems list shall contain all of them
 CSetNodeTransformActionThis class is used to represent any user's action setting node transforms
 CUndoUndo manager class. This class is used to manage undo/redo operations for user actions in the Editor
 CViewportManagerViewport manager class. This class is used to create, manage, and remove all viewports in the Editor
 CWindowManagerWindow manager class. This class is used to manage tool windows in the Editor