Jump to content


Photo

Documentation

World Editor

  • This topic is locked This topic is locked
6 replies to this topic

#1 gizmo

gizmo

    Administrator

  • Administrators
  • 785 posts
  • Location3DXChat

Posted 18 November 2017 - 06:32 PM

3DXChat World Editor Documentation
 

Table of Contents

 

Tutorials

 

Other


  • Chilles, Shanti, Pierrousss and 22 others like this

#2 gizmo

gizmo

    Administrator

  • Administrators
  • 785 posts
  • Location3DXChat

Posted 23 November 2017 - 11:37 AM

1 Introduction
This document explains how you can start using World Editor. It provides information about all the gizmo properties and system settings.
 
2 The Gizmos
In this chapter we will take a look at how the gizmos work and all the properties which can be modified for each gizmo. We will also talk about transform spaces and transform pivot points.
 
2.1 The Translation Gizmo
The translation gizmo allows you to move objects around in the scene. The following image shows a screen-shot of the translation gizmo:
 
01.jpg
 
2.1.1 Using The Translation Gizmo
If you click and drag one of the gizmo axis you will perform a translation along the corresponding gizmo axis. The gizmo also has a set of squares. Clicking and dragging one of the squares will allow you to perform a translation along 2 axes at once. If you hold down the SHIFT key, a square will be shown centered around the gizmo position. Clicking and dragging the mouse while the square is selected will perform a translation along the camera right and up axes. This is a little bit like performing a translation in screen space. Note: The move gizmo can be used to perform certain special operations, like the camera axes
translation discussed above or vertex snapping etc. When a special operation is being performed, a square will appear in the center of the gizmo. I will be referring to this as the special operation square or special op square for short.
 
2.1.1.1 Mesh Surface Placement
The move gizmo can be used to greatly speed up mesh surface placement. With it you can place an object (or collection of objects) on the surface of a mesh and also align the objects' axes to the surface normal.
Here are the shortcut keys that allow you to do this:

  • SPACE – the special op square will appear and if you left click the left mouse button inside the square and then drag while hovering a terrain/mesh, the object(s) and the gizmo will move along the terrain/mesh surface and the objects' Y axis will be aligned with the surface normal;
  • SPACE + X – same, but this time the X axis will be aligned with the surface normal;
  • SPACE + Z – same, but this time the Z axis will be aligned with the surface normal;
  • SPACE + LCTRL – with this combination the object(s)' positions will be snapped to the surface, but no axis alignment will be performed. Note: In this case, because no axis alignment is done for the bjects, the objects will most likely become embedded inside the surface because the system no longer knows how to offset the object accordingly since no reference axis is specified.

2.1.1.2 Grid Surface Placement
The move gizmo can also be used to place and align objects on the grid surface using the same combination of keys discussed previously. Note: Grid placement will only be performed if the hotkeys are active and if no terrain or mesh object is hovered by the mouse cursor.
 
2.1.1.3 Snapping
The translation gizmo supports 3 types of snapping: Step, Vertex Snapping and Box Snapping.
 
2.1.1.3.1 Step Snapping
Step snapping allows you to perform translations in increments of a specified step value. For example, if the step value is set to 1, this means that a translation is only performed when the accumulated translation amount is >= 1. In order to use step snapping, you have to keep the CTRL button pressed and then manipulate the gizmo as you would normally do (using the axes or the squares or pressing the SHIFT key to translate along the camera right and up axes).
 
2.1.1.3.2 Vertex to Vertex Snapping
Press the V key on the keyboard and then move the mouse around to select one of the vertices of the selected game objects. This is the vertex that will be snapped to the destination position. Once you found the vertex that you are interested in, press the left mouse button and move the mouse around to snap the selected objects. The objects will be snapped to the vertex which is closest to the mouse cursor.
 
2.1.1.3.3 Vertex to Grid Snapping
This works in the same way as vertex-to vertex snapping, but this time the source vertex will be snapped to one of the grid's cell corner points.
 
2.1.1.3.4 Box Snapping
Works in the same way as vertex snapping, but it applies to the center and corner points of the objects' bounding box.
 
 
2.2 The Rotation Gizmo
The rotation gizmo allows you to rotate objects in the scene. The following image shows a screen-shot of the rotation gizmo:
 
02.jpg
 
2.2.1 Using The Rotation Gizmo
The rotation gizmo has 3 colored circles that can be used to rotate around a single axis. You can rotate around a single axis by clicking on one of the circles and then start dragging the mouse.
As you can see in the image above, there is also an outer circle (the one which encloses the rotation sphere and which is also slightly bigger). Clicking on this circle and then dragging the mouse will allow you to rotate around the camera view vector.
If you click on a point on the imaginary sphere (not on any of the components that we have discussed so far), you will be able to rotate around the camera right and up axes.
 
2.2.1.1 Snapping
The rotation gizmo supports Step snapping which allows you to rotate in increments of a specified step value (expressed in units of degrees). For example, if this step value is set to 15, a rotation is performed
only when the accumulated rotation amount is >= 15. In order to use Step snapping, you have to keep the CTRL button pressed and then manipulate the gizmo as you normally do.
Note: Step snapping works only when you are using one of the 3 colored circles.
 
 
2.3 The Scale Gizmo
The following image shows the scale gizmo:
 
03.jpg
 
2.3.1 Using The Scale Gizmo
The scale gizmo has 3 colored axes. Clicking on of these axes and dragging the mouse, will perform a scale operation along the specified axis.
As you can see in the image above, there are also 3 multi-axis triangles. Clicking on one of these triangles and than dragging the mouse, will perform a scale operation along 2 axes at once.
If you want to perform a scale operation along all axes at once, you have to keep the SHIFT key pressed and then drag the mouse around.
 
2.3.1.1 Snapping
The scale gizmo supports Step snapping which allows you to scale in increments of a specified world unit amount. For example, if the step value is set to 1, a scale operation will be performed only when the accumulated scale is >= 1. In order to use Step snapping, you have to keep the CTRL key pressed and then use the scale gizmo as you normally do (drag the axes or the multi-axis triangles or press SHIFT to scale along all axes at once).
 
 
2.4 The Volume Scale Gizmo
The volume scale gizmo is another type of gizmo which allows you to perform object scaling, but it works a bit differently than the standard scale gizmo. Instead of using axes that can be dragged, you can use handles to resize an object. This in combination with the step snapping functionality can provide a much more intuitive scaling interface in some scenarios.
 
04.jpg
 
2.4.1 Using the Volume Scale Gizmo
The gizmo is composed of 6 drag handles which can be dragged to scale the object. There are 2 drag handles for each axis. Dragging one of them will scale along the corresponding object local axis.
When you drag,the size and position of the object will be affected.
Holding down SHIFT before dragging will cause the scale to happen from the center of the object. This key can be modified from the gizmo's inspector.
Note: The volume scale gizmo only works when a single object is selected and that object has to have a mesh attached to it. When more than one object is selected, the gizmo will be hidden.
 
2.4.1.1 Snapping
If you hold down LCTRL while dragging the handles, the gizmo will scale the object in increments of a specified step size. 
 
2.5 The Hand Gizmo
 
05.jpg
 
In fact, this is the Translation Gizmo. But it works as if the Space button is constantly pressed (Mesh Surface Placement mode).


  • Chilles, Shanti, Ashbash and 8 others like this

#3 gizmo

gizmo

    Administrator

  • Administrators
  • 785 posts
  • Location3DXChat

Posted 23 November 2017 - 11:46 AM

3 Camera control
 
To move the camera you have to hold down the right mouse button and use the following buttons:
 
W → Move forward;
S → Move back;
A → Strafe left;
D → Strafe right;
E → Move up;
Q → Move down;
LALT → Camera orbit (Use F key to focus on selected object first);
 
Camera look araund - Hold down RIGHT mouse button and move mouse;
Camera pan - Hold down MIDDLE mouse button and move mouse;
 
4 Hotkeys
W → activate the translation gizmo;
E → activate the rotation gizmo;
R → activate the scale gizmo;
U → activate volume scale gizmo;
Q → turn off gizmos. This allows you to perform object selections without having a gizmo active in the scene;
G → activates the global transform space;
L → activates the local transform space;
P → toggles the transform pivot point between Center and MeshPivot.
F → focus the camera on the object selection (only works when there is at least one selected object);

LCTRL + D → Object duplication;

Gizmo specific keys:
 
Translation gizmo:
V → while held down, allows you to perform vertex snapping. When released, vertex snapping is disabled;
B – while held down, allows you to perform box snapping. When released, box snapping is disabled;
LCTRL → while held down, allows you to perform step snapping;
SHIFT → while held down, allows you to translate along the camera right and up axes;
SPACE – surface placement with Y axis alignment;
SPACE + X – surface placement with X axis alignment;
SPACE +Z - surface placement with Z axis alignment;
LCTRL + SPACE - surface placement with no axis alignment;
LALT – activate move scale.
 
Rotation gizmo:
LCTRL → while held down, allows you to perform step snapping;
 
Scale gizmo:
LCTRL → while held down, allows you to perform step snapping;
LSHIFT → while held down, allows you to perform a scale operation along all axes at once.
 
Volume scale gizmo:
LCTRL → while held down, allows you to perform step snapping;
LSHIFT → holding this down before a drag starts, will cause the gizmo to scale from the center of the object;
 
Object selection specific keys: 
LCTRL → while held down, allows you to add objects to the current selection. For example, you can hold down this key and click on individual game objects to add them to the selection or drag the mouse while the left mouse button is pressed in order to add objects to the selection using the object selection shape. If this key is not held down, when you select new objects, the previous selection is cleared. Note: If you click on a game object while this key is pressed and the game object is already selected, it will be removed from the selection.
LSHIFT → while held down, allows you to deselect multiple objects using the object selection shape.
 
Undo/Redo specific keys:
CTRL + Z → Undo;
CTRL + Y → Redo;

 

Switch Camera mode:

F5 → Builder camera

F6 → Character camera

F7 → First person camera

 

Character teleportation (in the Editor mode for quick movement):

Hold Left Shift and click left mouse button


  • Chilles, Shanti, Pierrousss and 9 others like this

#4 gizmo

gizmo

    Administrator

  • Administrators
  • 785 posts
  • Location3DXChat

Posted 23 November 2017 - 12:33 PM

5 File menu
 
06.jpg
 
5.1 Save to File
Saves your current world layout to file (.world)
 
5.2 Save selected to file
Saves only selected objects to file. This option is useful when you want to save and share only a part of your world or a group of objects. Example being if you created your own structure and just want to share the structure only, rather than the entire layout of your world.

 
5.3 Load from File
Loads world layout from file. Your current layout will be lost.
 
5.4 Merge from File
Appends objects from file to your current layout meaning you can add specific created designs with objects to your layout without replacing the entire layout. This is related to 5.2.
 
5.5 Clear all Props
Deletes all objects from your layout. You cannot undo this action.
 
5.6 Load Default World
Loads default layout from the server. Your current layout will be lost.
 
5.7 Old Room Format
These are only a temporary option that provides backwards compatibility with the old room format (.dat files). You can open the old layout format in the World Editor and use or save it in the new format so you don't lose it.
This older format will be removed in a later patch, due to no longer being used.

 

5.7.1 Load House 1 Props from server

Loads House 1 objects. Your current layout will be lost.

 

5.7.2 Load House 2 Props from server
Loads House 2 objects. Your current layout will be lost.

 

5.7.3 Load from file (old file format)
Loads room layout from the .dat file. Your current layout will be lost. (Do note, .dat file support will be removed in a later patch)


  • Chilles, Shanti, Pierrousss and 11 others like this

#5 gizmo

gizmo

    Administrator

  • Administrators
  • 785 posts
  • Location3DXChat

Posted 23 November 2017 - 01:16 PM

6 Tools
 
07.jpg
 
6.1 Undo / Redo
08.jpg
Allows you to undo or redo some changes and actions.

 

6.2 Copy and Delete

09.jpg

Copy or delete selected objects.

 

6.3 The Gizmos

10.jpg

Choose 'Gizmo' to work with objects: Translation, Rotate, Scale, Volume Scale, Hand

 

6.4 Transform space

11.jpg

Toggles the Global/Local transform space.

 

6.5 Transform pivot

12.jpg

Toggles the transform pivot point between Center and Mesh Pivot.

 

6.6 Camera Focus

13.jpg

Moves the camera to focus on selected objects.

 

6.7 Color palette

14.jpg

Applies colors to block objects (primitives).

 

6.8 Group and Ungroup

15.jpg

Group and Ungroup objects. If the objects are grouped, you can easily select the whole group by clicking on one object from the group. 

If the group of objects is selected, then you can select one object with the second click. This allows you to work with an object within the group without ungrouping.

 

6.9 Snapping

16.jpg

Enable or Disable step and angle snapping.


  • Chilles, Shanti, Pierrousss and 11 others like this

#6 gizmo

gizmo

    Administrator

  • Administrators
  • 785 posts
  • Location3DXChat

Posted 24 November 2017 - 09:20 AM

7 Objects

 

This section explains the difference between object types.

 

7.1 Categories of Objects

 

17.jpg

 

All objects are divided into categories so that they are easier to find. You can switch categories using the category icons.

 

7.2 Object Types

Objects are divided into types depending on their use.

 

7.2.1 Blocks (Primitives)

 

18.jpg 19.jpg

 

Blocks (or primitives) are the basic type of object shapes. They are designed to build your worlds foundations. You can move, rotate, and scale these objects. And also apply color and materials to these how you wish.

 

7.2.2 Props (Furniture)

 

20.jpg 21.jpg

 

Most of the objects are furniture type. Characters can use different animations on these objects. These objects cannot be scaled.

 

7.2.3 Particles / Effects

 

22.jpg 23.jpg

 

Visual effects such as fire, smoke, electricity.

 

7.2.4 Animation Triggers

 

24.jpg 25.jpg

 

If you want some place in your world to function like furniture, then use the necessary animation triggers. These objects are invisible and indicate which set of animations the character will use with it.

 

7.2.5 Start Point Trigger

 

26.jpg

 

This object determines the starting position of the characters in your world. This object cannot be deleted or copied, it can only be moved.


  • Chilles, Shanti, Pierrousss and 15 others like this

#7 gizmo

gizmo

    Administrator

  • Administrators
  • 785 posts
  • Location3DXChat

Posted 24 November 2017 - 10:27 AM

8 Materials

 

27.jpg

 

 

You can apply materials only to objects of the block type. To apply a material, first select the objects. Then click on the material icon on the materials tab.


  • Chilles, Shanti, Ashbash and 25 others like this



Also tagged with one or more of these keywords: World Editor

1 user(s) are reading this topic

0 members, 1 guests, 0 anonymous users