Block: Model

An Model object for configuring a Grasshopper model.
Tags:

Overview

You can use a Model object to add a Grasshopper model to your configuration.

ModelConfig

The Model controls a parametric model

Name Type Required Description
kind "Model" Yes
modelFile string Yes A relative path to a valid model file, for Grasshopper models use binary format files (.gh).
The file name can only contain lowercase letters, numbers, and dashes
subscribe List<ModelSubscribe> No Subscribe to one or more sources
triggerSolveOn List<string> No The model solve will only trigger when these specified inputs change

ModelSubscribe

ModelControlPanelSubscribe

Name Type Required Description
kind "ControlPanel" Yes Subscribe to the value of a control panel. By default all changes are propagated to the inputs of your model
frame string Yes The frame that the control panel you wish to subscribe to lives.
source string Yes The control panel name to use as a source. This is the same name as used in your contents
select "submitted" | "initial" No
action "update" No

ModelDataStoreSubscribe

Name Type Required Description
kind "DataStore" Yes Subscribe to the value of a data store. By default all changes are propagated to the inputs of your model
frame string Yes The frame that the data store you wish to subscribe to lives.
source string Yes The DataStore name to use as a source. This is the same name as used in your contents
action "update" No

ModelPopupFormSubscribe

Name Type Required Description
kind "PopupForm" Yes Subscribe to the value of a popup form. By default all changes are propagated to the inputs of your model
frame string Yes The frame that the popup form you wish to subscribe to lives.
source string Yes The popup form name to use as a source. This is the same name as used in your contents
select "submitted" | "initial" No
action "update" No

ModelEntityDataStoreSubscribeForInput

Name Type Required Description
kind "EntityDataStore" Yes
frame string Yes The frame that the entity data store you wish to subscribe to lives.
source string Yes The entity data store name to use as a source. This is the same name as used in your contents
setInput string Yes The name of grasshopper model input to be set
filterEntities List<string> No
action "update" No

ModelEntityDataStoreSubscribe

Name Type Required Description
kind "EntityDataStore" Yes
frame string Yes The frame that the entity data store you wish to subscribe to lives.
source string Yes The entity data store name to use as a source. This is the same name as used in your contents
action "update" No

ModelMapSubscribe

Name Type Required Description
kind "Map" Yes Subscribes to a Map
frame string Yes The frame of the map you wish to subscribe to lives
source string Yes The name of the map to subscribe to. This is the same name as used in your contents
setInputFromMarkers string Yes Pass all markers from the map to the model input defined here