List of IDs of parameters influencing this output.
The format of the items in the content array.
The freeze flag. When set to true, calls to the following functions will not update the output:
Controls whether the parameter should be hidden in the UI.
ID of the output, dependent on model ID, and therefore changing each time a model gets uploaded.
Name of the output.
A callback that is executed whenever an output's node is to be replaced due to an update of the output's content. Provides the new scene tree node and the old one, so that data can be carried over. If the callback is a promise it will be awaited in the execution chain.
A unique identifier for the particular version of the output. This is a hash code which is based on the parameter values that were used to compute the resulting data. The hash code only depends on the values of the parameters which may theoretically influence the results of the output. As an example, parameters which are in no way connected to the output component in Grasshopper are not considered.
Optional bounding box, maximum corner.
Optional bounding box, minimum corner.
Information about which chunks exist in the asset/sdTF.
Result parts. In case this array does not exist, this means that the workers have not finished computation for this output version.
The delay in milliseconds after which an output cache request shall be sent to check again for this output version. This property is used ONLY if the output version has not been computed yet.
Note that the existence of this property does not necessarily imply the presence of an active or queued computation for the respective output version.
Parameter name to display instead of name.
Group of an output.
Optional ID of the output holding material information for this output.
In case computation of the output version (temporarily) failed:
Optional message to the user, explaining what went wrong.
The node corresponding to the output in the scene tree.
Ordering of the output in client applications.
Status of collecting results for the output version.
Status of the computation which resulted in the output version.
Description that is shown as a tooltip in the clients.
Constant ID of the output, not dependent on model ID, and therefore NOT changing each time a model gets uploaded. Might be undefined because this property was introduced in summer 2020 and does not exist for outputs of older models.
Update the output's content, effectively overriding the content which was output from the model.
This can be used to override the content which was output from the model (e.g. materials). In case you want the override content to persist further calls to ISessionApi.customize, await the call to this function and then set freeze to true.
The new output content.
Option to not update the output immediately (default: false). Use this to update the content of several outputs at the same time, then call ISessionApi.updateOutputs.
The api for an output of a corresponding session.
Outputs represent the channels through which data is output from the model represented by a session. They are computed as part of customizations (see customize).
Outputs contain static properties which do not depend on parameter values, these are:
The remaining properties are dynamic and may change depending on parameter values. Specifically the content property refers to output assets and embedded data.
Each output has a corresponding node in the scene tree which represents the data that got output from the model for the parameter values stored in IParameterApi.sessionValue.
An output's content can be updated manually by calling the updateOutputContent method. Using the freeze property the output's content can be frozen, which means subsequent customize calls will not update the output.