Documentation/Articles/Overview of Resource Editor

From NeoAxis 3D Engine Wiki

Jump to: navigation, search
Go to higher level

Contents

Description

ResourceEditorIcon.jpg Resource Editor (ResourceEditor.exe) is a tool you will use to manage the resources of your project. The tool is intended to configure 3D models, materials, textures, physics models, game objects, graphic user interfaces and more.

ResourceEditor 001.jpg

All of the resources are located in the Data folder of the project, each represented by a single file. Resources are divided into the following types:

  • types of objects — .type;
  • 3D models — .mesh;
  • physical models — .physics;
  • material — .highMaterial;
  • texture — .dds, .jpg, .png, .tga, .bmp, .hdr and more;
  • interfaces — .gui;
  • particle system — .particle;
  • font description — .fontDefinition;
  • sounds — .ogg, .wav;
  • video — .ogv, .ogg;
  • сonfiguration files to import 3D models — .modelImport.

General View

Editor window includes the following parts:

  1. Top panel - menu and toolbar.
  2. Resources window - the resources tree.
  3. Properties window - the properties of the selected objects.
  4. Workspace - a window for editing objects using visual tools.
ResourceEditor 002.jpg

Working with Editor

Resource Editor is a set of specialized editors, created for work with different resources. Thus the managing editors, involving workspace, remains a single.

Camera Control

In addition to the usual mode of the camera, the editor has a free camera mode. To enable free camera, you can use the corresponding items menu Edit or buttons on the toolbar. Camera mode is selected separately for viewing and editing resource.

Camera Сontrol in Usual Mode

Use the following keys for navigation in the editor's workspace:

  • W - turn the camera down,
  • A - turn the camera left,
  • S - turn the camera up,
  • D - turn the camera to the right,
  • Q - the approach of the camera,
  • E - the removal of the camera.

Pressing and holding the Shift allows you to rotate the camera faster.

When pressing right mouse button camera follows the cursor. When scrolling wheel camera gets closer or moves away.

Camera Control in Free Mode

Use the following keys for navigation in the editor:

  • W - move forward,
  • A - move left,
  • S - move backwards,
  • D - move right,
  • Q - move up,
  • E - move down.

Pressing and holding Shift allows you to move around the map faster.

When pressing right mouse button camera follows the cursor. The camera is fixed at one point. When pressing the middle mouse button and moving the mouse, camera moves in corresponding direction, analogous to the buttons A and D. When moving the mouse up-and-down, the camera moves up and down, analogous to the key Q and E. The camera looks directly and doesn't rotate.

Transformation Tool (Gizmo)

Such elements as attached objects in the object type editor, bodies in the physics model editor, particle sources in the particle system editor, mesh sources in model import editor have such characteristics as position, rotation and scale. These parameters define placement of the object in space. To edit these properties you can use the corresponding fields in the map object properties — Position, Rotation and Scale. But editing spatial placement of objects is much more convenient by visual means. That is what the transformation tool is for.

ResourceEditor 039.jpg

Each of three characteristics of an object is controlled by its own transformation tool:

ResourceEditor 040.jpg

You can choose the tools on the toolbar or in the Edit menu.

Before placement of some object or objects can be changed, this object objects must first be selected. Object selection works with the chosen transformation tool too, so you can first select a transformation tool and then select an object.

Position

ResourceEditor 041.jpg

The position transformation tool allows changing position of the object as specified by the Position property of the map object. This tool is represented with three orthogonal axes — X, Y, Z.

ResourceEditor 042.jpg

To change one of object position components (X, Y or Z) you should hold the left mouse button over the coresponding axis and drag to an appropriate side. When the component is changed, release the mouse button.

ResourceEditor 043.jpg

By pointing the cursor to one of the edges formed by a pair of the transformation tool axes and by dragging it you can change two components of the object placement simultaneously.

On the toolbar there are additional object movement options:

  • Movement Snapping — change position with the given step,
  • Move Objects Using Local Coordinates — us local coordinates when moving the object.

You can get thorough information about these buttons in the toolbar section.

Rotation

ResourceEditor 044.jpg

The rotation transformation tool allows changing rotation angle of the object as specified in the Rotation property of the map object. This tool is a sphere made of three circles each corresponding to one of coordinate axes. There is also one mor circle in the rotation tool lying in a plane that is orthogonal to the camera direction.

ResourceEditor 045.jpg

To rotate the object around one of the axes (X, Y or Z), drag the corresponding sphere of the transformation tool.

ResourceEditor 046.jpg

The additional circle orthogonal to the camera direction is colored in gray. By dragging it you can change the rotation angle of the object around the current camera direction axis.

ResourceEditor 047.jpg

Also, you can rotate the object around multiple axes. To do this, point the mouse cursor to the circle in the central part of the transformation tool and drag it.

The toolbar offers additional options to rotate objects:

  • Rotation Snapping — change rotation angle with the given step,
  • Move Objects Using Local Coordinates — use local coordinates when rotating the object ,
  • Move Objects During Rotation — move objects when a group of objects is rotated.

You can learn more about these buttons in the toolbar section.

Scale

ResourceEditor 048.jpg

The scale transformation tool allows changing object scale as specified by the Scale property. This tool is represented as three orthogonal axes — X, Y, Z.

ResourceEditor 049.jpg

To change one of components of the object's scale (X, Y или Z) drag the corresponding axis of the transformation tool.

ResourceEditor 050.jpg

All axes of the transformation tool are connected in twos. By fraggin the edge, you can change two components of the scale simultaneously.

ResourceEditor 051.jpg

Also, by dragging the triangle in the central part of the transformation tool you can modify the scale of the object symmetrically along all three axes.

The toolbar offers additional options to scale objects:

  • Scaling Snapping — change scale with the given step,
  • Move Objects During Scaling — move objects when a group of objects is scaled.

You can learn more about these buttons in the toolbar section.

Menu

Name Description
New Create new resource.
Import 3D Models... Fast import 3D models, read more here .
Edit Switch to edit mode of the resource.
Close Editing Exit edit mode.
Save Save resource.
Reload Resource Editor Reload Resource Editor.
Exit Exit editor.
ResourceEditor 003.jpg



Name Description
Undo Undo the last action.
Redo Redo the undone action.
Select Enable selection of objects.
Move Enable mode of selecting and moving objects. You can move objects with the transformation tool in this mode.
Rotate Enable mode of selecting and rotating objects. You can rotate an object with the transformation tool in this mode.
Scale Enable mode of selecting and scaling objects. You can scale an object with the transformation tool in this mode.
Movement Snapping Enable/disable step mode of moving objects. Movement is accomplished by fixed pitch. The step is specified in options.
Rotation Snapping Enable/disable step mode of rotating objects. Rotation is accomplished by fixed pitch. The step is specified in options.
Scaling Snapping Enable/disable step mode of scaling objects. Scale is accomplished by fixed pitch. The step is specified in options.
Move Objects Using Local Coordinates Enable/disable a mode of movement and rotation of objects in local coordinates of object. The direction of the axes of the tool transforming objects will be in the local coordinates of the object, instead of the world coordinates in this mode.
Move Objects During Rotation Enable/disable moving objects during rotation. If this option is selected, the rotation group of selected objects is relative to the center of the group. It means changing the coordinates of objects. If the option is disabled, then rotation of each object in the selected group is relatively own center facility. Thus, the coordinates of the objects remain unchanged.
Move Objects During Scaling Enable/disable moving objects while scaling. If this option is selected, the scale has the infuence both on the objects of the selected group and on their position relative to the group center. If the option is disabled, scaling coordinates of the selected objects is not performed.
Clone Clone selected objects.
Delete... Delete selected objects.
Free Camera Mod For Viewing Enable/disable mode of free camera when viewing the resources.
Free Camera Mod For Editing Enable/disable mode of free camera when editing resources.
ResourceEditor 004.jpg


Name Description
Resources Window Show/Hide tree resources.
Properties Window Show/Hide Properties window.
Output Window Show/hide output window.
Reset Window Settings Reset settings window.
Toolbar Set the position of the toolbar. It is proposed to place the panel at the top, bottom, left, right, or remove the panel.
Status Bar Show/hide the status bar.
Full Screen Mode Switch on full screen mode.
ResourceEditor 005.jpg


Name Description
Example of Add-on Creation Example of the addition to the editor.
ResourceEditor 007.jpg


Name Description
Open Map Editor Open Map Editor.
Run Simulation Start a simulation. Opens Game.exe. You can specify startup parameters in the settings.
Options... Open the editor options.
ResourceEditor 008.jpg



Name Description
Overview of Resource Editor Open the resource editor, i.e. this article.
Documentation Open the title page of the documentation.
About... Open "About" window.
ResourceEditor 009.jpg


Toolbar

ResourceEditor 010.jpg
Name Description
1. Import 3D models Fast Import 3D models.
2. New Folder Create a new directory.
3. New Resource Create a new resource.
4. Edit Edit resource.
5. Close Editing Close editing.
6. Save Save resource.
7. Undo Undo the last action.
8. Redo Redo the undone action.
9. Select Enable selection of objects.
10. Move Enable mode of selecting and moving objects. You can move objects with the transformation tool in this mode.
11. Rotate Enable mode of selecting and rotating objects. You can rotate objects with the transformation tool in this mode.
12. Scale Enable mode of selecting and scaling objects. You can scale objects with the transformation tool in this mode.
13. Movement Snapping Enable/disable step mode of moving objects. Movement is accomplished by fixed pitch. The step is specified in options.
14. Rotation Snapping Enable/disable step mode of rotating objects. Rotation is accomplished by fixed pitch. The step is specified in options.
15. Scaling Snapping Enable/disable step mode of scaling objects. Scale is accomplished by fixed pitch. The step is specified in options.
16. Move Objects Using Local Coordinates Enable/disable a mode of movement and rotation of objects in local coordinates of object. The direction of the axes of the tool transforming objects will be in the local coordinates of the object, instead of the world coordinates in this mode.
17. Move Objects During Rotation Enable/disable moving objects during rotation. If this option is selected, the rotation group of selected objects is relative to the center of the group. It means changing the coordinates of objects. If the option is disabled, then rotation of each object in the selected group is relatively own center facility. Thus, the coordinates of the objects remain unchanged.
18. Move Objects During Scaling Enable/disable moving objects while scaling. If this option is selected, the scale has the infuence both on the objects of the selected group and on their position relative to the group center. If the option is disabled, scaling coordinates of the selected objects is not performed.
19. Clone Clone selected objects.
20. Delete Delete selected objects.
21. Use Free Camera Mode for Viewing Enable/disable mode of free camera when viewing the resources.
22. Use Free Camera Mode for Editing Enable/disable mode of free camera when editing resources.
23. Options Open the editor options.
24. Reload Resource Editor Reload Resource Editor.
25. Open Map Editor Open Map Editor.
26. Run Simulation Start a simulation. Opens Game.exe. You can specify startup parameters in the settings.

Resources Window

The tree of files and catalogs of the Data folder of the project is in the window resources. Resource is selected for viewing or editing in this window. Different types of resources are arranged in folders. When developing the project, we recommend the systematization of resource allocation. An alternative option is to create a separate folder for all project resources.

ResourceEditor 011.jpg

Context menu is available by pressing right mouse button for folders and resources:

ResourceEditor 012.jpg
Name Description
New Create a new resource in the selected directory.
Edit Edit resource.
Open in External Program Open a resource in an external program.
Cut Cut resource.
Copy Copy resource.
Delete Delete resource.
Rename Rename resource.
Sort by Sort the items of the resource tree.
Refresh Refresh resource tree.
Properties Open resource properties.


Editors

Each type of resource has a specialized editor. In other words, the resource editor is a collection of a variety of editors:

Object Type Editor

Object Type Editor is used to configure types of objects which will be placed in the map editor. Types of objects are stored in .type files.

Go to Object Type Editor

Editor of the objects


Physics Model Editor

Editor of the physical models is used to configure the behavior of physical objects. Physical model describes the properties of the object that will be used when calculating the simulation physics, collision, transformation. Physical models are stored in .physics files.

Go to Overview of Physics Model Editor

Physics Model Editor


Particle System Editor

Particle System Editor is created for effect settings. Particle systems are stored in .particle files.

Go to Overview of Particle System Editor

Particle System Editor


Editor of the Settings for 3D Models

Editor of the settings for 3D models is intended for setting created during the import 3D models. 3D models are stored in .mesh files. The Editor allows you to change the scale, move the center of the model, change materials, calculate levels of detail (LOD), customize the animation, which is stored in .skeleton files.

Go to Overview of Mesh Editor

Mesh Editor


Material Editor

Material Editor is intended for the settings of 3D models materials. Materials are stored in .highMaterial files.

Go to Overview of Material Editor

Material Editor


User Interface Editor

User Interface Editor is intended for the settings of the elements, the user interface screens project. User interfaces are stored in .gui files.

Go to Overview of User Interface Editor

User Interface Editor


Font Definition Editor

Font Definition Editor is intended for configuration of the display of fonts in the engine. Font descriptions are stored in .fontDefintion files.

Go to Overview of Font Definition Editor

Font Definition Editor


3D Model Import Editor

Model Import Editor is intended for import 3D models from other formats in the format of the engine. Import settings are stored in .modelImport files.

Go to Overview of Model Import Editor

Model Import Editor


Audio/Video Player

Audio and video files are played in this editor. Two operations are available For them in the window Properties:

  1. Button Play allows you to play the selected resource.
  2. Checkbox Loop Play allows you to loop the selected resource.

We recommend you to use the following formats .ogg for audio and .ogv for video. You can find more detailes about these formats here.

There is a special converter in the SDK engine for convertation video to the format .ogg which can be found in SDK\Tools\Video\ffmpeg2theora folder.

Audio/Video Player


Texture Viewer

Textures viewer allows you to view textures and convert them to other formats. You need to click on the texture in the resource box for convertation, right-click on the shortcut menu, select "Convert to...". Supported formats:

  • TGA,
  • JPG,
  • PNG,
  • DDS-TXT1,
  • DDS-TXT5,
  • DDS-3Dc (Normal Map),
  • DDS-(A)RGB.
Texture Viewer


Windows Editor Configuration

The editor allows you to configure the position of the Windows. If you want to move a window, you have to drag it in the right direction for the title, holding the left mouse button.

ResourceEditor 023.jpg

Editor Settings

The settings window can be opened through the menu item Tools. Settings are divided into several tabs.

General Settings

Tab General contains general settings of the editor.

Tab General
Option Description
General
General Background Color General background color of the editor.
Hide Directories And Files List of hidden directories and files. Directories and files from this list are displayed by gray color in a window of resources.
Show Splash Screen At Startup Enable/disable pop-up screen when loading the editor.
Sound Volume Sound Volume.
Lighting
Default Ambient Light The brightness of the light source. Set as the color.
Default Light Diffuse Color Color of the light source by default.
Default Light Direction Direction of the light source by default.
Default Light Specular Color Color reflection of the light source by default.
Run Simulation
Run Simulation Parameters The command line to run the simulation (Game.exe).
Viewport
Invert Mouse Wheel Enable/disable invert mouse wheel.
Max Frames Per Second In Active State Maximum frame rate in the active state of the editor.
Max Frames Per Second In Inactive State Maximum frame rate in the inactive state of the editor.

Setting of the User Interface Editor

You can cofigure the font editor in the tab User Interface.

Вкладка User Interface
Option Description
Fonts
The Font of Context Menu The font of context Menu.
The Font of Form The font of form.
The Font of Main Menu The font of main mnu.
The Font of Property Grid The font of property Grid.
The Font of Tree Control The font of tree Control.

Camera Settings

Tab Camera contains camera settings.

Tab Camera
Option Description
Keyboard
Keyboard Movement Fast Speed The speed of fast moving the camera (pressing Shift) when controlling by keyboard.
Keyboard Movement Speed Camera speed in normal mode when controlling by keyboard.
Keyboard Rotation Fast Speed Fast Rotation speed of the camera (pressing Shift) when controlling by keyboard.
Keyboard Rotation Speed Speed rotation of the canera in normal mode when controlling by keyboard.
Mouse
Mouse Movement Fast Sensitivity The sensitivity of the camera movement in the accelerated mode (pressing Shift) using mouse.
Mouse Movement Sensitivity The sensitivity of the camera rotation using mouse.
Mouse Rotation Horizontal Sensitivity The sensitivity of the camera rotation using mouse.
Mouse Rotation Vertical Sensitivity The sensitivity of the camera rotation using mouse.
Settings
Far Clip Distance The range of objects visibility.
Field of View Viewing angle.
Near Clip Distance The near distance of objects visibility. If the objects are closer of the specified radius, they are not displayed.

Settings of the Tranformation Tool

You can configure the parameters of the transformation tool of the objects in this tab Transform Gizmo

Tab Transform Gizmo
Option Description
General
Line Thickness The thickness of the lines.
Rotation Sensitivity Sensitivity during the rotation of the object.
Shadow Intensity Shadow intensity.
Size (pixels) Tool size (in pixels).
Snapping
Movement Snapping Step when moving an object (in metres).
Rotation Snapping (degrees) Step when you the object is rotated (in degrees).
Scale Snapping (%) Step when scaling an object (in percentage).