User Interface#

On this page, you will find a description of all aspects of our user interface.

Viewport#

This is where you can view your simulations, shapes, forces or anything that’s in the scene.

viewport
  1. move section icon Using left mouse button dragging, you can use this icon to rearrange the UI layout by moving the 4 main sections.

  2. Scene is the default tab where you can view and manipulate everything.

  1. home icon Dropdown menu of the available cameras. Here you can select which camera you want to look through.

viewport
  1. view icon Dropdown menu of all the things that can be hidden or viewed in the Scene tab.

    • Simulation M (16)

    • Bounding Box B (15)

    • Shapes H (17)

    • Masking This visualizes all the voxels containing something.

    • Manipulators Shift+Q (18,19)

    • Manipulator Switcher This shows the Move move icon (9), Rotate rotate icon (10), and Scale scale icon (11) buttons.

    • Entity Icons (20) Show the node icons on the node position.

    • Render Quality will open a menu to its right where you can pick either Low Ctrl + 1, Medium Ctrl + 2, or High Ctrl + 3

      In certain cases, like when using Flames translucency, you can get a lot of banding when you look up close at your sim. Setting a higher render quality will help to deal with this.

      You can also lower the render quality to gain performance.

      Low, Medium, and High are presets that can be edited in Settings>Preferences>Viewport Quality

    • Stats (21)
      • Resolution: The resolution of the viewport

      • Simulate: The time it takes in milliseconds to do a single simulation step.

      • Render: The time it takes in milliseconds to render the simulation.

      • Framerate: How many times per second the UI is updated

      • VRAM: The amount currently used GPU memory vs total available memory.

  2. fullscreen Icon Toggle panel fullscreen

  1. Viewport orientation gizmo. You can left mouse button click on the dots to orient the view to that axis. Or left mouse button click and drag the sphere to rotate the view.

  2. Sky: These settings are controlled in the Skybox node.

  3. Ground: These settings are controlled in the Ground node.

render tab
  1. Render is the tab where you can preview what will be exported.

    1. Zoom in or out.

    2. Zoom to fit the whole tab. Checking this will disable 1 and 3

    3. zoom Default Icon Set the zoom back to 100%

    4. Toggle the crop gizmo.

    5. Crop in the horizontal and vertical axis.

    6. Crop vertical.

    7. Crop horizontal.

    8. Dropdown menu for selecting the Capture Type you want to preview.

export tab
  1. Export is the tab Here you can View your exported flipbook or the last frame of your exported sequence.

    • left mouse button Click on a frame to toggle between viewing the flipbook as a grid or as a single image.

    • Play or scrub through the flipbook using the timeline controls.

debug tab
  1. Debug shows detailed technical information about the simulation based on a specified slice of voxels.

Node Graph#

This is where the building blocks to create the simulation are managed.

node graph
  1. move section icon Using left mouse button dragging, you can use this icon to rearrange the UI layout by moving the 4 main sections.

  2. search icon Open search box. left mouse button Clicking on this will open a search box where you can type a node name or a part of the name to quickly select that node.

  3. list view icon Toggle graph tree. (6)

  4. fit To View Icon Move view to center of nodes.

  5. focus node icon Move view to center of selected nodes.

  6. zoom Default Icon Reset zoom to default.

  7. fullscreen Icon Toggle panel fullscreen

  8. Graph Tree Here you’ll find all the nodes represented in a list. You can use the unfold icon icon to get a dropdown menu of nodes that are connected to an input pin of the node.

  9. Node

  10. Input pins

  11. Connection wires

  12. Output pin

  13. node toggle icon Toggles whether a node is enabled. Shift + left mouse button to toggle for all selected nodes.

Timeline Editor#

This is where time is visualized from left to right.

For a description of how to use this editor check out our Timeline Editor section.

timeline editor
  1. move section icon Using left mouse button dragging, you can use this icon to rearrange the UI layout by moving the 4 main sections.

  2. fit To View Icon Fit view to all keys

  3. fit To View Icon Fit view to selected keys

  4. zoom Default Icon Reset the vertical zoom to default in the Curve Editor.

  5. fullscreen Icon Toggle panel fullscreen

  6. reset Icon Reset R Reset the simulation to the beginning of the timeline.

  7. previous key icon Move the playhead to the previous keyframe Left

  8. play Icon Play or pause the simulation Space

  9. next key icon Move playhead to the next keyframe Right

  10. next frame Move to the next frame/simulation step Z

  11. icon loop Toggle Loop L When looping is on you’ll see the looping area represented in blue in the timeline editor. This blue bar can be moved around by left mouse button clicking and dragging the middle or scaled by left mouse button clicking and dragging the edges.

  12. Toggle between displaying the timeline in seconds or frames. Shift + F

  13. Scrollbar for the timeline.

  14. search icon Here you can search for a specific parameter in the list of animated parameters.

  15. curve mode icon Toggle Curve Editor ` For a description of how to use this editor check out our Curve Editor section.

  16. autokey icon Toggle Timeline Autokey A With this on a keyframe will be added at the playhead when changing the value of a parameter with keyframe animation enabled.

  17. curve mode icon Toggle Timeline Sync D With this one the playhead is always at the same position as the stimulation time. So the blue line and the pink line can’t be split up when playing.

  18. curve mode icon Toggle Follow Playhead F With this on, the timeline will be panned to always keep the playhead in the middle of the editor.

  19. Playhead Indicates the current time on the timeline.

  20. This indicates the current time the simulation is at.

  21. Frame number.

  22. Node with a parameter that has keyframe animation on it. You can use the unfold icon icon to hide or show the animated parameters.

  23. play icon timeline Enable or disable the keyframe animation for the node. When disabling this the parameters of the node won’t change over time anymore but will keep the values they had when toggling this button off.

  24. eye icon Hide or Show the curves for all parameters of this node in the Curve Editor.

  25. Parameter Here you can set the parameter value for the current frame.

  26. play icon timeline Enable or disable the keyframe animation for the parameter. When disabling this the parameter won’t change over time anymore but will keep the value it had when toggling this button off.

  27. eye icon Hide or Show the curves for this parameter in the Curve Editor.

  28. Keyframe

export image curve
  1. This button can be found on an Export or Import node.

    For an export node, this will toggle a different view where you can see and edit how the frames will be exported.

  1. Shows the duration of the sequence that will be exported.

  2. This indicates what part of the timeline will be exported. This bar can be moved around.

  3. Information on the controls of the editor. These will change to showing keyframe controls when hovering over a keyframe.

Properties Panel#

properties panel
  1. move section icon Using left mouse button dragging, you can use this icon to rearrange the UI layout by moving the 4 main sections.

  2. Node Details: This tab shows all the parameters for the selected node.

favorites tab
  1. Favorites This tab shows all the parameters that are marked as favorites.

    You can do this with any parameter from the Node Details tab by checking the star icon favorite right next to it.

    Clear All will remove all the items from the favorites list. All the star icons will be unchecked.

timeline tab
  1. Timeline: This tab shows all the parameters with keyframe animation enabled.

    Clear All will remove all the items from the list. Note that this will remove all animation!

  2. search icon This will open a search box to find the parameter you are looking for regardless of the tab you are in.

  3. key filter icon Only show the parameters with keyframe animation regardless of the tab you are in. This is different from the timeline tab since this only shows animated parameters of the selected node instead of all nodes.

  4. move icon This will open a dropdown menu with the options to reset or randomize all parameters of the selected node or tab.

  5. fullscreen Icon Toggle panel fullscreen

  6. Parameter tab: All nodes have their own collection of parameter tabs.

override states
  1. Cycle Override State: Clicking on this will cycle through the different override states for the parameter.

  2. Parameter name: Hovering over this will show a description of what the parameter does.

  3. Checkbox: This can set a parameter on or off.

  4. Value Slider: You can left mouse button within this box to type in the value you want. Or left mouse button and drag to change the value.

  5. reset Icon Reset to the default value.

  6. favorite Mark as favorite: This will make the parameter appear in the favorites tab.

  7. Current software version.

Project Manager#

project manager
  1. Return to the normal user interface with the project you’re currently in.

  2. Minimize the Embergen window.

  3. Maximize the Embergen window.

  4. Close Embergen.

  5. Projects/Presets list

  6. Specify if you want to sort by date or by name.

  7. Search for a project. This is especially useful when looking through our long list of presets.

  8. Project/Preset: This represents a .ember file that was either recently worked on by you or provided as a preset with Embergen. left mouse button on a project to open it.

  9. Set the list to show the projects you recently worked on.

  10. Set the list to show the Embergen presets.

  11. Set the list to show tutorials on how to use Embergen.

  12. Link to our discord server where you can get help, give feedback on the software, or show off things you made.

  13. Link to our forums.

  14. Open the default preset.

  15. This opens a file browser where you can look for a .ember file to open.

  16. Links to the JangaFX social media pages.