Skip to main content

Using Input Nodes in Flow

Establish editable properties that control your Flow's outputs

Holly Conrad Smith avatar
Written by Holly Conrad Smith
Updated over 2 months ago

The results of a flow are due to the property values being written to the geometry via the flow nodes. Almost all nodes will have parametric input values. These can be set within the flow itself, or made editable via the properties palette using input nodes.

Inputs in the properties palette will appear in the Flow Controls section, under the flow selector.

Here are a few examples:

Let's learn how to create these inputs.

The Input Parameter

The input Parameter allows you to define a custom property for a flow.

This is an example in one of our default flows from the Lightning Bolt:

The properties palette shows this:

This is the configured input node:

Changes to the input adjust the flow results.

In this case, building footprints smaller than the minimum size set are replaced by a tree.

Input Types

The Input Parameter node allows you to configure the following input types:

  • String

  • Number

  • Vector

  • Color

  • Boolean

  • Feature

  • Group

Each type has different settings. Learn More in the Input Node documentation.

You will also configure a parameter name and description, which display in the properties palette, as well as a default value.

Connecting the Input Node

Connect the configured Input node to any input connector that expects the data type you configured.

A few examples:

String

Number

Boolean

Dendrogram Transforms

Some nodes have built-in input parameters. The nodes in the "Dendrogram" category all have coordinating input parameter nodes called "Transforms."

For example:

Parking Node + Parking Transform

The inputs created by parking lots transform:

Dendrogram Nodes will work without the Transform, but you won't be able to change the default values without the Transform

Add the Transform

Every Dendrogram node has a Transform input, labelled with "T".

Connect the output of the Transform Node into the "T" input of the Dendrogram node.

Edit Defaults

Dendrogram Transforms are unique in that they are pre-configured with multiple parameters and defaults.

To override the Giraffe defaults, click "Edit Defaults" on the Transform Node.

A flyout appears with the settings from the transform.

Give the parameter a new name.

This overrides the section title in the properties palette.

Publish or unpublish the transform.

This controls whether the transform appears in the properties palette.

If toggled off, all flows inherit the default values and those values cannot be changed without editing the flow.

Adjust the default values

This is different than editing the values in the property palette. The default values will apply to all geometries sharing that flow unless the value is over-ridden at the object level.

The parameters vary on every dendrogram transform. Review the documentation of each node for details.

Organizing the Properties Palette

Input Parameters will always appear in the properties palette form in the "Flow Controls" section, directly following the flow selector dropdown.

When there are multiple input nodes in a flow, the nodes display in the properties palette from highest on the flow canvas to lowest (IE North/South).

The canvas location of both Dendrogram Transforms and Input Parameter nodes affect their order in the properties palette.

In this example, the Input parameter node "Level Offset" displays first, followed by the Round Corners Transform

In the flow, the input parameter is furthers "North" on the canvas.

In situ

General Properties

The geometries generated from flows will also inherit values from properties in the Properties Palette, unless those property values are over-ridden within the flow.

This means you can easily add levels, change the floor-to-floor height, adjust color, and more without adding those values as inputs in the flow.

The built-in properties will always display after the Flow Controls section.

Did this answer your question?