Mutable Macro Library - anticto/Mutable-Documentation GitHub Wiki

⚠️EXPERIMENTAL⚠️

Overview

Mutable Macros are small graphs that support Mutable nodes. These graphs can be instantiated in any Customizable Object graph. The purpose of this new type of graph is to reduce the amount of repeated node patterns.

This feature is currently experimental, so expect limitations, bugs, and future API breakage.

How to Use

There is a new asset in the Mutable section of the asset creator of the content browser, the Customizable Object Macro Library. A Macro Library is an asset that allows users to create, edit and organize Macros. In order to create a Mutable Macro, users will need to create an instance of this asset.

image

A Mutable Macro Library can be opened by double clicking the asset from the content browser. By doing so the Customizable Object Macro Library Editor will open.

image

  1. Macro Creator (+): By clicking on this button a new macro will be created.
  2. Macro Name: Determines the name of the Macro.
  3. Macro Description: Allows the user to describe the macro functionality. This description will appear on hover a node that instantiates the macro.
  4. Inputs (+): This section allows users to create the inputs of the macro.
  5. Outputs (+): This section allows users to create the outputs of the macro.

[!NOTE] Inputs and Outputs are represented with pins. By clicking on the + button users will create new i/o variables. Once a variable has been created, users can set the name and the type of the variable.

  1. Input Node: This node will show the pins of the input variables.

  2. Output Node: This node will show the pins of the output variables

Users can instantiate a Mutable Macro in a Customizable Object graph using the new node Mutable Macro Instance. Users can specify a Macro Library asset and the Macro to instantiate in the Node’s details panel.

image

image

What is supported

  • Create Component Nodes.
  • Create Child Object Nodes.
  • Create Group Object Nodes.
  • Create Mesh Section Nodes.
  • Create Parameter Nodes.
  • Usage of Modifier Nodes.
  • Texture Operations.
  • Nested Macros (Macros inside other Macros).