View source for LFS Editor/Modeller

{{Infobox vehicle mods}}
{{Under construction}}

The Modeller is a part of the [[LFS Editor]]. It is used to edit the 3D model, which includes editing the mesh and applying textures.

For user guides and walkthroughs for various modeller features, see [[Modeller Guides]].

== Requirements ==

To be able to use the modeller, you must have an S3 license. To get the S3 license, you can visit the [https://www.lfs.net/shop/licenseselect LFS shop page].

== Starting the modeller ==

First, follow the [[LFS Editor#Downloading|instructions]] how to download and install the [[LFS Editor]].

[[image:LFS Editor welcome screen.jpg|thumb|LFS Editor entry screen]]
[[image:LFS Modeller - start screen.png|thumb|Modeller start screen - standalone mode]]

Once you have the editor installed and run the LFS Editor application, you will be presented with the entry screen. Click the {{button|Modeller}} button to enter the Modeller.

The modeller can also be entered from the [[Vehicle Editor]] by pressing {{key press|E}} or clicking the {{old button|E - Edit Model|#a1a1ff}} button on the right hand side of the vehicle editor.

== General modeller tips ==

* The list of colours at the bottom left in 'tri' mode is a different view of the list of mappings in 'map' mode.
* When you select a triangle, its colour is selected in the bottom left list. If the list is long, click {{old button|cols : X|#ffffa1}} to bring the selected colour onto screen.
* In 'subob' mode you can select a subobject with {{key press|Ctrl|click}} while pointing at one of its surfaces.
* In 'tri' mode, {{key press|Ctrl|click}} adds or removes triangles from the selection. {{key press|Alt|click}} starts a new selection (one triangle).
* In the special view modes (like groups or mappings) the group select feature ({{key press|Ctrl|Shift|click}}) does a flood select within the group.
* Press {{key press|Shift|F}} to temporarily hide the editor buttons.
* To reduce clutter, use {{old button|hide selected|#ffffa1}} to temporarily hide points and triangles, then {{old button|unhide all|#a1ffa1}} to show the again.

== User interface ==

When you open the Modeller, the user interface looks as follows:

[[File:LFS Editor modeller user interface.jpg]]

The interface consists of the following parts:

# 3D model view
# editing mode selector
# editing mode specific controls
# [[#Load / save object|load / save object]]
# modeller [[Modeller#View modes|view modes]] & view options
# [[LFS Editor User Interface#View controls|common editor view controls]]

== View modes ==

In the bottom right part of the screen, you can choose different view modes of the model:

[[image:LFS_Editor_Modeller_view_modes.jpg|Modeller view modes]]

=== Layers ===

[[Image:LFS Editor Modeller layers mode.jpg|thumb|Layers]]

Each colour represents triangles assigned to a particular layer. You can toggle layers on/off by clicking the layer buttons in the top left part of the screen.

{{Clear}}

=== Wire ===

[[Image:LFS Editor Modeller wire mode.jpg|thumb|Wireframe]]

Shows the edges as a wireframe. The edges can have different colours:

* grey - two triangles share the edge. This is the normal condition for most edges in an object.
* red - an unshared edge - only one triangle uses this edge.
* cyan - three triangles share the edge.
* orange - four triangles share the edge.

When you see an edge that is not grey, it may be intentional or it may draw your attention to a bug in the model. There are reasons to have unshared edges or multiple shared edges in some cases. But if it is not intentional, it may indicate a modelling error such as:

* A double built triangle - this would appear as a cyan triangle where you expect grey triangles.
* A triangle connected to the wrong vertex - could cause unshared edges.

It's good to click wire mode occasionally and if you see edges that are not grey, make sure that you know the reason for them and that they are as intended.

{{Clear}}

=== Mappings ===

[[Image:LFS Editor Modeller mappings view.jpg|thumb|Mappings]]

Each colour represents a different mapping.

{{Clear}}

=== Flat ===

[[Image:LFS Editor Modeller flat mode.jpg|thumb|Flat]]

Flat shading of the triangles without being smoothed.

{{Clear}}

=== Groups ===

[[Image:LFS Editor Modeller groups mode.jpg|thumb|Smoothing groups]]

{{see also|LFS Editor Guides#Smoothing groups}}

Smoothing groups. The boundaries between different smoothing groups usually have a sharp edge. All triangles within one smoothing group have artificial smoothing applied.

When you switch to the groups view mode and select {{old button|tri}} mode, an additional set of buttons will be shown in the top right corner of the screen.

[[Image:LFS Editor smoothing group tri mode.jpg|thumb|Groups mode in combination with tri mode]]

Each smoothing group is represented by a number and a distinct colour.

[[Image:LFS Editor smoothing group buttons.jpg|Smoothing group buttons]]

If needed, you can create new groups by clicking the {{old button|new group (N)|#ffffa1}} button, where N is the number of the group to be created.

You can create up to 23 groups for the model.

When you select a group which is not assigned to any triangles, a {{old button|delete|#EA927E}} button appears at the top, allowing you to delete unused groups:

[[Image:LFS Editor smoothing group delete button.jpg|Delete group button]]

When you press and hold {{key press|Ctrl}}, the labels of the group buttons will say {{old button|all}}. If you click one of them, all triangles assigned to that group will be selected.

[[Image:LFS Editor smoothing group all buttons.jpg|Select all buttons]]

=== Gouraud ===

[[Image:LFS Editor Modeller gouraud mode.jpg|thumb|Gouraud]]

The default rendering of the model with [https://en.wikipedia.org/wiki/Gouraud_shading gouraud shading] applied. This is how the car should appear in game.

{{Clear}}

=== N.C.level ===

[[Image:LFS Editor Modeller NC level mode.jpg|thumb|Normal contribution levels]]

Normal contribution levels. Each triangle meeting at a vertex, within the same smoothing group, contributes to the [https://en.wikipedia.org/wiki/Normal_(geometry) normal] of that surface at that vertex. In fact, large triangles have a larger contribution. So for example you could make a simple "hardback book" shaped object and most of the apparent curvature would be on the spine of that book. But the spine would still be contributing to the normals, so the front and back faces of the "book" would still be a little curved. If, however, you set the normal contribution level" of the spine to zero, then the spine would not contribute to the normals at all. Then the front and back face of the book would look totally flat.

{{Clear}}

=== L.R.swap ===

[[Image:LFS Editor Modeller L.R. swap mode.jpg|thumb|Left/right swap]]

Driver swap modes. The triangles can have different colours:

* grey - applied to mirrored triangles, which do not have any swapping
* blue (static) - do not change sides when driver side is swapped
* red (swap) - change sides when driver side is swapped

In this mode, you can set driver swap modes to triangles by going to the {{old button|tri|#c9c9c9}} mode, selecing one or more triangles and clicking one of the swap mode buttons in the top right corner.

{{Clear}}

== Load / save object ==

{{see also|LFS Editor Guides#Loading a model}}

At the bottom left of the screen, there is a set of buttons used to load or save an object in the Modeller.

[[image:Modeller load and save objects.jpg]]

If you have an subobject selected, another row of buttons appears, allowing you to load or save the current subobject.

{| class="wikitable"
|+ Load / save object buttons
|-
| {{old button|subobject}} || Indicates that a subobject is currently selected
|-
| {{old button|load|#a1ffa1}} || Load a new subobject, replacing the selected subobject
|-
| {{old button|save|#a1ffa1}} || Save the current subobject as an object in data\3dob
|-
| {{old button|main object}} || The name of the main object
|-
| {{old button|LOAD|#00ff00}} || Load a new object from data\3dob
|-
| {{old button|SAVE|#00ff00}} || Load the main object to data\3dob
|-
| {{old button|skin}}{{old button|XFG_DEFAULT}} || Click the skin name (e.g. XFG_DEFAULT) to select a JPG image in data\skins to use as a skin in the editor
|-
|}