bstt / AutoNodeArranger

Documentation for Auto Node Arranger UE4 plugin.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Auto Node Arranger

Presentation:

Marketplace link : https://www.unrealengine.com/marketplace/en-US/slug/auto-node-arranger

With the Auto Node Arranger plugin, you can automatically arrange your graph nodes the way you want. The arrangement works for all graph types. You can customize the arrangement for having exactly the graph you want.

Please report any unexpected behaviours. It will be fixed as soon as possible. (cf. Contact-me)

Support e-mail : bstt.ue4@gmail.com

Table of contents

1. Tips

2.1. Arrange

What is new ?

  • Deletion of Auto arrange feature

1. Tips

The Arrange commands of ANA (Auto Node Arranger) work the same way regardless of the selected nodes in the connected graph(s) to arrange.

The arrangement requires a first good sight of all nodes that will be arranged in order to not depend on the current zoom.

Zoom

All 'free' nodes that aren't locked are placed the most on the right.

RerouteNodeLockOn

The default commands have been chosen for their compatibility with Unreal Engine default settings, but you can change it in Editor Preferences/General/Keyboard Shortcuts/Auto Node Arranger.

KeyboardShortcuts

Table of contents

2. Commands : (default shortcut)

2.1. Arrange

The Arrange Command behaviour depends on the selected nodes count. (cf. Arrange selection type)

The default Arrange Selection Type is One For All.

If you have multiple selected nodes, ANA will arrange only the selected nodes.

ArrangeSelectedNodes

If you have only selected comments, ANA will arrange all nodes in the selected comments.

ArrangeSelectedComments

If you have only one selected node, ANA will arrange the graph connected to the selected node.

ArrangeConnectedGraphs

If you have no selected nodes, ANA will arrange all nodes in the graph.

ArrangeAllNodes

2.1.1. Arrange Straight (Shift+Q)

ANA places all selected connected graphs with the minimum spacing required to aligned at the best all nodes.

Straight

2.1.2. Arrange Center (Shift+X)

The only difference with Arrange Straight is that ANA tries to center each 'free' nodes.

Center

2.1.3. Arrange Compact (Shift+V)

ANA places a node below another on its right if it is not exec connected and it has less than 1 connected input pin and 1 connected output pin.

Compact

2.2. Toggle Auto Arrange (Shift+Space)

2.3. Select Connected Graph (Shift+F)

You can gradually select all connected nodes and comments of a graph.
Press again Shift+F to increase the selection.

Show selection phasis

At each step : Select all comments containing only selected nodes

  1. Select all nodes contained by selected comments
  2. Select all nodes connected to selected nodes in selected comments
  3. Select all nodes connected to selected nodes
  4. Select all comment containing selected nodes

ConnectedGraph

2.4. Register All Nodes (Shift+P)

You can register the size of all nodes of the current graph.

If all nodes are registered you can simultaneously arrange multiple graph.

SimultaneousMultipleGraphArrangement

Tip : Use this command when many nodes are not registered (due to copy-paste or an implementation started without ANA)

2.5. Add Custom Graph Config (Shift+Enter)

You can have as many different configurations as you want by graph type (see Custom graph config).

Table of contents

3. Configuration

ANA has a lot of customizable options : you can change them in Editor Preferences/Plugins/Auto Node Arranger.

ANA_EditorPreferences

3.1. Basic configuration

3.1.1. Arrange selection type

There are 3 types of arrangement according to the selected nodes count.

  • One For All (default) : if one node is selected, ANA will arrange all connected nodes of the selected node. If multiple nodes are selected, ANA will arrange the selected nodes.
  • Always Selected : ANA will always arrange the selected nodes.
  • Always Connected (previous default) : ANA will always arrange all connected nodes of the selected nodes.

For all types, if no node is selected, ANA will arrange all nodes of the current graph.

3.1.2. Auto arrange
3.1.3. Auto generate reroute

If enabled, ANA automatically generates reroute nodes for each loop connection.

Tip : reroute nodes are generated between the 2 nodes the most 'negatively' spaced in X'.

ReroutePlacement RerouteArrangement

3.1.4. Exec spacing

Exec Spacing is used between 2 nodes connected by exec pins.

ExecSpacing50 ExecSpacing200

3.1.5. Group all connected graph

If enabled, ANA groups all connected graph.

GroupOn GroupOff

3.1.6. Instant arrange

If enabled, animation is disabled.

3.1.7. Progressive selection

On Select Connected Graph (Shift+F),

  • if enabled, the selection of nodes and comment is progresive
  • if disabled, all nodes that are related to selection are selected.

3.2. Graph configuration

3.2.1. Spacing

Spacing is used with the Arrange Straight and Arrange Center commands whereas Compact Spacing is used with the Arrange Compact command.

Spacing1 Spacing2

3.2.2. Comment spacing

Comment spacing is used between comment and nodes inside.

LowCommentSpacing HighCommentSpacing

3.2.2.1. 'Auto Size Comment' plugin compatibility

ANA is compatible with the 'Auto Size Comment' plugin which is a plugin that automatically resize your comments.

Link : https://www.unrealengine.com/marketplace/en-US/product/auto-size-comments

The padding of 'Auto Size Comment' should be equal to or lower than the Comment spacing of 'Auto Node Arranger'

ANA_Spacing ASC_Padding

Example with ASC Padding equal to ANA Spacing :

PaddingEqualToSpacing

Example with ASC Padding lower than ANA Spacing :

PaddingLowerThanSpacing

A padding greater than comment spacing can lead to this :

PaddingGreaterThanSpacing

3.2.3. Arranged dimensions

You can choose to arrange only in X, only in Y, or in both dimensions.

3.3. Advanced configuration

3.3.1. Aligned pins offset

ANA handles line overlap by adding an offset to node responsible of the overlap.

3.3.1.1. Increase offset

You can increase the value in order to better discern the lines.

Offset5 Offset15

3.3.1.2. Disable aligned pins

You can disable this feature by putting 0 as value for the aligned pins offset, and then lines can overlap. A solution is to create reroute nodes until the overlap disappears.

SolutionOverlap

3.3.2. Custom graph config

By default, there are 3 graph configs : the Material Graph config, the AI Graph config and the default Graph config used with all other graph types.
You can add a custom graph config for one graph type with Add custom graph config command (Shift+Enter by default).
ANA warns you when you already add this graph type, else it adds a new configuration which override the “default” graph config.

Tip : you can also override Material Graph config or AI Graph config.

Table of contents

3.3.3. Show new features

You can enable this option to display the notifications that describe how to use the features of the new version of ANA.

ShowNewFeatures

4. Node properties register

ANA stores the size of all nodes in the Node properties register: you can access it here : Project Settings/Plugins/Auto Node Arranger.

ANA_ProjectSettings

There you can delete node properties that you don't need anymore.

5. Contact me

When you got an error :

Table of contents

About

Documentation for Auto Node Arranger UE4 plugin.