Introduction
The Flow Editor uses node-based graphs to process data.
The data usually flows from the left side to the right side, from an input pin to an output pin.
The nodes are executed at the pace of the frame rate, which can be modified at Edit->Preference->Rendering.
Layout
The Flow Editor is located in the middle section of the Aximmetry Composer.
Exposing Area of Input and Output Pins
On the left side of the Flow Editor, you have the area where you can expose input pins. The exposed pins will appear on the Dashboard panel where they can be edited.
Here a Video Player module's Speed has been connected out the left side, and the Speed pin's value appears on the Dashboard panel:
Adding data sources and streams, like video and tracking is done by Module nodes and not by exposing the video pin to the left side.
On the right side of the Flow Editor, you have the area where you can expose output pins. Any video pin connected out this side can be considered as a Video Output:
Exposed Video Output Index
Exposed Video pins to the right side of the Flow Editor are automatically indexed. The index numbers follow the order of the video pins.
For example in the Preview panels it is possible to select from these index numbers:
After a video output, you can also expose its corresponding audio output, like in the picture above.
The same video index numbers are used at the Video Output devices in the Startup Configuration:
Tabs
Multiple projects (compound or shader) can be opened at the same time, these are placed in separate tabs:
The play and stop buttons can run and stop a compound in the currently active tab. At the same time, only one compound can run. The play indicator
shows which compound is running:
Projects that are stopped can be modified, but the modules inside of them won't be executed. For example, if a trigger button is pressed inside a stopped project, it won't have any effect.
Projects that are not saved are marked with a * symbol before the project's name:
Editing
Aximmetry supports most of the editing methods that 3D editing software or node-based visual scripting software use.
However, there are several editing methods unique to Aximmetry.
There is an extensive editable list of keyboard shortcuts at Edit->Preferences->Keyboard Shortcuts.
Adding Nodes
Right-clicking with the mouse on the Flow Editor brings up various options:
The Insert Module... option is discussed in further detail in the Module documentation.
The New Simple Compound option is discussed in further detail in the Compound documentation.
Any file that the Flow Editor is able to use can be drag and dropped into an open compound or sharer. For example, video files, 3D models, text files, Aximmetry compounds, etc...:
And it is also possible to drag and drop from file explorer programs.
Navigating in the Flow
Holding down the middle mouse button enables one to pan the view:
Holding down CTRL while pressing the middle mouse will zoom out to the maximum and allows you to move the whole view rectangle. Only use it in very big projects.
The mouse scroll wheel changes the zoom level:
NOTE: You can also toggle between a maximized view of the Flow Editor by pressing down TAB.
Expanding Nodes Pin List
By default, a node doesn't display every pin. Clicking on the 3 lines expands the module and shows every pin:
Only connected pins are shown.
Important and connected pins are shown.
Every pin is shown.
Connecting Pins
Pins of a node can be connected by pressing down the left mouse button:
NOTE: We refer to connecting pins to the left or the right side of the Flow Editor as exposing.
When exposing pins Aximmetry will name the pin based on the source of the pin if the mouse cursor is outside of the Flow Editor. For example, when the mouse cursor is over the Pin Values panel in the picture below:
If the mouse is inside the Flow Editor, Aximmetry will provide a pop-up window to name the exposed pin:
More about exposing in the Compound documentation.
A connection can be cloned by holding down the ALT button on the keyboard.
This is especially useful in big projects with long connections when the source node of the connection is not visible in the Flow Editor's view.
When connecting to a shrunk node ( or
), pressing down the SHIFT button on the keyboard will reveal the connectable pins:
Disconnecting and Changing Pins Connection
Right-clicking with the mouse on a pin connection gives you the option to Disconnect it.
Also, it gives the option to Go To the source or the target, which can be useful in big compounds like in the Camera compounds.
It is also possible to disconnect or change a connection's end by dragging the connection:
Changing a connection's start can be done by pressing down SHIFT before dragging the connection:
And another way to disconnect connections is by holding down the CTRL and SHIFT buttons on the keyboard, while holding down the left mouse button:
Interacting with Nodes
It is possible to move nodes by holding down the left mouse button on them:
Note that the board of the Flow Editor is limitless in size, you can move nodes as far as you wish.
Nodes can be copied by holding down the ALT button on the keyboard and pressing down the left mouse button:
Copy-pasting with CTRL + C and CTRL + V works too.
Nodes can be inserted into a connection by pressing down the CTRL button on the keyboard while moving the node. The mouse cursor has to be exactly over the connection's line for it to work.
If there are more than 1 viable pins to connect, then the Select Pins window will appear. Where it is possible to choose between the viable pins:
Holding down the SHIFT while inserting with CTRL, will reconnect all connections coming from the source pin.
In a similar way, selecting a node and pressing the Delete keyboard button while holding down the CTRL button will delete the module but keep the connection.
Multi-Selection
Multiple nodes can be selected at once by clicking or dragging to create a marquee selection. Holding SHIFT while dragging creates a marquee selection that adds to the current selection. Holding CTRL while clicking or dragging creates a marquee selection that toggles selection:
Not just moving nodes but the copy, cut, and delete interactions also work with multi-selected nodes.
Multi-selected nodes can be connected to one common source node or exposed together.
Keep Selection in View
To move modules with the view panning, press CTRL + K when the modules are selected. Press CTRL + SHIFT + K to stop keeping the selection in the view:
Bookmarking
It is possible to save a location inside the Flow Editor by using the CTRL + 1 .. 9 shortcuts. And return to this position by using the SHIFT + 1 .. 9 shortcuts:
Bookmarking also works inside edited compounds' hierarchy or inside groups and on Control Boards.
Bookmarks can be deleted by the CTRL + SHIFT + ALT + 1 .. 9 shortcuts.
Bookmarking shortcut keys can be changed in Edit-> Preferences -> Keyboard Shortcuts.
Peeking
To see what information or data is being transferred through a connection or being present in a pin, move the mouse cursor over a pin or connection while holding down the CTRL keyboard button:
