Frictional Game Wiki

<h1>Model Editor</h1> <div class="level1"> <p> The Model Editor is our own application to create entities. An entity (saved in a .ent file) is composed of a mesh and a set of physical properties, bodies, and optionally joints and sub-entities. It can also contain animations for an animated entity, such as NPC's. Also worth noting is that an entity must be set up with a user defined type. </p> </div> <h2>Overview</h2> <div class="level2"> <p> When run, the first screen we get to see is like this: </p> <p> <img src="/lib/exe/fetch.php?media=hpl3:tools:maineditors:model_editor:modeleditor.png" class="mediacenter" alt="" /> </p> <p> Each part of the screen has a specific function, as follows: </p> <ol> <li class="level1"> <a href="#main_menu" title="hpl3:tools:maineditors:model_editor:main ↵" class="wikilink1">Main menu bar</a>: this is where every non-editor command lies, as well as some edition ones.</li> <li class="level2"> <a href="#editmode_selection_bar" title="hpl3:tools:maineditors:model_editor:main ↵" class="wikilink1">EditMode sidebar</a>: here you will find a set of buttons used to switch the current behaviour of the editor. More on this later.</li> <li class="level2"> EditMode window area: any helper input the current EditMode needs will appear here.</li> <li class="level2"> <a href="#viewport_area" title="hpl3:tools:maineditors:model_editor:main ↵" class="wikilink1">Viewport area</a>: this area of the screen is reserved for the viewports, which are used to actually see what you are doing to the map. Every viewport has its own menu bar, to control some parameters of the visualization.</li> <li class="level2"> <a href="#lower_toolbar" title="hpl3:tools:maineditors:model_editor:main ↵" class="wikilink1">Lower toolbar</a>: some tools that are either viewport-dependent or global are located here.</li> </ol> <p> Not listed above are some special windows, used pretty often here: </p> <ul> <li class="level1"> <a href="/doku.php?id=hpl3:tools:maineditors:level_editor:save_dialog" class="wikilink1" title="hpl3:tools:maineditors:level_editor:save_dialog">Save entity dialog</a> </li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:level_editor:load_dialog" class="wikilink1" title="hpl3:tools:maineditors:level_editor:load_dialog">Load entity dialog</a> </li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:common:color_dialog" class="wikilink1" title="hpl3:tools:maineditors:common:color_dialog">Color Picker</a> </li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:common:texture_browser" class="wikilink1" title="hpl3:tools:maineditors:common:texture_browser">Texture Browser</a> </li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:common:sound_browser" class="wikilink1" title="hpl3:tools:maineditors:common:sound_browser">Sound Browser</a> </li> </ul> <p> This is a menu bar, just like in any other windowed application. Available options for this particular editor are as follows: </p> <ul> <li class="level1 node"> <b>File</b><ul> <li class="level3"> <b>New</b>: This command will reset the map to an empty one, and the editor to a default state as well.</li> <li class="level3"> <b>Open</b>: This will open the <a href="/doku.php?id=hpl3:tools:maineditors:level_editor:load_dialog" class="wikilink1" title="hpl3:tools:maineditors:level_editor:load_dialog">Load entity dialog</a> to load an entity file in the editor. If the mesh used in the entity was updated with a different number of submeshes or with some of these renamed, the <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:submesh_reassign_dialog" class="wikilink1" title="hpl3:tools:maineditors:model_editor:submesh_reassign_dialog">SubMesh Reassign dialog</a> will pop up to set up how the new submeshes should replace the old ones.</li> <li class="level3"> <b>Save</b>: Use this to save your work to a file in disk. Will open the <a href="/doku.php?id=hpl3:tools:maineditors:level_editor:save_dialog" class="wikilink1" title="hpl3:tools:maineditors:level_editor:save_dialog">Save entity dialog</a> in case no file had been created already.</li> <li class="level3"> <b>Save As</b>: This will also save your work, but will always open the <a href="/doku.php?id=hpl3:tools:maineditors:level_editor:save_dialog" class="wikilink1" title="hpl3:tools:maineditors:level_editor:save_dialog">Save entity dialog</a> to ask for a file name whenever it is chosen.</li> <li class="level3"> <b>Import Mesh</b>: This option will open a dialog for importing a mesh file into the entity. Will open the <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:submesh_reassign_dialog" class="wikilink1" title="hpl3:tools:maineditors:model_editor:submesh_reassign_dialog">SubMesh Reassign dialog</a> in case an imported mesh is already present.</li> <li class="level3"> <b>Open Recent</b>: This will show a list of up to 10 files that have been recently loaded or saved.</li> <li class="level3"> <b>Quit</b>: This will exit the program.</li> </ul> </li> <li class="level2 node"> <b>Edit</b><ul> <li class="level3"> <b>Undo</b>: Use this to undo the last action. Note that not everything you can do in the editor is undoable.</li> <li class="level3"> <b>Redo</b>: Use this to redo the last undone action.</li> <li class="level3"> <b>Delete</b>: This will delete the current selected objects. Note that not all objects can be deleted.</li> <li class="level3"> <b>Clone</b>: This will create copy objects out of the currently selected ones. Note that not all objects can be cloned.</li> </ul> </li> <li class="level2 node"> <b>View</b><ul> <li class="level3"> <b>Outline</b>: This will bring up the <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:window_outline" class="wikilink1" title="hpl3:tools:maineditors:model_editor:window_outline">Outline Window</a>. It can be used to edit attachments with ease.</li> </ul> </li> <li class="level2 node"> <b>Entity Settings</b><ul> <li class="level3"> <b>Class</b>: This will bring up the <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:window_class" class="wikilink1" title="hpl3:tools:maineditors:model_editor:window_class">Entity class window</a>. Use this to set up a user defined type to your created entity.</li> <li class="level3"> <b>Animations</b>: This will bring up the <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:window_animation" class="wikilink2" title="hpl3:tools:maineditors:model_editor:window_animation" rel="nofollow">Animations window</a>. Animations are added and set up here.</li> <li class="level3"> <b>Notes</b>: Brings up the <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:window_notes" class="wikilink1" title="hpl3:tools:maineditors:model_editor:window_notes">Entity notes window</a>. You can add information about the entity in text form with this tool.</li> </ul> </li> </ul> </div> <h2>EditMode selection bar</h2> <div class="level2"> <p> Here you will be able to switch between the different EditModes available in this editor. An EditMode describes the state the editor is going to work in when selected. These five EditModes can be found in both this and the Model Editor. </p> <ul> <li class="level1"> <a href="/doku.php?id=hpl3:tools:maineditors:common:select_editmode" class="wikilink1" title="hpl3:tools:maineditors:common:select_editmode">Select EditMode</a>: this mode is used to select and edit objects.</li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:common:light_editmode" class="wikilink1" title="hpl3:tools:maineditors:common:light_editmode">Light EditMode</a>: with this mode you will be able to place lights around.</li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:common:billboard_editmode" class="wikilink1" title="hpl3:tools:maineditors:common:billboard_editmode">Billboard EditMode</a>: use this to create Billboards. Light halos, light shafts, and some other</li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:common:particlesystem_editmode" class="wikilink1" title="hpl3:tools:maineditors:common:particlesystem_editmode">Particle System EditMode</a>: one can add Particle systems to the map with this mode.</li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:common:sound_editmode" class="wikilink1" title="hpl3:tools:maineditors:common:sound_editmode">Sound EditMode</a>: used to place sound entities in the map.</li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:common:lensflare_editmode" class="wikilink1" title="hpl3:tools:maineditors:common:lensflare_editmode">LensFlare EditMode</a>: used to create objects that will generate a lensflare effect when looked at.</li> </ul> <p> The following EditModes are exclusive to the Model Editor </p> <ul> <li class="level1"> <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:shape_editmode" class="wikilink1" title="hpl3:tools:maineditors:model_editor:shape_editmode">Shape EditMode</a>: physical bodies are created over shapes. Create shapes with this EditMode.</li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:joint_editmode" class="wikilink1" title="hpl3:tools:maineditors:model_editor:joint_editmode">Joint EditMode</a>: using this mode you will be able to create joints. Joints are used to add contraints to body movements.</li> </ul> </div> <h2>Viewport area</h2> <div class="level2"> <p> This area is meant to actually show what the map contains. There are four viewports in this editor, and their initial setup is shown in this picture: </p> <p> <img src="/lib/exe/fetch.php?media=hpl3:tools:maineditors:level_editor:viewportarea.png" class="mediacenter" alt="" /> </p> </div> <h3>Viewport in focus</h3> <div class="level3"> <p> When working on a map, only one viewport will be focused at a time. This is shown by a red highlight around the currently focused viewport (in the picture above, focus is on the lower right viewport). To set the focus on a viewport, just move the mouse into it. </p> <p> In the Level Editor, some controls for the currently focused viewport is shown in the Lower Toolbar. </p> </div> <h3>View Menu</h3> <div class="level3"> <p> Each viewport has a "View" menu bar, which includes the following options: </p> <ul> <li class="level1 node"> <b>Camera Mode</b>: choosing an item from this submenu will reset the viewport to a preset. An ortho preset means that it will use orthographic mode, so no perspective distortion will be seen. All presets reset the camera target to a (0,0,0) position. One out of the following presets can be picked:<ul> <li class="level3"> <b>Front</b>: ortho preset, scene will be seen from the front.</li> <li class="level3"> <b>Right</b>: ortho preset, scene will be seen from the right side of the objects, pointing to the left.</li> <li class="level3"> <b>Top</b>: ortho preset, scene will be seen top-bottom.</li> <li class="level3"> <b>Perspective</b>: this is the only perspective mode, will reset the camera position to (10,10,10).</li> </ul> </li> </ul> <ul> <li class="level1 node"> <b>Render Mode</b>: the mode that will be used by the viewport to draw objects<ul> <li class="level3"> <b>Wireframe</b>: only edge lines for polygons will be drawn in this mode.</li> <li class="level3"> <b>Shaded</b>: drawing will be fully done, using lighting just like ingame. Ortho presets cannot use this mode.</li> </ul> </li> <li class="level2"> <b>Controllers</b>: under this item you will find the available controllers for the current view. These can either be <b>Maya</b> or <b>Fly</b>. More details later.</li> <li class="level2"> <b>Show Grid</b>: toggles showing of the helper grid.</li> <li class="level2"> <b>Show Axes</b>: toggles showing of the XYZ axes.</li> </ul> </div> <h3>Moving and looking around</h3> <div class="level3"> <p> Depending on the active controller, moving will be done differently, but all are activated using the view mode key (default left Alt). When this key is held, the red focus frame will turn yellow. </p> <p> <b>Linux Note:</b> Left Super (aka "Windows" or Apple key) and the Z key are also the view key as the Alt key is usually bound by the Window Manager. <br/> <b>Mac&lt;nowiki> OS&lt;/nowiki> X Note:</b> A three button mouse is required to use the editor. </p> </div> <h4>Maya</h4> <div class="level4"> <p> All movement and looking will be done using the mouse. In a nutshell, there are three basic movements that can be done: </p> <ul> <li class="level1"> <b>Tumble</b>: pressing the 'view' key and the left mouse button at the same time will activate the Tumble mode. This means the camera target will stay in place while the camera will orbit around it.</li> <li class="level2 node"> <b>Track</b>: pressing the 'view' key and the middle mouse button at the same time will activate the Track mode. According to the track mode that is set, this will behave in two different ways:<ul> <li class="level3"> Tracking lock to grid is disabled: the camera target will move along the current screen plane, meaning it will move left-right or up-down along with the mouse. The camera position will stay the same with respect to the target.</li> <li class="level3"> Tracking lock to grid is enabled: this allows the user to click on the grid, hold and drag to get a camera displacement. Pretty useful when one wants to cover large distances. This mode is forced in ortho views.</li> </ul> </li> <li class="level2"> <b>Zoom</b>: pressing the 'view' key and the right mouse button at the same time will activate the Zoom mode. Moving the mouse forward/backward will then zoom in/out respectively. Note there are limits for zooming in and out. You can also zoom in/out by rolling the mouse wheel up/down.</li> </ul> </div> <h4>Fly</h4> <div class="level4"> <p> Looking around is done with the mouse, moving is done with standard FPS controls: W key moves forward, S key moves backward, A and D goes left and right respectively. Q and E for moving up and down. </p> </div> <h3>Enlarging a viewport</h3> <div class="level3"> <p> When working in a viewport, the common thing to do is enlarging it. This can be done by clicking on the 'enlarge button' in the lower toolbar, or pressing the shortcut for it (spacebar). </p> </div> <h2>Lower Toolbar</h2> <div class="level2"> <p> You can find some useful controls in this bar located at all times at the lower part of the screen. </p> <p> <img src="/lib/exe/fetch.php?media=hpl3:tools:maineditors:model_editor:window_modeleditor_lowertoolbar.png" class="mediacenter" alt="" /> </p> <ol> <li class="level1 node"> Grid Controls:<ul> <li class="level3"> <b>Grid Plane</b>: cycles through the available grid planes (XZ, XY, YZ).</li> <li class="level3"> <b>Toggle Snap</b> (magnet button): enables/disables snapping for translation (over grid), rotation and scale.</li> <li class="level3"> <b>Grid Height</b>: height of the plane, measured on the plane normal.</li> <li class="level3"> <b>Snap Separation</b>: separation of snapping points.</li> </ul> </li> <li class="level2"> <b>Enlarge Viewport button</b>: will toggle enlargement of the focused viewport.</li> <li class="level2"> <b>Entity Preview button</b>: will toggle the <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:window_entitypreview" class="wikilink1" title="hpl3:tools:maineditors:model_editor:window_entitypreview">entity preview mode</a>.</li> <li class="level2 node"> Misc controls:<ul> <li class="level3"> <b>A</b>: toggles global ambient lighting</li> <li class="level3"> <b>P</b>: togles global point light</li> <li class="level3"> <b>LT</b>: toggles Lock to grid for tracking in focused viewport</li> <li class="level3"> <b>F</b>: focus on currently selected object(s)</li> <li class="level3"> <b>I</b>: toggles displaying of icons.</li> </ul> </li> </ol> </div> <h2>Types of Objects</h2> <div class="level2"> <p> These are the kinds of objects that you can create and place in this editor. Details on each one and parameter listing in the following links: </p> <ul> <li class="level1"> <a href="/doku.php?id=hpl3:tools:maineditors:common:lights" class="wikilink1" title="hpl3:tools:maineditors:common:lights">Lights</a></li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:common:billboards" class="wikilink1" title="hpl3:tools:maineditors:common:billboards">Billboards</a> </li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:common:particle_systems" class="wikilink1" title="hpl3:tools:maineditors:common:particle_systems">Particle Systems</a> </li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:common:sounds" class="wikilink1" title="hpl3:tools:maineditors:common:sounds">Sounds</a></li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:common:lensflares" class="wikilink1" title="hpl3:tools:maineditors:common:lensflares">LensFlares</a></li> </ul> <p> The following types are exclusive to the Model Editor </p> <ul> <li class="level1"> <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:shapes" class="wikilink1" title="hpl3:tools:maineditors:model_editor:shapes">Shapes</a> </li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:bodies" class="wikilink1" title="hpl3:tools:maineditors:model_editor:bodies">Bodies</a> </li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:joints" class="wikilink1" title="hpl3:tools:maineditors:model_editor:joints">Joints</a> </li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:submeshes" class="wikilink1" title="hpl3:tools:maineditors:model_editor:submeshes">SubMeshes</a> </li> <li class="level2"> <a href="/doku.php?id=hpl3:tools:maineditors:model_editor:bones" class="wikilink1" title="hpl3:tools:maineditors:model_editor:bones">Bones</a></li> </ul> </div>