UnigineEditor
Interface Overview
Assets Workflow
Settings and Preferences
Adjusting Node Parameters
Setting Up Materials
Setting Up Properties
Landscape Tool
Using Editor Tools for Specific Tasks
FAQ
Programming
Fundamentals
Setting Up Development Environment
Usage Examples
UnigineScript
C++
C#
UUSL (Unified UNIGINE Shader Language)
File Formats
Rebuilding the Engine and Tools
GUI
Double Precision Coordinates
API
Containers
Common Functionality
Controls-Related Classes
Engine-Related Classes
Filesystem Functionality
GUI-Related Classes
Math Functionality
Node-Related Classes
Networking Functionality
Pathfinding-Related Classes
Physics-Related Classes
Plugins-Related Classes
CIGI Client Plugin
Rendering-Related Classes

Migrating to Unigine from Unity

This section gives a brief overview of UNIGINE from a Unity user's perspective and provides basic information to help you transfer your Unity experience to UNIGINE.

Editor Interface#

Below you can see interfaces of the Unity Editor and UnigineEditor. Interface elements in the images are color-coded to indicate common functionality. Each element has a label to show UNIGINE's equivalent. The layout of UnigineEditor is fully customizable by resizing, dragging and dropping the tabbed windows.

Unity and Unigine Editor UI Comparison (click to enlarge)

Unity and Unigine Editor UI Comparison

To learn more about the UnigineEditor interface, read this article.

Scene#

The concept of the Scene in both engines is the same. However, Unity3D and UNIGINE use different coordinate systems.

UnityUNIGINE

Unity Coordinate System (left-handed)

Unity uses a left-handed coordinate system where the vertical direction is usually represented by the +Y axis.

Axes and Directions:

  • X — right (+), left (-)
  • Y — up (+), down (-)
  • Z — forwards (+), backwards (-)

Positive rotation angle sets the rotation clockwise.

File format: *.scene

UNIGINE Coordinate System (right-handed)

UNIGINE uses a right-handed coordinate system where the vertical direction is usually represented by the +Z axis.

Axes and Directions:

  • X — right (+), left (-)
  • Y — forwards (+), backwards (-)
  • Z — up (+), down (-)

Positive rotation angle sets the rotation counterclockwise.

File format: *.world

Loading a Scene#

  • In Unity you would use:
    Source code
    SceneManager.LoadScene("YourSceneName",LoadSceneMode.Single);
  • In UNIGINE you should use:
    Source code (C++)
    Console::get()->run("world_load YourSceneName");

Scene Objects#

This section gives a brief description of basic scene objects in both engines as well as their basic similarities and differences.

UnityUNIGINE

Basic scene object — GameObject.

GameObjects are containers for all other Components. Every GameObject has the Transform component by default.

Components add functionality to the GameObject.

GameObjects can be organized into a hierarchy (parent-child relation).

Node is a basic type from which all types of scene objects are inherited. Some of them appear visually: Objects, Decals, and Effects — they all have surfaces to represent their geometry (mesh), while others (Light Sources, Players, etc.) are invisible.

Basic functionality of a node is determined by its type. Additional functionality can be added using properties and the custom component system.

Each node has a transformation matrix, which encodes its position, rotation, and scale in the world.

Nodes can be organized into a hierarchy (parent-child relation).

Notice
All scene objects added to the scene regardless of their type are called nodes.

Quick Glossary#

This chapter matches common Unity terms on the left and their UNIGINE equivalents (or rough equivalent) on the right. UNIGINE keywords are linked directly to related articles to provide you with more in-depth information.

CategoryUnityUNIGINE
Editor UIHierarchy PanelWorld Hierarchy window
InspectorParameters window
Project BrowserAsset Browser window
Scene ViewScene Viewport
SceneSceneWorld
Gameplay TypesComponentCustom Component System (Properties + Code)
GameObjectNode
PrefabNodeReference
MeshesMeshStatic Mesh, Dynamic Mesh
Skinned MeshSkinned Mesh
EffectsParticles EffectParticle System
Game UIUIGUI
MaterialsShaderBase Material
MaterialUser Material
ProgrammingC#C++ / C#
ScriptUnigineScript
PhysicsRaycastgetIntersection
Rigid BodyRigid Body
ColliderShape
JointJoint
AnimationTimelineTracker

Projects and Files#

Directories and Files#

A project in UNIGINE, just like a Unity project, is stored in its own folder, project settings are stored in the *.project file. There are various subfolders inside the project's folder, where your content and source files as well as various configuration files and binaries are stored. The most important are the data and source sub-folders.

In UNIGINE, each project has a data folder. Similar to a Unity project's Assets folder, this is where your project's assets are stored. To import assets into your project, simply drop files into your project's data directory and they will be automatically imported and appear in the Asset Browser. The assets in the editor will update automatically as you make changes to the files using an external program.

Bringing Your Assets from Unity#

Meshes

You can import an asset you used in Unity to Unigine if you have it as an FBX model. While importing the FBX model to Unigine, check the required import options depending on the model.

Materials

Similar to other engines, Unigine works with PBR materials. Moreover, Unigine supports both Metalness and Specular workflows and has a rich out-of-the-box library of materials that can be used to create almost any material. Therefore, materials created for the model in Unity can be re-created in Unigine using mesh_base material, the base material in Unigine used for physically based materials.

Textures

Textures can be imported as a part of a model or separately and then applied to a mesh. To import textures, you might have to do some adjustments in advance. For example, the shading texture in Unigine stores the metalness, roughness, specular, and microfiber maps in its corresponding channels, so you need to modify the texture using third-party software, such as GIMP or Photoshop, and then import it to Unigine.

To import the normal texture, you should invert the G channel. This can be done while importing the texture (or even later) by using the Invert G Channel setting.

Animations

You can import an animated model you used in Unity to Unigine if you have it as an FBX model. While importing the FBX model, enable the Import Animations option and finetune the import using additional options.

For more details, see import recommendations.

Supported File Types#

Unity supports a wide range of file formats, while UNIGINE supports the ones most commonly used.

Project Assembly#

In Unity you got used to assembling your projects via the editor. In UNIGINE all projects are managed via the specialized tool called SDK Browser.

To learn more about creating a release build of your project, please follow the link below:

Key Concepts#

Game Logic#

Game logic in a Unity project is implemented via Script components. You got used to determine GameObject's behavior by writing event functions like Start(), Update(), etc.

UNIGINE has quite a similar concept. Each component has a set of functions (init(), update(), etc.), that are called by the corresponding functions of the Engine's main loop. Thus, you implement logic by writing your code inside the init(), update(), etc. In UNIGINE, you can do it either for each component individually, like in Unity, or for the whole application.

To learn more about the execution sequence and how to build components, please follow the links below:

Prefabs#

The workflow in Unity is based on prefabs. It is usual for you to assemble a complex object from GameObjects with certain components and properties and create a prefab from such object. Prefabs can then be placed in your world via Editor, or instantiated at run time.

UNIGINE's workflow is based on Node References that are very similar to prefabs. In order to make a complex object to be instanced in your world, you just build the desired hierarchy from nodes, assign materials and properties to them, and save it as a Node Reference. Then you can use this node reference as many times as necessary and, just like with the prefabs, modify the node reference by changing any of its instances.

Notice
Node References support nesting, so you can build complex hirarchies easily!

To learn more about creating Node References and managing them, please follow the link below:

Last update: 2019-04-04