Editor API
UnigineEditor public API
Editor Namespace Reference

Namespaces

 Internal
 
 Utils
 

Classes

class  Action
 This basic class is used to represent any possible user action. More...
 
class  AssetCreateMenuContext
 
class  AssetCreatorRegistry
 
class  AssetDialogs
 This class is used to represent a standard asset dialog of the UnigineEditor that can be used for opening and saving assets. More...
 
class  AssetManager
 This 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. More...
 
class  Controls
 
class  CreateNodesAction
 This class is used to represent any user's action creating nodes. More...
 
class  EnableNodeAction
 This class is used to represent any user's action changing node's enabled state. More...
 
class  EngineGuiWindow
 This 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. More...
 
class  IndexList
 This 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. More...
 
class  MenuBase
 
class  NewSelection
 
class  PlacementTools
 
class  Plugin
 This class is used for plugin interface implementation when creating Editor plugins. It is a base class for all Editor plugins. More...
 
struct  PluginDependency
 Defines dependency on a plugin. More...
 
class  PluginInfo
 This 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). More...
 
class  PluginManager
 The Editor::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.
More...
 
class  RemoveNodesAction
 This class is used to represent any user's action removing nodes. More...
 
class  RenameNodeAction
 This class is used to represent any user's action changing node's name. More...
 
class  RenderWindow
 This 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. More...
 
class  ReparentNodesAction
 This class is used to represent any user's action changing nodes parents. More...
 
class  Selection
 
class  SelectionAction
 This class is used to represent any user's selection action. More...
 
class  Selector
 
class  SelectorGUIDs
 Selector for GUIDs-based items (materials, properties, runtimes). An item of this type is associated with a file referred to via a GUID. More...
 
class  SelectorNodes
 This class is used to manage selected nodes along with their subobjects (such as surfaces, shapes, joints, billboards, etc.). More...
 
class  SetNodeTransformAction
 This class is used to represent any user's action setting node transforms. More...
 
class  SettingManager
 
class  SettingsParameters
 
class  Undo
 Undo manager class. This class is used to manage undo/redo operations for user actions in the Editor. More...
 
class  UserSettings
 
class  ViewportManager
 Viewport manager class. This class is used to create, manage, and remove all viewports in the Editor. More...
 
class  WindowManager
 Window manager class. This class is used to manage tool windows in the Editor. More...
 

Typedefs

using ViewportWindowId = ViewportWindow *
 

Enumerations

enum  SelectorType {
  SELECTOR_NODES = 0, SELECTOR_MATERIALS, SELECTOR_PROPERTIES, SELECTOR_RUNTIMES,
  SELECTOR_USER = 0x0100
}
 Selector type, defines the type of selected entities. The first 256 types are reserved by UNIGINE, user selector types start from SELECTOR_USER + i (256 and higher). More...
 

Typedef Documentation

◆ ViewportWindowId

using Editor::ViewportWindowId = typedef ViewportWindow *

Enumeration Type Documentation

◆ SelectorType

Selector type, defines the type of selected entities. The first 256 types are reserved by UNIGINE, user selector types start from SELECTOR_USER + i (256 and higher).

Enumerator
SELECTOR_NODES 

Nodes selector.

SELECTOR_MATERIALS 

Materials selector.

SELECTOR_PROPERTIES 

Properties selector.

SELECTOR_RUNTIMES 

Runtimes selector.

SELECTOR_USER 

Beginning of the range of user-defined types. Types are referred to as SELECTOR_USER+0, SELECTOR_USER+1...