This article covers the RealMotion interface and the basic functionality of each panel.

Menu

The RealMotion menu bar contains six menus: File, Edit, Project, Windows, View, and Help.

MenuFunctions
FileCreate, open, and save projects and graphs
EditUndo/redo in graph view; edit RealMotion configuration
ProjectLaunch, play, pause, and stop a project; access the Surface Editor and Project Configuration
WindowsToggle visibility of all dockable panels
ViewRe-center the graph view
HelpAccess offline help, About information, and system information

New Project

The New Project dialog allows you to start from a Project Template or a Sample.

To start a new project:

  1. Go to File > New Project.
  2. Select a project template or sample.
  3. Enter a project name and select a save folder.
  4. Click Create.

Graph Panel

RealMotion is a node-based engine. The Graph panel is the primary workspace where you build your project by connecting nodes (boxes).

To connect two nodes:

  1. Click a pin on a node.
  2. Drag the cord to a compatible pin on another node.

Toolkit Panel

The Toolkit panel provides three tabs for adding content to your project: Box, Graph, and Template.

BoxesThe fundamental building blocks in RealMotion. Each box is a nodal representation of a process, containing input pins, output pins, and properties.
GraphsSub-projects within your project. Like folders, they contain boxes and help organize your project.
TemplatesPre-built, optimized graphs created by the RealMotion team. They are copied into your project on use, so you can modify them freely.

To add an element from the Toolkit:

  1. In the Toolkit panel, select a Template, Graph, or Box.
  2. Drag and drop it into the Graph panel.

Media Library Panel

The Media Library panel displays media files in your project folder and any additional folders configured as media library sources.

To add media to your project:

  1. Select a media file in the Media Library panel.
  2. Drag and drop it into the Graph panel or timeline.

To add a folder as a media library source:

  1. Go to Project > Project Configuration.
  2. Select the Library tab.
  3. Set the Media Library Path.

Hierarchy Panel

The Hierarchy panel displays the structure of your project and allows you to navigate between graphs and timelines.

To navigate within a project, use one of the following methods:

  1. Select a graph or timeline in the Hierarchy panel.
  2. Double-click a graph or timeline in the Graph panel.
  3. Press Backspace or B to return to the previous graph.

Properties Panel

The Properties panel displays the properties of the selected box. Most parameters can be edited while the project is running.

Note: Some parameters — such as texture format and resolution — cannot be changed while the project is running. Stop the project before modifying these values.

To change a parameter:

  1. Select a box in the Graph panel.
  2. In the Properties panel, change the desired parameter value.

To expose a parameter as a pin:

  1. Stop the project if it is running.
  2. In the Properties panel, click the Round icon next to the parameter.
  3. If prompted, enable the Enable Input Pin toggle.

Box Description

The Box Description panel displays a general description of the selected box and links to related boxes. Full online documentation is also available.

To view a box's documentation:

  1. Select a box in the Graph panel.
  2. Press F1. The box reference page opens in your web browser, showing all pins and parameter descriptions.

Error Log Panel

The Error Log panel displays errors detected during loading and at runtime.

LevelDescription
WarningAn undesired behavior was detected, but the graph can still run. Example: a configured Media Library folder cannot be found.
ErrorA condition is preventing the graph from running. Example: no node is connected to the Texture Out.
Critical ErrorThe system itself is compromised — for example, the hard drive or memory is saturated beyond recovery. If this level is reached, save your project immediately and reboot the computer.

To locate the source of an error:

  1. Double-click the error in the Error Log panel. The Graph view will navigate to the affected box. If the error is not related to a specific box (e.g., a configuration error), the Root Graph is displayed.

Console Panel

The Console panel displays user-generated messages, error messages, and technical messages from RealMotion.

To send a message to the console:

  1. Add a Console Output box (shortcut: W).
  2. Connect the box's input to a data source.
  3. Run the graph.
  4. The Console panel will display the output data.

Preview Panel

The Preview panel displays the output of the selected box or the final Backbuffer output. The preview mode is controlled by the Preview Slider in the toolbar.

To preview the output of a specific box:

  1. Set the Preview Slider to Current Box.
  2. Select the desired box or output. If the box does not output a texture, the preview displays the final Backbuffer texture with the data shown as an overlay.

To view frame timing statistics for a box:

  1. Enable the Show Statistics button.
  2. Select the desired box or output. Timing information is displayed as an overlay in the preview.

Secondary Display

The Secondary Display shows the Backbuffer output at 1:1 scale. Like the Preview panel, it can also display the output of a selected box. The Secondary Display is typically used in a dual-monitor workspace.

To reposition the Secondary Display while the project is running, use one of the following methods:

  1. Press Ctrl + ← or Ctrl + →.
  2. Right-click the Secondary Display to access its contextual menu.

Rev 1.1  ·  Last updated: 2017-01-06